forked from RestComm/sip-servlets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSipFactory.html
689 lines (623 loc) · 35 KB
/
SipFactory.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_14) on Fri Jun 27 17:25:15 PDT 2008 -->
<TITLE>
SipFactory (SIP Servlet API 1.1)
</TITLE>
<META NAME="keywords" CONTENT="javax.servlet.sip.SipFactory interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="SipFactory (SIP Servlet API 1.1)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/servlet/sip/SipErrorListener.html" title="interface in javax.servlet.sip"><B>PREV CLASS</B></A>
<A HREF="../../../javax/servlet/sip/SipServlet.html" title="class in javax.servlet.sip"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/servlet/sip/SipFactory.html" target="_top"><B>FRAMES</B></A>
<A HREF="SipFactory.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.servlet.sip</FONT>
<BR>
Interface SipFactory</H2>
<HR>
<DL>
<DT><PRE>public interface <B>SipFactory</B></DL>
</PRE>
<P>
Factory interface for a variety of SIP Servlet API abstractions.
<p>SIP servlet containers are requried to make a
<code>SipFactory</code> instance available to applications
through a <code>ServletContext</code> attribute with name
<code>javax.servlet.sip.SipFactory</code>.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createAddress(java.lang.String)">createAddress</A></B>(java.lang.String addr)</CODE>
<BR>
Returns a <code>Address</code> corresponding to the specified
string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createAddress(javax.servlet.sip.URI)">createAddress</A></B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri)</CODE>
<BR>
Returns an <code>Address</code> with the specified URI and no
display name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createAddress(javax.servlet.sip.URI, java.lang.String)">createAddress</A></B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri,
java.lang.String displayName)</CODE>
<BR>
Returns a new <code>Address</code> with the specified
<code>URI</code> and display name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createApplicationSession()">createApplicationSession</A></B>()</CODE>
<BR>
Returns a new <code>SipApplicationSession</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createApplicationSessionByKey(java.lang.String)">createApplicationSessionByKey</A></B>(java.lang.String sipApplicationKey)</CODE>
<BR>
Returns a new <code>SipApplicationSession</code> identified by the specified
SipApplicationKey.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/AuthInfo.html" title="interface in javax.servlet.sip">AuthInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createAuthInfo()">createAuthInfo</A></B>()</CODE>
<BR>
Creates a new AuthInfo object that can be used to provide authentication
information on servlet initiated requests.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Parameterable.html" title="interface in javax.servlet.sip">Parameterable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createParameterable(java.lang.String)">createParameterable</A></B>(java.lang.String s)</CODE>
<BR>
Creates a new <code>Parameterable</code> parsed from the specified
string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, javax.servlet.sip.Address, javax.servlet.sip.Address)">createRequest</A></B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> from,
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> to)</CODE>
<BR>
Returns a new request object with the specified request method, From,
and To headers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, java.lang.String, java.lang.String)">createRequest</A></B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
java.lang.String from,
java.lang.String to)</CODE>
<BR>
Returns a new request object with the specified request method, From,
and To headers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, javax.servlet.sip.URI, javax.servlet.sip.URI)">createRequest</A></B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> from,
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> to)</CODE>
<BR>
Returns a new request object with the specified request method, From,
and To headers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createRequest(javax.servlet.sip.SipServletRequest, boolean)">createRequest</A></B>(<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> origRequest,
boolean sameCallId)</CODE>
<BR>
<B>Deprecated.</B> <I>usage of this method is deprecated. Setting the sameCallId
flag to "true" actually breaks the provisions of [RFC 3261] where the
Call-ID value is to be unique accross dialogs.
Instead use a more general method defined on the B2buaHelper
<A HREF="../../../javax/servlet/sip/B2buaHelper.html#createRequest(javax.servlet.sip.SipServletRequest)"><CODE>B2buaHelper.createRequest(SipServletRequest)</CODE></A></I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipURI.html" title="interface in javax.servlet.sip">SipURI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createSipURI(java.lang.String, java.lang.String)">createSipURI</A></B>(java.lang.String user,
java.lang.String host)</CODE>
<BR>
Constructs a <code>SipURI</code> with the specified user and host
components.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipFactory.html#createURI(java.lang.String)">createURI</A></B>(java.lang.String uri)</CODE>
<BR>
Returns a <code>URI</code> object corresponding to the specified
string, which should represent an escaped SIP, SIPS, or tel URI.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="createURI(java.lang.String)"><!-- --></A><H3>
createURI</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> <B>createURI</B>(java.lang.String uri)
throws <A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></PRE>
<DL>
<DD>Returns a <code>URI</code> object corresponding to the specified
string, which should represent an escaped SIP, SIPS, or tel URI.
The <code>URI</code> may then be used as request URI in
SIP requests or as the URI component of <A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip"><CODE>Address</CODE></A> objects.
<p>Implementations must be able to represent URIs of any scheme.
This method returns a <code>SipURI</code> object if the specified
string is a <code>sip</code> or a <code>sips</code> URI, and a
<code>TelURL</code> object if it's a <code>tel</code> URL.
<p>If the specified URI string contains any reserved characters,
then the container is responsible for escaping them,
in accordance with RFC2396.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the SIP, SIPS, or tel string to parse
<DT><B>Returns:</B><DD>a parsed <code>URI</code> object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></CODE> - if the URI scheme
is unknown or parsing failed</DL>
</DD>
</DL>
<HR>
<A NAME="createSipURI(java.lang.String, java.lang.String)"><!-- --></A><H3>
createSipURI</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipURI.html" title="interface in javax.servlet.sip">SipURI</A> <B>createSipURI</B>(java.lang.String user,
java.lang.String host)</PRE>
<DL>
<DD>Constructs a <code>SipURI</code> with the specified user and host
components. The scheme will initially be <code>sip</code> but the
application may change it to <code>sips</code> by calling
<code>setSecure(true)</code> on the returned <code>SipURI</code>.
Likewise, the port number of the new URI is left unspecified but
may subsequently be set by calling <code>setPort</code> on the
returned <code>SipURI</code>.
<p>If the specified URI string contains any reserved characters, then
the container is responsible for escaping them,
in accordance with RFC2396.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>user</CODE> - user part of the new <code>SipURI</code><DD><CODE>host</CODE> - host part of the new <code>SipURI</code>
<DT><B>Returns:</B><DD>new <em>insecure</em> <code>SipURI</code> with the specified
user and host parts</DL>
</DD>
</DL>
<HR>
<A NAME="createAddress(java.lang.String)"><!-- --></A><H3>
createAddress</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> <B>createAddress</B>(java.lang.String addr)
throws <A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></PRE>
<DL>
<DD>Returns a <code>Address</code> corresponding to the specified
string. The resulting object can be used, for example, as the
value of From or To headers of locally initiated SIP requests.
<p>The special argument "*" results in a <em>wildcard</em>
<code>Address</code> being returned, that is, an <code>Address</code>
for which <code>isWildcard</code> returns true. Such addresses are
for use in <code>Contact</code> headers only.
<p>The specified address string must be UTF-8 encoded. Furthermore,
if the URI component of the address string contains any reserved
characters then the container is responsible for escaping them
in accordance with RFC2396 as indicated
for <A HREF="../../../javax/servlet/sip/SipFactory.html#createURI(java.lang.String)"><CODE>createURI(String)</CODE></A>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addr</CODE> - valid value of SIP From or To header
<DT><B>Returns:</B><DD>a parsed <code>Address</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></CODE> - if parsing failed</DL>
</DD>
</DL>
<HR>
<A NAME="createAddress(javax.servlet.sip.URI)"><!-- --></A><H3>
createAddress</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> <B>createAddress</B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri)</PRE>
<DL>
<DD>Returns an <code>Address</code> with the specified URI and no
display name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the <code>URI</code> of the returned <code>Address</code>
<DT><B>Returns:</B><DD>an <code>Address</code> whose <code>URI</code>
component is the argument</DL>
</DD>
</DL>
<HR>
<A NAME="createAddress(javax.servlet.sip.URI, java.lang.String)"><!-- --></A><H3>
createAddress</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> <B>createAddress</B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri,
java.lang.String displayName)</PRE>
<DL>
<DD>Returns a new <code>Address</code> with the specified
<code>URI</code> and display name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - <code>URI</code> of the new <code>Address</code><DD><CODE>displayName</CODE> - display name of the new <code>Address</code></DL>
</DD>
</DL>
<HR>
<A NAME="createParameterable(java.lang.String)"><!-- --></A><H3>
createParameterable</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Parameterable.html" title="interface in javax.servlet.sip">Parameterable</A> <B>createParameterable</B>(java.lang.String s)
throws <A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></PRE>
<DL>
<DD>Creates a new <code>Parameterable</code> parsed from the specified
string. The string must be in the following format:
<pre>
field-value *(;parameter-name[=parameter-value])
</pre>
where the field-value may be in name-addr or addr-spec format as defined in
RFC 3261 or may be any sequence of tokens till the first semicolon.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the header field string
<DT><B>Returns:</B><DD>a parsed <code>Parameterable</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></CODE> - if parsing failed<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, javax.servlet.sip.Address, javax.servlet.sip.Address)"><!-- --></A><H3>
createRequest</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> <B>createRequest</B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> from,
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> to)</PRE>
<DL>
<DD>Returns a new request object with the specified request method, From,
and To headers. The returned request object exists in a new
<code>SipSession</code> which belongs to the specified
<code>SipApplicationSession</code>.
<p>This method is used by servlets acting as SIP clients in order to
send a request in a new call leg. The container is responsible for
assigning the request appropriate Call-ID and CSeq headers, as well as
Contact header <em>if</em> the method is not REGISTER.
<p>This method makes a copy of the from and to arguments and
associates them with the new <code>SipSession</code>. Any component
of the from and to URIs not allowed in the context of SIP
From and To headers are removed from the copies [refer Table 1, Section 19.1.1, RFC3261].
This includes,
headers and various parameters. Also, a "tag" parameter in either
of the copied from or to is also removed, as it is illegal in an
initial To header and the container will choose it's own tag for
the From header. The copied from and to addresses can be obtained
from the SipSession but must not be modified by applications.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>appSession</CODE> - the application session to which the new
<code>SipSession</code> and <code>SipServletRequest</code>
belongs<DD><CODE>method</CODE> - the method of the new request, e.g. "INVITE"<DD><CODE>from</CODE> - value of the From header<DD><CODE>to</CODE> - value of the To header
<DT><B>Returns:</B><DD>the request object with method, request URI,
and From, To, Call-ID, CSeq, Route headers filled in.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the method is "ACK" or "CANCEL",
or the specified SipApplicationSession is invalid.</DL>
</DD>
</DL>
<HR>
<A NAME="createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, javax.servlet.sip.URI, javax.servlet.sip.URI)"><!-- --></A><H3>
createRequest</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> <B>createRequest</B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> from,
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> to)</PRE>
<DL>
<DD>Returns a new request object with the specified request method, From,
and To headers. The returned request object exists in a new
<code>SipSession</code> which belongs to the specified
<code>SipApplicationSession</code>.
<p>This method is used by servlets acting as SIP clients in order to
send a request in a new call leg. The container is responsible for
assigning the request appropriate Call-ID and CSeq headers, as well as
Contact header <em>if</em> the method is not REGISTER.
<p>This method makes a copy of the from and to arguments and
associates them with the new <code>SipSession</code>. Any component
of the from and to URIs not allowed in the context of SIP
From and To headers are removed from the copies [refer Table 1, Section 19.1.1, RFC3261].
This includes,
headers and various parameters.
The from and to addresses can subsequently be obtained from the
SipSession or the returned request object but must not be modified
by applications.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>appSession</CODE> - the application session to which the new
<code>SipSession</code> and <code>SipServletRequest</code>
belongs<DD><CODE>method</CODE> - the method of the new request, e.g. "INVITE"<DD><CODE>from</CODE> - value of the From header<DD><CODE>to</CODE> - value of the To header
<DT><B>Returns:</B><DD>the request object with method, request URI,
and From, To, Call-ID, CSeq, Route headers filled in.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the method is "ACK" or "CANCEL",
or the specified SipApplicationSession is invalid.</DL>
</DD>
</DL>
<HR>
<A NAME="createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
createRequest</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> <B>createRequest</B>(<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> appSession,
java.lang.String method,
java.lang.String from,
java.lang.String to)
throws <A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></PRE>
<DL>
<DD>Returns a new request object with the specified request method, From,
and To headers. The returned request object exists in a new
<code>SipSession</code> which belongs to the specified
<code>SipApplicationSession</code>.
<p>This method is used by servlets acting as SIP clients in order to
send a request in a new call leg. The container is responsible for
assigning the request appropriate Call-ID and CSeq headers, as well as
Contact header <em>if</em> the method is not REGISTER.
<p>This method is functionally equivalent to:
<pre>
createRequest(method, f.createAddress(from), f.createAddress(to));
</pre>
Note that this implies that if either of the from or to argument
is a SIP URI containing parameters, the URI must be enclosed in
angle brackets. Otherwise the address will be parsed as if the
parameter belongs to the address and not the URI.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>appSession</CODE> - the application session to which the new
<code>SipSession</code> and <code>SipServletRequest</code>
belongs<DD><CODE>method</CODE> - the method of the new request, e.g. "INVITE"<DD><CODE>from</CODE> - value of the From header -- this must be a
valid <code>Address</code><DD><CODE>to</CODE> - value of the To header -- this must be a
valid <code>Address</code>
<DT><B>Returns:</B><DD>the request object with method, request URI,
and From, To, Call-ID, CSeq, Route headers filled in.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/ServletParseException.html" title="class in javax.servlet.sip">ServletParseException</A></CODE> - if the URI scheme of
the from or to argument is unknown or if parsing failed
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the method is "ACK" or "CANCEL",
or the specified SipApplicationSession is invalid.</DL>
</DD>
</DL>
<HR>
<A NAME="createRequest(javax.servlet.sip.SipServletRequest, boolean)"><!-- --></A><H3>
createRequest</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> <B>createRequest</B>(<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> origRequest,
boolean sameCallId)</PRE>
<DL>
<DD><B>Deprecated.</B> <I>usage of this method is deprecated. Setting the sameCallId
flag to "true" actually breaks the provisions of [RFC 3261] where the
Call-ID value is to be unique accross dialogs.
Instead use a more general method defined on the B2buaHelper
<A HREF="../../../javax/servlet/sip/B2buaHelper.html#createRequest(javax.servlet.sip.SipServletRequest)"><CODE>B2buaHelper.createRequest(SipServletRequest)</CODE></A></I>
<P>
<DD>Creates a new request object belonging to a new SipSession. The
new request is similar to the specified <code>origRequest</code>
in that the method and the majority of header fields are copied
from <code>origRequest</code> to the new request. The SipSession
created for the new request also shares the same SipApplicationSession
associated with the original request.
<p>This method satisfies the following rules:
<ul>
<li>The From header field of the new request has a new tag chosen
by the container.
<li>The To header field of the new request has no tag.
<li>If the <code>sameCallId</code> argument is false, the new
request (and the corresponding <code>SipSession</code>)is
assigned a new Call-ID.
<li>Record-Route and Via header fields are not copied. As usual,
the container will add its own Via header field to the request
when it's actually sent outside the application server.
<li>For non-REGISTER requests, the Contact header field is not
copied but is populated by the container as usual.
</ul>
<p>This method provides a convenient and efficient way of
constructing the second "leg" of a B2BUA application. It is used
only for the initial request. Subsequent requests in either leg
must be created using <A HREF="../../../javax/servlet/sip/SipSession.html#createRequest(java.lang.String)"><CODE>SipSession.createRequest(java.lang.String)</CODE></A> as usual.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>origRequest</CODE> - request to be "copied"<DD><CODE>sameCallId</CODE> - whether or not to use same Call-ID for the new
dialog
<DT><B>Returns:</B><DD>the "copied" request object</DL>
</DD>
</DL>
<HR>
<A NAME="createApplicationSession()"><!-- --></A><H3>
createApplicationSession</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> <B>createApplicationSession</B>()</PRE>
<DL>
<DD>Returns a new <code>SipApplicationSession</code>. This is useful,
for example, when an application is being initialized and wishes
to perform some signaling action.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a new <code>SipApplicationSession</code> object</DL>
</DD>
</DL>
<HR>
<A NAME="createApplicationSessionByKey(java.lang.String)"><!-- --></A><H3>
createApplicationSessionByKey</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipApplicationSession.html" title="interface in javax.servlet.sip">SipApplicationSession</A> <B>createApplicationSessionByKey</B>(java.lang.String sipApplicationKey)</PRE>
<DL>
<DD>Returns a new <code>SipApplicationSession</code> identified by the specified
SipApplicationKey. This is same as the one generated by the method annotated
with @SipApplicationKey annotation.
This allows a way to associate incoming requests to an
already existing SipApplicationSession.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sipApplicationKey</CODE> - id for the <code>SipApplicationSession</code>
<DT><B>Returns:</B><DD>a new <code>SipApplicationSession</code> object with the specified id<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="createAuthInfo()"><!-- --></A><H3>
createAuthInfo</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/AuthInfo.html" title="interface in javax.servlet.sip">AuthInfo</A> <B>createAuthInfo</B>()</PRE>
<DL>
<DD>Creates a new AuthInfo object that can be used to provide authentication
information on servlet initiated requests.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>AuthInfo a new instance of <code>AuthInfo</code></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/servlet/sip/SipErrorListener.html" title="interface in javax.servlet.sip"><B>PREV CLASS</B></A>
<A HREF="../../../javax/servlet/sip/SipServlet.html" title="class in javax.servlet.sip"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/servlet/sip/SipFactory.html" target="_top"><B>FRAMES</B></A>
<A HREF="SipFactory.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>