forked from RestComm/sip-servlets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSipServletRequest.html
1092 lines (987 loc) · 52.8 KB
/
SipServletRequest.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
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>
SipServletRequest (SIP Servlet API 1.1)
</TITLE>
<META NAME="keywords" CONTENT="javax.servlet.sip.SipServletRequest interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="SipServletRequest (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/SipServletMessage.HeaderForm.html" title="enum in javax.servlet.sip"><B>PREV CLASS</B></A>
<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface 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/SipServletRequest.html" target="_top"><B>FRAMES</B></A>
<A HREF="SipServletRequest.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 SipServletRequest</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD>java.lang.Cloneable, javax.servlet.ServletRequest, <A HREF="../../../javax/servlet/sip/SipServletMessage.html" title="interface in javax.servlet.sip">SipServletMessage</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>SipServletRequest</B><DT>extends javax.servlet.ServletRequest, <A HREF="../../../javax/servlet/sip/SipServletMessage.html" title="interface in javax.servlet.sip">SipServletMessage</A></DL>
</PRE>
<P>
Represents SIP request messages. When receiving an incoming SIP request
the container creates a <code>SipServletRequest</code> and passes it to
the handling servlet. For outgoing, locally initiated requests,
applications call <A HREF="../../../javax/servlet/sip/SipFactory.html#createRequest(javax.servlet.sip.SipApplicationSession, java.lang.String, javax.servlet.sip.Address, javax.servlet.sip.Address)"><CODE>SipFactory.createRequest</CODE></A>
to obtain a <code>SipServletRequest</code> that can then be modified and
sent.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="nested_classes_inherited_from_class_javax.servlet.sip.SipServletMessage"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface javax.servlet.sip.<A HREF="../../../javax/servlet/sip/SipServletMessage.html" title="interface in javax.servlet.sip">SipServletMessage</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../javax/servlet/sip/SipServletMessage.HeaderForm.html" title="enum in javax.servlet.sip">SipServletMessage.HeaderForm</A></CODE></TD>
</TR>
</TABLE>
<!-- ========== 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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#addAuthHeader(javax.servlet.sip.SipServletResponse, javax.servlet.sip.AuthInfo)">addAuthHeader</A></B>(<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A> challengeResponse,
<A HREF="../../../javax/servlet/sip/AuthInfo.html" title="interface in javax.servlet.sip">AuthInfo</A> authInfo)</CODE>
<BR>
This method allows the addition of the appropriate authentication header(s)
to the request that was challenged with a challenge response.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#addAuthHeader(javax.servlet.sip.SipServletResponse, java.lang.String, java.lang.String)">addAuthHeader</A></B>(<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A> challengeResponse,
java.lang.String username,
java.lang.String password)</CODE>
<BR>
This method allows the addition of the appropriate authentication header(s)
to the request that was challenged with a challenge response without needing the
creation and/or maintenance of the <code>AuthInfo</code> object.</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/SipServletRequest.html#createCancel()">createCancel</A></B>()</CODE>
<BR>
Returns a CANCEL request object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#createResponse(int)">createResponse</A></B>(int statuscode)</CODE>
<BR>
Creates a response for this request with the specifies status code.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#createResponse(int, java.lang.String)">createResponse</A></B>(int statusCode,
java.lang.String reasonPhrase)</CODE>
<BR>
Creates a response for this request with the specifies status code
and reason phrase.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/B2buaHelper.html" title="interface in javax.servlet.sip">B2buaHelper</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getB2buaHelper()">getB2buaHelper</A></B>()</CODE>
<BR>
Returns the B2buaHelper associated with this request.</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/SipServletRequest.html#getInitialPoppedRoute()">getInitialPoppedRoute</A></B>()</CODE>
<BR>
If a top route header had been removed by the container upon
initially receiving this request, then this method can be used to
retrieve it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> javax.servlet.ServletInputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getInputStream()">getInputStream</A></B>()</CODE>
<BR>
Always returns null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getMaxForwards()">getMaxForwards</A></B>()</CODE>
<BR>
Returns the value of the Max-Forwards header.</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/SipServletRequest.html#getPoppedRoute()">getPoppedRoute</A></B>()</CODE>
<BR>
If a top route header had been removed by the container upon receiving
this request, then this method can be used to retrieve it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Proxy.html" title="interface in javax.servlet.sip">Proxy</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getProxy()">getProxy</A></B>()</CODE>
<BR>
Returns the <code>Proxy</code> object associated with this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/Proxy.html" title="interface in javax.servlet.sip">Proxy</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getProxy(boolean)">getProxy</A></B>(boolean create)</CODE>
<BR>
Returns the <code>Proxy</code> object associated with this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.io.BufferedReader</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getReader()">getReader</A></B>()</CODE>
<BR>
Always returns null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingRegion.html" title="class in javax.servlet.sip.ar">SipApplicationRoutingRegion</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getRegion()">getRegion</A></B>()</CODE>
<BR>
This method allows the application to obtain the region it was
invoked in for this SipServletRequest.</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/SipServletRequest.html#getRequestURI()">getRequestURI</A></B>()</CODE>
<BR>
Returns the request URI of this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingDirective.html" title="enum in javax.servlet.sip.ar">SipApplicationRoutingDirective</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getRoutingDirective()">getRoutingDirective</A></B>()</CODE>
<BR>
Returns the <code>SipApplicationRoutingDirective</code> associated with
this request.</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/SipServletRequest.html#getSubscriberURI()">getSubscriberURI</A></B>()</CODE>
<BR>
Returns the URI of the subscriber for which this application
is invoked to serve.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#isInitial()">isInitial</A></B>()</CODE>
<BR>
Returns true if this is an <em>initial request</em>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#pushPath(javax.servlet.sip.Address)">pushPath</A></B>(<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> uri)</CODE>
<BR>
Adds a Path header field value to this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#pushRoute(javax.servlet.sip.Address)">pushRoute</A></B>(<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> uri)</CODE>
<BR>
Adds a Route header field value to this request with Address argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#pushRoute(javax.servlet.sip.SipURI)">pushRoute</A></B>(<A HREF="../../../javax/servlet/sip/SipURI.html" title="interface in javax.servlet.sip">SipURI</A> uri)</CODE>
<BR>
Adds a Route header field value to this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#send()">send</A></B>()</CODE>
<BR>
Causes this request to be sent.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#setMaxForwards(int)">setMaxForwards</A></B>(int n)</CODE>
<BR>
Sets the value of the Max-Forwards header.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#setRequestURI(javax.servlet.sip.URI)">setRequestURI</A></B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri)</CODE>
<BR>
Sets the request URI of this request.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/servlet/sip/SipServletRequest.html#setRoutingDirective(javax.servlet.sip.ar.SipApplicationRoutingDirective, javax.servlet.sip.SipServletRequest)">setRoutingDirective</A></B>(<A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingDirective.html" title="enum in javax.servlet.sip.ar">SipApplicationRoutingDirective</A> directive,
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> origRequest)</CODE>
<BR>
Sets the application routing directive for an outgoing request.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.servlet.ServletRequest"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.ServletRequest</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding</CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.servlet.sip.SipServletMessage"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.sip.<A HREF="../../../javax/servlet/sip/SipServletMessage.html" title="interface in javax.servlet.sip">SipServletMessage</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../javax/servlet/sip/SipServletMessage.html#addAcceptLanguage(java.util.Locale)">addAcceptLanguage</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#addAddressHeader(java.lang.String, javax.servlet.sip.Address, boolean)">addAddressHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#addHeader(java.lang.String, java.lang.String)">addHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#addParameterableHeader(java.lang.String, javax.servlet.sip.Parameterable, boolean)">addParameterableHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAcceptLanguage()">getAcceptLanguage</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAcceptLanguages()">getAcceptLanguages</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAddressHeader(java.lang.String)">getAddressHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAddressHeaders(java.lang.String)">getAddressHeaders</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getApplicationSession()">getApplicationSession</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getApplicationSession(boolean)">getApplicationSession</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getAttributeNames()">getAttributeNames</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getCallId()">getCallId</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getCharacterEncoding()">getCharacterEncoding</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContent()">getContent</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContentLanguage()">getContentLanguage</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContentLength()">getContentLength</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContentType()">getContentType</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getExpires()">getExpires</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getFrom()">getFrom</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getHeader(java.lang.String)">getHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getHeaderForm()">getHeaderForm</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getHeaderNames()">getHeaderNames</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getHeaders(java.lang.String)">getHeaders</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getInitialRemoteAddr()">getInitialRemoteAddr</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getInitialRemotePort()">getInitialRemotePort</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getInitialTransport()">getInitialTransport</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getLocalAddr()">getLocalAddr</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getLocalPort()">getLocalPort</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getMethod()">getMethod</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getParameterableHeader(java.lang.String)">getParameterableHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getParameterableHeaders(java.lang.String)">getParameterableHeaders</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getProtocol()">getProtocol</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRawContent()">getRawContent</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRemoteAddr()">getRemoteAddr</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRemotePort()">getRemotePort</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRemoteUser()">getRemoteUser</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getSession()">getSession</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getSession(boolean)">getSession</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getTo()">getTo</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getTransport()">getTransport</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getUserPrincipal()">getUserPrincipal</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#isCommitted()">isCommitted</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#isSecure()">isSecure</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#isUserInRole(java.lang.String)">isUserInRole</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#removeHeader(java.lang.String)">removeHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setAcceptLanguage(java.util.Locale)">setAcceptLanguage</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setAddressHeader(java.lang.String, javax.servlet.sip.Address)">setAddressHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setContent(java.lang.Object, java.lang.String)">setContent</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setContentLanguage(java.util.Locale)">setContentLanguage</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setContentLength(int)">setContentLength</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setContentType(java.lang.String)">setContentType</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setExpires(int)">setExpires</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setHeader(java.lang.String, java.lang.String)">setHeader</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setHeaderForm(javax.servlet.sip.SipServletMessage.HeaderForm)">setHeaderForm</A>, <A HREF="../../../javax/servlet/sip/SipServletMessage.html#setParameterableHeader(java.lang.String, javax.servlet.sip.Parameterable)">setParameterableHeader</A></CODE></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="getRequestURI()"><!-- --></A><H3>
getRequestURI</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> <B>getRequestURI</B>()</PRE>
<DL>
<DD>Returns the request URI of this request.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>request URI of this <code>SipServletRequest</code></DL>
</DD>
</DL>
<HR>
<A NAME="setRequestURI(javax.servlet.sip.URI)"><!-- --></A><H3>
setRequestURI</H3>
<PRE>
void <B>setRequestURI</B>(<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> uri)</PRE>
<DL>
<DD>Sets the request URI of this request. This then becomes the
destination used in a subsequent invocation of <A HREF="../../../javax/servlet/sip/SipServletRequest.html#send()"><CODE>send</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - new request URI of this <code>SipServletRequest</code>
<DT><B>Throws:</B>
<DD><CODE>java.lang.NullPointerException</CODE> - on null <code>uri</code></DL>
</DD>
</DL>
<HR>
<A NAME="pushRoute(javax.servlet.sip.SipURI)"><!-- --></A><H3>
pushRoute</H3>
<PRE>
void <B>pushRoute</B>(<A HREF="../../../javax/servlet/sip/SipURI.html" title="interface in javax.servlet.sip">SipURI</A> uri)</PRE>
<DL>
<DD>Adds a Route header field value to this request. The new value is
added ahead of any existing Route header fields. If this request does
not already contains a Route header, one is added with the value
as specified in the argument.
<p>This method allows a UAC or a proxy to specify that the request
should visit one or more proxies before being delivered to the
destination.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the address that is added as a Route header value<DT><B>See Also:</B><DD>"RFC 3261, section 16.6",
<A HREF="../../../javax/servlet/sip/SipServletRequest.html#pushRoute(javax.servlet.sip.Address)"><CODE>pushRoute(Address)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="pushRoute(javax.servlet.sip.Address)"><!-- --></A><H3>
pushRoute</H3>
<PRE>
void <B>pushRoute</B>(<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> uri)</PRE>
<DL>
<DD>Adds a Route header field value to this request with Address argument. The new value is
added ahead of any existing Route header fields. If this request does
not already contains a Route header, one is added with the value
as specified in the argument.
<p>This method allows a UAC or a proxy to specify that the request
should visit one or more proxies before being delivered to the
destination.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the address that is added as a Route header value<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD>"RFC 3261, section 16.6",
<A HREF="../../../javax/servlet/sip/SipServletRequest.html#pushRoute(javax.servlet.sip.SipURI)"><CODE>pushRoute(SipURI)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getMaxForwards()"><!-- --></A><H3>
getMaxForwards</H3>
<PRE>
int <B>getMaxForwards</B>()</PRE>
<DL>
<DD>Returns the value of the Max-Forwards header.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the value of the Max-Forwards header, or -1 if there is no
such header in this message</DL>
</DD>
</DL>
<HR>
<A NAME="setMaxForwards(int)"><!-- --></A><H3>
setMaxForwards</H3>
<PRE>
void <B>setMaxForwards</B>(int n)</PRE>
<DL>
<DD>Sets the value of the Max-Forwards header. Max-Forwards serves to
limit the number of hops a request can make on the way to its
destination. It consists of an integer that is decremented by one
at each hop.
<p>This method is equivalent to:
<pre>
setHeader("Max-Forwards", String.valueOf(n));
</pre>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>n</CODE> - new value of the Max-Forwards header
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the argument is not in the range
0 to 255</DL>
</DD>
</DL>
<HR>
<A NAME="send()"><!-- --></A><H3>
send</H3>
<PRE>
void <B>send</B>()
throws java.io.IOException</PRE>
<DL>
<DD>Causes this request to be sent. This method is used by SIP servlets
acting as user agent clients (UACs) only. Proxying applications use
<A HREF="../../../javax/servlet/sip/Proxy.html#proxyTo(javax.servlet.sip.URI)"><CODE>Proxy.proxyTo(javax.servlet.sip.URI)</CODE></A> instead.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/servlet/sip/SipServletMessage.html#send()">send</A></CODE> in interface <CODE><A HREF="../../../javax/servlet/sip/SipServletMessage.html" title="interface in javax.servlet.sip">SipServletMessage</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if a transport error occurs when trying to
send this request</DL>
</DD>
</DL>
<HR>
<A NAME="isInitial()"><!-- --></A><H3>
isInitial</H3>
<PRE>
boolean <B>isInitial</B>()</PRE>
<DL>
<DD>Returns true if this is an <em>initial request</em>. An initial
request is one that is dispatched to applications based on the
containers configured rule set, as opposed to subsequent requests
which are routed based on the <em>application path</em> established
by a previous initial request.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this is an initial request</DL>
</DD>
</DL>
<HR>
<A NAME="getInputStream()"><!-- --></A><H3>
getInputStream</H3>
<PRE>
javax.servlet.ServletInputStream <B>getInputStream</B>()
throws java.io.IOException</PRE>
<DL>
<DD>Always returns null. SIP is not a content transfer protocol and
having stream based content accessors is of little utility.
<p>Message content can be retrieved using <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContent()"><CODE>SipServletMessage.getContent()</CODE></A>
and <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRawContent()"><CODE>SipServletMessage.getRawContent()</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getInputStream</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>null
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getReader()"><!-- --></A><H3>
getReader</H3>
<PRE>
java.io.BufferedReader <B>getReader</B>()
throws java.io.IOException</PRE>
<DL>
<DD>Always returns null. SIP is not a content transfer protocol and
having stream based content accessors is of little utility.
<p>Message content can be retrieved using <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getContent()"><CODE>SipServletMessage.getContent()</CODE></A>
and <A HREF="../../../javax/servlet/sip/SipServletMessage.html#getRawContent()"><CODE>SipServletMessage.getRawContent()</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getReader</CODE> in interface <CODE>javax.servlet.ServletRequest</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>null
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getProxy()"><!-- --></A><H3>
getProxy</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Proxy.html" title="interface in javax.servlet.sip">Proxy</A> <B>getProxy</B>()
throws <A HREF="../../../javax/servlet/sip/TooManyHopsException.html" title="class in javax.servlet.sip">TooManyHopsException</A></PRE>
<DL>
<DD>Returns the <code>Proxy</code> object associated with this request.
A <code>Proxy</code> instance will be created if one doesn't already
exist. This method behaves the same as <code>getProxy(true)</code>.
<p>Note that the container must return the <em>same</em>
<code>Proxy</code> instance whenever a servlet invokes
<code>getProxy</code> on messages belonging to the same transaction.
In particular, a response to a proxied request is associated with
the same <code>Proxy</code> object as is the original request.
<p>This method throws an <code>IllegalStateException</code> if the
<code>Proxy</code> object didn't already exist and the transaction
underlying this SIP message is in a state which doesn't allow proxying,
for example if this is a <code>SipServletRequest</code> for which a
final response has already been generated.
<p>If the request contains a Max-Forwards header field value of 0,
then this method will generate a 483 (Too many hops) error response
and throw <code>TooManyHopsException</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>Proxy</code> object associated with this request
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/TooManyHopsException.html" title="class in javax.servlet.sip">TooManyHopsException</A></CODE> - if the request has a Max-Forwards
header field value of 0.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the transaction underlying this
message isn't already associated with a <code>Proxy</code>
object and its state disallows proxying to be initiated,
for example, because a final response has already been generated. Also
if the application previously accessed the B2buaHelper by invoking
<A HREF="../../../javax/servlet/sip/SipServletRequest.html#getB2buaHelper()"><CODE>getB2buaHelper()</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../javax/servlet/sip/SipServletRequest.html#getProxy(boolean)"><CODE>getProxy(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getProxy(boolean)"><!-- --></A><H3>
getProxy</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Proxy.html" title="interface in javax.servlet.sip">Proxy</A> <B>getProxy</B>(boolean create)
throws <A HREF="../../../javax/servlet/sip/TooManyHopsException.html" title="class in javax.servlet.sip">TooManyHopsException</A></PRE>
<DL>
<DD>Returns the <code>Proxy</code> object associated with this request.
If no <code>Proxy</code> object has yet been created for this request,
the <code>create</code> argument specifies whether a <code>Proxy</code>
object is to be created or not.
<p>Once a <code>Proxy</code> object has been associated with a request
subsequent invocations of this method will yield the same
<code>Proxy</code> object, as will the no-argument
<A HREF="../../../javax/servlet/sip/SipServletRequest.html#getProxy()"><CODE>getProxy()</CODE></A> method and <A HREF="../../../javax/servlet/sip/SipServletResponse.html#getProxy()"><CODE>SipServletResponse.getProxy()</CODE></A>
for responses received to proxied requests.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>create</CODE> - indicates whether the servlet engine should create
a new <code>Proxy</code> object if one does not already exist
<DT><B>Returns:</B><DD><code>Proxy</code> object associated with this request
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/servlet/sip/TooManyHopsException.html" title="class in javax.servlet.sip">TooManyHopsException</A></CODE> - if this request has a Max-Forwards
header field value of 0.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the transaction has already completed</DL>
</DD>
</DL>
<HR>
<A NAME="createResponse(int)"><!-- --></A><H3>
createResponse</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A> <B>createResponse</B>(int statuscode)</PRE>
<DL>
<DD>Creates a response for this request with the specifies status code.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>statuscode</CODE> - status code for the response
<DT><B>Returns:</B><DD>response object with specified status code
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the statuscode is not a valid
SIP status code
<DD><CODE>java.lang.IllegalStateException</CODE> - if this request has already been
responded to with a final status code</DL>
</DD>
</DL>
<HR>
<A NAME="createResponse(int, java.lang.String)"><!-- --></A><H3>
createResponse</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A> <B>createResponse</B>(int statusCode,
java.lang.String reasonPhrase)</PRE>
<DL>
<DD>Creates a response for this request with the specifies status code
and reason phrase.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>statusCode</CODE> - status code for the response<DD><CODE>reasonPhrase</CODE> - reason phrase to appear in response line
<DT><B>Returns:</B><DD>response object with specified status code and reason phrase
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the statuscode is not a valid
SIP status code
<DD><CODE>java.lang.IllegalStateException</CODE> - if this request has already been
responded to with a final status code</DL>
</DD>
</DL>
<HR>
<A NAME="createCancel()"><!-- --></A><H3>
createCancel</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> <B>createCancel</B>()</PRE>
<DL>
<DD>Returns a CANCEL request object. This method is used by
applications to cancel outstanding transactions for which they
act as a user agent client (UAC). The CANCEL request is sent
when the application invokes <A HREF="../../../javax/servlet/sip/SipServletRequest.html#send()"><CODE>send()</CODE></A> on
it.
<p>Note that proxy applications MUST use <A HREF="../../../javax/servlet/sip/Proxy.html#cancel()"><CODE>Proxy.cancel()</CODE></A>
to cancel outstanding branches.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>CANCEL request object corresponding to this request
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if the transaction state is such that
it doesn't allow a CANCEL request to be sent</DL>
</DD>
</DL>
<HR>
<A NAME="pushPath(javax.servlet.sip.Address)"><!-- --></A><H3>
pushPath</H3>
<PRE>
void <B>pushPath</B>(<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> uri)</PRE>
<DL>
<DD>Adds a Path header field value to this request. The new value is
added ahead of any existing Path header fields. If this request
does not already contain a Path header, one is added with the
value specified in the argument.
This method allows a UAC or a proxy to add Path on a REGISTER
Request.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - The address that is added as a Route header value
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if invoked on non-REGISTER Request.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getB2buaHelper()"><!-- --></A><H3>
getB2buaHelper</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/B2buaHelper.html" title="interface in javax.servlet.sip">B2buaHelper</A> <B>getB2buaHelper</B>()</PRE>
<DL>
<DD>Returns the B2buaHelper associated with this request. Invocation of
this method also indicates to the container that the application
wishes to be a B2BUA, and any subsequent call to <A HREF="../../../javax/servlet/sip/SipServletRequest.html#getProxy()"><CODE>getProxy()</CODE></A> will
result in IllegalStateException.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the B2buaHelper for this request
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if getProxy() had already been called<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPoppedRoute()"><!-- --></A><H3>
getPoppedRoute</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> <B>getPoppedRoute</B>()</PRE>
<DL>
<DD>If a top route header had been removed by the container upon receiving
this request, then this method can be used to retrieve it. Otherwise,
if no route header had been popped then this method will return null.
<p>Note that the URI parameters added to the Record-Route header using
<A HREF="../../../javax/servlet/sip/Proxy.html#getRecordRouteURI()"><CODE>Proxy.getRecordRouteURI()</CODE></A> should be retrieved from the URI of
the popped route Address using
<code>poppedRoute.getURI().getParameter()</code> and not using
<code>poppedRoute.getParameter()</code>.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the popped top route header, or null if none<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getInitialPoppedRoute()"><!-- --></A><H3>
getInitialPoppedRoute</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/Address.html" title="interface in javax.servlet.sip">Address</A> <B>getInitialPoppedRoute</B>()</PRE>
<DL>
<DD>If a top route header had been removed by the container upon
initially receiving this request, then this method can be used to
retrieve it. Otherwise, if no route header had been popped then this
method will return null. <br/>
Unlike <code>getPoppedRoute()</code>, this method returns the same
value regardless of which application invokes it in the same application
composition chain.
<p>Note that the URI parameters added to the Record-Route header using
<A HREF="../../../javax/servlet/sip/Proxy.html#getRecordRouteURI()"><CODE>Proxy.getRecordRouteURI()</CODE></A> should be retrieved from the URI of
the popped route Address using
<code>initialPoppedRoute.getURI().getParameter()</code> and not using
<code>initialPoppedRoute.getParameter()</code>.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the popped top route header, or null if none<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setRoutingDirective(javax.servlet.sip.ar.SipApplicationRoutingDirective, javax.servlet.sip.SipServletRequest)"><!-- --></A><H3>
setRoutingDirective</H3>
<PRE>
void <B>setRoutingDirective</B>(<A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingDirective.html" title="enum in javax.servlet.sip.ar">SipApplicationRoutingDirective</A> directive,
<A HREF="../../../javax/servlet/sip/SipServletRequest.html" title="interface in javax.servlet.sip">SipServletRequest</A> origRequest)
throws java.lang.IllegalStateException</PRE>
<DL>
<DD>Sets the application routing directive for an outgoing request.
<p>
By default, a request created by
SipFactory.createRequest(SipServletRequest origRequest,
boolean sameCallId) continues the application selection
process from origRequest, i.e. directive is CONTINUE. A
request created by the other SipFactory.createRequest()
methods starts the application selection process afresh,
i.e. directive is NEW.
<p>
This method allows the servlet to assign a routing directive
different from the default.
<p>
If directive is NEW, origRequest parameter is ignored.
If directive is CONTINUE or REVERSE, the parameter origRequest must
be an initial request dispatched by the container to this application,
i.e. origRequest.isInitial() must be true. This request
must be a request created in a new SipSession or from
an initial request, and must not have been sent. If any
one of these preconditions are not met, the method throws
an IllegalStateException.
<p>
Note that when a servlet acts as a proxy and calls
Proxy.proxyTo() to proxy a request, the request is always
a continuation.
<p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>directive</CODE> - Routing directive<DD><CODE>origRequest</CODE> - An initial request that the application received
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - when given directive cannot be set<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getRoutingDirective()"><!-- --></A><H3>
getRoutingDirective</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingDirective.html" title="enum in javax.servlet.sip.ar">SipApplicationRoutingDirective</A> <B>getRoutingDirective</B>()
throws java.lang.IllegalStateException</PRE>
<DL>
<DD>Returns the <code>SipApplicationRoutingDirective</code> associated with
this request.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>SipApplicationRoutingDirective</code> associated with this
request.
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if called on a request that is not initial</DL>
</DD>
</DL>
<HR>
<A NAME="getRegion()"><!-- --></A><H3>
getRegion</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/ar/SipApplicationRoutingRegion.html" title="class in javax.servlet.sip.ar">SipApplicationRoutingRegion</A> <B>getRegion</B>()</PRE>
<DL>
<DD>This method allows the application to obtain the region it was
invoked in for this SipServletRequest. This information helps the application to
determine the location of the subscriber returned by
<code>SipServletRequest.getSubscriberURI()</code>.
<p>
If this SipServletRequest is an initial request, this method returns the
region in which this servlet is invoked. The <code>SipApplicationRoutingRegion</code>
is only available for initial requests. For all other requests, this
method throws IllegalStateException.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The routing region (ORIGINATING, NEUTRAL, TERMINATING or their
sub-regions)
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a request that is not initial.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSubscriberURI()"><!-- --></A><H3>
getSubscriberURI</H3>
<PRE>
<A HREF="../../../javax/servlet/sip/URI.html" title="interface in javax.servlet.sip">URI</A> <B>getSubscriberURI</B>()</PRE>
<DL>
<DD>Returns the URI of the subscriber for which this application
is invoked to serve. This is only available if this SipServletRequest
received is an initial request. For all other requests, this method throws
IllegalStateException.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>URI of the subscriber
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalStateException</CODE> - if this method is called on a request that is not initial.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="addAuthHeader(javax.servlet.sip.SipServletResponse, javax.servlet.sip.AuthInfo)"><!-- --></A><H3>
addAuthHeader</H3>
<PRE>
void <B>addAuthHeader</B>(<A HREF="../../../javax/servlet/sip/SipServletResponse.html" title="interface in javax.servlet.sip">SipServletResponse</A> challengeResponse,
<A HREF="../../../javax/servlet/sip/AuthInfo.html" title="interface in javax.servlet.sip">AuthInfo</A> authInfo)</PRE>
<DL>
<DD>This method allows the addition of the appropriate authentication header(s)
to the request that was challenged with a challenge response.
<P>
<DD><DL>