java.lang.Throwable
- java.lang.Exception
- javax.servlet.ServletException
- javax.servlet.sip.Rel100Exception
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -javax.servlet.* | -
|---|
- -
| javax.servlet.sip.Rel100Exception | -||
|---|---|---|
-public static final int |
-NO_REQ_SUPPORT |
-2 |
-
-public static final int |
-NOT_100rel |
-4 |
-
-public static final int |
-NOT_1XX |
-0 |
-
-public static final int |
-NOT_INVITE |
-1 |
-
-public static final int |
-NOT_SUPPORTED |
-3 |
-
- -
- -
| javax.servlet.sip.SipServlet | -||
|---|---|---|
-public static final java.lang.String |
-OUTBOUND_INTERFACES |
-"javax.servlet.sip.outboundInterfaces" |
-
-public static final java.lang.String |
-PRACK_SUPPORTED |
-"javax.servlet.sip.100rel" |
-
-public static final java.lang.String |
-SIP_FACTORY |
-"javax.servlet.sip.SipFactory" |
-
-public static final java.lang.String |
-SIP_SESSIONS_UTIL |
-"javax.servlet.sip.SipSessionsUtil" |
-
-public static final java.lang.String |
-SUPPORTED |
-"javax.servlet.sip.supported" |
-
-public static final java.lang.String |
-SUPPORTED_RFCs |
-"javax.servlet.sip.supportedRfcs" |
-
-public static final java.lang.String |
-TIMER_SERVICE |
-"javax.servlet.sip.TimerService" |
-
- -
- -
| javax.servlet.sip.SipServletResponse | -||
|---|---|---|
-public static final int |
-SC_ACCEPTED |
-202 |
-
-public static final int |
-SC_ADDRESS_INCOMPLETE |
-484 |
-
-public static final int |
-SC_ALTERNATIVE_SERVICE |
-380 |
-
-public static final int |
-SC_AMBIGUOUS |
-485 |
-
-public static final int |
-SC_BAD_EVENT |
-489 |
-
-public static final int |
-SC_BAD_EXTENSION |
-420 |
-
-public static final int |
-SC_BAD_GATEWAY |
-502 |
-
-public static final int |
-SC_BAD_IDENTITY_INFO |
-436 |
-
-public static final int |
-SC_BAD_REQUEST |
-400 |
-
-public static final int |
-SC_BUSY_EVERYWHERE |
-600 |
-
-public static final int |
-SC_BUSY_HERE |
-486 |
-
-public static final int |
-SC_CALL_BEING_FORWARDED |
-181 |
-
-public static final int |
-SC_CALL_LEG_DONE |
-481 |
-
-public static final int |
-SC_CALL_QUEUED |
-182 |
-
-public static final int |
-SC_CONDITIONAL_REQUEST_FAILED |
-412 |
-
-public static final int |
-SC_DECLINE |
-603 |
-
-public static final int |
-SC_DOES_NOT_EXIT_ANYWHERE |
-604 |
-
-public static final int |
-SC_EXTENSION_REQUIRED |
-421 |
-
-public static final int |
-SC_FORBIDDEN |
-403 |
-
-public static final int |
-SC_GONE |
-410 |
-
-public static final int |
-SC_INTERVAL_TOO_BRIEF |
-423 |
-
-public static final int |
-SC_INVALID_IDENTITY_HEADER |
-438 |
-
-public static final int |
-SC_LOOP_DETECTED |
-482 |
-
-public static final int |
-SC_MESSAGE_TOO_LARGE |
-513 |
-
-public static final int |
-SC_METHOD_NOT_ALLOWED |
-405 |
-
-public static final int |
-SC_MOVED_PERMANENTLY |
-301 |
-
-public static final int |
-SC_MOVED_TEMPORARILY |
-302 |
-
-public static final int |
-SC_MULTIPLE_CHOICES |
-300 |
-
-public static final int |
-SC_NOT_ACCEPTABLE |
-406 |
-
-public static final int |
-SC_NOT_ACCEPTABLE_ANYWHERE |
-606 |
-
-public static final int |
-SC_NOT_ACCEPTABLE_HERE |
-488 |
-
-public static final int |
-SC_NOT_FOUND |
-404 |
-
-public static final int |
-SC_NOT_IMPLEMENTED |
-501 |
-
-public static final int |
-SC_OK |
-200 |
-
-public static final int |
-SC_PAYMENT_REQUIRED |
-402 |
-
-public static final int |
-SC_PRECONDITION_FAILURE |
-580 |
-
-public static final int |
-SC_PROVIDE_REFERER_IDENTITY |
-429 |
-
-public static final int |
-SC_PROXY_AUTHENTICATION_REQUIRED |
-407 |
-
-public static final int |
-SC_REQUEST_ENTITY_TOO_LARGE |
-413 |
-
-public static final int |
-SC_REQUEST_PENDING |
-491 |
-
-public static final int |
-SC_REQUEST_TERMINATED |
-487 |
-
-public static final int |
-SC_REQUEST_TIMEOUT |
-408 |
-
-public static final int |
-SC_REQUEST_URI_TOO_LONG |
-414 |
-
-public static final int |
-SC_RINGING |
-180 |
-
-public static final int |
-SC_SECURITY_AGREEMENT_REQUIRED |
-494 |
-
-public static final int |
-SC_SERVER_INTERNAL_ERROR |
-500 |
-
-public static final int |
-SC_SERVER_TIMEOUT |
-504 |
-
-public static final int |
-SC_SERVICE_UNAVAILABLE |
-503 |
-
-public static final int |
-SC_SESSION_INTERVAL_TOO_SMALL |
-422 |
-
-public static final int |
-SC_SESSION_PROGRESS |
-183 |
-
-public static final int |
-SC_TEMPORARLY_UNAVAILABLE |
-480 |
-
-public static final int |
-SC_TOO_MANY_HOPS |
-483 |
-
-public static final int |
-SC_TRYING |
-100 |
-
-public static final int |
-SC_UNAUTHORIZED |
-401 |
-
-public static final int |
-SC_UNDECIPHERABLE |
-493 |
-
-public static final int |
-SC_UNSUPPORTED_CERTIFICATE |
-437 |
-
-public static final int |
-SC_UNSUPPORTED_MEDIA_TYPE |
-415 |
-
-public static final int |
-SC_UNSUPPORTED_URI_SCHEME |
-416 |
-
-public static final int |
-SC_USE_IDENTITY_HEADER |
-428 |
-
-public static final int |
-SC_USE_PROXY |
-305 |
-
-public static final int |
-SC_VERSION_NOT_SUPPORTED |
-505 |
-
- -
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Deprecated Fields | -|
|---|---|
| javax.servlet.sip.SipServlet.PRACK_SUPPORTED
- - in favor of using the "javax.servlet.sip.supported" attribute |
-|
| -Deprecated Methods | -|
|---|---|
| javax.servlet.sip.SipFactory.createRequest(SipServletRequest, boolean)
- - 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 - B2buaHelper.createRequest(SipServletRequest) |
-|
| javax.servlet.sip.SipApplicationSession.encodeURI(URI)
- - has potential to break application composition - instead of this use the SipApplicationKey mechanism - as described in section 15.11.2 in the SIP Servlet - specification document. |
-|
| javax.servlet.sip.Proxy.getSequentialSearchTimeout()
- - use a more general purpose Proxy.getProxyTimeout() |
-|
| javax.servlet.sip.Proxy.getStateful()
- - stateless proxy is no longer supported |
-|
| javax.servlet.sip.Proxy.setSequentialSearchTimeout(int)
- - use a more general purpose Proxy.setProxyTimeout(int) |
-|
| javax.servlet.sip.Proxy.setStateful(boolean)
- - stateless proxy is no longer supported |
-|
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
- ---The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
- ---Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
-
-- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
- -- --Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
-
-Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description -
-
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary -
-
- Field Detail
- Constructor Detail
- Method Detail
- -- --Each annotation type has its own separate page with the following sections:
-
-- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
- ---Each enum has its own separate page with the following sections:
-
-- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
-There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with-java.lang.Object. The interfaces do not inherit fromjava.lang.Object.-
-- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
-The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.-
-The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.-
-
-
-
-
-This help file applies to API documentation generated using the standard doclet.
-
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
Locale of this user agent.
-Address as a new value of the
- named header field.
-AuthInfo object.
-Parameterable as a new value of the
- named header field.
-Proxy.cancel() provides a way to specify the
- reason for cancelling this Proxy by including the appropriate
- Reason headers [RFC 3326].
-ProxyBranch.cancel() provides a way to specify the
- reason for cancelling this branch by including the appropriate Reason headers [RFC 3326].
-Address.
-Parameterable.
-Address corresponding to the specified
- string.
-Address with the specified URI and no
- display name.
-Address with the specified
- URI and display name.
-SipApplicationSession.
-SipApplicationSession identified by the specified
- SipApplicationKey.
-Parameterable parsed from the specified
- string.
-ProxyBranch objects given a set of targets.
-B2buaHelper.createRequest(SipServletRequest)
-SipURI with the specified user and host
- components.
-ServletTimer and schedules it to
- expire after the specified delay.
-ServletTimer and schedules it to
- expire after the specified delay and then again at approximately
- regular intervals.
-URI object corresponding to the specified
- string, which should represent an escaped SIP, SIPS, or tel URI.
-Locale that the UA originating
- this message will accept content in, based on the Accept-Language
- header.
-Iterator over Locale objects
- indicating, in decreasing order starting with the preferred locale,
- the locales that are acceptable to the sending UA based on the
- Accept-Language header.
-Address object.
-ListIterator over all Address
- header field values for the specified header.
-proxyTo(URI) or startProxy() will add a Path header
- to the proxied request, false otherwise.
-startProxy() will add a Path header
- to the proxied request, false otherwise.
-SipApplicationSession is
- associated with.
-ServletTimer.
-SipSession
- is associated.
-applicationSessionKey.
-Iterator over the String
- objects containing the names of all the objects bound to this session.
-Enumeration containing the names of the
- attributes available to this message object.
-Enumeration over the String
- objects containing the names of all the objects bound to this session.
-SipServletMessage.
-SipSession.
-Iterator over all the realms associated with this
- challenge response.
-Address.
-String.
-Iterator over all the header names this
- message contains.
-Iterator over the names of all headers
- present in this SipURI.
-String objects.
-SipURI.
-getRemoteAddr(), this method
- returns the same value regardless of which application invokes it
- in the same application composition chain of a specific application router.
-SipApplicationSession is in the ready-to-invalidate state.
-SipSession is in the ready-to-invalidate state.
-B2buaHelper.createRequest(SipServletRequest, boolean, java.util.Map)
- or using B2buaHelper.createRequest(SipSession, SipServletRequest, java.util.Map)
- the new request gets implicitly linked with the original request.
-Address identifying the local party.
-true if the proxy will not cancel outstanding
- branches upon receiving the first 2xx INVITE response as in RFC 3841
-Parameterable object.
-ListIterator over all Parameterable
- header field values for the specified header name.
-Iterator of the names of all parameters
- contained in this object.
-Iterator over the names of all parameters
- present in this URI.
-SipURI that the application can use to
- add parameters to the Path header.
-SipURI that the application can use to
- add parameters to the Path header.
-TelURL for local numbers or
- null if the phone number is global
-TelURL.
-SipURI,
- or -1 if this is not set.
-Proxy object associated with this request.
-Proxy object associated with this request.
-Proxy object associated with the
- transaction of this SIP response object.
-ProxyBranch object associated with the transaction
- of this SIP response object.
-Proxy.proxyTo(List) or Proxy.createProxyBranches(List)
- is used.
-ProxyBranch object.
-Address.
-proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise.
-proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise.
-SipURI that the application can use to
- add parameters to the Record-Route header.
-SipURI that the application can use to
- add parameters to the Record-Route header.
-Address identifying the remote party.
-SipErrorEvent.
-SipErrorEvent.
-SipApplicationRoutingDirective associated with
- this request.
-URI,
- for example "sip", "sips" or "tel".
-Proxy.getProxyTimeout()
-SipSession to which this message belongs.
-SipSession to which this message belongs.
-Iterator over all valid "protocol" sessions
- associated with this application session.
-Iterator over all valid "protocol" session objects
- associated with the specified protocol associated with this application
- session.
-SipServletContextEvent.
-SipSession with the specified id belonging
- to this application session, or null if not found.
-URI component of this Address.
-SipURI.
-SipURI,
- or null if this is not set.
-java.security.Principal object containing
- the name of the authenticated user agent sending this message.
-ProxyBranch.
-TelURL is global, and false
- otherwise.
-SipURI is secure, that is,
- if this it represents a sips URI.
-Proxy.createProxyBranches(java.util.List) and may be
- started at a later time by using Proxy.startProxy().
-Address represents the "wildcard"
- contact address.
-javax.servlet.sip.ar package contains Application Router interfacesjavax.servlet.sip.ar.spi package contains application router service
-provider interfaces.Throwable exception to the servlet log file.
-SipServletResponse.createPrack()
- was invoked on a provisional response that is not reliable.
-SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked on a final or a 100 response.
-SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked for a response to a
- non-INVITE request.
-Parameterable interface is used to indicate a SIP header
- field value with optional parameters.ProxyBranch represents a branch which the Proxy sends out the
- request on.Rel100Exception with the specified
- error reason.
-SipURI.
-SipServletMessage.
-TimerService for servlet applications
- wishing to schedule future tasks.SipSession was created.
-SipSession was destroyed.
-SipApplicationSession is in the
- ready-to-invalidate state.
-SipSession is in the ready-to-invalidate
- state.
-Locale that this user agent will
- accept content, reason phrases, warnings, etc.
-Object.
-Address.
-SipSession.
-SipURI.
-SipURI.
-TelURL.
-TelURL.
-SipURI.
-ProxyBranch object.
-Addresss qvalue.
-sip or sips
- depending on whether the argument is true or not.
-Proxy.setProxyTimeout(int)
-Address.
-SipURI.
-SipURI.
-SipApplicationSession belong to.SipApplicationSession may listen to container events
- notifying them when the application session to which they are bound will be passivated or
- activated.SipApplicationSessionBindingListener when it is bound or unbound from an
- application session, or to a SipApplicationSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in an application session.SipApplicationSessions within a SIP servlet application.SipApplicationSessionEvent object.
-SipApplicationSession objects
- in the SIP application they are part of.SipErrorListener interface when an error occurs which
- is related to the applications processing of a SIP transaction.SipErrorEvent.
-SipServletContextEvent.
-SipSessionBindingListener when it is bound or unbound from a
- session, or to a SipSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in a session.SipSessions within a SIP servlet application.SipSessions in a SIP servlet application.sip and sips URIs.Proxy.createProxyBranches(java.util.List).
-tel URLs as defined by RFC 3966.Proxy object for a request with a Max-Forwards
- header with value 0.TooManyHopsException exception, without any message.
-TooManyHopsException exception with the specified message.
-TooManyHopsException exception with the specified detail message and
- cause.
-TooManyHopsException exception with the specified cause and a detail
- message of (cause==null ? null : cause.toString()) (which
- typically contains the class and detail message of cause).
-String.
-String representation of this
- SipURI.
-String representation of this
- TelURL.
-URI as a String.
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface Address
-Represents SIP addresses as found, for example, in From, To, and - Contact headers. Applications use addresses when sending requests - as a user agent client (UAC) and when redirecting an incoming - request. - -
Addresses appear in a number of SIP headers and generally adhere - to the grammar (constituent non-terminals are defined in the SIP - specification, RFC 3261): -
- (name-addr / addr-spec) *(SEMI generic-param) -- that is to say, Addresses consist of a URI, an optional display name, - and a set of name-value parameters. - -
The Address interface is used to represent the value of
- all headers defined to contain one or more addresses as defined above.
- Apart from From, To, and Contact, this includes
- Route, Record-Route, Reply-To, Alert-Info, Call-Info, Error-Info,
- as well as extension headers like P-Asserted-Identity,
- P-Preferred-Identity, and Path.
-
-
Address objects can be constructed using one of the
- SipFactory.createAddress methods and can be obtained
- from messages using SipServletMessage.getAddressHeader(java.lang.String) and
- SipServletMessage.getAddressHeaders(java.lang.String).
-
- -
-
| -Method Summary | -|
|---|---|
- java.lang.Object |
-clone()
-
-- Returns a clone of this Address. |
-
- boolean |
-equals(java.lang.Object o)
-
-- Compares the given Address with this one. |
-
- java.lang.String |
-getDisplayName()
-
-- Returns the display name of this Address. |
-
- int |
-getExpires()
-
-- Returns the value of the "expires" parameter as delta-seconds. |
-
- float |
-getQ()
-
-- Returns the value of the "q" parameter of this Address. |
-
- URI |
-getURI()
-
-- Returns the URI component of this Address. |
-
- boolean |
-isWildcard()
-
-- Returns true if this Address represents the "wildcard"
- contact address. |
-
- void |
-setDisplayName(java.lang.String name)
-
-- Sets the display name of this Address. |
-
- void |
-setExpires(int seconds)
-
-- Sets the value of the "expires" parameter. |
-
- void |
-setQ(float q)
-
-- Sets this Addresss qvalue. |
-
- void |
-setURI(URI uri)
-
-- Sets the URI of this Address. |
-
- java.lang.String |
-toString()
-
-- Returns the value of this address as a String. |
-
| Methods inherited from interface javax.servlet.sip.Parameterable | -
|---|
getParameter, getParameterNames, getParameters, getValue, removeParameter, setParameter, setValue |
-
| -Method Detail | -
|---|
-java.lang.String getDisplayName()-
Address. This is
- typically a caller or callees real name and may be rendered by a
- user agent, for example when alerting.
--
Address, or null if
- one doesn't exist-void setDisplayName(java.lang.String name)-
Address.
--
name - display name
-java.lang.IllegalStateException - if this Address is used
- in a context where it cannot be modified-URI getURI()-
URI component of this Address.
- This method will return null for wildcard addresses
- (see isWildcard(). For non-wildcard addresses the result
- will always be non-null.
--
URI of this Address-void setURI(URI uri)-
Address.
--
uri - new URI of this Address
-java.lang.IllegalStateException - if this Address is used
- in a context where it cannot be modified
-java.lang.NullPointerException - on null uri.-boolean isWildcard()-
Address represents the "wildcard"
- contact address. This is the case if it represents a Contact header
- whose string value is "*". Likewise,
- SipFactory.createAddress("*")
- always returns a wildcard Address instance.
--
Address represents the "wildcard"
- contact address, and false otherwise-float getQ()-
Address.
- The "qvalue" indicates the relative preference amongst a set of
- locations. "qvalue" values are decimal numbers from 0 to 1, with
- higher values indicating higher preference.
--
Address' qvalue or -1.0 if this is not set-void setQ(float q)-
Addresss qvalue.
--
q - new qvalue for this Address or -1 to remove
- the qvalue
-java.lang.IllegalArgumentException - if the new qvalue isn't between
- 0.0 and 1.0 (inclusive) and isn't -1.0.-int getExpires()-
-
-void setExpires(int seconds)-
-
seconds - new relative value of the "expires" parameter.
- A negative value causes the "expires" parameter to be removed.-java.lang.String toString()-
String. The
- resulting string must be a valid value of a SIP From or To header.
--
toString in class java.lang.ObjectAddress as a String-java.lang.Object clone()-
Address. The cloned
- Address has identical display name, URI, and
- parameters, except that it has no tag parameter. This
- means the cloned address can be used as an argument to
- SipFactory.createRequest.
--
clone in interface ParameterableAddress-boolean equals(java.lang.Object o)-
As Addresses consist of a URI, an optional display name, and an optional set - of name-value parameters, the following rules should be used for - comparing them: -
-
equals in interface Parameterableequals in class java.lang.Objecto - given Parameterable to be compared with this.
-true if the two Addresses are equal.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface AuthInfo
-This interface allows applications to set the authentication information on servlet - initiated requests that are challenged by a Proxy or UAS. -
- -
-
| -Method Summary | -|
|---|---|
- void |
-addAuthInfo(int statusCode,
- java.lang.String realm,
- java.lang.String username,
- java.lang.String password)
-
-- Helper method to add authentication info into the AuthInfo object for - a challenge response of a specific type (401/407) and realm. |
-
| -Method Detail | -
|---|
-void addAuthInfo(int statusCode, - java.lang.String realm, - java.lang.String username, - java.lang.String password)-
-
statusCode - Status code (401/407) of the challenge responserealm - Realm that was returned in the challenge responseusername - password -
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface B2buaHelper
-Helper class providing support for B2BUA applications. An instance of this
- class can be retrieved from a SipServletRequest by invoking
- the method SipServletRequest.getB2buaHelper().
-
- -
-
| -Method Summary | -|
|---|---|
- SipServletRequest |
-createCancel(SipSession session)
-
-- Creates a new CANCEL request to cancel the initial request sent on the other - leg. |
-
- SipServletRequest |
-createRequest(SipServletRequest origRequest)
-
-- Creates a new request object belonging to a new SipSession. |
-
- SipServletRequest |
-createRequest(SipServletRequest origRequest,
- boolean linked,
- java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap)
-
-- Creates a new request object belonging to a new SipSession. |
-
- SipServletRequest |
-createRequest(SipSession session,
- SipServletRequest origRequest,
- java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap)
-
-- Creates a new subsequent request based on the specified original - request. |
-
- SipServletResponse |
-createResponseToOriginalRequest(SipSession session,
- int status,
- java.lang.String reasonPhrase)
-
-- The request that results in creation of a SipSession is termed as the - original request, a response to this original request can be created by - the application even if the request was committed and application does - not have a reference to this Request. |
-
- SipSession |
-getLinkedSession(SipSession session)
-
-- Returns the other SipSession that is linked to the specified SipSession, - or null if none. |
-
- SipServletRequest |
-getLinkedSipServletRequest(SipServletRequest req)
-
-- If a new request is created based on an existing one with the - link argument true using createRequest(SipServletRequest, boolean, java.util.Map)
- or using createRequest(SipSession, SipServletRequest, java.util.Map)
- the new request gets implicitly linked with the original request. |
-
- java.util.List<SipServletMessage> |
-getPendingMessages(SipSession session,
- UAMode mode)
-
-- For the specified SipSession, returns a List of all uncommitted messages - in the order of increasing CSeq number for the given mode of the session. |
-
- void |
-linkSipSessions(SipSession session1,
- SipSession session2)
-
-- Links the specified sessions, such that there is a 1-1 mapping - between them. |
-
- void |
-unlinkSipSessions(SipSession session)
-
-- If the specified SipSession is linked to another session, then unlinks - the two sessions from each other. |
-
| -Method Detail | -
|---|
-SipSession getLinkedSession(SipSession session)-
linkSipSessions(SipSession, SipSession) or
- createRequest(SipServletRequest, boolean, java.util.Map)
--
session - the SipSession from which to obtain the linked session
-java.lang.IllegalArgumentException - if the session is invalid-SipServletRequest getLinkedSipServletRequest(SipServletRequest req)-
createRequest(SipServletRequest, boolean, java.util.Map)
- or using createRequest(SipSession, SipServletRequest, java.util.Map)
- the new request gets implicitly linked with the original request.
- This method is to be used to retrieve the linked request. There is no
- explicit linking/unlinking like that of the session for requests. However unlinking
- of sessions also result in unlinking of linked requests.
--
req - other request
--void linkSipSessions(SipSession session1, - SipSession session2)-
getLinkedSession(javax.servlet.sip.SipSession). One SipSession at any given time can be
- linked to only one other SipSession belonging to the same
- SipApplicationSession. Calling linkSessions() with already
- linked sessions to each other is a no-op and is to be silently ignored, while
- calling linkSessions() with any of the session linked with
- other sessions result in java.lang.IllegalArgumentException
--
session1 - the first SipSession to linksession2 - the other SipSession to link
-java.lang.IllegalArgumentException - if either of the specified sessions
- has been terminated or the sessions do not belong to the same
- application session or one or both the sessions are already linked
- with some other session(s)
-java.lang.NullPointerException - if any of the arguments is null-void unlinkSipSessions(SipSession session)-
-
session - the session to be unlinked
-java.lang.IllegalArgumentException - if the session is not currently linked
- to another session or it has been terminated-java.util.List<SipServletMessage> getPendingMessages(SipSession session, - UAMode mode)-
-
session - the SipSession to check for pending messagesmode - the mode for which the pending messages are required, one of UAC or UAS
-SipServletMessage objects representing
- pending messages for the session, or the empty list if none
-java.lang.IllegalArgumentException - if the session is invalid-SipServletResponse createResponseToOriginalRequest(SipSession session, - int status, - java.lang.String reasonPhrase)-
The response thus generated must have a different To tag from the
- other responses generated to the Request and must result in a different
- SipSession. In this (and similar) cases the container clones the
- original SipSession for the second and subsequentdialogs, as detailed
- above. The cloned session object will contain the same application data
- but its createRequest method will create requests belonging to that
- second or subsequent dialog, that is, with a To tag specific to that
- dialog.
-
-
session - the SipSession for the original requeststatus - the status code for the responsereasonPhrase - the reason phrase for the response, or null to use
- a default reason phrase
-SipServletResponse
-java.lang.IllegalStateException - if a subsequent response is inconsistent
- with an already sent response. For example, a 400 response
- following a 200 OK response.
-java.lang.IllegalArgumentException - if the session is invalid-SipServletRequest createRequest(SipServletRequest origRequest, - boolean linked, - java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap) - throws java.lang.IllegalArgumentException, - TooManyHopsException-
origRequest
- in that the method and the majority of header fields are copied
- from origRequest to the new request.
- The headerMap parameter can contain From, To, Contact, Route headers and any
- non system header. The header field map is then used to override the
- headers in the newly created request.
- The SipSession created for the new request also shares the same
- SipApplicationSession
- associated with the original request.
-
- This method satisfies the following rules: -
This method provides a convenient and efficient way of - constructing the second "leg" of a B2BUA application, giving the - additional flexibility of changing the headers including From, To, Contact - and Route. - -
This method will also perform loop detection. - If the value of the original request's Max-Forwards header field is 0, - then TooManyHopsException is thrown and a 483 (Too many hops) - response is sent for the original request. Otherwise, the value of the - new requests Max-Forwards header is set to that of the original request - minus one. -
It is used only for the initial request. Subsequent requests in either leg
- must be created using SipSession.createRequest(java.lang.String) or createRequest(SipSession, SipServletRequest, java.util.Map) as usual.
-
-
origRequest - request to be "copied"linked - indicating if the resulting session should be linked with original or notheaderMap - a simple map containing header names and their
- values to be overridden in the new request. The values can be a specified in a
- java.util.List to accomodate for multi-valued headers
-java.lang.IllegalArgumentException - if the headerMap contains a system
- header other than From, To, Contact and Route (see section 4.1.3 to see what part of Contact header is to be used)
- or some other header not relevant for the context, or the origRequest and
- its session is linked to some other request/session and the linked flag is true,
- or if the origRequest is not initial
-java.lang.NullPointerException - if the original request is null
-TooManyHopsException - if the original request's Max-Forwards header value is 0-SipServletRequest createRequest(SipServletRequest origRequest)-
origRequest
- in that the method and the majority of header fields are copied
- from origRequest to the new request. The SipSession
- created for the new request also shares the same SipApplicationSession
- associated with the original request.
-
- This method satisfies the following rules: -
SipSession)is
- assigned a new Call-ID.
- This method provides a convenient and efficient way of
- constructing a new "leg" of a B2BUA application. It is used
- only for the initial request. Subsequent requests in either leg
- must be created using SipSession.createRequest(java.lang.String) or
- createRequest(SipSession, SipServletRequest, java.util.Map) as usual.
-
-
origRequest - request to be "copied"
--SipServletRequest createRequest(SipSession session, - SipServletRequest origRequest, - java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerMap) - throws java.lang.IllegalArgumentException-
This method, though similar to the factory method of creating the
- request for a B2BUA for initial requests, is to be used for subsequent
- requests.
- The semantics are similar to SipSession.createRequest(String)
- except that here it copies non system headers from the original request
- onto the new request, the system headers are created based on the session
- that this request is created on. Further the Route headers are set as
- based on the session route set. The method of the new request is same
- as that of the origRequest. If Contact header is present in
- the headerMap then relevant portions of the Contact header are to be used
- in the request created, in accordance with section 4.1.3 of the specification.
- If From and To headers are present in the headerMap then all parts of
- those headers except the tag parameter are to be used in the request
- created, in accordance with section 4.1.2 of the specification.
-
-
session - the session on which this request is to be createdorigRequest - the original requestheaderMap - the header map used to override the headers in the new
- subsequent request created. Also see
- createRequest(SipServletRequest, boolean, java.util.Map)
-java.lang.IllegalArgumentException - if the header map contains a system
- header other than Contact, From or To (see sections 4.1.2 and 4.1.3 of
- specification document) or other header which does not makes sense in the context,
- or in case when the session does not belong to the same
- SipApplicationSession as the origRequest, or the original request or session is
- already linked with some other request/session,
- or if the origRequest is not initial
-java.lang.NullPointerException - if the original request or the session is null-SipServletRequest createCancel(SipSession session)-
-
session - the session whose initial request is to be cancelled.
-java.lang.NullPointerException - if the session is null
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface ConvergedHttpSession
-The ConvergedHttpSession class provides access to HttpSession related - functionality which is only present in a converged HTTP/SIP container. - In a converged container, an instance of HttpSession can be cast to - ConvergedHttpSession in order to access methods available available - only to converged applications. -
- -
-
| -Method Summary | -|
|---|---|
- java.lang.String |
-encodeURL(java.lang.String url)
-
-- This method encodes the HTTP URL with the jsessionid. |
-
- java.lang.String |
-encodeURL(java.lang.String relativePath,
- java.lang.String scheme)
-
-- Converts the given relative path to an absolute URL by - prepending the contextPath for the current ServletContext, the given - scheme ("http" or "https"), and the host:port, and then encoding the - resulting URL with the jsessionid. |
-
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the parent SipApplicationSession if it exists, if none exists - then a new one is created and returned after associating it with the - converged http session. |
-
| Methods inherited from interface javax.servlet.http.HttpSession | -
|---|
getAttribute, getAttributeNames, getCreationTime, getId, getLastAccessedTime, getMaxInactiveInterval, getServletContext, getSessionContext, getValue, getValueNames, invalidate, isNew, putValue, removeAttribute, removeValue, setAttribute, setMaxInactiveInterval |
-
| -Method Detail | -
|---|
-SipApplicationSession getApplicationSession()-
-
-java.lang.String encodeURL(java.lang.String url)-
-
url - the HTTP URL String to be encoded
--java.lang.String encodeURL(java.lang.String relativePath, - java.lang.String scheme)-
- For example, this method converts: -
- from:Where, - - "/mywebapp" is the contextPath for the current ServletContext - server is the front end host defined for the web server. -"/foo.jsp"- to:"http://server:8888/mywebapp/foo.jsp;jsessionid=http-session-id"-
-
relativePath - relative to the current webappscheme - the scheme ("http" or "https")
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface Parameterable
-The Parameterable interface is used to indicate a SIP header
- field value with optional parameters. All of the Address header fields are
- Parameterable, including Contact, From, To, Route, Record-Route, and
- Reply-To. In addition, the header fields Accept, Accept-Encoding,
- Alert-Info, Call-Info, Content-Disposition, Content-Type, Error-Info,
- Retry-After and Via are also Parameterable.
-
- -
-
| -Method Summary | -|
|---|---|
- java.lang.Object |
-clone()
-
-- Returns a clone of this Parameterable. |
-
- boolean |
-equals(java.lang.Object o)
-
-- Compares the given Parameterable with this one. |
-
- java.lang.String |
-getParameter(java.lang.String key)
-
-- Returns the value of the named parameter, or null if it is not - set. |
-
- java.util.Iterator<java.lang.String> |
-getParameterNames()
-
-- Returns an Iterator of the names of all parameters
- contained in this object. |
-
- java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> |
-getParameters()
-
-- Returns a Collection view of the parameter name-value mappings - contained in this Parameterable. |
-
- java.lang.String |
-getValue()
-
-- Returns the field value as a string. |
-
- void |
-removeParameter(java.lang.String name)
-
-- Removes the named parameter from this object. |
-
- void |
-setParameter(java.lang.String name,
- java.lang.String value)
-
-- Sets the value of the named parameter. |
-
- void |
-setValue(java.lang.String value)
-
-- Set the value of the field. |
-
| -Method Detail | -
|---|
-java.lang.String getValue()-
-
-void setValue(java.lang.String value)-
-
value - the new header field value, not including parameters
-java.lang.IllegalStateException - if the header field cannot be modified for this object
-java.lang.NullPointerException - if the value parameter is null-java.lang.String getParameter(java.lang.String key)-
String indicates a flag parameter.
--
key - a String specifying the parameter name
-java.lang.NullPointerException - if key is null-void setParameter(java.lang.String name, - java.lang.String value)-
removeParameter(String)
--
name - parameter namevalue - new parameter value
-java.lang.IllegalStateException - if parameters cannot be modified for this object
-java.lang.NullPointerException - if name parameter is null-void removeParameter(java.lang.String name)-
-
name - parameter name
-java.lang.IllegalStateException - if parameters cannot be modified for this object
-java.lang.NullPointerException - if name is null-java.util.Iterator<java.lang.String> getParameterNames()-
Iterator of the names of all parameters
- contained in this object. The order is the order of appearance of the
- parameters in the Parameterable.
--
Iterator of String objects that
- are the names of the parameters contained in this object-java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getParameters()-
-
Set of Map.Entry objects that
- are the parameters on this Parameterable.-java.lang.Object clone()-
Parameterable. The cloned
- Parameterable has identical field value and parameters.
--
Parameterable-boolean equals(java.lang.Object o)-
As Parameterables consist of a field-value and an optional set of - name-value parameters, the following rules should be used for - comparing them: -
String comparison should be used.
- -
equals in class java.lang.Objecto - given Parameterable to be compared with this.
-true if the two Parameterable are deemed equal.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface Proxy
-Represents the operation of proxying a SIP request. - -
A number of parameters control how proxying is carried out: -
proxyTimeout parameter.
- - -
-
| -Method Summary | -|
|---|---|
- void |
-cancel()
-
-- Cancels this proxy transaction and any of its child branches if recursion - was enabled. |
-
- void |
-cancel(java.lang.String[] protocol,
- int[] reasonCode,
- java.lang.String[] reasonText)
-
-- This overloaded method of cancel() provides a way to specify the
- reason for cancelling this Proxy by including the appropriate
- Reason headers [RFC 3326]. |
-
- java.util.List<ProxyBranch> |
-createProxyBranches(java.util.List<? extends URI> targets)
-
-- Returns the list of ProxyBranch objects given a set of targets. |
-
- boolean |
-getAddToPath()
-
-- Returns true if subsequent invocations of proxyTo(URI) or startProxy() will add a Path header
- to the proxied request, false otherwise. |
-
- boolean |
-getNoCancel()
-
-- Returns true if the proxy will not cancel outstanding
- branches upon receiving the first 2xx INVITE response as in RFC 3841 |
-
- SipServletRequest |
-getOriginalRequest()
-
-- Returns the request received from the upstream caller. |
-
- boolean |
-getParallel()
-
-- Returns true if this proxy object is set to proxy in parallel, or - false if it is set to proxy sequentially. |
-
- SipURI |
-getPathURI()
-
-- Returns a SipURI that the application can use to
- add parameters to the Path header. |
-
- ProxyBranch |
-getProxyBranch(URI uri)
-
-- Any branch has a primary URI associated with it, using which it was - created. |
-
- java.util.List<ProxyBranch> |
-getProxyBranches()
-
-- More than one branches are associated with a proxy when proxyTo(List) or createProxyBranches(List)
- is used. |
-
- int |
-getProxyTimeout()
-
-- The current value of the overall proxy timeout value. |
-
- boolean |
-getRecordRoute()
-
-- Returns true if subsequent invocations of proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise. |
-
- SipURI |
-getRecordRouteURI()
-
-- Returns a SipURI that the application can use to
- add parameters to the Record-Route header. |
-
- boolean |
-getRecurse()
-
-- Returns true if this proxy object is set to recurse, or false otherwise. |
-
- int |
-getSequentialSearchTimeout()
-
-- Deprecated. use a more general purpose getProxyTimeout() |
-
- boolean |
-getStateful()
-
-- Deprecated. stateless proxy is no longer supported |
-
- boolean |
-getSupervised()
-
-- Returns true if the controlling servlet will be invoked on incoming - responses for this proxying operation, and false otherwise. |
-
- void |
-proxyTo(java.util.List<? extends URI> uris)
-
-- Proxies a SIP request to the specified set of destinations. |
-
- void |
-proxyTo(URI uri)
-
-- Proxies a SIP request to the specified destination. |
-
- void |
-setAddToPath(boolean p)
-
-- Specifies whether branches initiated in this proxy operation should - include a Path header for the REGISTER request for this servlet - container or not. |
-
- void |
-setNoCancel(boolean noCancel)
-
-- Specifies whether the proxy should, or should not cancel outstanding - branches upon receiving the first 2xx INVITE response as defined - in RFC 3841. |
-
- void |
-setOutboundInterface(java.net.InetAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface to use when sending requests for proxy branches. |
-
- void |
-setOutboundInterface(java.net.InetSocketAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface and port number to use for proxy branches. |
-
- void |
-setParallel(boolean parallel)
-
-- Specifies whether to proxy in parallel or sequentially. |
-
- void |
-setProxyTimeout(int seconds)
-
-- Sets the overall proxy timeout. |
-
- void |
-setRecordRoute(boolean rr)
-
-- Specifies whether branches initiated in this proxy operation should - include a Record-Route header for this servlet engine or not. |
-
- void |
-setRecurse(boolean recurse)
-
-- Specifies whether the servlet engine will automatically recurse or not. |
-
- void |
-setSequentialSearchTimeout(int seconds)
-
-- Deprecated. use a more general purpose setProxyTimeout(int) |
-
- void |
-setStateful(boolean stateful)
-
-- Deprecated. stateless proxy is no longer supported |
-
- void |
-setSupervised(boolean supervised)
-
-- Specifies whether the controlling servlet is to be invoked for - incoming responses relating to this proxying. |
-
- void |
-startProxy()
-
-- Proxies a SIP request to the set of destinations previously specified - in createProxyBranches(java.util.List). |
-
| -Method Detail | -
|---|
-SipServletRequest getOriginalRequest()-
-
-void proxyTo(URI uri)-
Implementations are required to support SipURI
- arguments and may support other types of URIs.
-
-
uri - specifies the destination to proxy to
-java.lang.IllegalStateException - if the transaction has already completed
-java.lang.IllegalArgumentException - e.g. if the scheme of the specified
- URI is not supported for proxying
-java.lang.NullPointerException - if the uri is null-void proxyTo(java.util.List<? extends URI> uris)-
-
uris - a list of URI objects to proxy to
-java.lang.IllegalStateException - if the transaction has already completed
-java.lang.IllegalArgumentException - if any of the destination URIs
- contains a scheme that is not supported for proxying
-java.lang.NullPointerException - if any of the URI in the List is null.-void cancel()-
-
java.lang.IllegalStateException - if the transaction has completed-void cancel(java.lang.String[] protocol, - int[] reasonCode, - java.lang.String[] reasonText)-
cancel() provides a way to specify the
- reason for cancelling this Proxy by including the appropriate
- Reason headers [RFC 3326].
--
protocol - describes the source of the 'cause' field in the Reason header field.reasonCode - corresponds to the 'cause' field. For eg, if protocol is SIP, the reasonCode
- would be the status code of the response which caused the cancelreasonText - describes the reason for cancelling the Proxy.-boolean getRecurse()-
-
-void setRecurse(boolean recurse)-
-
recurse - if true enables recursion, otherwise disables it-boolean getRecordRoute()-
proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise.
--
-void setRecordRoute(boolean rr)-
Record-routing is used to specify that this servlet engine must - stay on the signaling path of subsequent requests. -
-
rr - if true the engine will record-route, otherwise it won't
-java.lang.IllegalStateException - if the proxy has already been started-boolean getParallel()-
-
-void setParallel(boolean parallel)-
-
parallel - if true the servlet engine will proxy to all
- destinations in parallel, otherwise it will proxy to one at a time-boolean getStateful()-
-
-
true-void setStateful(boolean stateful)-
-
This proxy parameter is a hint only. Implementations may - choose to maintain transaction state regardless of the value of - this flag, but if so the application will not be invoked again - for this transaction. -
-
stateful - if true the proxy operation will be stateful-boolean getSupervised()-
-
-void setSupervised(boolean supervised)-
-
supervised - if true, the servlet invoked to handle the request
- originally received will be notified when the "best" response
- is received.-int getProxyTimeout()-
-
-int getSequentialSearchTimeout()-
getProxyTimeout()
--
-
-void setProxyTimeout(int seconds)-
setSequentialSearchTimeout(int).
- Further the value set through this method shall override any explicit
- sequential value set through deprecated setSequentialSearchTimeout(int).
- On the other hand if the proxy is parallel then this acts as the upper limit
- for the entire proxy operation resulting in equivalent of invoking cancel() if the
- the proxy did not complete during this time, which means that a final response was not
- sent upstream.
--
seconds - seconds waited for each branch in case proxy is sequential and
- overall wait for parallel proxy.
-java.lang.IllegalArgumentException - if the container cannot set the value as requested because it is too high, too low or negative-void setSequentialSearchTimeout(int seconds)-
setProxyTimeout(int)
--
Proxy object. This is the amount of time the
- container waits for a final response when proxying
- sequentially. When the timer expires the container CANCELs the
- current branch and proxies to the next element in the target
- set.
-
- The container is free to ignore this parameter. -
-
seconds - seconds waited for a final responses when proxying
- sequentially-SipURI getRecordRouteURI()-
SipURI that the application can use to
- add parameters to the Record-Route header. This is used by
- record-routing proxy applications in order to push state to the
- endpoints and have it returned in subsequent requests belonging
- to the same dialog.
-
- Parameters added through a URI returned by this method can
- be retrieved from a subsequent request in the same dialog by
- calling ServletRequest.getParameter(java.lang.String).
-
-
Note that the URI returned is good only for - specifying a set of parameters that the application can - retrieve when invoked to handle subsequent requests in the same - dialog. Other components of the URI are irrelevant and cannot - be trusted to reflect the actual values that the container will - be using when inserting a Record-Route header into proxied - request. - -
Applications must not set SIP URI parameters defined in RFC3261.
- This includes transport, user, method, ttl, maddr, and lr. Other
- components of the URI, e.g. host, port, and URI scheme must also not
- by modified by the application. These Record-Route URI components will
- be populated by the container and may or may not have valid values at
- the time an application proxies a request. Any attempt to set these
- parameters or URI contents will thrown an IllegalArgumentException.
-
- Record Route parameters thus added affect the branches created right after.
- If there are branches that were created prior to this modification then they
- MUST continue to have the Record-Route header as was when they were created.
- This means that the ProxyBranch gets a cloned copy of the header.
-
-
java.lang.IllegalStateException - if record-routing is not enabled-java.util.List<ProxyBranch> createProxyBranches(java.util.List<? extends URI> targets)-
ProxyBranch objects given a set of targets.
-
- The resulting branches will not have associated client transactions
- until startProxy() is invoked.
-
- Implementations are required to support SipURI
- arguments and may support other types of URIs.
-
-
targets - a list of URI objects to proxy to
-java.lang.IllegalArgumentException - if any of the destination URIs
- contains a scheme that is not supported for proxying-ProxyBranch getProxyBranch(URI uri)-
createProxyBranches(List)
- method, implicitly when proxyTo() is called or when any of the proxy branch recurses
- as a result of a redirect response. A URI uniquely identifies a branch.
--
uri - URI using which the ProxyBranch may have been created
--java.util.List<ProxyBranch> getProxyBranches()-
proxyTo(List) or createProxyBranches(List)
- is used. This method returns the top level branches thus created. If recursion is enabled on
- proxy or on any of its branches then on receipt of a 3xx class response on that branch, the branch may recurse into sub-branches. This method
- returns just the top level branches started.
--
-void startProxy()-
createProxyBranches(java.util.List). This method will actually start
- the proxy branches and their associated client transactions.
-
- For example,
- - List- is essentially equivalent tobranches = proxy.createProxyBranches(targets); - proxy.startProxy(); -
Proxy.proxyTo(targets),
- with the former giving the application finer control over the
- individual proxy branches through the ProxyBranch class. Since the
- createProxyBranches(List) can be invoked multiple times before
- the startProxy method the effect of startProxy is
- to start all the branches added in the target set.
--
java.lang.IllegalStateException - if the branches have not yet been created
- or the proxy is already completed (final response sent upstream).-void setOutboundInterface(java.net.InetSocketAddress address)-
javax.servlet.sip.outboundInterfaces.
-
- The port is interpreted as an advice by the app to the container. - If the port of the socket address has a non-zero value, the container - will make a best-effort attempt to use it as the source port number - for UDP packets, or as a source port number for TCP connections it - originates. If the port is not available, the container will use - its default port allocation scheme. -
Invocation of this method also impacts the system headers
- generated by the container for this Proxy, such as the
- Record-Route header (getRecordRouteURI()),
- the Via and the Contact header.
- The IP address part of the socket address is used to construct
- these system headers.
-
-
address - the socket address representing the outbound interface to use when
- forwarding requests with this proxy
-java.lang.IllegalArgumentException - if the address is not understood
- by the container as one of its outbound interface
-java.lang.NullPointerException - on null address-void setOutboundInterface(java.net.InetAddress address)-
javax.servlet.sip.outboundInterfaces.
- Invocation of this method also impacts the system headers
- generated by the container for the branches, such as the
- Record-Route header (getRecordRouteURI()) and
- the Via. The specified IP address is used to construct
- these system headers.
-
-
address - the address which represents the outbound interface
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.IllegalArgumentException - if the address does not
- represent one of the container's outbound interfaces
-java.lang.NullPointerException - on null address-boolean getAddToPath()-
proxyTo(URI) or startProxy() will add a Path header
- to the proxied request, false otherwise.
--
-void setAddToPath(boolean p)-
SipServletRequest.pushPath() API).
-
- Path header is used to specify that this Proxy must - stay on the signaling path of subsequent requests sent to the - Registered UA from the Home Proxy in the network. As a best practice, - before calling this method a proxy should check if the UA has indicated - support for the Path extension by checking the Supported header field - value in the request being proxied. The detailed procedure of Path header - handling is defined in RFC 3327. -
-
p - if true the container will add Path header-SipURI getPathURI()-
SipURI that the application can use to
- add parameters to the Path header. This may be used by
- Path header adding proxy applications in order to push state to the
- Registrar and have it returned in subsequent requests for the
- registered UA.
-
- Parameters added through a URI returned by this method can
- be retrieved from a subsequent request in the same dialog by
- calling ServletRequest.getParameter(java.lang.String).
-
-
Note that the URI returned is good only for - specifying a set of parameters that the application can - retrieve when invoked to handle subsequent requests - Other components of the URI are irrelevant and cannot - be trusted to reflect the actual values that the container will - be using when inserting a Path header into proxied - request. -
-
java.lang.IllegalStateException - if addToPath is not enabled-void setNoCancel(boolean noCancel)-
The default proxy behavior, as per RFC 3261 section 16.7 point 10, - is to cancel outstanding branches upon receiving the first 2xx response; - this method allows configuring the proxy to keep the branches and - forward all 2xx responses upstream. -
Default is false.
-
-
noCancel - when true, the proxy will not cancel outstanding branches
- upon receiving the first 2xx response-boolean getNoCancel()-
true if the proxy will not cancel outstanding
- branches upon receiving the first 2xx INVITE response as in RFC 3841
--
true if the proxy will not cancel outstanding
- branches upon receiving the first 2xx response,
- false otherwise
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface ProxyBranch
-A ProxyBranch represents a branch which the Proxy sends out the
- request on. The ProxyBranch object models the branch as used in
- RFC3261 while describing a stateful proxy.
-
- For example,
-
- public void doInvite(SipServletRequest req) {
- ...
- Proxy p = req.getProxy();
- p.setRecordRoute(true);
- List branches = p.createProxyBranches(getTargets(req));
- branches.get(0).setProxyBranchTimeout(5);
- branches.get(1).setProxyBranchTimeout(10);
- p.startProxy();
- ...
- }
-
-- -
-
| -Method Summary | -|
|---|---|
- void |
-cancel()
-
-- Cancels this branch and all the child branches if recursion is enabled and - sends a CANCEL to the proxied INVITEs. |
-
- void |
-cancel(java.lang.String[] protocol,
- int[] reasonCode,
- java.lang.String[] reasonText)
-
-- This overloaded method of cancel() provides a way to specify the
- reason for cancelling this branch by including the appropriate Reason headers [RFC 3326]. |
-
- boolean |
-getAddToPath()
-
-- Returns true if subsequent invocations of - startProxy() will add a Path header
- to the proxied request, false otherwise. |
-
- SipURI |
-getPathURI()
-
-- Returns a SipURI that the application can use to
- add parameters to the Path header. |
-
- Proxy |
-getProxy()
-
-- |
-
- int |
-getProxyBranchTimeout()
-
-- Returns the current value of the search timeout associated - with this ProxyBranch object. |
-
- boolean |
-getRecordRoute()
-
-- Returns true if subsequent invocations of proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise. |
-
- SipURI |
-getRecordRouteURI()
-
-- Returns a SipURI that the application can use to
- add parameters to the Record-Route header. |
-
- boolean |
-getRecurse()
-
-- Returns true if this proxy branch object is set to recurse, or false otherwise. |
-
- java.util.List<ProxyBranch> |
-getRecursedProxyBranches()
-
-- Receipt of a 3xx class redirect response on a branch can result in recursed branches - if the proxy or the branch has recursion enabled. |
-
- SipServletRequest |
-getRequest()
-
-- Returns the request associated with this branch. |
-
- SipServletResponse |
-getResponse()
-
-- Returns the last response received on this branch. |
-
- boolean |
-isStarted()
-
-- The branch can be created using Proxy.createProxyBranches(java.util.List) and may be
- started at a later time by using Proxy.startProxy(). |
-
- void |
-setAddToPath(boolean p)
-
-- Specifies whether this branch should - include a Path header for the REGISTER request for this servlet - container or not. |
-
- void |
-setOutboundInterface(java.net.InetAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface to use when sending requests for this - proxy branch. |
-
- void |
-setOutboundInterface(java.net.InetSocketAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface and source port number when forwarding requests - for this proxy branch. |
-
- void |
-setProxyBranchTimeout(int seconds)
-
-- Sets the search timeout value for this - ProxyBranch object. |
-
- void |
-setRecordRoute(boolean rr)
-
-- Specifies whether this branch should - include a Record-Route header for this servlet engine or not. |
-
- void |
-setRecurse(boolean recurse)
-
-- Specifies whether the servlet engine will automatically recurse or not. |
-
| -Method Detail | -
|---|
-SipServletRequest getRequest()-
-
-void cancel()-
Proxy.cancel() except that it is
- limited to this branch and its children only.
--
java.lang.IllegalStateException - if the transaction has already been completed and it has no
- child branches-void cancel(java.lang.String[] protocol, - int[] reasonCode, - java.lang.String[] reasonText)-
cancel() provides a way to specify the
- reason for cancelling this branch by including the appropriate Reason headers [RFC 3326].
--
protocol - describes the source of the 'cause' field in the Reason header field.reasonCode - corresponds to the 'cause' field. For eg, if protocol is SIP, the reasonCode
- would be the status code of the response which caused the cancelreasonText - describes the reason for cancelling the Proxy.-int getProxyBranchTimeout()-
ProxyBranch object. If this value is
- not explicitly set using the setProxyBranchTimeout(int) then
- the value is inherited from the Proxy setting.
--
-void setProxyBranchTimeout(int seconds)-
ProxyBranch object.
-
- This is the amount of time the container waits for a final response
- when proxying on this branch. This method can be used to
- override the default timeout the branch obtains from the Proxy.setProxyTimeout(int)
- object. When the timer expires the container CANCELs this branch and
- proxies to the next element in the target set in case the proxy is a sequential proxy.
- In case the proxy is a parallel proxy then this can only set the timeout value of this
- branch to a value lower than the value in the proxy Proxy.getProxyTimeout(). The
- effect of expiry of this timeout in case of parallel proxy is just to cancel this
- branch as if an explicit call to cancel() has been made.
--
seconds - new search timeout in seconds
-java.lang.IllegalArgumentException - if this value cannot be set by the container. Either it is too high, too low, negative or
- greater than the overall proxy timeout value in parallel case.-boolean getRecurse()-
-
-void setRecurse(boolean recurse)-
-
recurse - if true enables recursion, otherwise disables it-boolean getRecordRoute()-
proxyTo(URI)
- will add a Record-Route header to the proxied request, false otherwise.
--
-void setRecordRoute(boolean rr)-
Record-routing is used to specify that this servlet engine must - stay on the signaling path of subsequent requests. -
-
rr - if true the engine will record-route, otherwise it won't
-java.lang.IllegalStateException - if the proxy has already been started-boolean getAddToPath()-
startProxy() will add a Path header
- to the proxied request, false otherwise.
--
-void setAddToPath(boolean p)-
Path header is used to specify that this Proxy must - stay on the signaling path of subsequent requests sent to the - Registered UA from the Home Proxy in the network. As a best practice, - before calling this method a proxy should check if the UA has indicated - support for the Path extension by checking the Supported header field - value in the request being proxied. The detailed procedure of Path header - handling is defined in RFC 3327. -
-
p - if true the container will add Path header-SipURI getRecordRouteURI()-
SipURI that the application can use to
- add parameters to the Record-Route header. This is used by
- record-routing proxy applications in order to push state to the
- endpoints and have it returned in subsequent requests belonging
- to the same dialog.
-
- Parameters added through a URI returned by this method can
- be retrieved from a subsequent request in the same dialog by
- calling ServletRequest.getParameter(java.lang.String).
-
-
Note that the URI returned is good only for - specifying a set of parameters that the application can - retrieve when invoked to handle subsequent requests in the same - dialog. Other components of the URI are irrelevant and cannot - be trusted to reflect the actual values that the container will - be using when inserting a Record-Route header into proxied - request. -
-
java.lang.IllegalStateException - if record-routing is not enabled-SipURI getPathURI()-
SipURI that the application can use to
- add parameters to the Path header. This may be used by
- Path header adding proxy applications in order to push state to the
- Registrar and have it returned in subsequent requests for the
- registered UA.
-
- Parameters added through a URI returned by this method can
- be retrieved from a subsequent request in the same dialog by
- calling ServletRequest.getParameter(java.lang.String).
-
-
Note that the URI returned is good only for - specifying a set of parameters that the application can - retrieve when invoked to handle subsequent requests - Other components of the URI are irrelevant and cannot - be trusted to reflect the actual values that the container will - be using when inserting a Path header into proxied - request. -
-
java.lang.IllegalStateException - if addToPath is not enabled-void setOutboundInterface(java.net.InetSocketAddress address)-
javax.servlet.sip.outboundInterfaces.
- The port is interpreted as an advice by the app to the container. - If the port of the socket address has a non-zero value, the container - will make a best-effort attempt to use it as the source port number - for UDP packets, or as a source port number for TCP connections it - originates. If the port is not available, the container will use - its default port allocation scheme. -
Invocation of this method also impacts the system headers
- generated by the container for this ProxyBranch, such as the
- Record-Route header (getRecordRouteURI()),
- the Via and the Contact header.
- The IP address part of the socket address is used to construct
- these system headers.
-
-
address - the socket address representing the outbound interface to use when
- forwarding requests with this proxy branch
-java.lang.IllegalArgumentException - if the address is not understood
- by the container as one of its outbound interface
-java.lang.NullPointerException - on null address-void setOutboundInterface(java.net.InetAddress address)-
javax.servlet.sip.outboundInterfaces.
- Invocation of this method also impacts the system headers
- generated by the container for the branch, such as the
- Record-Route header (getRecordRouteURI())
- and the Via. The supplied IP address is used to construct
- these system headers.
-
-
address - the address which represents the outbound interface
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.IllegalArgumentException - if the address does not
- represent one of the container's outbound interfaces
-java.lang.NullPointerException - on null address-SipServletResponse getResponse()-
-
SipServletResponse received, or null if
- no response has been received so far.-boolean isStarted()-
Proxy.createProxyBranches(java.util.List) and may be
- started at a later time by using Proxy.startProxy(). This method tells if the given
- branch has been started yet or not. The branches created as a result of proxyTo
- are always started on creation.
--
-java.util.List<ProxyBranch> getRecursedProxyBranches()-
ProxyBranch
--
-Proxy getProxy()-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class Rel100Exception
-Indicates that a provisional response cannot be sent reliably or PRACK was - attempted to be created on a non reliable provisional response. - -
This is thrown by the container when an application requested - that a provisional response be sent reliably (using the 100rel - extension defined in RFC 3262) but one or more of the conditions - for using 100rel is not satisfied: -
SipServletResponse.createPrack() is
- called for non-reliable provisional response or a final response or if the
- original request was not an INVITE.
-
- The actual reason why SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() failed can be discovered through
- getReason().
-
- -
-
| -Field Summary | -|
|---|---|
-static int |
-NO_REQ_SUPPORT
-
-- Reason code indicating that the UAC didn't indicate support for - the reliable responses extension in the request. |
-
-static int |
-NOT_100rel
-
-- Reason code indicating that SipServletResponse.createPrack()
- was invoked on a provisional response that is not reliable. |
-
-static int |
-NOT_1XX
-
-- Reason code indicating that SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked on a final or a 100 response. |
-
-static int |
-NOT_INVITE
-
-- Reason code indicating that SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked for a response to a
- non-INVITE request. |
-
-static int |
-NOT_SUPPORTED
-
-- Reason code indicating that the container does not support - reliable provisional response. |
-
| -Constructor Summary | -|
|---|---|
Rel100Exception(int reason)
-
-- Constructs a new Rel100Exception with the specified
- error reason. |
-|
| -Method Summary | -|
|---|---|
- java.lang.String |
-getMessage()
-
-- Returns message phrase suitable for the reason integer code. |
-
- int |
-getReason()
-
-- Returns an integer code indicating the specific reason why this - exception was thrown. |
-
| Methods inherited from class javax.servlet.ServletException | -
|---|
getRootCause |
-
| Methods inherited from class java.lang.Throwable | -
|---|
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Field Detail | -
|---|
-public static final int NOT_1XX-
SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked on a final or a 100 response.
--
-public static final int NOT_INVITE-
SipServletResponse.sendReliably() or
- SipServletResponse.createPrack() was invoked for a response to a
- non-INVITE request.
--
-public static final int NO_REQ_SUPPORT-
-
-public static final int NOT_SUPPORTED-
-
-public static final int NOT_100rel-
SipServletResponse.createPrack()
- was invoked on a provisional response that is not reliable.
--
| -Constructor Detail | -
|---|
-public Rel100Exception(int reason)-
Rel100Exception with the specified
- error reason.
--
reason - one of NOT_1XX, NOT_INVITE,
- NO_REQ_SUPPORT, NOT_SUPPORTED,
- NOT_100rel| -Method Detail | -
|---|
-public int getReason()-
-
NOT_1XX, NOT_INVITE,
- NO_REQ_SUPPORT, NOT_SUPPORTED,
- NOT_100rel-public java.lang.String getMessage()-
-
getMessage in class java.lang.Throwable
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class ServletParseException
-Thrown by the container when an application attempts to parse - a malformed header or addressing structure. -
- -
-
| -Constructor Summary | -|
|---|---|
ServletParseException()
-
-- Constructs a new parse exception, without any message. |
-|
ServletParseException(java.lang.String msg)
-
-- Constructs a new parse exception with the specified message. |
-|
ServletParseException(java.lang.String message,
- java.lang.Throwable cause)
-
-- Constructs a new parse exception with the specified detail message and - cause. |
-|
ServletParseException(java.lang.Throwable cause)
-
-- Constructs a new parse exception with the specified cause and a detail - message of (cause==null ? null : cause.toString()) (which - typically contains the class and detail message of cause). |
-|
| -Method Summary | -
|---|
| Methods inherited from class javax.servlet.ServletException | -
|---|
getRootCause |
-
| Methods inherited from class java.lang.Throwable | -
|---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public ServletParseException()-
-
-public ServletParseException(java.lang.String msg)-
-
msg - a String specifying the text of the
- exception message-public ServletParseException(java.lang.String message, - java.lang.Throwable cause)-
Note that the detail message associated with cause is
- not automatically incorporated in this exception's detail
- message.
-
-
message - the detail message (which is saved for later retrieval
- by the Throwable.getMessage() method).cause - the cause (which is saved for later retrieval by the
- Throwable.getCause() method). (A null value
- is permitted, and indicates that the cause is nonexistent or
- unknown.)-public ServletParseException(java.lang.Throwable cause)-
-
cause - the cause (which is saved for later retrieval by the
- Throwable.getCause() method). (A null value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface ServletTimer
-Created by the TimerService for servlet applications
- wishing to schedule future tasks.
-
- -
-
TimerService,
-TimerListener| -Method Summary | -|
|---|---|
- void |
-cancel()
-
-- Cancels this timer. |
-
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the application session associated with this - ServletTimer. |
-
- java.lang.String |
-getId()
-
-- Returns a string containing the unique identifier assigned to - this timer task. |
-
- java.io.Serializable |
-getInfo()
-
-- Get the information associated with the timer at the time of - creation. |
-
- long |
-getTimeRemaining()
-
-- Get the number of milliseconds that will elapse before the next scheduled - timer expiration. |
-
- long |
-scheduledExecutionTime()
-
-- Returns the scheduled expiration time of the most recent actual - expiration of this timer. |
-
| -Method Detail | -
|---|
-java.lang.String getId()-
-
-SipApplicationSession getApplicationSession()-
ServletTimer.
--
ServletTimer-java.io.Serializable getInfo()-
-
Serializable object that was passed in
- at timer creation, or null if the info argument
- passed in at timer creation was null.-long scheduledExecutionTime()-
This method is typically invoked from within
- TimerListener.timerFired to determine whether the
- timer callback was sufficiently timely to warrant performing the
- scheduled activity:
-
-
- public void run() {
- if (System.currentTimeMillis() - scheduledExecutionTime() >=
- MAX_TARDINESS)
- return; // Too late; skip this execution.
- // Perform the task
- }
-
-
- This method is typically not used in conjunction with fixed-delay - execution repeating tasks, as their scheduled execution times are - allowed to drift over time, and so are not terribly significant. -
-
Date.getTime().
- The return value is undefined if the timer has yet to expire for
- the first time.-void cancel()-
Note that calling this method on a repeating ServletTimer
- from within the timerFired method of a
- TimerListener absolutely guarantees that the timer
- will not fire again (unless rescheduled).
-
-
This method may be called repeatedly; the second and subsequent - calls have no effect. -
-
-long getTimeRemaining()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public static enum SipApplicationSession.Protocol
-Possible protocols to which sessions contained in the
- SipApplicationSession belong to.
-
- -
-
| -Enum Constant Summary | -|
|---|---|
HTTP
-
-- |
-|
SIP
-
-- |
-|
| -Method Summary | -|
|---|---|
-static SipApplicationSession.Protocol |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipApplicationSession.Protocol[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipApplicationSession.Protocol SIP-
-public static final SipApplicationSession.Protocol HTTP-
| -Method Detail | -
|---|
-public static final SipApplicationSession.Protocol[] values()-
-for(SipApplicationSession.Protocol c : SipApplicationSession.Protocol.values()) - System.out.println(c); --
-
-public static SipApplicationSession.Protocol valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationSession
-Represents application instances. The SipApplicationSession
- interface acts as a store for application data and provides access to
- contained protocol sessions, e.g. SipSession and
- HttpSession objects representing point-to-point signaling
- relationships.
-
- -
-
| -Nested Class Summary | -|
|---|---|
-static class |
-SipApplicationSession.Protocol
-
-- Possible protocols to which sessions contained in the - SipApplicationSession belong to. |
-
| -Method Summary | -|
|---|---|
- void |
-encodeURI(URI uri)
-
-- Deprecated. has potential to break application composition - instead of this use the SipApplicationKey mechanism - as described in section 15.11.2 in the SIP Servlet - specification document. |
-
- java.net.URL |
-encodeURL(java.net.URL url)
-
-- Encode specified URL to include the application session ID in a way - such that the parameter used to encode the application session ID - should be unique across implementations. |
-
- java.lang.String |
-getApplicationName()
-
-- Returns the name of the SIP application this SipApplicationSession is
- associated with. |
-
- java.lang.Object |
-getAttribute(java.lang.String name)
-
-- Returns the object bound with the specified name in this session, - or null if no object is bound under the name. |
-
- java.util.Iterator<java.lang.String> |
-getAttributeNames()
-
-- Returns an Iterator over the String
- objects containing the names of all the objects bound to this session. |
-
- long |
-getCreationTime()
-
-- Returns the time when this session was created, measured in - milliseconds since midnight January 1, 1970 GMT. |
-
- long |
-getExpirationTime()
-
-- Returns the time in future when this SipApplicationSession will expire. |
-
- java.lang.String |
-getId()
-
-- Returns a string containing the unique identifier assigned to - this session. |
-
- boolean |
-getInvalidateWhenReady()
-
-- Returns true if the container will notify the application when this - SipApplicationSession is in the ready-to-invalidate state. |
-
- long |
-getLastAccessedTime()
-
-- Returns the last time an event occurred on this application session. |
-
- java.lang.Object |
-getSession(java.lang.String id,
- SipApplicationSession.Protocol protocol)
-
-- Returns the session object with the specified id associated with the - specified protocol belonging to this application session, or null if not - found. |
-
- java.util.Iterator<?> |
-getSessions()
-
-- Returns an Iterator over all valid "protocol" sessions
- associated with this application session. |
-
- java.util.Iterator<?> |
-getSessions(java.lang.String protocol)
-
-- Returns an Iterator over all valid "protocol" session objects
- associated with the specified protocol associated with this application
- session. |
-
- SipSession |
-getSipSession(java.lang.String id)
-
-- Returns the SipSession with the specified id belonging
- to this application session, or null if not found. |
-
- ServletTimer |
-getTimer(java.lang.String id)
-
-- Returns the active timer identified by a specific id that is associated - with this application session. |
-
- java.util.Collection<ServletTimer> |
-getTimers()
-
-- Returns all active timers associated with this application session. |
-
- void |
-invalidate()
-
-- Invalidates this application session and unbinds any objects bound to - it. |
-
- boolean |
-isReadyToInvalidate()
-
-- Returns true if this application session is in a ready-to-invalidate state. |
-
- boolean |
-isValid()
-
-- Returns if this SipApplicationSession is valid, false otherwise. |
-
- void |
-removeAttribute(java.lang.String name)
-
-- Removes the object bound with the specified name from this session. |
-
- void |
-setAttribute(java.lang.String name,
- java.lang.Object attribute)
-
-- Binds an object to this session, using the name specified. |
-
- int |
-setExpires(int deltaMinutes)
-
-- Sets the time of expiry for this application session. |
-
- void |
-setInvalidateWhenReady(boolean invalidateWhenReady)
-
-- Specifies whether the container should notify the application when the - SipApplicationSession is in the ready-to-invalidate state as defined - above. |
-
| -Method Detail | -
|---|
-long getCreationTime()-
-
java.lang.IllegalStateException - if this method is called on an invalidated session-long getLastAccessedTime()-
Actions that applications take, such as getting or setting a - value associated with the session, do not affect the access time. -
-
-long getExpirationTime()-
Long.MIN_VALUE
-
- The time is returned as the number of milliseconds
- since midnight January 1, 1970 GMT.
--
java.lang.IllegalStateException - if this application session is not valid-java.lang.String getId()-
-
String identifier for this application session-java.lang.String getApplicationName()-
SipApplicationSession is
- associated with.
--
SipApplicationSession is
- associated with-int setExpires(int deltaMinutes)-
This allows servlets to programmatically extend the lifetime
- of application sessions. This method may be invoked by an
- application in the notification that the application session has
- expired: SipApplicationSessionListener.sessionExpired.
- If the server is willing to extend the session lifetime it returns
- the actual number of minutes the session lifetime has been extended
- with, and the listener will be invoked about session expiry again
- at a later time.
-
-
This helps applications clean up resources in a reasonable - amount of time in situations where it depends on external events - to complete an application session. Being able to extend session - lifetime means the application is not forced to choose a very high - session lifetime to begin with. - -
It is entirely up to server policy whether to grant or deny the
- applications request to extend session lifetime.
-
- Note that any attempt to extend the lifetime of an explicitly
- invalidated application session, one for which setExpires(int)
- has been invoked, will always fail.
-
-
In order to make the SipApplicationSession immortal i.e never
- expire, setExpires should be called with 0 (or -ve number),
- again it is upto the container to accept this or not. If the container
- does accept setting the session to never expire then it returns
- Integer.MAX_VALUE.
-
-
deltaMinutes - the number of minutes that the lifetime of this
- SipApplicationSession is extended with, if this param is
- 0 (or negative) then the session never expires
-java.lang.IllegalStateException - if this application session is not valid-void invalidate()-
-
java.lang.IllegalStateException - if this application session is not valid-boolean isReadyToInvalidate()-
SipApplicationSession is in the ready-to-invalidate state
- if the following conditions are met:
- -
java.lang.IllegalStateException - if this application session is not validSipSession.isReadyToInvalidate()-void setInvalidateWhenReady(boolean invalidateWhenReady)-
SipApplicationSessionListener.sessionReadyToInvalidate
- callback.
--
invalidateWhenReady - if true, the container will observe this
- application session and notify the application when it is in the
- ready-to-invalidate state. The application session is not observed if the
- flag is false.
- The default is true for v1.1 applications and false for v1.0
- applications.
-java.lang.IllegalStateException - if this application session is not validisReadyToInvalidate(),
-SipApplicationSessionListener.sessionReadyToInvalidate(SipApplicationSessionEvent ev)-boolean getInvalidateWhenReady()-
SipApplicationSession is in the ready-to-invalidate state.
--
java.lang.IllegalStateException - if this application session is not validisReadyToInvalidate()-java.util.Iterator<?> getSessions()-
Iterator over all valid "protocol" sessions
- associated with this application session. This may include a mix
- of different types of protocol sessions, e.g. SipSession
- and javax.servlet.http.HttpSession objects.
--
Iterator over set of valid protocol sessions belonging
- to this application session
-java.lang.IllegalStateException - if this application session is not valid-java.util.Iterator<?> getSessions(java.lang.String protocol)-
Iterator over all valid "protocol" session objects
- associated with the specified protocol associated with this application
- session. If the specified protocol is not supported, an empty
- Iterator is returned.
-
- If "SIP" is specified the result will be an Iterator
- over the set of valid SipSession objects belonging to this application
- session. For "HTTP" the result will be a list of
- javax.servlet.http.HttpSession objects.
-
-
protocol - a string identifying the protocol name, e.g. "SIP"
-Iterator over all valid protocol sessions of the
- specified protocol
-java.lang.IllegalStateException - if this application session is not valid
-java.lang.NullPointerException - if the protocol is null
-java.lang.IllegalArgumentException - if the protocol is not understood by container.-SipSession getSipSession(java.lang.String id)-
SipSession with the specified id belonging
- to this application session, or null if not found.
--
id - the SipSession id
-SipSession, or null if none is found.
-java.lang.NullPointerException - on null id
-java.lang.IllegalStateException - if this application session is not valid-java.lang.Object getSession(java.lang.String id, - SipApplicationSession.Protocol protocol)-
-
id - the session idprotocol - an Enum identifying the protocol
-java.lang.NullPointerException - on null id or protocol
-java.lang.IllegalStateException - if this application session is not valid-void encodeURI(URI uri)-
-
SipApplicationSession into the
- specified URI. The container must then be prepared to associate
- this application session with an incoming request which was
- triggered by activating the encoded URI.
-
- In the case of SIP and SIPS URIs, the container may also rewrite - the host, port, and transport protocol components of the URI based - on its knowledge of local listen points. When doing so it should - take existing settings as a hint as to which listen point to select - when it has more than one. - -
This method allow applications to correlate events which would - otherwise be treated as being independent, that is, as belonging to - different application sessions. For example, an application might - send an instant message with an HTML body to someone. The - IM body may then contain a SIP URI pointing back to the SIP servlet - container and the - application session in which the IM was generated, thus ensuring - that an INVITE triggered by the IM recipient triggering that URI - is associated with this application session when received by the - container. - -
Containers are required to support rewriting of SIP and SIPS URIs. -
-
uri - the uri to be encoded
-java.lang.IllegalArgumentException - if the container doesn't know how
- to rewrite the specified URI, for example, because it doesn't
- know the specific scheme
-java.lang.IllegalStateException - if this application session is not valid-java.lang.Object getAttribute(java.lang.String name)-
-
name - a string specifying the name of the object
-java.lang.IllegalStateException - if this application session is not valid-java.util.Iterator<java.lang.String> getAttributeNames()-
Iterator over the String
- objects containing the names of all the objects bound to this session.
- Note: This is a fail-fast iterator and can throw ConcurrentModificationException - if the underlying implementation does not allow modification after the - iterator is created. -
-
Iterator over the String objects
- specifying the names of all the objects bound to this session
-java.lang.IllegalStateException - if this application session is not valid-void setAttribute(java.lang.String name, - java.lang.Object attribute)-
-
name - the name to which the object is bound; cannot be nullattribute - the object to be bound; cannot be null
-java.lang.IllegalStateException - if this application session is not valid
-java.lang.NullPointerException - if the name or attribute
- is null.-void removeAttribute(java.lang.String name)-
-
name - the name of the object to remove from this session
-java.lang.IllegalStateException - if this application session is not valid-java.util.Collection<ServletTimer> getTimers()-
-
Collection of ServletTimer
- objects belonging to this application session
-java.lang.IllegalStateException - if this application session is not valid-ServletTimer getTimer(java.lang.String id)-
-
ServletTimer object identified by the id belonging
- to this application session
-java.lang.IllegalStateException - if this application session is not valid-boolean isValid()-
SipSession.invalidate() on it or if its invalidateWhenReady flag
- is true and it transitions to the ready-to-invalidate state.
- Also the SipSession can be invalidated by the container when either the associated
- SipApplicationSession times out or
- invalidate() is invoked.
--
-java.net.URL encodeURL(java.net.URL url)-
com.acme.appsession. This mechanism can be used by the applications
- to encode the HTTP URL with the application session Id. This URL can
- then be sent out through some of out of band mechanism. When the HTTP
- Request comes back to the converged container with this request, the
- container must associate the new HttpSession with the encoded
- Application Session. In case the HTTP request is not a new request
- but a follow on request already associated with a HTTP Session then
- the converged containers must use the HTTP session association
- mechanism to route the request to the right HTTP Session. If that HTTP
- Session was not associated with the encoded SipApplicationSession in the
- request then that association MUST occur. This mechanism is
- similar to how the (deprecated) encodeURI() operates for SIP.
-
-
--
url - the URL to be encoded
-java.lang.IllegalStateException - if this application session is not valid
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationSessionActivationListener
-Objects that are bound to a SipApplicationSession may listen to container events
- notifying them when the application session to which they are bound will be passivated or
- activated. A container that migrates application sessions between VMs or persists them is
- required to notify all attributes implementing this listener and that are bound to those
- application sessions of the events.
-
- -
-
| -Method Summary | -|
|---|---|
- void |
-sessionDidActivate(SipApplicationSessionEvent se)
-
-- Notification that the application session has just been activated. |
-
- void |
-sessionWillPassivate(SipApplicationSessionEvent se)
-
-- Notification that the application session is about to be passivated. |
-
| -Method Detail | -
|---|
-void sessionWillPassivate(SipApplicationSessionEvent se)-
-
se - event identifying the application session about to be persisted-void sessionDidActivate(SipApplicationSessionEvent se)-
-
se - event identifying the activated application session
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationSessionAttributeListener
-This listener interface can be implemented in order to get - notifications of changes to the attribute lists of application sessions. -
- -
-
| -Method Summary | -|
|---|---|
- void |
-attributeAdded(SipApplicationSessionBindingEvent ev)
-
-- Notification that an attribute has been added to an application session. |
-
- void |
-attributeRemoved(SipApplicationSessionBindingEvent ev)
-
-- Notification that an attribute has been removed from an application session. |
-
- void |
-attributeReplaced(SipApplicationSessionBindingEvent ev)
-
-- Notification that an attribute has been replaced in an application session. |
-
| -Method Detail | -
|---|
-void attributeAdded(SipApplicationSessionBindingEvent ev)-
-
ev - event identifying the affected SipApplicationSession-void attributeRemoved(SipApplicationSessionBindingEvent ev)-
-
ev - event identifying the affected SipApplicationSession-void attributeReplaced(SipApplicationSessionBindingEvent ev)-
-
ev - event identifying the affected SipApplicationSession
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipApplicationSessionBindingEvent
-Events of this type are either sent to an object that implements
- SipApplicationSessionBindingListener when it is bound or unbound from an
- application session, or to a SipApplicationSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in an application session.
-
-
The session binds the object by a call to
- SipApplicationSession.setAttribute(String, Object) and unbinds the object by a call
- to SipApplicationSession.removeAttribute(String).
-
- -
-
SipApplicationSession,
-SipApplicationSessionBindingListener,
-SipApplicationSessionAttributeListener,
-Serialized Form| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipApplicationSessionBindingEvent(SipApplicationSession session,
- java.lang.String name)
-
-- Constructs an event that notifies an object that it has been bound - to or unbound from an application session. |
-|
| -Method Summary | -|
|---|---|
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the application session to or from which the object is bound or unbound. |
-
- java.lang.String |
-getName()
-
-- Returns the name with which the object is bound to or unbound from - the application session. |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipApplicationSessionBindingEvent(SipApplicationSession session, - java.lang.String name)-
SipApplicationSessionBindingListener.
--
session - the application ession to which the object is bound or unboundname - the name with which the object is bound or unbound| -Method Detail | -
|---|
-public java.lang.String getName()-
-
-public SipApplicationSession getApplicationSession()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationSessionBindingListener
-Causes an object to be notified when it is bound to or unbound from
- a SipApplicationSession. The object is notified by an SipApplicationSessionBindingEvent
- object. This may be as a result of a servlet programmer explicitly
- unbinding an attribute from an application session, due to an application session being invalidated,
- or due to an application session timing out.
-
- -
-
SipApplicationSession,
-SipApplicationSessionBindingEvent| -Method Summary | -|
|---|---|
- void |
-valueBound(SipApplicationSessionBindingEvent event)
-
-- Notifies the object that it is being bound to an application session and - identifies the application session. |
-
- void |
-valueUnbound(SipApplicationSessionBindingEvent event)
-
-- Notifies the object that it is being unbound from an application session and - identifies the application session. |
-
| -Method Detail | -
|---|
-void valueBound(SipApplicationSessionBindingEvent event)-
-
event - the event that identifies the application session-void valueUnbound(SipApplicationSessionBindingEvent event)-
-
event - the event that identifies the application session
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipApplicationSessionEvent
-This is the class representing event notifications for changes to
- SipApplicationSessions within a SIP servlet application.
-
-
-
A SipApplicationSessionListener receiving this notification
- may attempt to extend the lifetime of the application instance
- corresponding to the expiring application session by invoking
- SipApplicationSession.setExpires(int).
-
- -
-
| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipApplicationSessionEvent(SipApplicationSession appSession)
-
-- Creates a new SipApplicationSessionEvent object. |
-|
| -Method Summary | -|
|---|---|
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the expired session object. |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipApplicationSessionEvent(SipApplicationSession appSession)-
SipApplicationSessionEvent object.
--
appSession - the expired application session| -Method Detail | -
|---|
-public SipApplicationSession getApplicationSession()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationSessionListener
-Implementations of this interface can receive notifications about
- invalidated and/or activated SipApplicationSession objects
- in the SIP application they are part of. To receive notification events,
- the implementation class must be configured in the deployment
- descriptor for the servlet application.
-
- -
-
| -Method Summary | -|
|---|---|
- void |
-sessionCreated(SipApplicationSessionEvent ev)
-
-- Notification that a session was created. |
-
- void |
-sessionDestroyed(SipApplicationSessionEvent ev)
-
-- Notification that a session was invalidated. |
-
- void |
-sessionExpired(SipApplicationSessionEvent ev)
-
-- Notification that an application session has expired. |
-
- void |
-sessionReadyToInvalidate(SipApplicationSessionEvent ev)
-
-- Notification that a SipApplicationSession is in the
- ready-to-invalidate state. |
-
| -Method Detail | -
|---|
-void sessionCreated(SipApplicationSessionEvent ev)-
-
ev - the notification event-void sessionDestroyed(SipApplicationSessionEvent ev)-
-
ev - the notification event-void sessionExpired(SipApplicationSessionEvent ev)-
SipApplicationSession.setExpires(int).
--
ev - the notification event-void sessionReadyToInvalidate(SipApplicationSessionEvent ev)-
SipApplicationSession is in the
- ready-to-invalidate state. The container will invalidate this session
- upon completion of this callback unless the listener implementation calls
- SipApplicationSessionEvent.getApplicationSession().setInvalidateWhenReady(false)
--
ev - the notification eventSipApplicationSession.isReadyToInvalidate()
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipErrorEvent
-Events of this type are sent to objects implementing the
- SipErrorListener interface when an error occurs which
- is related to the applications processing of a SIP transaction.
-
- -
-
| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipErrorEvent(SipServletRequest request,
- SipServletResponse response)
-
-- Constructs a new SipErrorEvent. |
-|
| -Method Summary | -|
|---|---|
- SipServletRequest |
-getRequest()
-
-- Returns the request object associated with this - SipErrorEvent. |
-
- SipServletResponse |
-getResponse()
-
-- Returns the response object associated with this - SipErrorEvent. |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipErrorEvent(SipServletRequest request, - SipServletResponse response)-
SipErrorEvent.
--
request - the request the error relates toresponse - the response the error relates to| -Method Detail | -
|---|
-public SipServletRequest getRequest()-
SipErrorEvent.
--
SipErrorEvent-public SipServletResponse getResponse()-
SipErrorEvent.
--
SipErrorEvent
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipErrorListener
-Causes applications to be notified of various error conditions - occurring during regular SIP transaction processing. -
- -
-
| -Method Summary | -|
|---|---|
- void |
-noAckReceived(SipErrorEvent ee)
-
-- Invoked by the servlet container to notify an application that - no ACK was received for an INVITE transaction for which a final - response has been sent upstream. |
-
- void |
-noPrackReceived(SipErrorEvent ee)
-
-- Invoked by the servlet container for applications acting as a UAS - when no PRACK was received for a previously sent reliable provisional - response. |
-
| -Method Detail | -
|---|
-void noAckReceived(SipErrorEvent ee)-
This method is invoked for UAS applications only and not for - applications that proxied the INVITE. -
-
ee - the event that identifies the request-void noPrackReceived(SipErrorEvent ee)-
SipErrorEvent argument.
--
ee - the event that identifies the original request and
- the reliable provisional response
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipFactory
-Factory interface for a variety of SIP Servlet API abstractions. - -
SIP servlet containers are requried to make a
- SipFactory instance available to applications
- through a ServletContext attribute with name
- javax.servlet.sip.SipFactory.
-
- -
-
| -Method Summary | -|
|---|---|
- Address |
-createAddress(java.lang.String addr)
-
-- Returns a Address corresponding to the specified
- string. |
-
- Address |
-createAddress(URI uri)
-
-- Returns an Address with the specified URI and no
- display name. |
-
- Address |
-createAddress(URI uri,
- java.lang.String displayName)
-
-- Returns a new Address with the specified
- URI and display name. |
-
- SipApplicationSession |
-createApplicationSession()
-
-- Returns a new SipApplicationSession. |
-
- SipApplicationSession |
-createApplicationSessionByKey(java.lang.String sipApplicationKey)
-
-- Returns a new SipApplicationSession identified by the specified
- SipApplicationKey. |
-
- AuthInfo |
-createAuthInfo()
-
-- Creates a new AuthInfo object that can be used to provide authentication - information on servlet initiated requests. |
-
- Parameterable |
-createParameterable(java.lang.String s)
-
-- Creates a new Parameterable parsed from the specified
- string. |
-
- SipServletRequest |
-createRequest(SipApplicationSession appSession,
- java.lang.String method,
- Address from,
- Address to)
-
-- Returns a new request object with the specified request method, From, - and To headers. |
-
- SipServletRequest |
-createRequest(SipApplicationSession appSession,
- java.lang.String method,
- java.lang.String from,
- java.lang.String to)
-
-- Returns a new request object with the specified request method, From, - and To headers. |
-
- SipServletRequest |
-createRequest(SipApplicationSession appSession,
- java.lang.String method,
- URI from,
- URI to)
-
-- Returns a new request object with the specified request method, From, - and To headers. |
-
- SipServletRequest |
-createRequest(SipServletRequest origRequest,
- boolean sameCallId)
-
-- Deprecated. 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 - B2buaHelper.createRequest(SipServletRequest) |
-
- SipURI |
-createSipURI(java.lang.String user,
- java.lang.String host)
-
-- Constructs a SipURI with the specified user and host
- components. |
-
- URI |
-createURI(java.lang.String uri)
-
-- Returns a URI object corresponding to the specified
- string, which should represent an escaped SIP, SIPS, or tel URI. |
-
| -Method Detail | -
|---|
-URI createURI(java.lang.String uri) - throws ServletParseException-
URI object corresponding to the specified
- string, which should represent an escaped SIP, SIPS, or tel URI.
- The URI may then be used as request URI in
- SIP requests or as the URI component of Address objects.
-
- Implementations must be able to represent URIs of any scheme.
- This method returns a SipURI object if the specified
- string is a sip or a sips URI, and a
- TelURL object if it's a tel URL.
-
-
If the specified URI string contains any reserved characters, - then the container is responsible for escaping them, - in accordance with RFC2396. -
-
uri - the SIP, SIPS, or tel string to parse
-URI object
-ServletParseException - if the URI scheme
- is unknown or parsing failed-SipURI createSipURI(java.lang.String user, - java.lang.String host)-
SipURI with the specified user and host
- components. The scheme will initially be sip but the
- application may change it to sips by calling
- setSecure(true) on the returned SipURI.
- Likewise, the port number of the new URI is left unspecified but
- may subsequently be set by calling setPort on the
- returned SipURI.
- If the specified URI string contains any reserved characters, then - the container is responsible for escaping them, - in accordance with RFC2396. -
-
user - user part of the new SipURIhost - host part of the new SipURI
-SipURI with the specified
- user and host parts-Address createAddress(java.lang.String addr) - throws ServletParseException-
Address 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.
-
- The special argument "*" results in a wildcard
- Address being returned, that is, an Address
- for which isWildcard returns true. Such addresses are
- for use in Contact headers only.
-
-
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 createURI(String)
-
-
addr - valid value of SIP From or To header
-Address
-ServletParseException - if parsing failed-Address createAddress(URI uri)-
Address with the specified URI and no
- display name.
--
uri - the URI of the returned Address
-Address whose URI
- component is the argument-Address createAddress(URI uri, - java.lang.String displayName)-
Address with the specified
- URI and display name.
--
uri - URI of the new AddressdisplayName - display name of the new Address-Parameterable createParameterable(java.lang.String s) - throws ServletParseException-
Parameterable parsed from the specified
- string. The string must be in the following format:
- - field-value *(;parameter-name[=parameter-value]) -- 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. -
-
s - the header field string
-Parameterable
-ServletParseException - if parsing failed-SipServletRequest createRequest(SipApplicationSession appSession, - java.lang.String method, - Address from, - Address to)-
SipSession which belongs to the specified
- SipApplicationSession.
-
- 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 if the method is not REGISTER. - -
This method makes a copy of the from and to arguments and
- associates them with the new SipSession. 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.
-
-
appSession - the application session to which the new
- SipSession and SipServletRequest
- belongsmethod - the method of the new request, e.g. "INVITE"from - value of the From headerto - value of the To header
-java.lang.IllegalArgumentException - if the method is "ACK" or "CANCEL",
- or the specified SipApplicationSession is invalid.-SipServletRequest createRequest(SipApplicationSession appSession, - java.lang.String method, - URI from, - URI to)-
SipSession which belongs to the specified
- SipApplicationSession.
-
- 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 if the method is not REGISTER. - -
This method makes a copy of the from and to arguments and
- associates them with the new SipSession. 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.
-
-
appSession - the application session to which the new
- SipSession and SipServletRequest
- belongsmethod - the method of the new request, e.g. "INVITE"from - value of the From headerto - value of the To header
-java.lang.IllegalArgumentException - if the method is "ACK" or "CANCEL",
- or the specified SipApplicationSession is invalid.-SipServletRequest createRequest(SipApplicationSession appSession, - java.lang.String method, - java.lang.String from, - java.lang.String to) - throws ServletParseException-
SipSession which belongs to the specified
- SipApplicationSession.
-
- 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 if the method is not REGISTER. - -
This method is functionally equivalent to: -
- createRequest(method, f.createAddress(from), f.createAddress(to)); -- 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. -
-
appSession - the application session to which the new
- SipSession and SipServletRequest
- belongsmethod - the method of the new request, e.g. "INVITE"from - value of the From header -- this must be a
- valid Addressto - value of the To header -- this must be a
- valid Address
-ServletParseException - if the URI scheme of
- the from or to argument is unknown or if parsing failed
-java.lang.IllegalArgumentException - if the method is "ACK" or "CANCEL",
- or the specified SipApplicationSession is invalid.-SipServletRequest createRequest(SipServletRequest origRequest, - boolean sameCallId)-
B2buaHelper.createRequest(SipServletRequest)
--
origRequest
- in that the method and the majority of header fields are copied
- from origRequest to the new request. The SipSession
- created for the new request also shares the same SipApplicationSession
- associated with the original request.
-
- This method satisfies the following rules: -
sameCallId argument is false, the new
- request (and the corresponding SipSession)is
- assigned a new Call-ID.
- 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 SipSession.createRequest(java.lang.String) as usual.
-
-
origRequest - request to be "copied"sameCallId - whether or not to use same Call-ID for the new
- dialog
--SipApplicationSession createApplicationSession()-
SipApplicationSession. This is useful,
- for example, when an application is being initialized and wishes
- to perform some signaling action.
--
SipApplicationSession object-SipApplicationSession createApplicationSessionByKey(java.lang.String sipApplicationKey)-
SipApplicationSession 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.
--
sipApplicationKey - id for the SipApplicationSession
-SipApplicationSession object with the specified id-AuthInfo createAuthInfo()-
-
AuthInfo
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public abstract class SipServlet
-Provides an abstract class to be subclassed to create a SIP servlet. - -
This class receives incoming messages through the
- service method. This method calls
- doRequest or doResponse
- for incoming requests and responses, respectively. These two methods
- in turn dispatch on request method or status code to one of the
- following methods:
-
-
doInvite - for SIP INVITE requests
- doAck - for SIP ACK requests
- doOptions - for SIP OPTIONS requests
- doBye - for SIP BYE requests
- doCancel - for SIP CANCEL requests
- doRegister - for SIP REGISTER requests
- doSubscribe - for SIP SUBSCRIBE requests
- doNotify - for SIP NOTIFY requests
- doMessage - for SIP MESSAGE requests
- doInfo - for SIP INFO requests
- doPrack - for SIP PRACK requests
- doUpdate - for SIP UPDATE requests
- doRefer - for SIP REFER requests
- doPublish - for SIP PUBLISH requests
-
- doProvisionalResponse
- - for SIP 1xx informational responses
- doSuccessResponse - for SIP 2xx responses
- doRedirectResponse
- - for SIP 3xx responses
- doErrorResponse
- - for SIP 4xx, 5xx, and 6xx responses
- The default implementation of doAck, doCancel
- and all the response handling methods are empty. All other request handling
- methods reject the request with a 500 error response.
-
-
Subclasses of SipServlet will usually override one
- or more of these methods.
-
- -
-
| -Field Summary | -|
|---|---|
-static java.lang.String |
-OUTBOUND_INTERFACES
-
-- The string "javax.servlet.sip.outboundInterfaces". |
-
-static java.lang.String |
-PRACK_SUPPORTED
-
-- Deprecated. in favor of using the "javax.servlet.sip.supported" attribute |
-
-static java.lang.String |
-SIP_FACTORY
-
-- The string "javax.servlet.sip.SipFactory". |
-
-static java.lang.String |
-SIP_SESSIONS_UTIL
-
-- The string "javax.servlet.sip.SipSessionsUtil". |
-
-static java.lang.String |
-SUPPORTED
-
-- The string "javax.servlet.sip.supported". |
-
-static java.lang.String |
-SUPPORTED_RFCs
-
-- The string "javax.servlet.sip.supportedRfcs". |
-
-static java.lang.String |
-TIMER_SERVICE
-
-- The string "javax.servlet.sip.TimerService". |
-
| -Constructor Summary | -|
|---|---|
SipServlet()
-
-- |
-|
| -Method Summary | -|
|---|---|
-protected void |
-doAck(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - ACK requests. |
-
-protected void |
-doBranchResponse(SipServletResponse resp)
-
-- Invoked by the server to handle intermediate final responses only if this - Servlet behaves as a proxy. |
-
-protected void |
-doBye(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - BYE requests. |
-
-protected void |
-doCancel(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - CANCEL requests. |
-
-protected void |
-doErrorResponse(SipServletResponse resp)
-
-- Invoked by the server (via the doResponse method) to handle incoming - 4xx - 6xx class responses. |
-
-protected void |
-doInfo(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - INFO requests. |
-
-protected void |
-doInvite(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - INVITE requests. |
-
-protected void |
-doMessage(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - MESSAGE requests. |
-
-protected void |
-doNotify(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - NOTIFY requests. |
-
-protected void |
-doOptions(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - OPTIONS requests. |
-
-protected void |
-doPrack(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - PRACK requests. |
-
-protected void |
-doProvisionalResponse(SipServletResponse resp)
-
-- Invoked by the server (via the doResponse method) to handle incoming - 1xx class responses. |
-
-protected void |
-doPublish(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - PUBLISH requests. |
-
-protected void |
-doRedirectResponse(SipServletResponse resp)
-
-- Invoked by the server to notify the servlet of incoming 3xx class - responses. |
-
-protected void |
-doRefer(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - REFER requests. |
-
-protected void |
-doRegister(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - REGISTER requests. |
-
-protected void |
-doRequest(SipServletRequest req)
-
-- Invoked to handle incoming requests. |
-
-protected void |
-doResponse(SipServletResponse resp)
-
-- Invoked to handle incoming responses. |
-
-protected void |
-doSubscribe(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - SUBSCRIBE requests. |
-
-protected void |
-doSuccessResponse(SipServletResponse resp)
-
-- Invoked by the server (via the doResponse method) to handle incoming - 2xx class responses. |
-
-protected void |
-doUpdate(SipServletRequest req)
-
-- Invoked by the server (via the service method) to handle incoming - UPDATE requests. |
-
- void |
-log(java.lang.String message)
-
-- Writes the specified message to a servlet log file. |
-
- void |
-log(java.lang.String message,
- java.lang.Throwable t)
-
-- Writes an explanatory message and a stack trace for a given - Throwable exception to the servlet log file. |
-
- void |
-service(javax.servlet.ServletRequest req,
- javax.servlet.ServletResponse resp)
-
-- Invoked to handle incoming SIP messages: requests or responses. |
-
| Methods inherited from class javax.servlet.GenericServlet | -
|---|
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
-
| -Field Detail | -
|---|
-public static final java.lang.String SIP_FACTORY-
ServletContext attribute whose value is an
- instance of the SipFactory interface.
--
SipFactory,
-Constant Field Values-public static final java.lang.String TIMER_SERVICE-
ServletContext attribute whose value is an
- instance of the TimerService interface.
--
TimerService,
-Constant Field Values-public static final java.lang.String SUPPORTED-
ServletContext attribute whose value is a
- List containing the names of SIP extensions supported
- by the container.
--
-public static final java.lang.String SUPPORTED_RFCs-
ServletContext attribute whose value is a
- List containing the RFC numbers represented as Strings
- of SIP RFCs supported by the container.
-
- For e.g., if the container supports RFC 3261, RFC 3262 and RFC 3265, the
- List associated with this attribute should contain the Strings "3261",
- "3262" and "3265".
--
-public static final java.lang.String OUTBOUND_INTERFACES-
ServletContext attribute whose value is a list
- of SipURI objects which represent the available outbound
- interfaces for sending SIP requests. On a multihomed machine, a specific
- outbound interface can be selected for sending requests by calling the
- the SipSession.setOutboundInterface(java.net.InetSocketAddress) or Proxy.setOutboundInterface(java.net.InetSocketAddress)
- with an available interface address chosen from this list.
--
-public static final java.lang.String SIP_SESSIONS_UTIL-
ServletContext attribute whose value is the @{link Sessions}
- utility class providing support for converged SIP/HTTP applications.
--
-public static final java.lang.String PRACK_SUPPORTED-
ServletContext attribute whose value suggests whether
- the container supports the 100rel extension i.e. RFC 3262.
--
| -Constructor Detail | -
|---|
-public SipServlet()-
| -Method Detail | -
|---|
-public void service(javax.servlet.ServletRequest req, - javax.servlet.ServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
This method dispatched to doRequest() or
- doResponse() as appropriate. Servlets will not
- usually need to override this method.
-
-
service in interface javax.servlet.Servletservice in class javax.servlet.GenericServletreq - the request to handle, or null if the triggering event
- was an incoming responseresp - incoming response or null if the triggering event was
- an incoming request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doRequest(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
-
req - represents the incoming SIP request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doInvite(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP INVITE request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doAck(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP ACK request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doOptions(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP OPTIONS request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doBye(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP BYE request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doCancel(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP CANCEL request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doRegister(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP REGISTER request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doSubscribe(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP SUBSCRIBE request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doNotify(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP NOTIFY request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doMessage(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP MESSAGE request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doInfo(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP INFO request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doPrack(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP PRACK request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doUpdate(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP UPDATE request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doRefer(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP REFER request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doPublish(SipServletRequest req) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
req - represents the incoming SIP PUBLISH request
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
doProvisionalResponse(),
- doSuccessResponse(),
- doBranchResponse(),
- doRedirectResponse() or
- doErrorResponse().
-
- Intermediate final responses received on a ProxyBranch are dispatched to
- doBranchResponse(javax.servlet.sip.SipServletResponse). To handle such responses override the
- doBranchResponse.
-
- Servlets will not usually need to override this method.
-
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occursSipServletResponse.isBranchResponse()-protected void doProvisionalResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doSuccessResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doRedirectResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doErrorResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to do something useful. -
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-protected void doBranchResponse(SipServletResponse resp) - throws javax.servlet.ServletException, - java.io.IOException-
The default implementation is empty and must be overridden by - subclasses to handle intermediate final responses received on a ProxyBranch. -
-
resp - the response object
-javax.servlet.ServletException - if an exception occurs that interferes
- with the servlet's normal operation
-java.io.IOException - if an input or output exception occurs-public void log(java.lang.String message)-
-
log in class javax.servlet.GenericServletmessage - a String specifying the message to be
- written to the log file-public void log(java.lang.String message, - java.lang.Throwable t)-
Throwable exception to the servlet log file. See
- ServletContext.log(String, Throwable).
--
log in class javax.servlet.GenericServletmessage - a String that describes the error
- or exceptiont - the java.lang.Throwable error or exception
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipServletContextEvent
-SIP Servlet specific context event. -
- -
-
SipServletListener,
-Serialized Form| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipServletContextEvent(javax.servlet.ServletContext context,
- SipServlet servlet)
-
-- Constructs a new SipServletContextEvent. |
-|
| -Method Summary | -|
|---|---|
- SipServlet |
-getSipServlet()
-
-- Returns the servlet associated with the event - SipServletContextEvent. |
-
| Methods inherited from class javax.servlet.ServletContextEvent | -
|---|
getServletContext |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipServletContextEvent(javax.servlet.ServletContext context, - SipServlet servlet)-
SipServletContextEvent.
--
context - the ServletContextservlet - the servlet, initialization of which triggered this event| -Method Detail | -
|---|
-public SipServlet getSipServlet()-
SipServletContextEvent.
--
SipErrorEvent
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipServletListener
-Containers are required to invoke init() on the servlets before
- the servlets are ready for service. The servlet can only be used
- after succesful initialization. Since SIP is a peer-to-peer protocol
- and some servlets may act as UACs, the container is required to
- let the servlet know when it is succesfully initialized by invoking
- SipServletListener.
-
- -
-
SipServletContextEvent| -Method Summary | -|
|---|---|
- void |
-servletInitialized(SipServletContextEvent ce)
-
-- Notification that the servlet was succesfully initialized |
-
| -Method Detail | -
|---|
-void servletInitialized(SipServletContextEvent ce)-
-
ce - event identifying the initialized servlet and associated context
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public static enum SipServletMessage.HeaderForm
-Type header forms. -
- -
-
| -Enum Constant Summary | -|
|---|---|
COMPACT
-
-- |
-|
DEFAULT
-
-- Default container form, also if this is set the indvidual headers can be set in different forms. |
-|
LONG
-
-- |
-|
| -Method Summary | -|
|---|---|
-static SipServletMessage.HeaderForm |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipServletMessage.HeaderForm[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipServletMessage.HeaderForm COMPACT-
-public static final SipServletMessage.HeaderForm LONG-
-public static final SipServletMessage.HeaderForm DEFAULT-
-
| -Method Detail | -
|---|
-public static final SipServletMessage.HeaderForm[] values()-
-for(SipServletMessage.HeaderForm c : SipServletMessage.HeaderForm.values()) - System.out.println(c); --
-
-public static SipServletMessage.HeaderForm valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipServletMessage
-Defines common aspects of SIP requests and responses. - -
The Servlet API is defined with an implicit assumption that servlets
- receives requests from clients, inspects various aspects of the
- corresponding ServletRequest object, and generates a
- response by setting various attributes of a ServletResponse
- object. This model fits HTTP well, because HTTP servlets always execute
- origin servers; they execute only to process incoming requests
- and never initiates HTTP requests of their own.
-
-
SIP services, on the other hand, does need to be able to initiate - requests of their own. This implies that SIP request and response classes - are more symmetric, that is, requests must be writable as well as - readable, and likewise, responses must be readable as well as writable. - -
The
-
-
-SipServletMessage interface defines a number of
- methods which are common to SipServletRequest and
- SipServletResponse, for example setters and getters for
- message headers and content.
-
- System Headers
-
- Applications must not add, delete, or modify so-called "system"
- headers. These are header fields that the servlet container manages:
- From, To, Call-ID, CSeq, Via, Route (except through
- pushRoute), Record-Route, Path. Contact is a system header field
- in messages other than REGISTER requests and responses, 3xx and 485
- responses, and 200/OPTIONS responses. Additionally, for containers
- implementing the reliable provisional responses extension, RAck and RSeq
- are considered system headers also. Note that From and To are system header
- fields only with respect to their tags (i.e., tag parameters on these headers
- are not allowed to be modified but modifications are allowed to the other parts).
-
- Implicit Transaction State
-
- SipServletMessage objects always implicitly
- belong to a SIP transaction, and the transaction state machine
- (as defined by the SIP specification) constrains
- what messages can legally be sent at various points of processing. If a
- servlet attempts to send a message which would violate the SIP
- specification (for example, the transaction state machine), the container
- throws an IllegalStateException.
-
-
-
| -Nested Class Summary | -|
|---|---|
-static class |
-SipServletMessage.HeaderForm
-
-- Type header forms. |
-
| -Method Summary | -|
|---|---|
- void |
-addAcceptLanguage(java.util.Locale locale)
-
-- Adds an acceptable Locale of this user agent. |
-
- void |
-addAddressHeader(java.lang.String name,
- Address addr,
- boolean first)
-
-- Adds the specified Address as a new value of the
- named header field. |
-
- void |
-addHeader(java.lang.String name,
- java.lang.String value)
-
-- Adds a header with the given name and value. |
-
- void |
-addParameterableHeader(java.lang.String name,
- Parameterable param,
- boolean first)
-
-- Adds the specified Parameterable as a new value of the
- named header field. |
-
- java.util.Locale |
-getAcceptLanguage()
-
-- Returns the preferred Locale that the UA originating
- this message will accept content in, based on the Accept-Language
- header. |
-
- java.util.Iterator<java.util.Locale> |
-getAcceptLanguages()
-
-- Returns an Iterator over Locale objects
- indicating, in decreasing order starting with the preferred locale,
- the locales that are acceptable to the sending UA based on the
- Accept-Language header. |
-
- Address |
-getAddressHeader(java.lang.String name)
-
-- Returns the value of the specified header as a - Address object. |
-
- java.util.ListIterator<Address> |
-getAddressHeaders(java.lang.String name)
-
-- Returns a ListIterator over all Address
- header field values for the specified header. |
-
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the application session to which this message belongs. |
-
- SipApplicationSession |
-getApplicationSession(boolean create)
-
-- Returns the app session to which this message belongs. |
-
- java.lang.Object |
-getAttribute(java.lang.String name)
-
-- Returns the value of the named attribute as an Object, or null if - no attribute of the given name exists. |
-
- java.util.Enumeration<java.lang.String> |
-getAttributeNames()
-
-- Returns an Enumeration containing the names of the
- attributes available to this message object. |
-
- java.lang.String |
-getCallId()
-
-- Returns the value of the Call-ID header in this - SipServletMessage. |
-
- java.lang.String |
-getCharacterEncoding()
-
-- Returns the name of the charset used for the MIME body sent in - this message. |
-
- java.lang.Object |
-getContent()
-
-- Returns the content as a Java object. |
-
- java.util.Locale |
-getContentLanguage()
-
-- Returns the locale of this message. |
-
- int |
-getContentLength()
-
-- Returns the length in number of bytes of the content part of this - message. |
-
- java.lang.String |
-getContentType()
-
-- Returns the value of the Content-Type header field. |
-
- int |
-getExpires()
-
-- Returns the value of the Expires header. |
-
- Address |
-getFrom()
-
-- Returns the value of the From header. |
-
- java.lang.String |
-getHeader(java.lang.String name)
-
-- Returns the value of the specified header as a - String. |
-
- SipServletMessage.HeaderForm |
-getHeaderForm()
-
-- |
-
- java.util.Iterator<java.lang.String> |
-getHeaderNames()
-
-- Returns an Iterator over all the header names this
- message contains. |
-
- java.util.ListIterator<java.lang.String> |
-getHeaders(java.lang.String name)
-
-- Returns all the values of the specified header as a - ListIterator over a number of String objects. |
-
- java.lang.String |
-getInitialRemoteAddr()
-
-- Returns the IP address of the upstream/downstream hop from which - this message was initially received by the container. - Unlike getRemoteAddr(), this method
- returns the same value regardless of which application invokes it
- in the same application composition chain of a specific application router. |
-
- int |
-getInitialRemotePort()
-
-- Returns the port number of the upstream/downstream hop from which - this message initially received by the container. |
-
- java.lang.String |
-getInitialTransport()
-
-- Returns the name of the protocol with which this message was initially - received by the container, - e.g. |
-
- java.lang.String |
-getLocalAddr()
-
-- Returns the IP address of the interface this message was received on. |
-
- int |
-getLocalPort()
-
-- Returns the local port this message was received on. |
-
- java.lang.String |
-getMethod()
-
-- Returns the SIP method of this message. |
-
- Parameterable |
-getParameterableHeader(java.lang.String name)
-
-- Returns the value of the specified header field as a - Parameterable object. |
-
- java.util.ListIterator<? extends Parameterable> |
-getParameterableHeaders(java.lang.String name)
-
-- Returns a ListIterator over all Parameterable
- header field values for the specified header name. |
-
- java.lang.String |
-getProtocol()
-
-- Returns the name and version of the protocol of this message. |
-
- byte[] |
-getRawContent()
-
-- Returns message content as a byte array. |
-
- java.lang.String |
-getRemoteAddr()
-
-- Returns the IP address of the next upstream/downstream hop from which - this message was received. |
-
- int |
-getRemotePort()
-
-- Returns the port number of the next upstream/downstream hop from which - this message was received. |
-
- java.lang.String |
-getRemoteUser()
-
-- Returns the login of the user sending this message, if the - user has been authenticated, or null if the user has not been - authenticated. |
-
- SipSession |
-getSession()
-
-- Returns the SipSession to which this message belongs. |
-
- SipSession |
-getSession(boolean create)
-
-- Returns the SipSession to which this message belongs. |
-
- Address |
-getTo()
-
-- Returns the value of the To header. |
-
- java.lang.String |
-getTransport()
-
-- Returns the name of the protocol with which this message was received, - e.g. |
-
- java.security.Principal |
-getUserPrincipal()
-
-- Returns a java.security.Principal object containing
- the name of the authenticated user agent sending this message. |
-
- boolean |
-isCommitted()
-
-- Returns true if this message is committed, that is, if one - of the following conditions is true: - - This message is an incoming request for which a final response - has already been generated - This message is an outgoing request which has already been sent - This message is an incoming non-reliable provisional response received - by a servlet acting as a UAC - This message is an incoming reliable provisional response for which PRACK - has already been generated. |
-
- boolean |
-isSecure()
-
-- Returns a boolean indicating whether this message was received over - a secure channel, such as TLS. |
-
- boolean |
-isUserInRole(java.lang.String role)
-
-- Returns a boolean indicating whether the authenticated user is - included in the specified logical "role". |
-
- void |
-removeAttribute(java.lang.String name)
-
-- Removes the named attribute from this message. |
-
- void |
-removeHeader(java.lang.String name)
-
-- Removes the specified header. |
-
- void |
-send()
-
-- Sends this SipServletMessage. |
-
- void |
-setAcceptLanguage(java.util.Locale locale)
-
-- Sets the preferred Locale that this user agent will
- accept content, reason phrases, warnings, etc. |
-
- void |
-setAddressHeader(java.lang.String name,
- Address addr)
-
-- Sets the header with the specified name to have the value - specified by the address argument. |
-
- void |
-setAttribute(java.lang.String name,
- java.lang.Object o)
-
-- Stores an attribute in this message. |
-
- void |
-setCharacterEncoding(java.lang.String enc)
-
-- Overrides the name of the character encoding that will be used to - convert the body of this message from bytes to characters or vice - versa. |
-
- void |
-setContent(java.lang.Object content,
- java.lang.String contentType)
-
-- Sets the content of this message to the specified Object. |
-
- void |
-setContentLanguage(java.util.Locale locale)
-
-- Sets the locale of this message, setting the headers (Content-Language - and the Content-Type's charset) as appropriate. |
-
- void |
-setContentLength(int len)
-
-- Sets the value of the Content-Length header. |
-
- void |
-setContentType(java.lang.String type)
-
-- Sets the content type of the response being sent to the client. |
-
- void |
-setExpires(int seconds)
-
-- Sets the value of the Expires header in this message. |
-
- void |
-setHeader(java.lang.String name,
- java.lang.String value)
-
-- Sets a header with the given name and value. |
-
- void |
-setHeaderForm(SipServletMessage.HeaderForm form)
-
-- Indicates which of the compact or long form should the headers in this - message have. |
-
- void |
-setParameterableHeader(java.lang.String name,
- Parameterable param)
-
-- Sets the header with the specified name to have the value - specified by the address argument. |
-
| -Method Detail | -
|---|
-Address getFrom()-
-
-Address getTo()-
-
-java.lang.String getMethod()-
-
SipServletMessage-java.lang.String getProtocol()-
For this version of the SIP Servlet API this is always "SIP/2.0". -
-
String containing the protocol name and
- version number-java.lang.String getHeader(java.lang.String name)-
String.
- If the message did not include a header of the specified name,
- this method returns null. If the message included a header of
- the specified name with no value, this method returns an empty
- String. If multiple headers exist, the first
- one is returned. The header name is case insensitive.
-
- Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - The list of assigned compact form is available in the IANA registry at http://www.iana.org/assignments/sip-parameters - -
For example, -
- getHeader("Content-Type");
- getHeader("c");
-
- will both return the same value.
--
name - a String specifying the header name, either
- the long or compact form
-String containing the value of the
- requested header, or null if the message does not have a
- header of that name
-java.lang.NullPointerException - if the name is null.-java.util.ListIterator<java.lang.String> getHeaders(java.lang.String name)-
Returns all the values of the specified header as a
- ListIterator over a number of String objects. The
- values returned by the Iterator follow the order in which they
- appear in the message header.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - The list of assigned compact form is available in the IANA registry at http://www.iana.org/assignments/sip-parameters - -
Some headers, such as Accept-Language can be sent - by clients as several headers each with a different value rather - than sending the header as a comma separated list. - -
If the message did not include any headers of the specified name,
- this method returns an empty Iterator. If the message included headers of
- the specified name with no values, this method returns an Iterator over empty
- Strings. The header name is case
- insensitive.
-
Note: This is a fail-fast iterator and can throw ConcurrentModificationException - if the underlying implementation does not allow modification after the - iterator is created. -
Attempts to modify the specified header field through the
- returned list iterator must fail with an
- IllegalArgumentException if the header field is a
- system header.
-
-
name - a String specifying the header name, either
- the long or compact form
-ListIterator over the String
- values of the specified header field
-java.lang.NullPointerException - if the name is null.-java.util.Iterator<java.lang.String> getHeaderNames()-
Iterator over all the header names this
- message contains. If the message has no headers, this method
- returns an empty Iterator.
- Note: This is a fail-fast iterator and can throw ConcurrentModificationException - if the underlying implementation does not allow modification after the - iterator is created. -
Some servlet containers do not allow servlets to access headers - using this method, in which case this method returns null. -
-
Iterator over the names of all header fields
- present within this message; if the message has no header fields,
- an empty enumeration; if the servlet container does not
- allow servlets to use this method, null-void setHeader(java.lang.String name, - java.lang.String value)-
Either the long or compact name can be used to access the header
- field, as both are treated as equivalent. The applications choice of
- long or compact form shall take effect only of the HeaderForm
- parameter is set to SipServletMessage.HeaderForm.DEFAULT.
-
-
Note: applications should never attempt to set the - From, To, Call-ID, CSeq, Via, Record-Route, and Route headers. - Also, setting of the Contact header is subject to the constraints - mentioned in the introduction. -
-
name - a String specifying the header name, either
- the long or compact formvalue - the header value
-java.lang.IllegalArgumentException - if the specified header field
- is a system header
-java.lang.NullPointerException - if the name or value is null-void addHeader(java.lang.String name, - java.lang.String value)-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - The list of assigned compact form is available in the IANA registry at http://www.iana.org/assignments/sip-parameters - -
Note: applications should never attempt to set the - From, To, Call-ID, CSeq, Via, Record-Route, and Route headers. - Also, setting of the Contact header is subject to the constraints - mentioned in the introduction. -
-
name - a String specifying the header name, either
- the long or compact formvalue - the additional header value
-java.lang.IllegalArgumentException - if the specified header field
- is a system header or if it cannot
- legally appear in this message-void removeHeader(java.lang.String name)-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. -
-
name - a String specifying the header name, either
- the long or compact form
-java.lang.IllegalArgumentException - if the specified header field
- is a system header-Address getAddressHeader(java.lang.String name) - throws ServletParseException-
Address object.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
- (name-addr | addr-spec) *(SEMI generic-param)
- as defined in RFC 3261. This includes, for example, Contact and Route.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - -
If there is more than one header field value the first is returned. -
-
name - a case insensitive String specifying
- the name of the header, either the long or compact form
-Address
-ServletParseException - if the specified header field
- cannot be parsed as a SIP address object
-java.lang.NullPointerException - if the name is null.-java.util.ListIterator<Address> getAddressHeaders(java.lang.String name) - throws ServletParseException-
ListIterator over all Address
- header field values for the specified header. The values returned
- by the Iterator follow the order in which they appear in the message
- header.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
- (name-addr | addr-spec) *(SEMI generic-param)
- as defined in RFC 3261. This includes, for example, Contact and Route.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - -
If the message did not include any headers of the specified name,
- this method returns an empty Iterator. If the message included headers of
- the specified name with no values, this method returns an Iterator over empty
- Strings.
-
-
Attempts to modify the specified header field through the
- returned list iterator must fail with an
- IllegalArgumentException if the header field is a
- system header. For non-system headers the
- argument to the add and set methods
- of the iterator returned by getAddressHeaders must
- be Address objects.
-
Note: This is a fail-fast iterator and can throw ConcurrentModificationException - if the underlying implementation does not allow modification after the - iterator is created. -
-
name - a case insensitive String specifying
- the name of the header field, either the long or compact form
-ListIterator over the Address
- values of the specified header field
-ServletParseException - if the specified header field
- cannot be parsed as a SIP address object
-java.lang.NullPointerException - if the name is null.-void setAddressHeader(java.lang.String name, - Address addr)-
This method can be used with headers which are defined to contain
- one or more entries matching
- (name-addr | addr-spec) *(SEMI generic-param)
- as defined in RFC 3261. This includes, for example, Contact and Route.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. -
-
name - the long or compact name of the header to setaddr - the assigned address value
-java.lang.IllegalArgumentException - if the specified header isn't
- defined to hold address values or if the specified header field
- is a system header-void addAddressHeader(java.lang.String name, - Address addr, - boolean first)-
Address as a new value of the
- named header field. The address is added as the last
- header field value.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
- (name-addr | addr-spec) *(SEMI generic-param)
- as defined in RFC 3261. This includes, for example, Contact and Route.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. -
-
name - the long or compact name of the header to setaddr - the additional address valuefirst - if true, the address is added as the first value of
- the specified header field, otherwise it will be the last
-java.lang.IllegalArgumentException - if the specified header isn't
- defined to hold address values or if the specified header field
- is a system header-Parameterable getParameterableHeader(java.lang.String name) - throws ServletParseException-
Parameterable object.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
- field-value *(;parameter-name=parameter-value)
- as defined in RFC 3261. This includes, for example, Event and Via.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - -
If there is more than one header field value the first is returned. -
-
name - a case insensitive String specifying
- the name of the header, either the long or compact form
-Parameterable
-ServletParseException - if the specified header field cannot be
- parsed as a SIP parameterable object
-java.lang.NullPointerException - if the name is null.-java.util.ListIterator<? extends Parameterable> getParameterableHeaders(java.lang.String name) - throws ServletParseException-
ListIterator over all Parameterable
- header field values for the specified header name. The values returned
- by the Iterator follow the order in which they appear in the message
- header.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
- field-value *(;parameter-name=parameter-value)
- as defined in RFC 3261. This includes, for example, Event and Via.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. - -
If the message did not include any headers of the specified name,
- this method returns an empty Iterator. If the message included headers of
- the specified name with no values, this method returns an Iterator over empty
- Strings.
-
-
Attempts to modify the specified header field through the
- returned list iterator must fail with an
- IllegalArgumentException if the header field is a
- system header.
-
Note: This is a fail-fast iterator and can throw ConcurrentModificationException - if the underlying implementation does not allow modification after the - iterator is created. -
-
name - a case insensitive String specifying
- the name of the header field, either the long or compact form
-ListIterator over the Parameterable
- values of the specified header field
-ServletParseException - if the specified header field cannot be
- parsed as a SIP parameterable object
-java.lang.NullPointerException - if the name is null.-void setParameterableHeader(java.lang.String name, - Parameterable param)-
This method can be used with headers which are defined to contain
- one or more entries matching
- field-value *(;parameter-name=parameter-value)
- as defined in RFC 3261. This includes, for example, Event and Via.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. -
-
name - the long or compact name of the header to setparam - the assigned Parameterable value
-java.lang.IllegalArgumentException - if the specified header isn't
- defined to hold Parameterable values or if the specified header field
- is a system header-void addParameterableHeader(java.lang.String name, - Parameterable param, - boolean first)-
Parameterable as a new value of the
- named header field. The parameterable is added as the last
- header field value.
-
- This method can be used with headers which are defined to contain
- one or more entries matching
-
- field-value *(;parameter-name=parameter-value)
-
- as defined in RFC 3261. This includes, for example, Event and Via.
-
-
Either the long or compact name can be used to access the header - field, as both are treated as equivalent. -
-
name - the long or compact name of the header to setparam - the additional parameterable valuefirst - if true, the parameterable is added as the first value of
- the specified header field, otherwise it will be the last
-java.lang.IllegalArgumentException - if the specified header isn't
- defined to hold Parameterable values or if the specified header field
- is a system header-java.lang.String getCallId()-
SipServletMessage.
--
SipServletMessage-int getExpires()-
-
-void setExpires(int seconds)-
- setHeader("Expires", String.valueOf(seconds));
-
--
seconds - the value of the Expires header measured in seconds-java.lang.String getCharacterEncoding()-
Returns the name of the charset used for the MIME body sent in - this message. This method returns null if the message does not - specify a character encoding. - -
The message character encoding is used when converting
- between bytes and characters. If the character encoding hasn't
- been set explicitly UTF-8 will be used for this
- purpose.
-
-
For more information about character encodings and MIME see - RFC 2045 (http://www.ietf.org/rfc/rfc2045.txt). -
-
String specifying the name of the charset,
- for example, UTF-8-void setCharacterEncoding(java.lang.String enc) - throws java.io.UnsupportedEncodingException-
Explicitly setting a message's character encoding potentially
- affects the behavior of subsequent calls to getContent()
- and setContent(java.lang.Object, java.lang.String).
- This method must be called prior to calling either of those methods.
-
-
enc - name of the chararacter encoding
-java.io.UnsupportedEncodingException - if this is not a valid encoding-int getContentLength()-
-
-java.lang.String getContentType()-
-
String containing the name of the
- MIME type of this message, or null if the body is empty-byte[] getRawContent() - throws java.io.IOException-
-
java.io.IOException - if an IOException occurred-java.lang.Object getContent() - throws java.io.IOException, - java.io.UnsupportedEncodingException-
String object for MIME type text/plain
- as for other text/* MIME types for which the
- container doesn't have specific knowledge.
-
- It is encouraged that the object returned for "multipart" MIME
- content is a javax.mail.Multipart object. A byte array
- is returned for content-types that are unknown to the container.
-
-
The message's character encoding is used when the MIME type - indicates that the content consists of character data. - -
Note: This method, together with setContent,
- is modelled over similar methods
- in the JavaMail API. Whereas the JavaMail API mandates the use of
- the Java Activation Framework (JAF) as the underlying data handling
- system, the SIP servlet API doesn't currently require JAF.
-
-
byte[] object containing the raw content
- if the MIME type isn't known to the platform
-java.io.IOException - if an IOException occurred
-java.io.UnsupportedEncodingException - if the content is textual in
- character but this message's character encoding is not
- supported by the platform-void setContent(java.lang.Object content, - java.lang.String contentType) - throws java.io.UnsupportedEncodingException-
Object.
-
- This method only works if the implementation "knows about" the
- specified object and MIME type. Containers are required to handle
- byte[] content with any MIME type.
-
-
Furthermore, containers are required to handle String
- content
- when used with a text/* content type. When invoked
- with non-String objects and a text/* content type,
- containers may invoke toString() on the content
- Object in order to obtain the body's character data.
- It is also recommended that implementations know how to handle
- javax.mail.Multipart content when used together with
- "multipart" MIME types.
-
-
When converting String content, this method may
- use the the message's character encoding
- (as set by setCharacterEncoding(java.lang.String), setContentType(java.lang.String)
- or setContentLanguage(java.util.Locale)) to map the String to
- a byte array.
-
-
Note: This method, together with
- getContent(), is modelled over a similar method
- in the JavaMail API. Whereas the JavaMail API mandates the use of
- the Java Activation Framework (JAF) as the underlying data handling
- system, the SIP servlet API doesn't currently require JAF.
-
-
content - an object representing the message contentcontentType - MIME type of the object
-java.io.UnsupportedEncodingException - if the content is textual in
- nature and this message's character encoding is unsupported by
- the server
-java.lang.IllegalArgumentException - if the platform doesn't know how to
- serrialize content of the specified MIME type
-java.lang.IllegalStateException - if the message has already been sent
- or if it's read-only-void setContentLength(int len)-
Applications are discouraged from setting the Content-Length
- directly using this method; they should instead use the
- setContent methods which guarantees that the
- Content-Length is computed and set correctly.
-
-
len - an integer specifying the length of the content being
- sent to the peer; sets the Content-Length header
-java.lang.IllegalStateException - if this is an incoming message or if
- it has already been sent-void setContentType(java.lang.String type)-
text/html; charset=UTF-8. This will
- cause the message's current character encoding to be set.
-
- If obtaining a PrintWriter or calling
- setContent, this method should be
- called first.
-
-
type - a String specifying the MIME type of
- the content-java.lang.Object getAttribute(java.lang.String name)-
Attributes can be set two ways. The servlet container may set
- attributes to make available custom information about a request
- or a response. For example, for requests made using HTTPS, the
- attribute javax.servlet.request.X509Certificate can
- be used to retrieve information on the certificate of the client.
- Attributes can also be set programatically using
- setAttribute(String, Object). This allows information to
- be embedded into a request or response before a
- RequestDispatcher call.
-
-
Attribute names should follow the same conventions as package
- names. Names beginning with javax.servlet.sip. are
- reserved for definition by the SIP Servlet API.
-
-
name - a String specifying the name of the attribute
-Object containing the value of the attribute,
- or null if the attribute does not exist
-java.lang.NullPointerException - if the name is null.-java.util.Enumeration<java.lang.String> getAttributeNames()-
Enumeration containing the names of the
- attributes available to this message object. This method returns
- an empty Enumeration if the message has no attributes
- available to it.
--
Enumeration of strings containing the names
- of the message's attributes-void setAttribute(java.lang.String name, - java.lang.Object o)-
RequestDispatcher.
-
- Attribute names should follow the same conventions as package - names. Names beginning with javax.servlet.sip.* are reserved for - definition by the SIP Servlet API. -
-
name - a String specifying the name of the attributeo - the Object to be stored
-java.lang.NullPointerException - if either of name or o is null.-void removeAttribute(java.lang.String name)-
Attribute names should follow the same conventions as package - names. Names beginning with javax.servlet.sip.* are reserved for - definition by the SIP Servlet API. -
-
name - a String specifying the name of the attribute
-java.lang.NullPointerException - if name is null.-SipSession getSession()-
SipSession to which this message belongs.
- If the session didn't already exist it is created. This method is
- equivalent to calling getSession(true).
--
SipSession to which this
- SipServletMessage belongs-SipSession getSession(boolean create)-
SipSession to which this message belongs.
--
create - indicates whether the session is created if it doesn't
- already exist
-SipSession to which this
- SipServletMessage belongs, or null if one hasn't
- been created and create is false-SipApplicationSession getApplicationSession()-
-
SipServletMessage belongs-SipApplicationSession getApplicationSession(boolean create)-
-
create - if true the session is created if it didn't
- already exist, otherwise null is returned-java.util.Locale getAcceptLanguage()-
Locale that the UA originating
- this message will accept content in, based on the Accept-Language
- header. If this message doesn't contain an Accept-Language header,
- this method returns null. Note that this behavior is different from
- v1.0 where the default locale for the server would have been returned.
--
Locale for the sending user agent-java.util.Iterator<java.util.Locale> getAcceptLanguages()-
Iterator over Locale objects
- indicating, in decreasing order starting with the preferred locale,
- the locales that are acceptable to the sending UA based on the
- Accept-Language header. If this message doesn't provide an
- Accept-Language header, this method returns an empty
- Iterator. Note that this behavior is different from
- v1.0 where an Iterator containing the default locale for
- the server would have been returned.
--
Iterator over preferred locales for the
- UA originating this message-void setAcceptLanguage(java.util.Locale locale)-
Locale that this user agent will
- accept content, reason phrases, warnings, etc. in. The language
- identified by the Locale will be listed in an
- Accept-Language header.
-
- A null argument is valid and removes and existing Accept-Language - headers. -
-
locale - the preferred locale of this user agent-void addAcceptLanguage(java.util.Locale locale)-
Locale of this user agent. The
- language identified by the Locale will be listed in
- an Accept-Language header with a lower q-value than any existing
- Accept-Language value, meaning the locale is less preferred than
- those already identified in this message.
--
locale - a locale acceptable to this user agent-void setContentLanguage(java.util.Locale locale)-
setContent.
--
locale - the locale of this message-java.util.Locale getContentLanguage()-
Locale identified by the Content-Language header
- of the message, or null if the Content-Language header is not present.
--
Locale of this message, or null if none.-void send() - throws java.io.IOException-
SipServletMessage.
--
java.io.IOException - if a transport error occurs when trying to
- send this message
-java.lang.IllegalStateException - if this message cannot legally be sent
- in the current state of the underlying SIP transaction-boolean isSecure()-
-
-boolean isCommitted()-
-
-java.lang.String getRemoteUser()-
-
String specifying the login of the user
- sending this message, or null if the user has not been
- authenticated-boolean isUserInRole(java.lang.String role)-
-
role - a String specifying the name of the role
--java.security.Principal getUserPrincipal()-
java.security.Principal object containing
- the name of the authenticated user agent sending this message.
- If the user agent has not been authenticated, the method returns null.
--
java.security.Principal representing the
- sending user, or null if the user has not been authenticated-java.lang.String getLocalAddr()-
-
-int getLocalPort()-
-
-java.lang.String getRemoteAddr()-
-
String containing the IP address of the
- sender of this message, or null if it was locally generated-int getRemotePort()-
-
-java.lang.String getTransport()-
-
-java.lang.String getInitialRemoteAddr()-
getRemoteAddr(), this method
- returns the same value regardless of which application invokes it
- in the same application composition chain of a specific application router.
--
String containing the IP address of the
- sender of this message, or null if it was locally generated-int getInitialRemotePort()-
getRemotePort(), this method
- returns the same value regardless of which application invokes it
- in the same application composition chain of a specific application router.
--
-java.lang.String getInitialTransport()-
-
-void setHeaderForm(SipServletMessage.HeaderForm form)-
setUseCompactForm method or set it to use SipServletMessage.HeaderForm.DEFAULT
- and instead set the non-system
- headers directly using the compact or long form setHeader(String, String).
- eg.
-
- SipServletMessage message;
- .....
- message.setHeader("s", "Meeting at 5pm"); // Subject header compact form
- message.setHeader("Allow-Events", "telephone-event"); // Long form
- .....
-
- For applications to set each header individually the value of the
- HeaderForm MUST be SipServletMessage.HeaderForm.DEFAULT
- The list of assigned compact form is available in the IANA registry at
- http://www.iana.org/assignments/sip-parameters
--
form - form desired by the application-SipServletMessage.HeaderForm getHeaderForm()-
SipServletMessage.HeaderForm.DEFAULT
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipServletRequest
-Represents SIP request messages. When receiving an incoming SIP request
- the container creates a SipServletRequest and passes it to
- the handling servlet. For outgoing, locally initiated requests,
- applications call SipFactory.createRequest
- to obtain a SipServletRequest that can then be modified and
- sent.
-
- -
-
| -Nested Class Summary | -
|---|
| Nested classes/interfaces inherited from interface javax.servlet.sip.SipServletMessage | -
|---|
SipServletMessage.HeaderForm |
-
| -Method Summary | -|
|---|---|
- void |
-addAuthHeader(SipServletResponse challengeResponse,
- AuthInfo authInfo)
-
-- This method allows the addition of the appropriate authentication header(s) - to the request that was challenged with a challenge response. |
-
- void |
-addAuthHeader(SipServletResponse challengeResponse,
- java.lang.String username,
- java.lang.String password)
-
-- 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 AuthInfo object. |
-
- SipServletRequest |
-createCancel()
-
-- Returns a CANCEL request object. |
-
- SipServletResponse |
-createResponse(int statuscode)
-
-- Creates a response for this request with the specifies status code. |
-
- SipServletResponse |
-createResponse(int statusCode,
- java.lang.String reasonPhrase)
-
-- Creates a response for this request with the specifies status code - and reason phrase. |
-
- B2buaHelper |
-getB2buaHelper()
-
-- Returns the B2buaHelper associated with this request. |
-
- Address |
-getInitialPoppedRoute()
-
-- 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. |
-
- javax.servlet.ServletInputStream |
-getInputStream()
-
-- Always returns null. |
-
- int |
-getMaxForwards()
-
-- Returns the value of the Max-Forwards header. |
-
- Address |
-getPoppedRoute()
-
-- If a top route header had been removed by the container upon receiving - this request, then this method can be used to retrieve it. |
-
- Proxy |
-getProxy()
-
-- Returns the Proxy object associated with this request. |
-
- Proxy |
-getProxy(boolean create)
-
-- Returns the Proxy object associated with this request. |
-
- java.io.BufferedReader |
-getReader()
-
-- Always returns null. |
-
- SipApplicationRoutingRegion |
-getRegion()
-
-- This method allows the application to obtain the region it was - invoked in for this SipServletRequest. |
-
- URI |
-getRequestURI()
-
-- Returns the request URI of this request. |
-
- SipApplicationRoutingDirective |
-getRoutingDirective()
-
-- Returns the SipApplicationRoutingDirective associated with
- this request. |
-
- URI |
-getSubscriberURI()
-
-- Returns the URI of the subscriber for which this application - is invoked to serve. |
-
- boolean |
-isInitial()
-
-- Returns true if this is an initial request. |
-
- void |
-pushPath(Address uri)
-
-- Adds a Path header field value to this request. |
-
- void |
-pushRoute(Address uri)
-
-- Adds a Route header field value to this request with Address argument. |
-
- void |
-pushRoute(SipURI uri)
-
-- Adds a Route header field value to this request. |
-
- void |
-send()
-
-- Causes this request to be sent. |
-
- void |
-setMaxForwards(int n)
-
-- Sets the value of the Max-Forwards header. |
-
- void |
-setRequestURI(URI uri)
-
-- Sets the request URI of this request. |
-
- void |
-setRoutingDirective(SipApplicationRoutingDirective directive,
- SipServletRequest origRequest)
-
-- Sets the application routing directive for an outgoing request. |
-
| Methods inherited from interface javax.servlet.ServletRequest | -
|---|
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 |
-
| -Method Detail | -
|---|
-URI getRequestURI()-
-
SipServletRequest-void setRequestURI(URI uri)-
send.
--
uri - new request URI of this SipServletRequest
-java.lang.NullPointerException - on null uri-void pushRoute(SipURI uri)-
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. -
-
uri - the address that is added as a Route header valuepushRoute(Address)-void pushRoute(Address uri)-
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. -
-
uri - the address that is added as a Route header valuepushRoute(SipURI)-int getMaxForwards()-
-
-void setMaxForwards(int n)-
This method is equivalent to: -
- setHeader("Max-Forwards", String.valueOf(n));
-
--
n - new value of the Max-Forwards header
-java.lang.IllegalArgumentException - if the argument is not in the range
- 0 to 255-void send() - throws java.io.IOException-
Proxy.proxyTo(javax.servlet.sip.URI) instead.
--
send in interface SipServletMessagejava.io.IOException - if a transport error occurs when trying to
- send this request-boolean isInitial()-
-
-javax.servlet.ServletInputStream getInputStream() - throws java.io.IOException-
Message content can be retrieved using SipServletMessage.getContent()
- and SipServletMessage.getRawContent().
-
-
getInputStream in interface javax.servlet.ServletRequestjava.io.IOException-java.io.BufferedReader getReader() - throws java.io.IOException-
Message content can be retrieved using SipServletMessage.getContent()
- and SipServletMessage.getRawContent().
-
-
getReader in interface javax.servlet.ServletRequestjava.io.IOException-Proxy getProxy() - throws TooManyHopsException-
Proxy object associated with this request.
- A Proxy instance will be created if one doesn't already
- exist. This method behaves the same as getProxy(true).
-
- Note that the container must return the same
- Proxy instance whenever a servlet invokes
- getProxy on messages belonging to the same transaction.
- In particular, a response to a proxied request is associated with
- the same Proxy object as is the original request.
-
-
This method throws an IllegalStateException if the
- Proxy 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 SipServletRequest for which a
- final response has already been generated.
-
-
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 TooManyHopsException.
-
-
Proxy object associated with this request
-TooManyHopsException - if the request has a Max-Forwards
- header field value of 0.
-java.lang.IllegalStateException - if the transaction underlying this
- message isn't already associated with a Proxy
- 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
- getB2buaHelper().getProxy(boolean)-Proxy getProxy(boolean create) - throws TooManyHopsException-
Proxy object associated with this request.
- If no Proxy object has yet been created for this request,
- the create argument specifies whether a Proxy
- object is to be created or not.
-
- Once a Proxy object has been associated with a request
- subsequent invocations of this method will yield the same
- Proxy object, as will the no-argument
- getProxy() method and SipServletResponse.getProxy()
- for responses received to proxied requests.
-
-
create - indicates whether the servlet engine should create
- a new Proxy object if one does not already exist
-Proxy object associated with this request
-TooManyHopsException - if this request has a Max-Forwards
- header field value of 0.
-java.lang.IllegalStateException - if the transaction has already completed-SipServletResponse createResponse(int statuscode)-
-
statuscode - status code for the response
-java.lang.IllegalArgumentException - if the statuscode is not a valid
- SIP status code
-java.lang.IllegalStateException - if this request has already been
- responded to with a final status code-SipServletResponse createResponse(int statusCode, - java.lang.String reasonPhrase)-
-
statusCode - status code for the responsereasonPhrase - reason phrase to appear in response line
-java.lang.IllegalArgumentException - if the statuscode is not a valid
- SIP status code
-java.lang.IllegalStateException - if this request has already been
- responded to with a final status code-SipServletRequest createCancel()-
send() on
- it.
-
- Note that proxy applications MUST use Proxy.cancel()
- to cancel outstanding branches.
-
-
java.lang.IllegalStateException - if the transaction state is such that
- it doesn't allow a CANCEL request to be sent-void pushPath(Address uri)-
-
uri - The address that is added as a Route header value
-java.lang.IllegalStateException - if invoked on non-REGISTER Request.-B2buaHelper getB2buaHelper()-
getProxy() will
- result in IllegalStateException.
--
java.lang.IllegalStateException - if getProxy() had already been called-Address getPoppedRoute()-
Note that the URI parameters added to the Record-Route header using
- Proxy.getRecordRouteURI() should be retrieved from the URI of
- the popped route Address using
- poppedRoute.getURI().getParameter() and not using
- poppedRoute.getParameter().
-
-Address getInitialPoppedRoute()-
getPoppedRoute(), this method returns the same
- value regardless of which application invokes it in the same application
- composition chain.
-
- Note that the URI parameters added to the Record-Route header using
- Proxy.getRecordRouteURI() should be retrieved from the URI of
- the popped route Address using
- initialPoppedRoute.getURI().getParameter() and not using
- initialPoppedRoute.getParameter().
-
-void setRoutingDirective(SipApplicationRoutingDirective directive, - SipServletRequest origRequest) - throws java.lang.IllegalStateException-
- 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. -
- This method allows the servlet to assign a routing directive - different from the default. -
- 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. -
- Note that when a servlet acts as a proxy and calls - Proxy.proxyTo() to proxy a request, the request is always - a continuation. -
-
-
directive - Routing directiveorigRequest - An initial request that the application received
-java.lang.IllegalStateException - when given directive cannot be set-SipApplicationRoutingDirective getRoutingDirective() - throws java.lang.IllegalStateException-
SipApplicationRoutingDirective associated with
- this request.
--
SipApplicationRoutingDirective associated with this
- request.
-java.lang.IllegalStateException - if called on a request that is not initial-SipApplicationRoutingRegion getRegion()-
SipServletRequest.getSubscriberURI().
-
-
- If this SipServletRequest is an initial request, this method returns the
- region in which this servlet is invoked. The SipApplicationRoutingRegion
- is only available for initial requests. For all other requests, this
- method throws IllegalStateException.
-
-
java.lang.IllegalStateException - if this method is called on a request that is not initial.-URI getSubscriberURI()-
-
java.lang.IllegalStateException - if this method is called on a request that is not initial.-void addAuthHeader(SipServletResponse challengeResponse, - AuthInfo authInfo)-
-
challengeResponse - The challenge response (401/407) receieved from a
- UAS/Proxy.authInfo - The AuthInfo object that will add the
- Authentication headers to the request.-void addAuthHeader(SipServletResponse challengeResponse, - java.lang.String username, - java.lang.String password)-
AuthInfo object.
--
challengeResponse - the challenge response (401/407) receieved from a
- UAS/Proxy.username - password -
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipServletResponse
-Represents SIP responses. Instances of this class are passed to servlets
- when the container receives incoming SIP responses and also, servlets
- acting as UA servers or proxies generates SIP responses of their own by
- creating SipServletResponses.
-
-
SIP responses has a three-digit status code that indicates - the outcome of the corresponding request. Responses with a status code - in the range of 100-199 (1xx's) are called provisional or - informational and indicate progress in processing of the request. - Any response with a status code of 200 or higher is a final - response. A UA server may send only one final response per request - but this may be preceeded by any number of provisional responses. - -
2xx responses indicate a successful outcome while 3xx-6xx indicate a - variety of non-success conditions. - -
The summary of status codes is [RFC 3261]: -
setCharacterEncoding()
- does NOT throw the java.io.UnsupportedEncodingException as derived from SipServletMessage.setCharacterEncoding(String)
- but inherits a more generic setCharacterEncoding() method from the javax.servlet.ServletResponse.
-- -
-
| -Nested Class Summary | -
|---|
| Nested classes/interfaces inherited from interface javax.servlet.sip.SipServletMessage | -
|---|
SipServletMessage.HeaderForm |
-
| -Field Summary | -|
|---|---|
-static int |
-SC_ACCEPTED
-
-- Status code (202) indicating that the request has been accepted for - processing, but the processing has not been completed. |
-
-static int |
-SC_ADDRESS_INCOMPLETE
-
-- Status code (484) indicating that the server received a request - with a To (Section 6.37) address or Request-URI that was - incomplete. |
-
-static int |
-SC_ALTERNATIVE_SERVICE
-
-- Status code (380) indicating alternative service. |
-
-static int |
-SC_AMBIGUOUS
-
-- Status code (485) indicating that the callee address provided - in the request was ambiguous. |
-
-static int |
-SC_BAD_EVENT
-
-- Status code (489) indicating that the server did - not understand the event package specified in a "Event" header field. |
-
-static int |
-SC_BAD_EXTENSION
-
-- Status code (420) indicating that the server did not understand - the protocol extension specified in a Require (Section 6.30) - header field. |
-
-static int |
-SC_BAD_GATEWAY
-
-- Status code (502) indicating that the server, while acting as - a gateway or proxy, received an invalid response from the - downstream server it accessed in attempting to fulfill the - request. |
-
-static int |
-SC_BAD_IDENTITY_INFO
-
-- Status code (436) indicating that the Identity-Info header - contains a URI that cannot be dereferenced by the verifier - (either the URI scheme is unsupported by the verifier, or - the resource designated by the URI is otherwise unavailable). |
-
-static int |
-SC_BAD_REQUEST
-
-- Status code (400) indicating Bad Request. |
-
-static int |
-SC_BUSY_EVERYWHERE
-
-- Status code (600) indicating that the callee's end system was - contacted successfully but the callee is busy and does not - wish to take the call at this time. |
-
-static int |
-SC_BUSY_HERE
-
-- Status code (486) indicating that the callee's end system was - contacted successfully but the callee is curently not willing - or able to take additional call. |
-
-static int |
-SC_CALL_BEING_FORWARDED
-
-- Status code (181) indicating the call is being forwarded. |
-
-static int |
-SC_CALL_LEG_DONE
-
-- Status code (481) indicating Call Leg/Transaction does not exist. |
-
-static int |
-SC_CALL_QUEUED
-
-- Status code (182) indicating the call is queued. |
-
-static int |
-SC_CONDITIONAL_REQUEST_FAILED
-
-- Status code (412) indicating that the precondition given for the - request has failed. |
-
-static int |
-SC_DECLINE
-
-- Status code (603) indicating that the callee's machine was - successfully contacted but the user explicily does not wish - to or cannot participate. |
-
-static int |
-SC_DOES_NOT_EXIT_ANYWHERE
-
-- Status code (604) indicating that the server has authoritative - information that the user indicated in the To request field - does not exist anywhere. |
-
-static int |
-SC_EXTENSION_REQUIRED
-
-- Status code (421) indicating that the UAS needs a particular - extension to process the request, but this extension is not - listed in a Supported header field in the request. |
-
-static int |
-SC_FORBIDDEN
-
-- Status code (403) indicating that the caller is forbidden to make - such requests. |
-
-static int |
-SC_GONE
-
-- Status code (410) indicating that the requested resource is no - longer available at the server an no forwarding address is known. |
-
-static int |
-SC_INTERVAL_TOO_BRIEF
-
-- Status code (423) indicating that the server is rejecting the - request because the expiration time of the resource refreshed - by the request is too short. |
-
-static int |
-SC_INVALID_IDENTITY_HEADER
-
-- Status code (438) indicating that the verifier receives a - message with an Identity signature that does not correspond - to the digest-string calculated by the verifier. |
-
-static int |
-SC_LOOP_DETECTED
-
-- Status code (482) indicating that the server received a request - with a Via (Section 6.40) path containing itself. |
-
-static int |
-SC_MESSAGE_TOO_LARGE
-
-- Status code (513) indicating that the server was unable to process - the request since the message length exceeded its capabilities. |
-
-static int |
-SC_METHOD_NOT_ALLOWED
-
-- Status code (405) indicating that the method specified in the - Request-Line is not allowed for the address identified byt the - Request-URI. |
-
-static int |
-SC_MOVED_PERMANENTLY
-
-- Status code (301) indicating that the callee has moved permanantly. |
-
-static int |
-SC_MOVED_TEMPORARILY
-
-- Status code (302) indicating that the callee has moved temporarily. |
-
-static int |
-SC_MULTIPLE_CHOICES
-
-- Status code (300) indicating Multiple Choices. |
-
-static int |
-SC_NOT_ACCEPTABLE
-
-- Status code (406) indicating the the resource identified by the - request is only capable of generating response entities which - have content characteristics not acceptable according to the - accept headers sent in the request. |
-
-static int |
-SC_NOT_ACCEPTABLE_ANYWHERE
-
-- Status code (606) indicating that the user's agent was contacted - successfully but some aspects of the session description such as - the requested media, bandwidth, or addressing style were not - acceptable. |
-
-static int |
-SC_NOT_ACCEPTABLE_HERE
-
-- Status code (488) indicating that the response has the same - meaning as 606 (Not Acceptable), but only applies to the - specific resource addressed by the Request-URI and the request - may succeed elsewhere. |
-
-static int |
-SC_NOT_FOUND
-
-- Status code (404) indicating that the server had definitive - information that the user does not exist at the domain - specified in the Request-URI. |
-
-static int |
-SC_NOT_IMPLEMENTED
-
-- Status code (501) indicating that the server does not support - the functionality required to fulfill the request. |
-
-static int |
-SC_OK
-
-- Status code (200) indicating the request succeeded normally. |
-
-static int |
-SC_PAYMENT_REQUIRED
-
-- Status code (402) indicating that the caller needs to make a payment. |
-
-static int |
-SC_PRECONDITION_FAILURE
-
-- Status code (580) indicating failure to meet certain preconditions. |
-
-static int |
-SC_PROVIDE_REFERER_IDENTITY
-
-- Status code (429) indicating that the referee must provide a - valid Referred-By token. |
-
-static int |
-SC_PROXY_AUTHENTICATION_REQUIRED
-
-- Status code (407) indicating that the client MUST first - authenticate itself with the proxy. |
-
-static int |
-SC_REQUEST_ENTITY_TOO_LARGE
-
-- Status code (413) indicating that the server si refusing to process - a request becaus the request entity is larger than the server is - willing or able to process. |
-
-static int |
-SC_REQUEST_PENDING
-
-- Status code (491) indicating that the request was received by - a UAS that had a pending request within the same dialog. |
-
-static int |
-SC_REQUEST_TERMINATED
-
-- Status code (487) indicating that the request was terminated by - a BYE or CANCEL request. |
-
-static int |
-SC_REQUEST_TIMEOUT
-
-- Status code (408) indicating that the server could not produce - a response, e.g., a user location, within the time indicated in - the Expires request-header field. |
-
-static int |
-SC_REQUEST_URI_TOO_LONG
-
-- Status code (414) indicating that the server if refusing to - service the request because the Request-URI is longer than the - server is willing to interpret. |
-
-static int |
-SC_RINGING
-
-- Status code (180) indicating the server has located the callee, - and callee user agent is Ringing the callee. |
-
-static int |
-SC_SECURITY_AGREEMENT_REQUIRED
-
-- Status code (494) indicating that the client must initiate a - security mechanism as defined in RFC 3329. |
-
-static int |
-SC_SERVER_INTERNAL_ERROR
-
-- Status code (500) indicating that the server encountered an - unexpected condition that prevented it from fulfilling the - request. |
-
-static int |
-SC_SERVER_TIMEOUT
-
-- Status code (504) indicating that the server did not receive - a timely response from an external server it accessed in - attempting to process the request. |
-
-static int |
-SC_SERVICE_UNAVAILABLE
-
-- Status code (503) indicating that the server is currently - unable to handle the request due to a temporary overloading - or maintenance of the server. |
-
-static int |
-SC_SESSION_INTERVAL_TOO_SMALL
-
-- Status code (422) indicating that a request contained a - Session-Expires header field with a duration below the - minimum timer for the server. |
-
-static int |
-SC_SESSION_PROGRESS
-
-- Status code (183) carries miscellaneous call progress information. |
-
-static int |
-SC_TEMPORARLY_UNAVAILABLE
-
-- Status code (480) indicating that the callee's end system was - contacted successfully but the callee is currently unavailable - (e.g., not logged in or logged in such a manner as to preclude - communication with the callee). |
-
-static int |
-SC_TOO_MANY_HOPS
-
-- Status code (483) indicating that the server received a request - that contains more Via entries (hops) (Section 6.40) than allowed - by the Max-Forwards (Section 6.23) header field. |
-
-static int |
-SC_TRYING
-
-- Status code (100) indicating the server is trying - to locate the callee. |
-
-static int |
-SC_UNAUTHORIZED
-
-- Status code (401) indicating that the caller is unauthorized to - make this request. |
-
-static int |
-SC_UNDECIPHERABLE
-
-- Status code (493) indicating that the request was received by - a UAS that contained an encrypted MIME body for which the recipient - does not possess or will not provide an appropriate decryption key. |
-
-static int |
-SC_UNSUPPORTED_CERTIFICATE
-
-- Status code (437) indicating that the verifier cannot validate - the certificate referenced by the URI of the Identity-Info header, - because, for example, the certificate is self-signed, or signed - by a root certificate authority for whom the verifier does not - possess a root certificate. |
-
-static int |
-SC_UNSUPPORTED_MEDIA_TYPE
-
-- Status code (415) indicating that the server is refusing to - service the request because the message body of the request is - in a format not supported by the requested resource for the - requested method. |
-
-static int |
-SC_UNSUPPORTED_URI_SCHEME
-
-- Status code (416) indicating that the server cannot process the - request because the scheme of the URI in the Request-URI is unknown - to the server. |
-
-static int |
-SC_USE_IDENTITY_HEADER
-
-- Status code (428) indicating that the request should - be re-sent with an Identity header. |
-
-static int |
-SC_USE_PROXY
-
-- Status code (305) indicating that he call can be better - handled by the specified proxy server. |
-
-static int |
-SC_VERSION_NOT_SUPPORTED
-
-- Status code (505) indicating that the server does not support, - the SIP protocol version that was used in the request message. |
-
| -Method Summary | -|
|---|---|
- SipServletRequest |
-createAck()
-
-- Returns an ACK request object corresponding to this response. |
-
- SipServletRequest |
-createPrack()
-
-- Creates a PRACK request object corresponding to this response. |
-
- java.util.Iterator<java.lang.String> |
-getChallengeRealms()
-
-- Returns an Iterator over all the realms associated with this
- challenge response. |
-
- javax.servlet.ServletOutputStream |
-getOutputStream()
-
-- Always returns null. |
-
- Proxy |
-getProxy()
-
-- Returns the Proxy object associated with the
- transaction of this SIP response object. |
-
- ProxyBranch |
-getProxyBranch()
-
-- Retruns the ProxyBranch object associated with the transaction
- of this SIP response object. |
-
- java.lang.String |
-getReasonPhrase()
-
-- Returns the reason phrase for this response object. |
-
- SipServletRequest |
-getRequest()
-
-- Returns the request associated with this response. |
-
- int |
-getStatus()
-
-- Returns the status code of this response object. |
-
- java.io.PrintWriter |
-getWriter()
-
-- Always returns null. |
-
- boolean |
-isBranchResponse()
-
-- Returns true if this is an intermediate final response that arrived on a - ProxyBranch. |
-
- void |
-send()
-
-- Causes this response to be sent. |
-
- void |
-sendReliably()
-
-- Requests that this response be sent reliably using the 100rel - extension defined in RFC 3262. |
-
- void |
-setStatus(int statusCode)
-
-- Sets the status code of this response object. |
-
- void |
-setStatus(int statusCode,
- java.lang.String reasonPhrase)
-
-- Sets the status code and reason phrase of this response object. |
-
| Methods inherited from interface javax.servlet.ServletResponse | -
|---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
-
| -Field Detail | -
|---|
-static final int SC_TRYING-
-
-static final int SC_RINGING-
-
-static final int SC_CALL_BEING_FORWARDED-
-
-static final int SC_CALL_QUEUED-
-
-static final int SC_SESSION_PROGRESS-
-
-static final int SC_OK-
-
-static final int SC_ACCEPTED-
-
-static final int SC_MULTIPLE_CHOICES-
-
-static final int SC_MOVED_PERMANENTLY-
-
-static final int SC_MOVED_TEMPORARILY-
-
-static final int SC_USE_PROXY-
-
-static final int SC_ALTERNATIVE_SERVICE-
-
-static final int SC_BAD_REQUEST-
-
-static final int SC_UNAUTHORIZED-
-
-static final int SC_PAYMENT_REQUIRED-
-
-static final int SC_FORBIDDEN-
-
-static final int SC_NOT_FOUND-
-
-static final int SC_METHOD_NOT_ALLOWED-
-
-static final int SC_NOT_ACCEPTABLE-
-
-static final int SC_PROXY_AUTHENTICATION_REQUIRED-
This status code is used for applications where access to the - communication channel (e.g., a telephony gateway) rather than - the callee requires authentication. -
-
-static final int SC_REQUEST_TIMEOUT-
-
-static final int SC_GONE-
-
-static final int SC_CONDITIONAL_REQUEST_FAILED-
-
-static final int SC_REQUEST_ENTITY_TOO_LARGE-
If the condition is temporary, teh server SHOULD include a - Retry-After header field to indicate that it is temporary and after - what time the client MAY try again. -
-
-static final int SC_REQUEST_URI_TOO_LONG-
-
-static final int SC_UNSUPPORTED_MEDIA_TYPE-
-
-static final int SC_UNSUPPORTED_URI_SCHEME-
-
-static final int SC_BAD_EXTENSION-
-
-static final int SC_EXTENSION_REQUIRED-
-
-static final int SC_SESSION_INTERVAL_TOO_SMALL-
-
-static final int SC_INTERVAL_TOO_BRIEF-
-
-static final int SC_USE_IDENTITY_HEADER-
-
-static final int SC_PROVIDE_REFERER_IDENTITY-
-
-static final int SC_BAD_IDENTITY_INFO-
-
-static final int SC_UNSUPPORTED_CERTIFICATE-
-
-static final int SC_INVALID_IDENTITY_HEADER-
-
-static final int SC_TEMPORARLY_UNAVAILABLE-
This status is also returned by a redirect server that recognizes - the user identified by the Request-URI, but does not currently - have a valide forwarding location for that user. -
-
-static final int SC_CALL_LEG_DONE-
This status is returned under two conditions: The server received - a BYE request that does not match any existing call leg or the - server received a CANCEL request that does not match any existing - transaction. (A server simply discards an ACK referring to an - unknown transaction.) -
-
-static final int SC_LOOP_DETECTED-
-
-static final int SC_TOO_MANY_HOPS-
-
-static final int SC_ADDRESS_INCOMPLETE-
Note: This status code allows overlapped dialing. With overlapped - dialing, the client does not know the length of the dialing - string. It sends strings of increasing lengths, prompting the - user for more input, until it no longer receives a 484 status - response. -
-
-static final int SC_AMBIGUOUS-
Revealing alternatives can infringe on privacy concerns of the - user or the organization. It MUST be possible to configure a - server to respond with status 404 (Not Found) or to suppress - the listing of possible choices if the request with the URL - lee@example.com. - -
- 485 Ambiguous SIP/2.0 - Contact: Carol Lee <sip:carol.lee@example.com> - Contact: Ping Lee <sip:p.lee@example.com> - Contact: Lee M. Foote <sip:lee.foote@example.com> -- -
Some email and voice mail systems provide this functionality. A - status code separate from 3xx is used since the semantics are - different: for 300, it is assumed that the same person or sevice - will be reached by the choices provided. While an automated choice - or sequential search makes sense for a 3xx response, user - intervention is required for a 485 response. -
-
-static final int SC_BUSY_HERE-
-
-static final int SC_REQUEST_TERMINATED-
-
-static final int SC_NOT_ACCEPTABLE_HERE-
-
-static final int SC_BAD_EVENT-
-
-static final int SC_REQUEST_PENDING-
-
-static final int SC_UNDECIPHERABLE-
-
-static final int SC_SECURITY_AGREEMENT_REQUIRED-
-
-static final int SC_SERVER_INTERNAL_ERROR-
-
-static final int SC_NOT_IMPLEMENTED-
-
-static final int SC_BAD_GATEWAY-
-
-static final int SC_SERVICE_UNAVAILABLE-
-
-static final int SC_SERVER_TIMEOUT-
-
-static final int SC_VERSION_NOT_SUPPORTED-
-
-static final int SC_MESSAGE_TOO_LARGE-
-
-static final int SC_PRECONDITION_FAILURE-
-
-static final int SC_BUSY_EVERYWHERE-
-
-static final int SC_DECLINE-
-
-static final int SC_DOES_NOT_EXIT_ANYWHERE-
-
-static final int SC_NOT_ACCEPTABLE_ANYWHERE-
-
| -Method Detail | -
|---|
-SipServletRequest getRequest()-
Proxying applications can use the request URI obtained from the - request object to correlate an incoming response to one of the several - destinations it has been proxied to. -
-
-int getStatus()-
The Status-Code is a 3-digit integer result code that indicates - the outcome of the attempt to understand and satisfy the request. -
-
-void setStatus(int statusCode)-
-
statusCode - status code of this response-void setStatus(int statusCode, - java.lang.String reasonPhrase)-
-
statusCode - status code of this responsereasonPhrase - short textual description of the status code
-java.lang.IllegalArgumentException - if the code is not a SIP allowable status code.-java.lang.String getReasonPhrase()-
-
-javax.servlet.ServletOutputStream getOutputStream() - throws java.io.IOException-
Message content can be set using the SipServletMessage.setContent(java.lang.Object, java.lang.String)
- method.
-
-
getOutputStream in interface javax.servlet.ServletResponsejava.io.IOException-java.io.PrintWriter getWriter() - throws java.io.IOException-
Message content can be set using the SipServletMessage.setContent(java.lang.Object, java.lang.String)
- method.
-
-
getWriter in interface javax.servlet.ServletResponsejava.io.IOException-Proxy getProxy()-
Proxy object associated with the
- transaction of this SIP response object. Such a Proxy object exists
- if this is a response for a previously proxied request. Otherwise,
- a Proxy object does not exist, and null is returned.
-
- Note that the container must return the same
- Proxy instance whenever a servlet invokes
- getProxy on messages belonging to the same transaction.
- In particular, a response to a proxied request is associated with
- the same Proxy object as is the original request.
-
-
Proxy object associated with this response's
- transaction, or null if this response was not received for a
- previously proxied request-ProxyBranch getProxyBranch()-
ProxyBranch object associated with the transaction
- of this SIP response object. Such a ProxyBranch object exists if this is a
- response for a previously proxied request. Otherwise, a ProxyBranch
- object does not exist, and null is returned.
-
- Note that the container must return the same
- ProxyBranch instance whenever a servlet invokes
- getProxyBranch on messages belonging to the same transaction.
- In particular, a response to a proxied request is associated with
- the same ProxyBranch object as was the request sent on that
- branch.
-
-
ProxyBranch object associated with this response's
- transaction, or null if this response was not received for a previously
- proxied request.-void sendReliably() - throws Rel100Exception-
Applications can test whether the container supports the 100rel
- extension by checking if the string "100rel" exists in the list of
- supported extensions available via the ServletContext
- attribute "javax.servlet.sip.supported".
-
-
Applications can also test the same using the v1.0 mechanism by
- checking whether an attribute with name "javax.servlet.sip.100rel"
- exists in the ServletContext and has a value which
- equals Boolean.TRUE. However, the v1.0 mechanism is being deprecated in
- this version in favor of checking using the "javax.servlet.sip.supported"
- attribute.
-
-
Rel100Exception - if one of the conditions for using the
- 100rel extension is not satisfied.
-java.lang.IllegalStateException - if this response was received from
- downstream or if it has already been sent-void send() - throws java.io.IOException-
-
send in interface SipServletMessagejava.io.IOException - if a transport error occurs when trying to
- send this response
-java.lang.IllegalStateException - if this response was received from
- downstream or if it has already been sent-SipServletRequest createAck()-
Please note that applications do not generate ACKs for - non-2xx responses, as this is done by the container itself. -
-
java.lang.IllegalStateException - if the transaction state is such that
- it doesn't allow an ACK to be sent now, e.g. if the original
- request was not an INVITE, if this response is provisional only,
- or if an ACK has already been generated-SipServletRequest createPrack() - throws Rel100Exception-
-
java.lang.IllegalStateException - if the transaction state is such
- that it doesn't allow a PRACK to be sent now, e.g. if a PRACK has
- already been generated.
-Rel100Exception - if the response is not a reliable provisional
- response or if the original request was not an INVITE.-java.util.Iterator<java.lang.String> getChallengeRealms()-
Iterator over all the realms associated with this
- challenge response.
--
Iterator over all the realms associated with this
- challenge response.-boolean isBranchResponse()-
ProxyBranch.
-
- This method is used by SipServlet.doResponse()
- to delegate handling of any intermediate final responses received on the
- ProxyBranch to the SipServlet.doBranchResponse() method.
-
-
SipServlet.doResponse(javax.servlet.sip.SipServletResponse)
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public static enum SipSession.State
-Possible SIP dialog states from SipSession FSM. -
- -
-
| -Enum Constant Summary | -|
|---|---|
CONFIRMED
-
-- |
-|
EARLY
-
-- |
-|
INITIAL
-
-- |
-|
TERMINATED
-
-- |
-|
| -Method Summary | -|
|---|---|
-static SipSession.State |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipSession.State[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipSession.State INITIAL-
-public static final SipSession.State EARLY-
-public static final SipSession.State CONFIRMED-
-public static final SipSession.State TERMINATED-
| -Method Detail | -
|---|
-public static final SipSession.State[] values()-
-for(SipSession.State c : SipSession.State.values()) - System.out.println(c); --
-
-public static SipSession.State valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSession
-Represents point-to-point SIP relationships. It roughly corresponds
- to a SIP dialog. In particular, for UAs it maintains (or is otherwise
- associated with) dialog state so as to be able to create subequent
- requests belonging to that dialog (using createRequest).
-
-
For UACs, SipSession extend the notion of SIP dialogs
- to have well-defined state before a dialog has been established and
- after a final non-2xx terminates an early dialog. This allows UACs to
- create "subsequent" requests without having an established dialog. The
- effect is that the subsequent request will have the same Call-ID,
- From and To headers (with the same From tag and without a To tag),
- the will exist in the same CSeq space.
-
-
All messages are potentially associated with a SipSession.
- The SipSession can be retrieved from the message by calling
- SipServletMessage.getSession().
-
- -
-
| -Nested Class Summary | -|
|---|---|
-static class |
-SipSession.State
-
-- Possible SIP dialog states from SipSession FSM. |
-
| -Method Summary | -|
|---|---|
- SipServletRequest |
-createRequest(java.lang.String method)
-
-- Returns a new request object. |
-
- SipApplicationSession |
-getApplicationSession()
-
-- Returns the application session with which this SipSession
- is associated. |
-
- java.lang.Object |
-getAttribute(java.lang.String name)
-
-- Returns the object bound with the specified name in this session, - or null if no object is bound under the name. |
-
- java.util.Enumeration<java.lang.String> |
-getAttributeNames()
-
-- Returns an Enumeration over the String
- objects containing the names of all the objects bound to this session. |
-
- java.lang.String |
-getCallId()
-
-- Returns the Call-ID for this SipSession. |
-
- long |
-getCreationTime()
-
-- Returns the time when this session was created, measured in - milliseconds since midnight January 1, 1970 GMT. |
-
- java.lang.String |
-getId()
-
-- Returns a string containing the unique identifier assigned to - this session. |
-
- boolean |
-getInvalidateWhenReady()
-
-- Returns true if the container will notify the application when this - SipSession is in the ready-to-invalidate state. |
-
- long |
-getLastAccessedTime()
-
-- Returns the last time the client sent a request associated with this - session, as the number of milliseconds since midnight January 1, - 1970 GMT. |
-
- Address |
-getLocalParty()
-
-- Returns the Address identifying the local party. |
-
- SipApplicationRoutingRegion |
-getRegion()
-
-- This method allows the application to obtain the region it was - invoked in for this SipSession. |
-
- Address |
-getRemoteParty()
-
-- Returns the Address identifying the remote party. |
-
- javax.servlet.ServletContext |
-getServletContext()
-
-- Returns the ServletContext to which this session belongs. |
-
- SipSession.State |
-getState()
-
-- Returns the current SIP dialog state, which is one of INITIAL, EARLY, - CONFIRMED, or TERMINATED. |
-
- URI |
-getSubscriberURI()
-
-- Returns the URI of the subscriber for which this application - is invoked to serve. |
-
- void |
-invalidate()
-
-- Invalidates this session and unbinds any objects bound to it. |
-
- boolean |
-isReadyToInvalidate()
-
-- Returns true if this session is in a ready-to-invalidate state. |
-
- boolean |
-isValid()
-
-- Returns true if this SipSession is valid, false otherwise. |
-
- void |
-removeAttribute(java.lang.String name)
-
-- Removes the object bound with the specified name from this session. |
-
- void |
-setAttribute(java.lang.String name,
- java.lang.Object attribute)
-
-- Binds an object to this session, using the name specified. |
-
- void |
-setHandler(java.lang.String name)
-
-- Sets the handler for this SipSession. |
-
- void |
-setInvalidateWhenReady(boolean invalidateWhenReady)
-
-- Specifies whether the container should notify the application when the - SipSession is in the ready-to-invalidate state as defined above. |
-
- void |
-setOutboundInterface(java.net.InetAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface to use when sending requests for this SipSession. |
-
- void |
-setOutboundInterface(java.net.InetSocketAddress address)
-
-- In multi-homed environment this method can be used to select - the outbound interface and source port number to use when sending - requests for this SipSession. |
-
| -Method Detail | -
|---|
-long getCreationTime()-
-
-java.lang.String getId()-
-
-long getLastAccessedTime()-
-
-void invalidate()-
-
java.lang.IllegalStateException - if this method is called on an invalidated session-boolean isReadyToInvalidate()-
SipSession is in the ready-to-invalidate state under any
- of the following conditions:
- -
java.lang.IllegalStateException - if this method is called on an invalidated session-void setInvalidateWhenReady(boolean invalidateWhenReady)-
SipSessionListener.sessionReadyToInvalidate callback.
--
invalidateWhenReady - if true, the container will observe this session
- and notify the application when it is in the ready-to-invalidate state.
- The session is not observed if the flag is false.
- The default is true for v1.1 applications and false for v1.0
- applications.
-java.lang.IllegalStateException - if this method is called on an invalidated sessionisReadyToInvalidate(),
-SipSessionListener.sessionReadyToInvalidate(SipSessionEvent se)-boolean getInvalidateWhenReady()-
SipSession is in the ready-to-invalidate state.
--
java.lang.IllegalStateException - if this method is called on an invalidated sessionisReadyToInvalidate()-SipApplicationSession getApplicationSession()-
SipSession
- is associated. If none exists, then a new one is created and returned
- after associating it with this SipSession.
--
SipSession-java.lang.String getCallId()-
SipSession. This is the
- value of the Call-ID header for all messages belonging to this session.
--
SipSession-Address getLocalParty()-
Address identifying the local party. This is
- the value of the From header of locally initiated requests in this leg.
--
-Address getRemoteParty()-
Address identifying the remote party. This is
- the value of the To header of locally initiated requests in this leg.
--
-SipServletRequest createRequest(java.lang.String method)-
Note that this method must not be used to create ACK or
- CANCEL requests. User agents create ACKs by calling SipServletResponse.createAck() and CANCELs are created by
- calling SipServletRequest.createCancel().
-
-
method - the SIP method of the new request
-java.lang.IllegalArgumentException - if method is not a syntactically valid
- SIP method or if it's "ACK" or "CANCEL"
-java.lang.IllegalStateException - if this SipSession has been invalidated or
- if this SipSession is in the INITIAL state and there
- is an ongoing transaction or
- if this SipSession is in the TERMINATED
- state-void setHandler(java.lang.String name) - throws javax.servlet.ServletException-
SipSession.
- This method can be used to
- explicitly specify the name of the servlet which should handle all
- subsequently received messages for this SipSession.
- The servlet must belong to the same application (i.e. same
- ServletContext) as the caller.
--
name - name of the servlet to be invoked for incoming
- SIP messages belonging to this SipSession
-javax.servlet.ServletException - if no servlet with the specified name
- exists in this application
-java.lang.IllegalStateException - if this method is called on an invalidated session-java.lang.Object getAttribute(java.lang.String name)-
-
name - a string specifying the name of the object
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.NullPointerException - if the name is null.-java.util.Enumeration<java.lang.String> getAttributeNames()-
Enumeration over the String
- objects containing the names of all the objects bound to this session.
--
java.lang.IllegalStateException - if this method is called on an invalidated session-void setAttribute(java.lang.String name, - java.lang.Object attribute)-
-
name - the name to which the object is bound; cannot be nullattribute - the object to be bound; cannot be null
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.NullPointerException - on null name or attribute.-void removeAttribute(java.lang.String name)-
-
name - the name of the object to remove from this session
-java.lang.IllegalStateException - if this method is called on an invalidated session-SipSession.State getState()-
-
java.lang.IllegalStateException - if this method is called on an invalidated session-void setOutboundInterface(java.net.InetSocketAddress address)-
javax.servlet.sip.outboundInterfaces.
-
- The port is interpreted as an advice by the app to the container. - If the port of the socket address has a non-zero value, the container - will make a best-effort attempt to use it as the source port number - for UDP packets, or as a source port number for TCP connections it - originates. If the port is not available, the container will use - its default port allocation scheme. -
Invocation of this method also impacts the system headers
- generated by the container for this SipSession, such as the
- the Via and the Contact headers.
- The IP address part of the socket address is used to construct
- these system headers.
-
-
address - the socket address which represents the outbound interface
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.IllegalArgumentException - if the address is not understood
- by the container as one of its outbound interfaces
-java.lang.NullPointerException - on null address-void setOutboundInterface(java.net.InetAddress address)-
javax.servlet.sip.outboundInterfaces.
- Invocation of this method also impacts the system headers
- generated by the container for this message, such as the
- the Via and the Contact header.
- The supplied IP address is used to construct
- these system headers.
-
-
address - the address which represents the outbound interface
-java.lang.IllegalStateException - if this method is called on an invalidated session
-java.lang.IllegalArgumentException - if the address does not
- represent one of the container's outbound interfaces
-java.lang.NullPointerException - on null address-boolean isValid()-
invalidate() on it or if its invalidateWhenReady flag
- is true and it transitions to the ready-to-invalidate state.
- Also the SipSession can be invalidated by the container when either the associated
- SipApplicationSession times out or
- SipApplicationSession.invalidate() is invoked.
--
-SipApplicationRoutingRegion getRegion()-
SipSession.getSubscriberURI().
-
-
- If this SipSession is created when this servlet receives an initial
- request, this method returns the region in which this servlet is invoked.
- The SipApplicationRoutingRegion is only available if this
- SipSession received an initial request. Otherwise, this method throws
- IllegalStateException.
-
-
java.lang.IllegalStateException - if this method is called on an invalidated session-URI getSubscriberURI()-
-
java.lang.IllegalStateException - if this method is called on an invalidated session-javax.servlet.ServletContext getServletContext()-
SipSession belonging to a distributed application
- deployed to a distributed container may be available across JVMs , this method
- returns the context that is local to the JVM on which it was invoked.
--
ServletContext
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSessionActivationListener
-Objects that are bound to a session may listen to container events
- notifying them that sessions will be passivated and that session
- will be activated. A container that migrates session between VMs or
- persists sessions is required to notify all attributes bound to
- sessions implementing SipSessionActivationListener.
-
- -
-
| -Method Summary | -|
|---|---|
- void |
-sessionDidActivate(SipSessionEvent se)
-
-- Notification that the session has just been activated. |
-
- void |
-sessionWillPassivate(SipSessionEvent se)
-
-- Notification that the session is about to be passivated. |
-
| -Method Detail | -
|---|
-void sessionWillPassivate(SipSessionEvent se)-
-
se - event identifying the session about to be persisted-void sessionDidActivate(SipSessionEvent se)-
-
se - event identifying the activated session
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSessionAttributeListener
-This listener interface can be implemented in order to get - notifications of changes to the attribute lists of sessions - within this SIP servlet application. -
- -
-
| -Method Summary | -|
|---|---|
- void |
-attributeAdded(SipSessionBindingEvent ev)
-
-- Notification that an attribute has been added to a session. |
-
- void |
-attributeRemoved(SipSessionBindingEvent ev)
-
-- Notification that an attribute has been removed from a session. |
-
- void |
-attributeReplaced(SipSessionBindingEvent ev)
-
-- Notification that an attribute has been replaced in a session. |
-
| -Method Detail | -
|---|
-void attributeAdded(SipSessionBindingEvent ev)-
-
ev - event identifying the affected SipSession-void attributeRemoved(SipSessionBindingEvent ev)-
-
ev - event identifying the affected SipSession-void attributeReplaced(SipSessionBindingEvent ev)-
-
ev - event identifying the affected SipSession
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipSessionBindingEvent
-Events of this type are either sent to an object that implements
- SipSessionBindingListener when it is bound or unbound from a
- session, or to a SipSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in a session.
-
-
The session binds the object by a call to
- SipSession.setAttribute and unbinds the object by a call
- to SipSession.removeAttribute.
-
- -
-
-| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipSessionBindingEvent(SipSession session,
- java.lang.String name)
-
-- Constructs an event that notifies an object that it has been bound - to or unbound from a session. |
-|
| -Method Summary | -|
|---|---|
- java.lang.String |
-getName()
-
-- Returns the name with which the object is bound to or unbound from - the session. |
-
- SipSession |
-getSession()
-
-- Returns the session to or from which the object is bound or unbound. |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipSessionBindingEvent(SipSession session, - java.lang.String name)-
SipSessionBindingListener.
--
session - the session to which the object is bound or unboundname - the name with which the object is bound or unbound| -Method Detail | -
|---|
-public java.lang.String getName()-
-
-public SipSession getSession()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSessionBindingListener
-Causes an object to be notified when it is bound to or unbound from
- a SipSession. The object is notified by an SipSessionBindingEvent
- object. This may be as a result of a servlet programmer explicitly
- unbinding an attribute from a session, due to a session being invalidated,
- or due to a session timing out.
-
- -
-
SipSession,
-SipSessionBindingEvent| -Method Summary | -|
|---|---|
- void |
-valueBound(SipSessionBindingEvent event)
-
-- Notifies the object that it is being bound to a session and - identifies the session. |
-
- void |
-valueUnbound(SipSessionBindingEvent event)
-
-- Notifies the object that it is being unbound from a session and - identifies the session. |
-
| -Method Detail | -
|---|
-void valueBound(SipSessionBindingEvent event)-
-
event - the event that identifies the session-void valueUnbound(SipSessionBindingEvent event)-
-
event - the event that identifies the session
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipSessionEvent
-This is the class representing event notifications for changes to
- SipSessions within a SIP servlet application.
-
- -
-
| -Field Summary | -
|---|
| Fields inherited from class java.util.EventObject | -
|---|
source |
-
| -Constructor Summary | -|
|---|---|
SipSessionEvent(SipSession source)
-
-- Construct a session event from the given source. |
-|
| -Method Summary | -|
|---|---|
- SipSession |
-getSession()
-
-- Returns the session that changed. |
-
| Methods inherited from class java.util.EventObject | -
|---|
getSource, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipSessionEvent(SipSession source)-
-
source - the affected SipSession object| -Method Detail | -
|---|
-public SipSession getSession()-
-
SipSession object
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSessionListener
-Implementations of this interface are notified of changes to the list
- of active SipSessions in a SIP servlet application. To
- recieve notification events, the implementation class must be configured
- in the deployment descriptor for the SIP application.
-
- -
-
| -Method Summary | -|
|---|---|
- void |
-sessionCreated(SipSessionEvent se)
-
-- Notification that a SipSession was created. |
-
- void |
-sessionDestroyed(SipSessionEvent se)
-
-- Notification that a SipSession was destroyed. |
-
- void |
-sessionReadyToInvalidate(SipSessionEvent se)
-
-- Notification that a SipSession is in the ready-to-invalidate
- state. |
-
| -Method Detail | -
|---|
-void sessionCreated(SipSessionEvent se)-
SipSession was created.
--
se - the notification event-void sessionDestroyed(SipSessionEvent se)-
SipSession was destroyed.
--
se - the notification event-void sessionReadyToInvalidate(SipSessionEvent se)-
SipSession is in the ready-to-invalidate
- state. The container will invalidate this session upon completion of
- this callback unless the listener implementation calls
- SipSessionEvent.getSession().setInvalidateWhenReady(false)
--
se - the notification eventSipSession.isReadyToInvalidate()
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipSessionsUtil
-A utility class providing additional support for - converged HTTP/SIP applications and converged Java EE / SIP applications. - -
This class can be accessed through the ServletContext
- parameter named javax.servlet.sip.SipSessionsUtil or it can be injected
- using the @Resource annotation.
-
- -
-
| -Method Summary | -|
|---|---|
- SipApplicationSession |
-getApplicationSessionById(java.lang.String applicationSessionId)
-
-- Returns the SipApplicationSession for a given applicationSessionId. |
-
- SipApplicationSession |
-getApplicationSessionByKey(java.lang.String applicationSessionKey,
- boolean create)
-
-- Returns the SipApplicationSession for a given session applicationSessionKey. |
-
- SipSession |
-getCorrespondingSipSession(SipSession session,
- java.lang.String headerName)
-
-- Returns related SipSession. |
-
| -Method Detail | -
|---|
-SipApplicationSession getApplicationSessionById(java.lang.String applicationSessionId)-
-
applicationSessionId - the SipApplicationSession's id
-java.lang.NullPointerException - if the applicationSessionId is null.SipApplicationSession.getId()-SipApplicationSession getApplicationSessionByKey(java.lang.String applicationSessionKey, - boolean create)-
applicationSessionKey.
- The applicationSessionKey String is the same as that supplied to
- SipFactory#createApplicationSessionByKey. The method shall return the
- Application Session only if the queried application session belongs to the
- application from where this method is invoked.
- The method returns null in case the container does not
- find the SipApplicationSession instance matching the applicationSessionKey.
--
applicationSessionKey - session applicationSessionKey of the SipApplicationSessioncreate - controls whether new session should be created upon lookup
- failure
-create is set to false. If create
- is true, create a new SipApplicationSession with the
- given applicationSessionKey
-java.lang.NullPointerException - if the applicationSessionKey is null.SipFactory.createApplicationSessionByKey(String)-SipSession getCorrespondingSipSession(SipSession session, - java.lang.String headerName)-
- @Resource
- SipSessionsUtil sipSessionsUtil;
- protected void doInvite(SipServletRequest req) {
- SipSession joining = req.getSession(true);
- SipSession beingJoined = sipSessionsUtil.getCorrespondingSipSession(
- joining,"Join");
- [...]
- }
-
--
session - one of the two related SIP sessions. For example, it can
- be the joining session or the replacing session.headerName - the header name through which the association is made.
- For example, for RFC 3911, it is Join,
- for RFC 3891, it is Replaces
-null.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipURI
-Represents sip and sips URIs.
-
-
SIP and SIPS URIs are used for addressing. They are similar to email - addresses in that they are of the form user@host where - user is either a user name or telephone number, and host - is a host or domain name, or a numeric IP address. Additionally, SIP and - SIPS URIs may contain parameters and headers (although headers are not - legal in all contexts). - -
Syntactically, SIP and SIPS URIs are identical except for the name of - URI scheme. The semantics differs in that the SIPS scheme implies that - the identified resource is to be contacted using TLS. The following quote - is from RFC 3261: - -
- "A SIPS URI specifies that the resource be contacted securely. This - means, in particular, that TLS is to be used between the UAC and the - domain that owns the URI. From there, secure communications are used - to reach the user, where the specific security mechanism depends on - the policy of the domain. Any resource described by a SIP URI can be - "upgraded" to a SIPS URI by just changing the scheme, if it is - desired to communicate with that resource securely." -- -
Because sip and sips URIs are syntactically
- identical and because they're used the same way, they're both represented
- by the SipURI interface.
-
-
The string form of SIP and SIPS URIs may contain escaped characters. - The SIP - servlet container is responsible for unescaping those characters before - presenting URIs to servlets. Likewise, string values passed to setters - for various SIP(S) URI components may contain reserved or excluded - characters that need escaping before being used. The container is - responsible for escaping those values. -
- -
-
Address,
-SipFactory.createSipURI(java.lang.String, java.lang.String),
-SipServletRequest.getRequestURI()| -Method Summary | -|
|---|---|
- boolean |
-equals(java.lang.Object o)
-
-- Compares the given SipURI with this SipURI. |
-
- java.lang.String |
-getHeader(java.lang.String name)
-
-- Returns the value of the specified header. |
-
- java.util.Iterator<java.lang.String> |
-getHeaderNames()
-
-- Returns an Iterator over the names of all headers
- present in this SipURI. |
-
- java.lang.String |
-getHost()
-
-- Returns the host part of this SipURI. |
-
- boolean |
-getLrParam()
-
-- Returns true if the "lr" flag parameter is set, and false - otherwise. |
-
- java.lang.String |
-getMAddrParam()
-
-- Returns the value of the "maddr" parameter, or null if this - is not set. |
-
- java.lang.String |
-getMethodParam()
-
-- Returns the value of the "method" parameter, or null if this - is not set. |
-
- int |
-getPort()
-
-- Returns the port number of this SipURI,
- or -1 if this is not set. |
-
- java.lang.String |
-getTransportParam()
-
-- Returns the value of the "transport" parameter, or null if this - is not set. |
-
- int |
-getTTLParam()
-
-- Returns the value of the "ttl" parameter, or -1 if this - is not set. |
-
- java.lang.String |
-getUser()
-
-- Returns the user part of this SipURI. |
-
- java.lang.String |
-getUserParam()
-
-- Returns the value of the "user" parameter, or null if this - is not set. |
-
- java.lang.String |
-getUserPassword()
-
-- Returns the password of this SipURI,
- or null if this is not set. |
-
- boolean |
-isSecure()
-
-- Returns true if this SipURI is secure, that is,
- if this it represents a sips URI. |
-
- void |
-removeHeader(java.lang.String name)
-
-- Removes the named header from this SipURI. |
-
- void |
-setHeader(java.lang.String name,
- java.lang.String value)
-
-- Sets the value of the specified header in this SipURI. |
-
- void |
-setHost(java.lang.String host)
-
-- Sets the host part of this SipURI. |
-
- void |
-setLrParam(boolean flag)
-
-- Sets or removes the "lr" parameter depending on the value of the flag. |
-
- void |
-setMAddrParam(java.lang.String maddr)
-
-- Sets the value of the "maddr" parameter. |
-
- void |
-setMethodParam(java.lang.String method)
-
-- Sets the value of the "method" parameter. |
-
- void |
-setPort(int port)
-
-- Sets the port number of this SipURI. |
-
- void |
-setSecure(boolean b)
-
-- Sets the scheme of this URI to sip or sips
- depending on whether the argument is true or not. |
-
- void |
-setTransportParam(java.lang.String transport)
-
-- Sets the value of the "transport" parameter. |
-
- void |
-setTTLParam(int ttl)
-
-- Sets the value of the "ttl" parameter. |
-
- void |
-setUser(java.lang.String user)
-
-- Sets the user part of this SipURI. |
-
- void |
-setUserParam(java.lang.String user)
-
-- Sets the value of the "user" parameter. |
-
- void |
-setUserPassword(java.lang.String password)
-
-- Sets the password of this SipURI. |
-
- java.lang.String |
-toString()
-
-- Returns the String representation of this
- SipURI. |
-
| Methods inherited from interface javax.servlet.sip.URI | -
|---|
clone, getParameter, getParameterNames, getScheme, isSipURI, removeParameter, setParameter |
-
| -Method Detail | -
|---|
-java.lang.String getUser()-
SipURI.
--
SipURI-void setUser(java.lang.String user)-
SipURI.
--
user - the new user part-java.lang.String getUserPassword()-
SipURI,
- or null if this is not set.
--
SipURI-void setUserPassword(java.lang.String password)-
SipURI. The use of passwords
- in SIP or SIPS URIs is discouraged as sending passwords in clear text
- is a security risk.
--
password - the new password-java.lang.String getHost()-
SipURI.
--
SipURI-void setHost(java.lang.String host)-
SipURI. This should be a fully
- qualified domain name or a numeric IP address.
--
host - the new host name-int getPort()-
SipURI,
- or -1 if this is not set.
--
SipURI-void setPort(int port)-
SipURI.
--
port - the new port number. A negative value means the
- port number is not set and a subsequent call to
- getPort() should return -1.-boolean isSecure()-
SipURI is secure, that is,
- if this it represents a sips URI. For "ordinary"
- sip URIs, false is returned.
--
SipURI represents a sips
- URI, and false if it represents a sip URI-void setSecure(boolean b)-
sip or sips
- depending on whether the argument is true or not.
--
b - determines whether the scheme of this SipURI
- is set to sip or sips-java.lang.String getTransportParam()-
getParameter("transport").
--
-void setTransportParam(java.lang.String transport)-
This method is equivalent to
- setParameter("transport", transport).
-
-
transport - new value for the "transport" parameter-java.lang.String getMAddrParam()-
getParameter("maddr").
--
-void setMAddrParam(java.lang.String maddr)-
setParameter("maddr", maddr).
--
maddr - new value of the "maddr" parameter-java.lang.String getMethodParam()-
getParameter("method").
--
-void setMethodParam(java.lang.String method)-
This method is equivalent to
- setParameter("method", method).
-
-
method - new value of the "method" parameter-int getTTLParam()-
getParameter("ttl").
--
-void setTTLParam(int ttl)-
This is equivalent to setParameter("ttl", ttl).
-
-
ttl - new value of the "ttl" parameter-java.lang.String getUserParam()-
getParameter("user").
--
-void setUserParam(java.lang.String user)-
setParameter("user", user).
--
user - new value for the "user" parameter-boolean getLrParam()-
"".equals(getParameter("lr")).
--
-void setLrParam(boolean flag)-
-
flag - specifies that the "lr" flag parameter is to be set (true)
- or removed (false)-java.lang.String getHeader(java.lang.String name)-
sip:joe@example.com?Priority=emergency has a header
- "Priority" whose value is "emergency".
--
name - the header name
-SipURI
-java.lang.NullPointerException - if the name is null.-void setHeader(java.lang.String name, - java.lang.String value)-
SipURI.
--
name - header namevalue - header value-void removeHeader(java.lang.String name)-
SipURI. Nothing is
- done if the SipURI did not already contain the
- specific header.
--
name - header name-java.util.Iterator<java.lang.String> getHeaderNames()-
Iterator over the names of all headers
- present in this SipURI.
--
Iterator over all header names-java.lang.String toString()-
String representation of this
- SipURI. Any reserved characters will be properly escaped
- according to RFC2396.
--
sip or sips URI as a
- String-boolean equals(java.lang.Object o)-
-
o - the URI which is to be compared with this.
-true if the two SipURIs are equal.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface TelURL
-Represents tel URLs as defined by RFC 3966. Tel URLs
- represent telephone numbers. SIP servlet containers may be able to
- route requests based on tel URLs but are not required to.
-
- -
-
| -Method Summary | -|
|---|---|
- boolean |
-equals(java.lang.Object o)
-
-- Compares the given TelURL with this TelURL. |
-
- java.lang.String |
-getPhoneContext()
-
-- Returns the phone context of this TelURL for local numbers or
- null if the phone number is global |
-
- java.lang.String |
-getPhoneNumber()
-
-- Returns the phone number of this TelURL. |
-
- boolean |
-isGlobal()
-
-- Returns true if this TelURL is global, and false
- otherwise. |
-
- void |
-setPhoneNumber(java.lang.String number)
-
-- Sets the (global) phone number of this TelURL. |
-
- void |
-setPhoneNumber(java.lang.String number,
- java.lang.String phoneContext)
-
-- Sets the (local) phone number of this TelURL. |
-
- java.lang.String |
-toString()
-
-- Returns the String representation of this
- TelURL. |
-
| Methods inherited from interface javax.servlet.sip.URI | -
|---|
clone, getParameter, getParameterNames, getScheme, isSipURI, removeParameter, setParameter |
-
| -Method Detail | -
|---|
-java.lang.String getPhoneNumber()-
TelURL. The
- returned string includes any visual separators present in the
- phone number part of the URL but does not include a
- leading "+" for global tel URLs.
--
TelURL-java.lang.String getPhoneContext()-
TelURL for local numbers or
- null if the phone number is global
--
TelURL for local numbers or
- null if the phone number is global-void setPhoneNumber(java.lang.String number)-
TelURL. The specified
- number must be a valid global number for the "tel" scheme as
- described in RFC3966 (URLs for Telephone Calls).
-
- The following usage of this method will result in valid global phone number: setPhoneNumber("+1-201-555-0123")
--
number - the new global phone number
-java.lang.IllegalArgumentException - if the phone number was invalid according
- to validation rules specified in RFC3966-void setPhoneNumber(java.lang.String number, - java.lang.String phoneContext)-
TelURL. The specified number
- must be a local phone number for the "tel" scheme as
- described in RFC3966 (URLs for Telephone Calls).
-
- The following usage of this method will result in a valid local phone number: setPhoneNumber("7042","example.com")
--
number - the new local phone numberphoneContext - the phone-context parameter of this TelURI
-java.lang.IllegalArgumentException - if the phone number was invalid according
- to validation rules specified in RFC3966-boolean isGlobal()-
TelURL is global, and false
- otherwise.
--
-java.lang.String toString()-
String representation of this
- TelURL. Any reserved characters will be properly escaped
- according to RFC2396.
--
String representation of this
- TelURL-boolean equals(java.lang.Object o)-
-
o - the TelURL which is to be compared with this.
-true if the two URLs are equal as per RFC 3966.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface TimerListener
-Listener interface implemented by SIP servlet applications using timers. - -
The application specifies an implementation of this interface
- in a listener element of the SIP deployment descriptor.
- There may be at most one TimerListener defined.
-
- -
-
TimerService| -Method Summary | -|
|---|---|
- void |
-timeout(ServletTimer timer)
-
-- Notifies the listener that the specified timer has expired. |
-
| -Method Detail | -
|---|
-void timeout(ServletTimer timer)-
-
timer - the timer that has expired
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface TimerService
-Allows SIP servlet applications to set timers in order to receive
- notifications on timer expiration. Applications receive such
- notifications through an implementation of the
- TimerListener interface. Applications using timers must
- implement this interface and declare it as listener
- in the SIP deployment descriptor.
-
-
SIP servlet containers are requried to make a
- TimerService instance available to applications
- through a ServletContext attribute with name
- javax.servlet.sip.TimerService.
-
- -
-
TimerListener,
-SipApplicationSession.getTimers()| -Method Summary | -|
|---|---|
- ServletTimer |
-createTimer(SipApplicationSession appSession,
- long delay,
- boolean isPersistent,
- java.io.Serializable info)
-
-- Creates a one-time ServletTimer and schedules it to
- expire after the specified delay. |
-
- ServletTimer |
-createTimer(SipApplicationSession appSession,
- long delay,
- long period,
- boolean fixedDelay,
- boolean isPersistent,
- java.io.Serializable info)
-
-- Creates a repeating ServletTimer and schedules it to
- expire after the specified delay and then again at approximately
- regular intervals. |
-
| -Method Detail | -
|---|
-ServletTimer createTimer(SipApplicationSession appSession, - long delay, - boolean isPersistent, - java.io.Serializable info)-
ServletTimer and schedules it to
- expire after the specified delay.
--
appSession - the application session with which the new
- ServletTimer is to be associateddelay - delay in milliseconds before timer is to expireisPersistent - if true, the ServletTimer will be
- reinstated after a shutdown be it due to complete failure
- or operator shutdowninfo - application information to be delivered along with the
- timer expiration notification. This may be null.
-ServletTimer
-java.lang.IllegalStateException - if the application session is invalid-ServletTimer createTimer(SipApplicationSession appSession, - long delay, - long period, - boolean fixedDelay, - boolean isPersistent, - java.io.Serializable info)-
ServletTimer and schedules it to
- expire after the specified delay and then again at approximately
- regular intervals.
-
- The ServletTimer is rescheduled to expire in either
- a fixed-delay or fixed-rate manner as specified
- by the fixedDelay argument.
-
-
The semantics are the same as for Timer:
-
-
- In fixed-delay execution, each execution is scheduled relative - to the actual execution time of the previous execution. If an - execution is delayed for any reason (such as garbage collection - or other background activity), subsequent executions will be - delayed as well. In the long run, the frequency of execution will - generally be slightly lower than the reciprocal of the specified - period (assuming the system clock underlying --Object.wait(long)is - accurate). - -In fixed-rate execution, each execution is scheduled relative - to the scheduled execution time of the initial execution. If an - execution is delayed for any reason (such as garbage collection - or other background activity), two or more executions will occur - in rapid succession to "catch up." In the long run, the frequency - of execution will be exactly the reciprocal of the specified period - (assuming the system clock underlying
Object.wait(long)- is accurate). -
-
appSession - the application session with which the new
- ServletTimer is to be associateddelay - delay in milliseconds before timer is to expireperiod - time in milliseconds between successive timer expirationsfixedDelay - if true, the repeating timer is scheduled in
- a fixed-delay mode, otherwise in a fixed-rate modeisPersistent - if true, the ServletTimer will be
- reinstated after a shutdown be it due to complete failure
- or operator shutdowninfo - application information to be delivered along with the
- timer expiration notification. This may be null.
-ServletTimer
-java.lang.IllegalStateException - if the application session is invalid
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class TooManyHopsException
-Thrown when a SIP Servlet application attempts to obtain a
- Proxy object for a request with a Max-Forwards
- header with value 0.
-
-
The application may catch this exception and generate its own - response. Otherwise the exception will propagate to the container - which will catch it and generate a 483 (Too many hops) response. -
- -
-
| -Constructor Summary | -|
|---|---|
TooManyHopsException()
-
-- Constructs a new TooManyHopsException exception, without any message. |
-|
TooManyHopsException(java.lang.String msg)
-
-- Constructs a new TooManyHopsException exception with the specified message. |
-|
TooManyHopsException(java.lang.String message,
- java.lang.Throwable cause)
-
-- Constructs a new TooManyHopsException exception with the specified detail message and
- cause. |
-|
TooManyHopsException(java.lang.Throwable cause)
-
-- Constructs a new TooManyHopsException exception with the specified cause and a detail
- message of (cause==null ? null : cause.toString()) (which
- typically contains the class and detail message of cause). |
-|
| -Method Summary | -
|---|
| Methods inherited from class javax.servlet.ServletException | -
|---|
getRootCause |
-
| Methods inherited from class java.lang.Throwable | -
|---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public TooManyHopsException()-
TooManyHopsException exception, without any message.
--
-public TooManyHopsException(java.lang.String msg)-
TooManyHopsException exception with the specified message.
--
msg - a String specifying the text of the
- exception message-public TooManyHopsException(java.lang.String message, - java.lang.Throwable cause)-
TooManyHopsException exception with the specified detail message and
- cause.
-
- Note that the detail message associated with cause is
- not automatically incorporated in this exception's detail
- message.
-
-
message - the detail message (which is saved for later retrieval
- by the Throwable.getMessage() method).cause - the cause (which is saved for later retrieval by the
- Throwable.getCause() method). (A null value
- is permitted, and indicates that the cause is nonexistent or
- unknown.)-public TooManyHopsException(java.lang.Throwable cause)-
TooManyHopsException exception with the specified cause and a detail
- message of (cause==null ? null : cause.toString()) (which
- typically contains the class and detail message of cause).
- This constructor is useful for exceptions that are little more than
- wrappers for other throwables.
--
cause - the cause (which is saved for later retrieval by the
- Throwable.getCause() method). (A null value is
- permitted, and indicates that the cause is nonexistent or
- unknown.)
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public enum UAMode
-User Agent modes, UAC (client) or UAS (server) -
- -
-
B2buaHelper.getPendingMessages(SipSession, UAMode)| -Enum Constant Summary | -|
|---|---|
UAC
-
-- |
-|
UAS
-
-- |
-|
| -Method Summary | -|
|---|---|
-static UAMode |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static UAMode[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final UAMode UAC-
-public static final UAMode UAS-
| -Method Detail | -
|---|
-public static final UAMode[] values()-
-for(UAMode c : UAMode.values()) - System.out.println(c); --
-
-public static UAMode valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface URI
-Base interface for any type of URI. These are used in the request line - of SIP requests to identify the callee and also in Contact, From, and - To headers. - -
The only feature common to all URIs is that they can be represented - as strings beginning with a token identifying the scheme of - the URI followed by a colon followed by a scheme-specific part. - -
The generic syntax of URIs is defined in RFC 2396. -
- -
-
| -Method Summary | -|
|---|---|
- URI |
-clone()
-
-- Returns a clone of this URI. |
-
- boolean |
-equals(java.lang.Object o)
-
-- Compares the given URI with this URI. |
-
- java.lang.String |
-getParameter(java.lang.String key)
-
-- Returns the value of the named parameter, or null if it is not - set. |
-
- java.util.Iterator<java.lang.String> |
-getParameterNames()
-
-- Returns an Iterator over the names of all parameters
- present in this URI. |
-
- java.lang.String |
-getScheme()
-
-- Returns the scheme of this URI,
- for example "sip", "sips" or "tel". |
-
- boolean |
-isSipURI()
-
-- Returns true if the scheme is "sip" or "sips", false otherwise. |
-
- void |
-removeParameter(java.lang.String name)
-
-- Removes the named parameter from this URL. |
-
- void |
-setParameter(java.lang.String name,
- java.lang.String value)
-
-- Sets the value of the named parameter. |
-
- java.lang.String |
-toString()
-
-- Returns the value of this URI as a String. |
-
| -Method Detail | -
|---|
-java.lang.String getScheme()-
URI,
- for example "sip", "sips" or "tel".
--
URI-java.lang.String toString()-
URI as a String.
- The result must be appropriately URL escaped.
--
toString in class java.lang.ObjectString value of this URI-boolean isSipURI()-
-
-java.lang.String getParameter(java.lang.String key)-
String indicates flag parameter.
--
key - a String specifying the parameter name
-java.lang.NullPointerException - if the key is null.-void setParameter(java.lang.String name, - java.lang.String value)-
-
name - parameter namevalue - new parameter value
-java.lang.NullPointerException - on eithet name or value being null.-void removeParameter(java.lang.String name)-
-
name - parameter name-java.util.Iterator<java.lang.String> getParameterNames()-
Iterator over the names of all parameters
- present in this URI.
--
-boolean equals(java.lang.Object o)-
-
equals in class java.lang.Objecto - the URI which is to be compared with this.
-true if the two URIs are equal as per the provisions of their specifications.-URI clone()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
@Target(value=PACKAGE) -@Retention(value=RUNTIME) -public @interface SipApplication
-The @SipApplication annotation is used to create an application level - annotation for a collection of SipServlets -
- -
-
| -Required Element Summary | -|
|---|---|
- java.lang.String |
-name
-
-- |
-
| -Optional Element Summary | -|
|---|---|
- java.lang.String |
-description
-
-- |
-
- java.lang.String |
-displayName
-
-- |
-
- boolean |
-distributable
-
-- |
-
- java.lang.String |
-largeIcon
-
-- |
-
- java.lang.String |
-mainServlet
-
-- |
-
- int |
-proxyTimeout
-
-- |
-
- int |
-sessionTimeout
-
-- |
-
- java.lang.String |
-smallIcon
-
-- |
-
| -Element Detail | -
|---|
-public abstract java.lang.String name-
-public abstract java.lang.String displayName-
-public abstract java.lang.String smallIcon-
-public abstract java.lang.String largeIcon-
-public abstract java.lang.String description-
-public abstract boolean distributable-
-public abstract int proxyTimeout-
-public abstract int sessionTimeout-
-public abstract java.lang.String mainServlet-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
@Target(value=METHOD) -@Retention(value=RUNTIME) -@Inherited -public @interface SipApplicationKey
-The @SipApplicationKey annotation is used when the application - wants to associate the incoming request (and SipSession) - with a certain SipApplicationSession. - - The method annotated with the @SipApplicationKey annotation MUST have the - following restrictions: -
- -
-
| -Optional Element Summary | -|
|---|---|
- java.lang.String |
-applicationName
-
-- |
-
-public abstract java.lang.String applicationName-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
@Target(value=TYPE) -@Retention(value=RUNTIME) -@Inherited -public @interface SipListener
-The @SipListener annotation allows the application - developer to specify a listener without declaring - it in the deployment descriptor of the application. - The listener type is inferred from the interfaces - implemented by the target class -
- -
-
| -Optional Element Summary | -|
|---|---|
- java.lang.String |
-applicationName
-
-- |
-
- java.lang.String |
-description
-
-- |
-
-public abstract java.lang.String applicationName-
-public abstract java.lang.String description-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
@Target(value=TYPE) -@Retention(value=RUNTIME) -@Inherited -public @interface SipServlet
-The @SipServlet annotation allows for the SipServlet metadata - to be declared without having to create the deployment descriptor. -
- -
-
| -Optional Element Summary | -|
|---|---|
- java.lang.String |
-applicationName
-
-- |
-
- java.lang.String |
-description
-
-- |
-
- int |
-loadOnStartup
-
-- |
-
- java.lang.String |
-name
-
-- |
-
-public abstract java.lang.String name-
-public abstract java.lang.String applicationName-
-public abstract java.lang.String description-
-public abstract int loadOnStartup-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: REQUIRED | OPTIONAL | --DETAIL: ELEMENT | -||||||||
|
-Annotation Types
-
- -SipApplication - -SipApplicationKey - -SipListener - -SipServlet |
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-See:
-
- Description
-
- -
| -Annotation Types Summary | -|
|---|---|
| SipApplication | -The @SipApplication annotation is used to create an application level - annotation for a collection of SipServlets | -
| SipApplicationKey | -The @SipApplicationKey annotation is used when the application - wants to associate the incoming request (and SipSession) - with a certain SipApplicationSession. | -
| SipListener | -The @SipListener annotation allows the application - developer to specify a listener without declaring - it in the deployment descriptor of the application. | -
| SipServlet | -The @SipServlet annotation allows for the SipServlet metadata - to be declared without having to create the deployment descriptor. | -
-The javax.servlet.sip.annotation package contains SIP Servlet annotation definitions - -
- -
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
public interface SipApplicationRouter
-This interface class specifies the API between the container and the - application router. -
- -
-
| -Method Summary | -|
|---|---|
- void |
-applicationDeployed(java.util.List<java.lang.String> newlyDeployedApplicationNames)
-
-- Container notifies application router that new applications are deployed. |
-
- void |
-applicationUndeployed(java.util.List<java.lang.String> undeployedApplicationNames)
-
-- Container notifies application router that some applications are - undeployed. |
-
- void |
-destroy()
-
-- Container calls this method when it finishes using this application - router. |
-
- SipApplicationRouterInfo |
-getNextApplication(SipServletRequest initialRequest,
- SipApplicationRoutingRegion region,
- SipApplicationRoutingDirective directive,
- SipTargetedRequestInfo targetedRequestInfo,
- java.io.Serializable stateInfo)
-
-- This method is called by the container when a servlet sends or proxies - an initial SipServletRequest. |
-
- void |
-init()
-
-- Initializes the SipApplicationRouter. |
-
- void |
-init(java.util.Properties properties)
-
-- Initializes the SipApplicationRouter and passes in initialization - properties. |
-
| -Method Detail | -
|---|
-void init()-
-
java.lang.IllegalStateException - if invoked more than once-void init(java.util.Properties properties)-
-
properties - AR initialization properties
-java.lang.IllegalStateException - if invoked more than once-void destroy()-
-
-void applicationDeployed(java.util.List<java.lang.String> newlyDeployedApplicationNames)-
-
newlyDeployedApplicationNames - A list of names of the newly added
- applications-void applicationUndeployed(java.util.List<java.lang.String> undeployedApplicationNames)-
-
undeployedApplicationNames - A list of names of the undeployed
- applications-SipApplicationRouterInfo getNextApplication(SipServletRequest initialRequest, - SipApplicationRoutingRegion region, - SipApplicationRoutingDirective directive, - SipTargetedRequestInfo targetedRequestInfo, - java.io.Serializable stateInfo)-
SipApplicationRouterInfo
- for details.
--
initialRequest - The initial request for which the container is
- asking for application selection. The request must not be
- modified by the AR. It is recommended that the implementations
- explicitly disallow any mutation action by throwing appropriate
- RuntimeException like IllegalStateException.region - Which region the application selection process is indirective - The routing directive used in creating this request.
- If this is a request received externally, directive is NEW.targetedRequestInfo - If initialRequest is a targeted request, this object
- gives the type of targeted request (ENCODED_URI, JOIN, REPLACES) and
- the targeted application name. If the initialRequest is not targeted, this parameter is null.stateInfo - If this request is relayed from a previous request by
- an application, this is the stored state the application router
- returned earlier when invoked to handle the previous request.
-null.
-java.lang.NullPointerException - if the initialRequest is null
-java.lang.IllegalStateException - if the application router has not been
- initialized yet
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --javax.servlet.sip.ar.SipApplicationRouterInfo -
public class SipApplicationRouterInfo
-The SipApplicationRouterInfo class encapsulates the different pieces of - information that the application router returns to the container when the - container calls the SipApplicationRouter.getNextApplication() method. -
- -
-
| -Constructor Summary | -|
|---|---|
SipApplicationRouterInfo(java.lang.String nextApplicationName,
- SipApplicationRoutingRegion routingRegion,
- java.lang.String subscriberURI,
- java.lang.String[] routes,
- SipRouteModifier mod,
- java.io.Serializable stateInfo)
-
-- Creates a SipApplicationRouterInfo object containing the information necessary for the - conatiner to perform its routing decision. |
-|
| -Method Summary | -|
|---|---|
- java.lang.String |
-getNextApplicationName()
-
-- |
-
- SipRouteModifier |
-getRouteModifier()
-
-- |
-
- java.lang.String[] |
-getRoutes()
-
-- An array of SIP routes of the same type (internal or external). |
-
- SipApplicationRoutingRegion |
-getRoutingRegion()
-
-- |
-
- java.io.Serializable |
-getStateInfo()
-
-- |
-
- java.lang.String |
-getSubscriberURI()
-
-- |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipApplicationRouterInfo(java.lang.String nextApplicationName, - SipApplicationRoutingRegion routingRegion, - java.lang.String subscriberURI, - java.lang.String[] routes, - SipRouteModifier mod, - java.io.Serializable stateInfo)-
-
nextApplicationName - The name of the application that the
- application router selects to service this request. If no
- further application is needed in the current region, this is
- set to null.routingRegion - The Routing region in which the application that is selected will serve.subscriberURI - The URI that the application is selected to serveroutes - array of external routes or an internal route. External routes
- are pushed onto the request by the container, internal route
- is used by SipServletRequest.getPoppedRoute().mod - An enum modifier which qualifies the routes returned and the router behaviorstateInfo - Arbitrary state information of the application router
- that it wishes the container to store on its behalf| -Method Detail | -
|---|
-public java.lang.String getNextApplicationName()-
-public java.lang.String[] getRoutes()-
-
-public java.io.Serializable getStateInfo()-
-public java.lang.String getSubscriberURI()-
-public SipApplicationRoutingRegion getRoutingRegion()-
-public SipRouteModifier getRouteModifier()-
SipRouteModifier associated with the router info.
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public enum SipApplicationRoutingDirective
-Routing directives that an application can select to qualify its actions in some cases. -
- -
-
| -Enum Constant Summary | -|
|---|---|
CONTINUE
-
-- |
-|
NEW
-
-- |
-|
REVERSE
-
-- |
-|
| -Method Summary | -|
|---|---|
-static SipApplicationRoutingDirective |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipApplicationRoutingDirective[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipApplicationRoutingDirective NEW-
-public static final SipApplicationRoutingDirective CONTINUE-
-public static final SipApplicationRoutingDirective REVERSE-
| -Method Detail | -
|---|
-public static final SipApplicationRoutingDirective[] values()-
-for(SipApplicationRoutingDirective c : SipApplicationRoutingDirective.values()) - System.out.println(c); --
-
-public static SipApplicationRoutingDirective valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipApplicationRoutingRegion
-A class that represents the application routing region. It uses the
- predefined regions in the Enum SipApplicationRoutingRegionType and also
- allows for implementations to have additional or new regions if it is so
- required. This could be useful in non telephony domains where the concept of
- of a caller and callee is not applicable.
-
- -
-
| -Field Summary | -|
|---|---|
-static SipApplicationRoutingRegion |
-NEUTRAL_REGION
-
-- The NEUTRAL region contains applications that do not service a specific - subscriber. |
-
-static SipApplicationRoutingRegion |
-ORIGINATING_REGION
-
-- The ORIGINATING region contains applications that service the caller. |
-
-static SipApplicationRoutingRegion |
-TERMINATING_REGION
-
-- The TERMINATING region contains applications that service the callee. |
-
| -Constructor Summary | -|
|---|---|
SipApplicationRoutingRegion(java.lang.String label,
- SipApplicationRoutingRegionType type)
-
-- Deployer may define new routing region by constructing a new - SipApplicationRoutingRegion object. |
-|
| -Method Summary | -|
|---|---|
- java.lang.String |
-getLabel()
-
-- Each routing region has a String label. |
-
- SipApplicationRoutingRegionType |
-getType()
-
-- Each routing region is either ORIGINATING, TERMINATING, or NEUTRAL type. |
-
- java.lang.String |
-toString()
-
-- |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
-
| -Field Detail | -
|---|
-public static final SipApplicationRoutingRegion ORIGINATING_REGION-
-
-public static final SipApplicationRoutingRegion TERMINATING_REGION-
-
-public static final SipApplicationRoutingRegion NEUTRAL_REGION-
-
| -Constructor Detail | -
|---|
-public SipApplicationRoutingRegion(java.lang.String label, - SipApplicationRoutingRegionType type)-
SipApplicationRoutingRegionType
- may be null in cases when a custom region is defined.
--
| -Method Detail | -
|---|
-public java.lang.String getLabel()-
-
-public final SipApplicationRoutingRegionType getType()-
-
-public java.lang.String toString()-
toString in class java.lang.Object
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public enum SipApplicationRoutingRegionType
-Routing regions used in the application selection process. -
- -
-
| -Enum Constant Summary | -|
|---|---|
NEUTRAL
-
-- The NEUTRAL region contains applications that do not service a specific subscriber. |
-|
ORIGINATING
-
-- The ORIGINATING region contains applications that service the caller. |
-|
TERMINATING
-
-- The TERMINATING region contains applications that service the callee. |
-|
| -Method Summary | -|
|---|---|
-static SipApplicationRoutingRegionType |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipApplicationRoutingRegionType[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipApplicationRoutingRegionType ORIGINATING-
-
-public static final SipApplicationRoutingRegionType TERMINATING-
-
-public static final SipApplicationRoutingRegionType NEUTRAL-
-
| -Method Detail | -
|---|
-public static final SipApplicationRoutingRegionType[] values()-
-for(SipApplicationRoutingRegionType c : SipApplicationRoutingRegionType.values()) - System.out.println(c); --
-
-public static SipApplicationRoutingRegionType valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public enum SipRouteModifier
-Route modifiers as returned by the Application Router, used to interpret the - routes returned from the router. -
- -
-
SipApplicationRouterInfo.getRouteModifier(),
-SipApplicationRouterInfo.getRoutes()| -Enum Constant Summary | -|
|---|---|
NO_ROUTE
-
-- Indicates that the value returned by SipApplicationRouterInfo.getRoutes()
- does not contain any valid routes and should be ignored. |
-|
ROUTE
-
-- Indicates that the routes returned by SipApplicationRouterInfo.getRoutes()
- are valid. |
-|
ROUTE_BACK
-
-- Tells the container to push a route back to itself - before pusing the external routes specified by - SipApplicationRouterInfo.getRoutes(). |
-|
| -Method Summary | -|
|---|---|
-static SipRouteModifier |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipRouteModifier[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipRouteModifier ROUTE-
SipApplicationRouterInfo.getRoutes()
- are valid.
--
-public static final SipRouteModifier ROUTE_BACK-
SipApplicationRouterInfo.getRoutes().
--
-public static final SipRouteModifier NO_ROUTE-
SipApplicationRouterInfo.getRoutes()
- does not contain any valid routes and should be ignored.
--
| -Method Detail | -
|---|
-public static final SipRouteModifier[] values()-
-for(SipRouteModifier c : SipRouteModifier.values()) - System.out.println(c); --
-
-public static SipRouteModifier valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --
public class SipTargetedRequestInfo
-The SipTargetedRequestInfo class encapsulates the information that the - container provides to the application router when the container calls the - SipApplicationRouter.getNextApplication() method and the initial request is a - targeted one. -
- -
-
| -Constructor Summary | -|
|---|---|
SipTargetedRequestInfo(SipTargetedRequestType targetedRequestType,
- java.lang.String applicationName)
-
-- Creates a SipTargetedRequestInfo object containing information necessary - to help the application router make its application selection decision - when the request is targeted. |
-|
| -Method Summary | -|
|---|---|
- java.lang.String |
-getApplicationName()
-
-- |
-
- SipTargetedRequestType |
-getType()
-
-- |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipTargetedRequestInfo(SipTargetedRequestType targetedRequestType, - java.lang.String applicationName)-
-
targetedRequestType - Targeted request type {ENCODED_URI, JOIN, REPLACES}applicationName - The name of the application targeted by the request.| -Method Detail | -
|---|
-public java.lang.String getApplicationName()-
-public SipTargetedRequestType getType()-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
-java.lang.Object --
public enum SipTargetedRequestType
-Type of targeted request -
- -
-
| -Enum Constant Summary | -|
|---|---|
ENCODED_URI
-
-- The request contains a Request-URI that contains an encoded URI |
-|
JOIN
-
-- The request contains a Join header (RFC 3911) |
-|
REPLACES
-
-- The request contains a Replaces header (RFC 3891) |
-|
| -Method Summary | -|
|---|---|
-static SipTargetedRequestType |
-valueOf(java.lang.String name)
-
-- Returns the enum constant of this type with the specified name. |
-
-static SipTargetedRequestType[] |
-values()
-
-- Returns an array containing the constants of this enum type, in -the order they're declared. |
-
| Methods inherited from class java.lang.Enum | -
|---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
-
| Methods inherited from class java.lang.Object | -
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
-
| -Enum Constant Detail | -
|---|
-public static final SipTargetedRequestType JOIN-
-
-public static final SipTargetedRequestType REPLACES-
-
-public static final SipTargetedRequestType ENCODED_URI-
-
| -Method Detail | -
|---|
-public static final SipTargetedRequestType[] values()-
-for(SipTargetedRequestType c : SipTargetedRequestType.values()) - System.out.println(c); --
-
-public static SipTargetedRequestType valueOf(java.lang.String name)-
-
name - the name of the enum constant to be returned.
-java.lang.IllegalArgumentException - if this enum type has no constant
-with the specified name
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | --DETAIL: ENUM CONSTANTS | FIELD | METHOD | -||||||||
|
-Interfaces
-
- -SipApplicationRouter |
-
|
-Classes
-
- -SipApplicationRouterInfo - -SipApplicationRoutingRegion - -SipTargetedRequestInfo |
-
|
-Enums
-
- -SipApplicationRoutingDirective - -SipApplicationRoutingRegionType - -SipRouteModifier - -SipTargetedRequestType |
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
javax.servlet.sip.ar package contains Application Router interfaces
-
-See:
-
- Description
-
- -
| -Interface Summary | -|
|---|---|
| SipApplicationRouter | -This interface class specifies the API between the container and the - application router. | -
- -
| -Class Summary | -|
|---|---|
| SipApplicationRouterInfo | -The SipApplicationRouterInfo class encapsulates the different pieces of - information that the application router returns to the container when the - container calls the SipApplicationRouter.getNextApplication() method. | -
| SipApplicationRoutingRegion | -A class that represents the application routing region. | -
| SipTargetedRequestInfo | -The SipTargetedRequestInfo class encapsulates the information that the - container provides to the application router when the container calls the - SipApplicationRouter.getNextApplication() method and the initial request is a - targeted one. | -
- -
| -Enum Summary | -|
|---|---|
| SipApplicationRoutingDirective | -Routing directives that an application can select to qualify its actions in some cases. | -
| SipApplicationRoutingRegionType | -Routing regions used in the application selection process. | -
| SipRouteModifier | -Route modifiers as returned by the Application Router, used to interpret the - routes returned from the router. | -
| SipTargetedRequestType | -Type of targeted request | -
-The javax.servlet.sip.ar package contains Application Router interfaces
-
-
- -
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
-java.lang.Object --javax.servlet.sip.ar.spi.SipApplicationRouterProvider -
public abstract class SipApplicationRouterProvider
-This class is used by the SIP Servlet container to load and instanciate the
- application router.
- The application router must be packaged in accordance with the rules specified in the
- Service Provider
- document. Specifically, the jar file containing the application router
- implementation must include META-INF/services/javax.servlet.sip.ar.spi.SipApplicationRouterProvider
- file. The contents of the file indicate the name of the concrete public subclass
- of the SipApplicationRouterProvider class.
- The concrete subclass must have a no-arg public constructor.
- As specified by the Service Provider
- framework, the providers may be installed by :
-
- public class AcmeAppRouter implements SipApplicationRouter {
- [...]
- }
-
- public class AcmeAppRouterProvider extends SipApplicationRouterProvider {
- private final AcmeAppRouter appRouter = new AcmeAppRouter();
- public AcmeAppRouterProvider() {
- }
- public SipApplicationRouter getSipApplicationRouter() {
- return appRouter;
- }
- }
-
- The AcmeAppRouter is then packaged in a jar file and prepended to
- the system class path. The SIP servlet container can look up the application
- router in a manner outlined below.
- SipApplicationRouter getSipApplicationRouter() {
- Iterator ps = Service.providers(SipApplicationRouterProvider.class);
- while (ps.hasNext()) {
- SipApplicationRouterProvider p = (SipApplicationRouterProvider)ps.next();
- return p.getSipApplicationRouter();
- }
- return null;
- }
- Since the SIP servlet specification allows for only one application router to be
- active at any given time, the container selects the first provider
- available in the system classpath. javax.servlet.sip.ar.spi.SipApplicationRouterProvider
- system property can be used to override loading behavior and force a specific
- provider implementation to be used. For portability reasons, containers
- that provide their own deployment mechanism for the application router SHOULD
- obey the system property, if specified by the deployer.
-- -
-
| -Constructor Summary | -|
|---|---|
SipApplicationRouterProvider()
-
-- |
-|
| -Method Summary | -|
|---|---|
-abstract SipApplicationRouter |
-getSipApplicationRouter()
-
-- Retrieve an instance of the application router created by - this provider |
-
| Methods inherited from class java.lang.Object | -
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
-
| -Constructor Detail | -
|---|
-public SipApplicationRouterProvider()-
| -Method Detail | -
|---|
-public abstract SipApplicationRouter getSipApplicationRouter()-
-
-
-
|
-- - | -||||||||
| - PREV CLASS - NEXT CLASS | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - SUMMARY: NESTED | FIELD | CONSTR | METHOD | --DETAIL: FIELD | CONSTR | METHOD | -||||||||
|
-Classes
-
- -SipApplicationRouterProvider |
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
javax.servlet.sip.ar.spi package contains application router service
-provider interfaces.
-
-See:
-
- Description
-
- -
| -Class Summary | -|
|---|---|
| SipApplicationRouterProvider | -This class is used by the SIP Servlet container to load and instanciate the - application router. | -
-The javax.servlet.sip.ar.spi package contains application router service
-provider interfaces. These interfaces define the deployment contract between the SIP application
-server and the application router implementation
-
-
- -
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
|
-Interfaces
-
- -Address - -AuthInfo - -B2buaHelper - -ConvergedHttpSession - -Parameterable - -Proxy - -ProxyBranch - -ServletTimer - -SipApplicationSession - -SipApplicationSessionActivationListener - -SipApplicationSessionAttributeListener - -SipApplicationSessionBindingListener - -SipApplicationSessionListener - -SipErrorListener - -SipFactory - -SipServletListener - -SipServletMessage - -SipServletRequest - -SipServletResponse - -SipSession - -SipSessionActivationListener - -SipSessionAttributeListener - -SipSessionBindingListener - -SipSessionListener - -SipSessionsUtil - -SipURI - -TelURL - -TimerListener - -TimerService - -URI |
-
|
-Classes
-
- -SipApplicationSessionBindingEvent - -SipApplicationSessionEvent - -SipErrorEvent - -SipServlet - -SipServletContextEvent - -SipSessionBindingEvent - -SipSessionEvent |
-
|
-Enums
-
- -SipApplicationSession.Protocol - -SipServletMessage.HeaderForm - -SipSession.State - -UAMode |
-
|
-Exceptions
-
- -Rel100Exception - -ServletParseException - -TooManyHopsException |
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-See:
-
- Description
-
- -
| -Interface Summary | -|
|---|---|
| Address | -Represents SIP addresses as found, for example, in From, To, and - Contact headers. | -
| AuthInfo | -This interface allows applications to set the authentication information on servlet - initiated requests that are challenged by a Proxy or UAS. | -
| B2buaHelper | -Helper class providing support for B2BUA applications. | -
| ConvergedHttpSession | -The ConvergedHttpSession class provides access to HttpSession related - functionality which is only present in a converged HTTP/SIP container. | -
| Parameterable | -The Parameterable interface is used to indicate a SIP header
- field value with optional parameters. |
-
| Proxy | -Represents the operation of proxying a SIP request. | -
| ProxyBranch | -A ProxyBranch represents a branch which the Proxy sends out the
- request on. |
-
| ServletTimer | -Created by the TimerService for servlet applications
- wishing to schedule future tasks. |
-
| SipApplicationSession | -Represents application instances. | -
| SipApplicationSessionActivationListener | -Objects that are bound to a SipApplicationSession may listen to container events
- notifying them when the application session to which they are bound will be passivated or
- activated. |
-
| SipApplicationSessionAttributeListener | -This listener interface can be implemented in order to get - notifications of changes to the attribute lists of application sessions. | -
| SipApplicationSessionBindingListener | -Causes an object to be notified when it is bound to or unbound from - a SipApplicationSession. | -
| SipApplicationSessionListener | -Implementations of this interface can receive notifications about
- invalidated and/or activated SipApplicationSession objects
- in the SIP application they are part of. |
-
| SipErrorListener | -Causes applications to be notified of various error conditions - occurring during regular SIP transaction processing. | -
| SipFactory | -Factory interface for a variety of SIP Servlet API abstractions. | -
| SipServletListener | -Containers are required to invoke init() on the servlets before - the servlets are ready for service. | -
| SipServletMessage | -Defines common aspects of SIP requests and responses. | -
| SipServletRequest | -Represents SIP request messages. | -
| SipServletResponse | -Represents SIP responses. | -
| SipSession | -Represents point-to-point SIP relationships. | -
| SipSessionActivationListener | -Objects that are bound to a session may listen to container events - notifying them that sessions will be passivated and that session - will be activated. | -
| SipSessionAttributeListener | -This listener interface can be implemented in order to get - notifications of changes to the attribute lists of sessions - within this SIP servlet application. | -
| SipSessionBindingListener | -Causes an object to be notified when it is bound to or unbound from - a SipSession. | -
| SipSessionListener | -Implementations of this interface are notified of changes to the list
- of active SipSessions in a SIP servlet application. |
-
| SipSessionsUtil | -A utility class providing additional support for - converged HTTP/SIP applications and converged Java EE / SIP applications. | -
| SipURI | -Represents sip and sips URIs. |
-
| TelURL | -Represents tel URLs as defined by RFC 3966. |
-
| TimerListener | -Listener interface implemented by SIP servlet applications using timers. | -
| TimerService | -Allows SIP servlet applications to set timers in order to receive - notifications on timer expiration. | -
| URI | -Base interface for any type of URI. | -
- -
| -Class Summary | -|
|---|---|
| SipApplicationSessionBindingEvent | -Events of this type are either sent to an object that implements
- SipApplicationSessionBindingListener when it is bound or unbound from an
- application session, or to a SipApplicationSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in an application session. |
-
| SipApplicationSessionEvent | -This is the class representing event notifications for changes to
- SipApplicationSessions within a SIP servlet application. |
-
| SipErrorEvent | -Events of this type are sent to objects implementing the
- SipErrorListener interface when an error occurs which
- is related to the applications processing of a SIP transaction. |
-
| SipServlet | -Provides an abstract class to be subclassed to create a SIP servlet. | -
| SipServletContextEvent | -SIP Servlet specific context event. | -
| SipSessionBindingEvent | -Events of this type are either sent to an object that implements
- SipSessionBindingListener when it is bound or unbound from a
- session, or to a SipSessionAttributeListener that has been
- configured in the deployment descriptor when any attribute is bound,
- unbound or replaced in a session. |
-
| SipSessionEvent | -This is the class representing event notifications for changes to
- SipSessions within a SIP servlet application. |
-
- -
| -Enum Summary | -|
|---|---|
| SipApplicationSession.Protocol | -Possible protocols to which sessions contained in the
- SipApplicationSession belong to. |
-
| SipServletMessage.HeaderForm | -Type header forms. | -
| SipSession.State | -Possible SIP dialog states from SipSession FSM. | -
| UAMode | -User Agent modes, UAC (client) or UAS (server) | -
- -
| -Exception Summary | -|
|---|---|
| Rel100Exception | -Indicates that a provisional response cannot be sent reliably or PRACK was - attempted to be created on a non reliable provisional response. | -
| ServletParseException | -Thrown by the container when an application attempts to parse - a malformed header or addressing structure. | -
| TooManyHopsException | -Thrown when a SIP Servlet application attempts to obtain a
- Proxy object for a request with a Max-Forwards
- header with value 0. |
-
-The javax.servlet.sip package is the API for the SIP Servlets developed under JSR 289, this v1.1 version obsoletes v1.0. - -The Session Initiation Protocol (SIP) is used to establish, modify, and tear down IP multimedia sessions including IP telephony, presence, instant messaging besides other SIP applications . An important aspect of any communication infrastructure is programmability and the purpose of the SIP Servlet API is to standardize the platform for delivering SIP based services. SIP Servlet API is based on the Servlet API and model. This API is parallel to the HTTP Servlet API. - - - -
- -
-
-
-
|
-- - | -||||||||
| - PREV PACKAGE - NEXT PACKAGE | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| - | -
|---|
| All Classes
-
-
-Packages
- |
-
- - - diff --git a/build/jsr289-apidocs/javadocs/overview-summary.html b/build/jsr289-apidocs/javadocs/overview-summary.html deleted file mode 100644 index f05bcb063e..0000000000 --- a/build/jsr289-apidocs/javadocs/overview-summary.html +++ /dev/null @@ -1,164 +0,0 @@ - - - -
- -
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Packages | -|
|---|---|
| javax.servlet.sip | -The javax.servlet.sip package is the API for the SIP Servlets developed under JSR 289, this v1.1 version obsoletes v1.0. | -
| javax.servlet.sip.annotation | -The javax.servlet.sip.annotation package contains SIP Servlet annotation definitions | -
| javax.servlet.sip.ar | -The javax.servlet.sip.ar package contains Application Router interfaces |
-
| javax.servlet.sip.ar.spi | -The javax.servlet.sip.ar.spi package contains application router service
-provider interfaces. |
-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||
| -Package javax.servlet.sip | -
|---|
| -Class javax.servlet.sip.Rel100Exception extends javax.servlet.ServletException implements Serializable | -
|---|
| -Serialized Fields | -
|---|
-int reason-
-
| -Class javax.servlet.sip.ServletParseException extends javax.servlet.ServletException implements Serializable | -
|---|
- -
| -Class javax.servlet.sip.SipApplicationSessionBindingEvent extends java.util.EventObject implements Serializable | -
|---|
| -Serialized Fields | -
|---|
-java.lang.String name-
-
| -Class javax.servlet.sip.SipApplicationSessionEvent extends java.util.EventObject implements Serializable | -
|---|
- -
| -Class javax.servlet.sip.SipErrorEvent extends java.util.EventObject implements Serializable | -
|---|
| -Serialized Fields | -
|---|
-SipServletRequest request-
-SipServletResponse response-
| -Class javax.servlet.sip.SipServlet extends javax.servlet.GenericServlet implements Serializable | -
|---|
- -
| -Class javax.servlet.sip.SipServletContextEvent extends javax.servlet.ServletContextEvent implements Serializable | -
|---|
| -Serialized Fields | -
|---|
-SipServlet servlet-
| -Class javax.servlet.sip.SipSessionBindingEvent extends java.util.EventObject implements Serializable | -
|---|
| -Serialized Fields | -
|---|
-java.lang.String name-
-
| -Class javax.servlet.sip.SipSessionEvent extends java.util.EventObject implements Serializable | -
|---|
- -
| -Class javax.servlet.sip.TooManyHopsException extends javax.servlet.ServletException implements Serializable | -
|---|
-
| -Package javax.servlet.sip.ar | -
|---|
| -Class javax.servlet.sip.ar.SipApplicationRoutingRegion extends java.lang.Object implements Serializable | -
|---|
-serialVersionUID: -7233928008846863057L - -
| -Serialized Fields | -
|---|
-SipApplicationRoutingRegionType type-
-java.lang.String label-
-
-
-
|
-- - | -||||||||
| - PREV - NEXT | -- FRAMES - NO FRAMES - - - - - | -||||||||