Skip navigation links
A B C D E G I J L N O P R S T U V
A
- addAcceptLanguage(Locale) - Method in interface javax.servlet.sip.SipServletMessage
- Adds an acceptable
Locale
of this user agent.
- addAddressHeader(String, Address, boolean) - Method in interface javax.servlet.sip.SipServletMessage
- Adds the specified
Address
as a new value of the named header field.
- addAuthHeader(SipServletResponse, AuthInfo) - Method in interface javax.servlet.sip.SipServletRequest
- This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response.
- addAuthHeader(SipServletResponse, String, String) - Method in interface javax.servlet.sip.SipServletRequest
- 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.
- addAuthInfo(int, String, String, String) - Method in interface javax.servlet.sip.AuthInfo
- Helper method to add authentication info into the AuthInfo object for a challenge response of a specific type (401/407) and realm.
- addHeader(String, String) - Method in interface javax.servlet.sip.SipServletMessage
- Adds a header with the given name and value.
- addParameterableHeader(String, Parameterable, boolean) - Method in interface javax.servlet.sip.SipServletMessage
- Adds the specified
Parameterable
as a new value of the named header field.
- Address - Interface in javax.servlet.sip
- Represents SIP addresses as found, for example, in From, To, and Contact headers.
- applicationDeployed(List<String>) - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- Container notifies application router that new applications are deployed.
- applicationUndeployed(List<String>) - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- Container notifies application router that some applications are undeployed.
- attributeAdded(SipApplicationSessionBindingEvent) - Method in interface javax.servlet.sip.SipApplicationSessionAttributeListener
- Notification that an attribute has been added to an application session.
- attributeAdded(SipSessionBindingEvent) - Method in interface javax.servlet.sip.SipSessionAttributeListener
- Notification that an attribute has been added to a session.
- attributeRemoved(SipApplicationSessionBindingEvent) - Method in interface javax.servlet.sip.SipApplicationSessionAttributeListener
- Notification that an attribute has been removed from an application session.
- attributeRemoved(SipSessionBindingEvent) - Method in interface javax.servlet.sip.SipSessionAttributeListener
- Notification that an attribute has been removed from a session.
- attributeReplaced(SipApplicationSessionBindingEvent) - Method in interface javax.servlet.sip.SipApplicationSessionAttributeListener
- Notification that an attribute has been replaced in an application session.
- attributeReplaced(SipSessionBindingEvent) - Method in interface javax.servlet.sip.SipSessionAttributeListener
- Notification that an attribute has been replaced in a session.
- AuthInfo - Interface in javax.servlet.sip
- This interface allows applications to set the authentication information on servlet initiated requests that are challenged by a Proxy or UAS.
B
- B2buaHelper - Interface in javax.servlet.sip
- Helper class providing support for B2BUA applications.
C
- cancel() - Method in interface javax.servlet.sip.Proxy
- Cancels this proxy transaction and any of its child branches if recursion was enabled.
- cancel(String[], int[], String[]) - Method in interface javax.servlet.sip.Proxy
- This overloaded method of
Proxy.cancel()
provides a way to specify the reason for cancelling this Proxy
by including the appropriate Reason headers [RFC 3326].
- cancel() - Method in interface javax.servlet.sip.ProxyBranch
- Cancels this branch and all the child branches if recursion is enabled and sends a CANCEL to the proxied INVITEs.
- cancel(String[], int[], String[]) - Method in interface javax.servlet.sip.ProxyBranch
- This overloaded method of
ProxyBranch.cancel()
provides a way to specify the reason for cancelling this branch by including the appropriate Reason headers [RFC 3326].
- cancel() - Method in interface javax.servlet.sip.ServletTimer
- Cancels this timer.
- clone() - Method in interface javax.servlet.sip.Address
- Returns a clone of this
Address
.
- clone() - Method in interface javax.servlet.sip.Parameterable
- Returns a clone of this
Parameterable
.
- clone() - Method in interface javax.servlet.sip.URI
- Returns a clone of this URI.
- ConvergedHttpSession - Interface in javax.servlet.sip
- The ConvergedHttpSession class provides access to HttpSession related functionality which is only present in a converged HTTP/SIP container.
- createAck() - Method in interface javax.servlet.sip.SipServletResponse
- Returns an ACK request object corresponding to this response.
- createAddress(String) - Method in interface javax.servlet.sip.SipFactory
- Returns a
Address
corresponding to the specified string.
- createAddress(URI) - Method in interface javax.servlet.sip.SipFactory
- Returns an
Address
with the specified URI and no display name.
- createAddress(URI, String) - Method in interface javax.servlet.sip.SipFactory
- Returns a new
Address
with the specified URI
and display name.
- createApplicationSession() - Method in interface javax.servlet.sip.SipFactory
- Returns a new
SipApplicationSession
.
- createApplicationSessionByKey(String) - Method in interface javax.servlet.sip.SipFactory
- Returns a new
SipApplicationSession
identified by the specified SipApplicationKey.
- createAuthInfo() - Method in interface javax.servlet.sip.SipFactory
- Creates a new AuthInfo object that can be used to provide authentication information on servlet initiated requests.
- createCancel(SipSession) - Method in interface javax.servlet.sip.B2buaHelper
- Creates a new CANCEL request to cancel the initial request sent on the other leg.
- createCancel() - Method in interface javax.servlet.sip.SipServletRequest
- Returns a CANCEL request object.
- createParameterable(String) - Method in interface javax.servlet.sip.SipFactory
- Creates a new
Parameterable
parsed from the specified string.
- createPrack() - Method in interface javax.servlet.sip.SipServletResponse
- Creates a PRACK request object corresponding to this response.
- createProxyBranches(List<? extends URI>) - Method in interface javax.servlet.sip.Proxy
- Returns the list of
ProxyBranch
objects given a set of targets.
- createRequest(SipServletRequest, boolean, Map<String, List<String>>) - Method in interface javax.servlet.sip.B2buaHelper
- Creates a new request object belonging to a new SipSession.
- createRequest(SipServletRequest) - Method in interface javax.servlet.sip.B2buaHelper
- Creates a new request object belonging to a new SipSession.
- createRequest(SipSession, SipServletRequest, Map<String, List<String>>) - Method in interface javax.servlet.sip.B2buaHelper
- Creates a new subsequent request based on the specified original request.
- createRequest(SipApplicationSession, String, Address, Address) - Method in interface javax.servlet.sip.SipFactory
- Returns a new request object with the specified request method, From, and To headers.
- createRequest(SipApplicationSession, String, URI, URI) - Method in interface javax.servlet.sip.SipFactory
- Returns a new request object with the specified request method, From, and To headers.
- createRequest(SipApplicationSession, String, String, String) - Method in interface javax.servlet.sip.SipFactory
- Returns a new request object with the specified request method, From, and To headers.
- createRequest(SipServletRequest, boolean) - Method in interface javax.servlet.sip.SipFactory
- 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)
- createRequest(String) - Method in interface javax.servlet.sip.SipSession
- Returns a new request object.
- createResponse(int) - Method in interface javax.servlet.sip.SipServletRequest
- Creates a response for this request with the specifies status code.
- createResponse(int, String) - Method in interface javax.servlet.sip.SipServletRequest
- Creates a response for this request with the specifies status code and reason phrase.
- createResponseToOriginalRequest(SipSession, int, String) - Method in interface javax.servlet.sip.B2buaHelper
- 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.
- createSipURI(String, String) - Method in interface javax.servlet.sip.SipFactory
- Constructs a
SipURI
with the specified user and host components.
- createTimer(SipApplicationSession, long, boolean, Serializable) - Method in interface javax.servlet.sip.TimerService
- Creates a one-time
ServletTimer
and schedules it to expire after the specified delay.
- createTimer(SipApplicationSession, long, long, boolean, boolean, Serializable) - Method in interface javax.servlet.sip.TimerService
- Creates a repeating
ServletTimer
and schedules it to expire after the specified delay and then again at approximately regular intervals.
- createURI(String) - Method in interface javax.servlet.sip.SipFactory
- Returns a
URI
object corresponding to the specified string, which should represent an escaped SIP, SIPS, or tel URI.
D
- destroy() - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- Container calls this method when it finishes using this application router.
- doAck(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming ACK requests.
- doBranchResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server to handle intermediate final responses only if this Servlet behaves as a proxy.
- doBye(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming BYE requests.
- doCancel(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming CANCEL requests.
- doErrorResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the doResponse method) to handle incoming 4xx - 6xx class responses.
- doInfo(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming INFO requests.
- doInvite(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming INVITE requests.
- doMessage(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming MESSAGE requests.
- doNotify(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming NOTIFY requests.
- doOptions(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming OPTIONS requests.
- doPrack(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming PRACK requests.
- doProvisionalResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the doResponse method) to handle incoming 1xx class responses.
- doPublish(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming PUBLISH requests.
- doRedirectResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server to notify the servlet of incoming 3xx class responses.
- doRefer(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming REFER requests.
- doRegister(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming REGISTER requests.
- doRequest(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked to handle incoming requests.
- doResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked to handle incoming responses.
- doSubscribe(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming SUBSCRIBE requests.
- doSuccessResponse(SipServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the doResponse method) to handle incoming 2xx class responses.
- doUpdate(SipServletRequest) - Method in class javax.servlet.sip.SipServlet
- Invoked by the server (via the service method) to handle incoming UPDATE requests.
E
- encodeURI(URI) - Method in interface javax.servlet.sip.SipApplicationSession
- 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.
- encodeURL(String) - Method in interface javax.servlet.sip.ConvergedHttpSession
- This method encodes the HTTP URL with the jsessionid.
- encodeURL(String, String) - Method in interface javax.servlet.sip.ConvergedHttpSession
- 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.
- encodeURL(URL) - Method in interface javax.servlet.sip.SipApplicationSession
- 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.
- equals(Object) - Method in interface javax.servlet.sip.Address
- Compares the given Address with this one.
- equals(Object) - Method in interface javax.servlet.sip.Parameterable
- Compares the given Parameterable with this one.
- equals(Object) - Method in interface javax.servlet.sip.SipURI
- Compares the given SipURI with this SipURI.
- equals(Object) - Method in interface javax.servlet.sip.TelURL
- Compares the given TelURL with this TelURL.
- equals(Object) - Method in interface javax.servlet.sip.URI
- Compares the given URI with this URI.
G
- getAcceptLanguage() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the preferred
Locale
that the UA originating this message will accept content in, based on the Accept-Language header.
- getAcceptLanguages() - Method in interface javax.servlet.sip.SipServletMessage
- 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.
- getAddressHeader(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the specified header as a
Address
object.
- getAddressHeaders(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns a
ListIterator
over all Address
header field values for the specified header.
- getAddToPath() - Method in interface javax.servlet.sip.Proxy
- Returns true if subsequent invocations of
proxyTo(URI)
or startProxy()
will add a Path header to the proxied request, false otherwise.
- getAddToPath() - Method in interface javax.servlet.sip.ProxyBranch
- Returns true if subsequent invocations of
startProxy()
will add a Path header to the proxied request, false otherwise.
- getApplicationName() - Method in class javax.servlet.sip.ar.SipTargetedRequestInfo
-
- getApplicationName() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the name of the SIP application this
SipApplicationSession
is associated with.
- getApplicationSession() - Method in interface javax.servlet.sip.ConvergedHttpSession
- 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.
- getApplicationSession() - Method in interface javax.servlet.sip.ServletTimer
- Returns the application session associated with this
ServletTimer
.
- getApplicationSession() - Method in class javax.servlet.sip.SipApplicationSessionBindingEvent
- Returns the application session to or from which the object is bound or unbound.
- getApplicationSession() - Method in class javax.servlet.sip.SipApplicationSessionEvent
- Returns the expired session object.
- getApplicationSession() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the application session to which this message belongs.
- getApplicationSession(boolean) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the app session to which this message belongs.
- getApplicationSession() - Method in interface javax.servlet.sip.SipSession
- Returns the application session with which this
SipSession
is associated.
- getApplicationSessionById(String) - Method in interface javax.servlet.sip.SipSessionsUtil
- Returns the SipApplicationSession for a given applicationSessionId.
- getApplicationSessionByKey(String, boolean) - Method in interface javax.servlet.sip.SipSessionsUtil
- Returns the SipApplicationSession for a given session
applicationSessionKey
.
- getAttribute(String) - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the object bound with the specified name in this session, or null if no object is bound under the name.
- getAttribute(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
- getAttribute(String) - Method in interface javax.servlet.sip.SipSession
- Returns the object bound with the specified name in this session, or null if no object is bound under the name.
- getAttributeNames() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns an
Iterator
over the String
objects containing the names of all the objects bound to this session.
- getAttributeNames() - Method in interface javax.servlet.sip.SipServletMessage
- Returns an
Enumeration
containing the names of the attributes available to this message object.
- getAttributeNames() - Method in interface javax.servlet.sip.SipSession
- Returns an
Enumeration
over the String
objects containing the names of all the objects bound to this session.
- getB2buaHelper() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the B2buaHelper associated with this request.
- getCallId() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the Call-ID header in this
SipServletMessage
.
- getCallId() - Method in interface javax.servlet.sip.SipSession
- Returns the Call-ID for this
SipSession
.
- getChallengeRealms() - Method in interface javax.servlet.sip.SipServletResponse
- Returns an
Iterator
over all the realms associated with this challenge response.
- getCharacterEncoding() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the name of the charset used for the MIME body sent in this message.
- getContent() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the content as a Java object.
- getContentLanguage() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the locale of this message.
- getContentLength() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the length in number of bytes of the content part of this message.
- getContentType() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the Content-Type header field.
- getCorrespondingSipSession(SipSession, String) - Method in interface javax.servlet.sip.SipSessionsUtil
- Returns related SipSession.
- getCreationTime() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
- getCreationTime() - Method in interface javax.servlet.sip.SipSession
- Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
- getDisplayName() - Method in interface javax.servlet.sip.Address
- Returns the display name of this
Address
.
- getExpirationTime() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the time in future when this SipApplicationSession will expire.
- getExpires() - Method in interface javax.servlet.sip.Address
- Returns the value of the "expires" parameter as delta-seconds.
- getExpires() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the Expires header.
- getFrom() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the From header.
- getHeader(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the specified header as a
String
.
- getHeader(String) - Method in interface javax.servlet.sip.SipURI
- Returns the value of the specified header.
- getHeaderForm() - Method in interface javax.servlet.sip.SipServletMessage
-
- getHeaderNames() - Method in interface javax.servlet.sip.SipServletMessage
- Returns an
Iterator
over all the header names this message contains.
- getHeaderNames() - Method in interface javax.servlet.sip.SipURI
- Returns an
Iterator
over the names of all headers present in this SipURI
.
- getHeaders(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns all the values of the specified header as a ListIterator over a number of
String
objects.
- getHost() - Method in interface javax.servlet.sip.SipURI
- Returns the host part of this
SipURI
.
- getId() - Method in interface javax.servlet.sip.ServletTimer
- Returns a string containing the unique identifier assigned to this timer task.
- getId() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns a string containing the unique identifier assigned to this session.
- getId() - Method in interface javax.servlet.sip.SipSession
- Returns a string containing the unique identifier assigned to this session.
- getInfo() - Method in interface javax.servlet.sip.ServletTimer
- Get the information associated with the timer at the time of creation.
- getInitialPoppedRoute() - Method in interface javax.servlet.sip.SipServletRequest
- 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.
- getInitialRemoteAddr() - Method in interface javax.servlet.sip.SipServletMessage
- 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.
- getInitialRemotePort() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the port number of the upstream/downstream hop from which this message initially received by the container.
- getInitialTransport() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the name of the protocol with which this message was initially received by the container, e.g.
- getInputStream() - Method in interface javax.servlet.sip.SipServletRequest
- Always returns null.
- getInvalidateWhenReady() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns true if the container will notify the application when this
SipApplicationSession
is in the ready-to-invalidate state.
- getInvalidateWhenReady() - Method in interface javax.servlet.sip.SipSession
- Returns true if the container will notify the application when this
SipSession
is in the ready-to-invalidate state.
- getLabel() - Method in class javax.servlet.sip.ar.SipApplicationRoutingRegion
- Each routing region has a String label.
- getLastAccessedTime() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the last time an event occurred on this application session.
- getLastAccessedTime() - Method in interface javax.servlet.sip.SipSession
- Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT.
- getLinkedSession(SipSession) - Method in interface javax.servlet.sip.B2buaHelper
- Returns the other SipSession that is linked to the specified SipSession, or null if none.
- getLinkedSipServletRequest(SipServletRequest) - Method in interface javax.servlet.sip.B2buaHelper
- If a new request is created based on an existing one with the link argument true using
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.
- getLocalAddr() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the IP address of the interface this message was received on.
- getLocalParty() - Method in interface javax.servlet.sip.SipSession
- Returns the
Address
identifying the local party.
- getLocalPort() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the local port this message was received on.
- getLrParam() - Method in interface javax.servlet.sip.SipURI
- Returns true if the "lr" flag parameter is set, and false otherwise.
- getMAddrParam() - Method in interface javax.servlet.sip.SipURI
- Returns the value of the "maddr" parameter, or null if this is not set.
- getMaxForwards() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the value of the Max-Forwards header.
- getMessage() - Method in class javax.servlet.sip.Rel100Exception
- Returns message phrase suitable for the reason integer code.
- getMethod() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the SIP method of this message.
- getMethodParam() - Method in interface javax.servlet.sip.SipURI
- Returns the value of the "method" parameter, or null if this is not set.
- getName() - Method in class javax.servlet.sip.SipApplicationSessionBindingEvent
- Returns the name with which the object is bound to or unbound from the application session.
- getName() - Method in class javax.servlet.sip.SipSessionBindingEvent
- Returns the name with which the object is bound to or unbound from the session.
- getNextApplication(SipServletRequest, SipApplicationRoutingRegion, SipApplicationRoutingDirective, SipTargetedRequestInfo, Serializable) - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- This method is called by the container when a servlet sends or proxies an initial SipServletRequest.
- getNextApplicationName() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
-
- getNoCancel() - Method in interface javax.servlet.sip.Proxy
- Returns
true
if the proxy will not cancel outstanding branches upon receiving the first 2xx INVITE response as in RFC 3841
- getOriginalRequest() - Method in interface javax.servlet.sip.Proxy
- Returns the request received from the upstream caller.
- getOutputStream() - Method in interface javax.servlet.sip.SipServletResponse
- Always returns null.
- getParallel() - Method in interface javax.servlet.sip.Proxy
- Returns true if this proxy object is set to proxy in parallel, or false if it is set to proxy sequentially.
- getParameter(String) - Method in interface javax.servlet.sip.Parameterable
- Returns the value of the named parameter, or null if it is not set.
- getParameter(String) - Method in interface javax.servlet.sip.URI
- Returns the value of the named parameter, or null if it is not set.
- getParameterableHeader(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the specified header field as a
Parameterable
object.
- getParameterableHeaders(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns a
ListIterator
over all Parameterable
header field values for the specified header name.
- getParameterNames() - Method in interface javax.servlet.sip.Parameterable
- Returns an
Iterator
of the names of all parameters contained in this object.
- getParameterNames() - Method in interface javax.servlet.sip.URI
- Returns an
Iterator
over the names of all parameters present in this URI
.
- getParameters() - Method in interface javax.servlet.sip.Parameterable
- Returns a Collection view of the parameter name-value mappings contained in this Parameterable.
- getPathURI() - Method in interface javax.servlet.sip.Proxy
- Returns a
SipURI
that the application can use to add parameters to the Path header.
- getPathURI() - Method in interface javax.servlet.sip.ProxyBranch
- Returns a
SipURI
that the application can use to add parameters to the Path header.
- getPendingMessages(SipSession, UAMode) - Method in interface javax.servlet.sip.B2buaHelper
- 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.
- getPhoneContext() - Method in interface javax.servlet.sip.TelURL
- Returns the phone context of this
TelURL
for local numbers or null
if the phone number is global
- getPhoneNumber() - Method in interface javax.servlet.sip.TelURL
- Returns the phone number of this
TelURL
.
- getPoppedRoute() - Method in interface javax.servlet.sip.SipServletRequest
- If a top route header had been removed by the container upon receiving this request, then this method can be used to retrieve it.
- getPort() - Method in interface javax.servlet.sip.SipURI
- Returns the port number of this
SipURI
, or -1 if this is not set.
- getProtocol() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the name and version of the protocol of this message.
- getProxy() - Method in interface javax.servlet.sip.ProxyBranch
-
- getProxy() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the
Proxy
object associated with this request.
- getProxy(boolean) - Method in interface javax.servlet.sip.SipServletRequest
- Returns the
Proxy
object associated with this request.
- getProxy() - Method in interface javax.servlet.sip.SipServletResponse
- Returns the
Proxy
object associated with the transaction of this SIP response object.
- getProxyBranch(URI) - Method in interface javax.servlet.sip.Proxy
- Any branch has a primary URI associated with it, using which it was created.
- getProxyBranch() - Method in interface javax.servlet.sip.SipServletResponse
- Retruns the
ProxyBranch
object associated with the transaction of this SIP response object.
- getProxyBranches() - Method in interface javax.servlet.sip.Proxy
- More than one branches are associated with a proxy when
Proxy.proxyTo(List)
or Proxy.createProxyBranches(List)
is used.
- getProxyBranchTimeout() - Method in interface javax.servlet.sip.ProxyBranch
- Returns the current value of the search timeout associated with this
ProxyBranch
object.
- getProxyTimeout() - Method in interface javax.servlet.sip.Proxy
- The current value of the overall proxy timeout value.
- getQ() - Method in interface javax.servlet.sip.Address
- Returns the value of the "q" parameter of this
Address
.
- getRawContent() - Method in interface javax.servlet.sip.SipServletMessage
- Returns message content as a byte array.
- getReader() - Method in interface javax.servlet.sip.SipServletRequest
- Always returns null.
- getReason() - Method in class javax.servlet.sip.Rel100Exception
- Returns an integer code indicating the specific reason why this exception was thrown.
- getReasonPhrase() - Method in interface javax.servlet.sip.SipServletResponse
- Returns the reason phrase for this response object.
- getRecordRoute() - Method in interface javax.servlet.sip.Proxy
- Returns true if subsequent invocations of
proxyTo(URI)
will add a Record-Route header to the proxied request, false otherwise.
- getRecordRoute() - Method in interface javax.servlet.sip.ProxyBranch
- Returns true if subsequent invocations of
proxyTo(URI)
will add a Record-Route header to the proxied request, false otherwise.
- getRecordRouteURI() - Method in interface javax.servlet.sip.Proxy
- Returns a
SipURI
that the application can use to add parameters to the Record-Route header.
- getRecordRouteURI() - Method in interface javax.servlet.sip.ProxyBranch
- Returns a
SipURI
that the application can use to add parameters to the Record-Route header.
- getRecurse() - Method in interface javax.servlet.sip.Proxy
- Returns true if this proxy object is set to recurse, or false otherwise.
- getRecurse() - Method in interface javax.servlet.sip.ProxyBranch
- Returns true if this proxy branch object is set to recurse, or false otherwise.
- getRecursedProxyBranches() - Method in interface javax.servlet.sip.ProxyBranch
- Receipt of a 3xx class redirect response on a branch can result in recursed branches if the proxy or the branch has recursion enabled.
- getRegion() - Method in interface javax.servlet.sip.SipServletRequest
- This method allows the application to obtain the region it was invoked in for this SipServletRequest.
- getRegion() - Method in interface javax.servlet.sip.SipSession
- This method allows the application to obtain the region it was invoked in for this SipSession.
- getRemoteAddr() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the IP address of the next upstream/downstream hop from which this message was received.
- getRemoteParty() - Method in interface javax.servlet.sip.SipSession
- Returns the
Address
identifying the remote party.
- getRemotePort() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the port number of the next upstream/downstream hop from which this message was received.
- getRemoteUser() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the login of the user sending this message, if the user has been authenticated, or null if the user has not been authenticated.
- getRequest() - Method in interface javax.servlet.sip.ProxyBranch
- Returns the request associated with this branch.
- getRequest() - Method in class javax.servlet.sip.SipErrorEvent
- Returns the request object associated with this
SipErrorEvent
.
- getRequest() - Method in interface javax.servlet.sip.SipServletResponse
- Returns the request associated with this response.
- getRequestURI() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the request URI of this request.
- getResponse() - Method in interface javax.servlet.sip.ProxyBranch
- Returns the last response received on this branch.
- getResponse() - Method in class javax.servlet.sip.SipErrorEvent
- Returns the response object associated with this
SipErrorEvent
.
- getRouteModifier() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
-
- getRoutes() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
- An array of SIP routes of the same type (internal or external).
- getRoutingDirective() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the
SipApplicationRoutingDirective
associated with this request.
- getRoutingRegion() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
-
- getScheme() - Method in interface javax.servlet.sip.URI
- Returns the scheme of this
URI
, for example "sip", "sips" or "tel".
- getSequentialSearchTimeout() - Method in interface javax.servlet.sip.Proxy
- Deprecated. use a more general purpose
Proxy.getProxyTimeout()
- getServletContext() - Method in interface javax.servlet.sip.SipSession
- Returns the ServletContext to which this session belongs.
- getSession(String, SipApplicationSession.Protocol) - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the session object with the specified id associated with the specified protocol belonging to this application session, or null if not found.
- getSession() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the
SipSession
to which this message belongs.
- getSession(boolean) - Method in interface javax.servlet.sip.SipServletMessage
- Returns the
SipSession
to which this message belongs.
- getSession() - Method in class javax.servlet.sip.SipSessionBindingEvent
- Returns the session to or from which the object is bound or unbound.
- getSession() - Method in class javax.servlet.sip.SipSessionEvent
- Returns the session that changed.
- getSessions() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns an
Iterator
over all valid "protocol" sessions associated with this application session.
- getSessions(String) - Method in interface javax.servlet.sip.SipApplicationSession
- Returns an
Iterator
over all valid "protocol" session objects associated with the specified protocol associated with this application session.
- getSipApplicationRouter() - Method in class javax.servlet.sip.ar.spi.SipApplicationRouterProvider
- Retrieve an instance of the application router created by this provider
- getSipServlet() - Method in class javax.servlet.sip.SipServletContextEvent
- Returns the servlet associated with the event
SipServletContextEvent
.
- getSipSession(String) - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the
SipSession
with the specified id belonging to this application session, or null if not found.
- getState() - Method in interface javax.servlet.sip.SipSession
- Returns the current SIP dialog state, which is one of INITIAL, EARLY, CONFIRMED, or TERMINATED.
- getStateful() - Method in interface javax.servlet.sip.Proxy
- Deprecated. stateless proxy is no longer supported
- getStateInfo() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
-
- getStatus() - Method in interface javax.servlet.sip.SipServletResponse
- Returns the status code of this response object.
- getSubscriberURI() - Method in class javax.servlet.sip.ar.SipApplicationRouterInfo
-
- getSubscriberURI() - Method in interface javax.servlet.sip.SipServletRequest
- Returns the URI of the subscriber for which this application is invoked to serve.
- getSubscriberURI() - Method in interface javax.servlet.sip.SipSession
- Returns the URI of the subscriber for which this application is invoked to serve.
- getSupervised() - Method in interface javax.servlet.sip.Proxy
- Returns true if the controlling servlet will be invoked on incoming responses for this proxying operation, and false otherwise.
- getTimer(String) - Method in interface javax.servlet.sip.SipApplicationSession
- Returns the active timer identified by a specific id that is associated with this application session.
- getTimeRemaining() - Method in interface javax.servlet.sip.ServletTimer
- Get the number of milliseconds that will elapse before the next scheduled timer expiration.
- getTimers() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns all active timers associated with this application session.
- getTo() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the value of the To header.
- getTransport() - Method in interface javax.servlet.sip.SipServletMessage
- Returns the name of the protocol with which this message was received, e.g.
- getTransportParam() - Method in interface javax.servlet.sip.SipURI
- Returns the value of the "transport" parameter, or null if this is not set.
- getTTLParam() - Method in interface javax.servlet.sip.SipURI
- Returns the value of the "ttl" parameter, or -1 if this is not set.
- getType() - Method in class javax.servlet.sip.ar.SipApplicationRoutingRegion
- Each routing region is either ORIGINATING, TERMINATING, or NEUTRAL type.
- getType() - Method in class javax.servlet.sip.ar.SipTargetedRequestInfo
-
- getURI() - Method in interface javax.servlet.sip.Address
- Returns the
URI
component of this Address
.
- getUser() - Method in interface javax.servlet.sip.SipURI
- Returns the user part of this
SipURI
.
- getUserParam() - Method in interface javax.servlet.sip.SipURI
- Returns the value of the "user" parameter, or null if this is not set.
- getUserPassword() - Method in interface javax.servlet.sip.SipURI
- Returns the password of this
SipURI
, or null if this is not set.
- getUserPrincipal() - Method in interface javax.servlet.sip.SipServletMessage
- Returns a
java.security.Principal
object containing the name of the authenticated user agent sending this message.
- getValue() - Method in interface javax.servlet.sip.Parameterable
- Returns the field value as a string.
- getWriter() - Method in interface javax.servlet.sip.SipServletResponse
- Always returns null.
I
- init() - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- Initializes the SipApplicationRouter.
- init(Properties) - Method in interface javax.servlet.sip.ar.SipApplicationRouter
- Initializes the SipApplicationRouter and passes in initialization properties.
- invalidate() - Method in interface javax.servlet.sip.SipApplicationSession
- Invalidates this application session and unbinds any objects bound to it.
- invalidate() - Method in interface javax.servlet.sip.SipSession
- Invalidates this session and unbinds any objects bound to it.
- isBranchResponse() - Method in interface javax.servlet.sip.SipServletResponse
- Returns true if this is an intermediate final response that arrived on a
ProxyBranch
.
- isCommitted() - Method in interface javax.servlet.sip.SipServletMessage
- 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.
- isGlobal() - Method in interface javax.servlet.sip.TelURL
- Returns true if this
TelURL
is global, and false otherwise.
- isInitial() - Method in interface javax.servlet.sip.SipServletRequest
- Returns true if this is an initial request.
- isReadyToInvalidate() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns true if this application session is in a ready-to-invalidate state.
- isReadyToInvalidate() - Method in interface javax.servlet.sip.SipSession
- Returns true if this session is in a ready-to-invalidate state.
- isSecure() - Method in interface javax.servlet.sip.SipServletMessage
- Returns a boolean indicating whether this message was received over a secure channel, such as TLS.
- isSecure() - Method in interface javax.servlet.sip.SipURI
- Returns true if this
SipURI
is secure, that is, if this it represents a sips
URI.
- isSipURI() - Method in interface javax.servlet.sip.URI
- Returns true if the scheme is "sip" or "sips", false otherwise.
- isStarted() - Method in interface javax.servlet.sip.ProxyBranch
- The branch can be created using
Proxy.createProxyBranches(java.util.List)
and may be started at a later time by using Proxy.startProxy()
.
- isUserInRole(String) - Method in interface javax.servlet.sip.SipServletMessage
- Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
- isValid() - Method in interface javax.servlet.sip.SipApplicationSession
- Returns if this SipApplicationSession is valid, false otherwise.
- isValid() - Method in interface javax.servlet.sip.SipSession
- Returns true if this SipSession is valid, false otherwise.
- isWildcard() - Method in interface javax.servlet.sip.Address
- Returns true if this
Address
represents the "wildcard" contact address.
J
- javax.servlet.sip - package 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 - package javax.servlet.sip.annotation
- The javax.servlet.sip.annotation package contains SIP Servlet annotation definitions
- javax.servlet.sip.ar - package javax.servlet.sip.ar
- The
javax.servlet.sip.ar
package contains Application Router interfaces
- javax.servlet.sip.ar.spi - package javax.servlet.sip.ar.spi
- The
javax.servlet.sip.ar.spi
package contains application router service provider interfaces.
L
- linkSipSessions(SipSession, SipSession) - Method in interface javax.servlet.sip.B2buaHelper
- Links the specified sessions, such that there is a 1-1 mapping between them.
- log(String) - Method in class javax.servlet.sip.SipServlet
- Writes the specified message to a servlet log file.
- log(String, Throwable) - Method in class javax.servlet.sip.SipServlet
- Writes an explanatory message and a stack trace for a given
Throwable
exception to the servlet log file.
N
- NEUTRAL_REGION - Static variable in class javax.servlet.sip.ar.SipApplicationRoutingRegion
- The NEUTRAL region contains applications that do not service a specific subscriber.
- NO_REQ_SUPPORT - Static variable in class javax.servlet.sip.Rel100Exception
- Reason code indicating that the UAC didn't indicate support for the reliable responses extension in the request.
- noAckReceived(SipErrorEvent) - Method in interface javax.servlet.sip.SipErrorListener
- 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.
- noPrackReceived(SipErrorEvent) - Method in interface javax.servlet.sip.SipErrorListener
- Invoked by the servlet container for applications acting as a UAS when no PRACK was received for a previously sent reliable provisional response.
- NOT_100rel - Static variable in class javax.servlet.sip.Rel100Exception
- Reason code indicating that
SipServletResponse.createPrack()
was invoked on a provisional response that is not reliable.
- NOT_1XX - Static variable in class javax.servlet.sip.Rel100Exception
- Reason code indicating that
SipServletResponse.sendReliably()
or SipServletResponse.createPrack()
was invoked on a final or a 100 response.
- NOT_INVITE - Static variable in class javax.servlet.sip.Rel100Exception
- Reason code indicating that
SipServletResponse.sendReliably()
or SipServletResponse.createPrack()
was invoked for a response to a non-INVITE request.
- NOT_SUPPORTED - Static variable in class javax.servlet.sip.Rel100Exception
- Reason code indicating that the container does not support reliable provisional response.
O
- ORIGINATING_REGION - Static variable in class javax.servlet.sip.ar.SipApplicationRoutingRegion
- The ORIGINATING region contains applications that service the caller.
- OUTBOUND_INTERFACES - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.outboundInterfaces".
P
- Parameterable - Interface in javax.servlet.sip
- The
Parameterable
interface is used to indicate a SIP header field value with optional parameters.
- PRACK_SUPPORTED - Static variable in class javax.servlet.sip.SipServlet
- Deprecated. in favor of using the "javax.servlet.sip.supported" attribute
- Proxy - Interface in javax.servlet.sip
- Represents the operation of proxying a SIP request.
- ProxyBranch - Interface in javax.servlet.sip
- A
ProxyBranch
represents a branch which the Proxy sends out the request on.
- proxyTo(URI) - Method in interface javax.servlet.sip.Proxy
- Proxies a SIP request to the specified destination.
- proxyTo(List<? extends URI>) - Method in interface javax.servlet.sip.Proxy
- Proxies a SIP request to the specified set of destinations.
- pushPath(Address) - Method in interface javax.servlet.sip.SipServletRequest
- Adds a Path header field value to this request.
- pushRoute(SipURI) - Method in interface javax.servlet.sip.SipServletRequest
- Adds a Route header field value to this request.
- pushRoute(Address) - Method in interface javax.servlet.sip.SipServletRequest
- Adds a Route header field value to this request with Address argument.
R
- Rel100Exception - Class in javax.servlet.sip
- Indicates that a provisional response cannot be sent reliably or PRACK was attempted to be created on a non reliable provisional response.
- Rel100Exception(int) - Constructor for class javax.servlet.sip.Rel100Exception
- Constructs a new
Rel100Exception
with the specified error reason.
- removeAttribute(String) - Method in interface javax.servlet.sip.SipApplicationSession
- Removes the object bound with the specified name from this session.
- removeAttribute(String) - Method in interface javax.servlet.sip.SipServletMessage
- Removes the named attribute from this message.
- removeAttribute(String) - Method in interface javax.servlet.sip.SipSession
- Removes the object bound with the specified name from this session.
- removeHeader(String) - Method in interface javax.servlet.sip.SipServletMessage
- Removes the specified header.
- removeHeader(String) - Method in interface javax.servlet.sip.SipURI
- Removes the named header from this
SipURI
.
- removeParameter(String) - Method in interface javax.servlet.sip.Parameterable
- Removes the named parameter from this object.
- removeParameter(String) - Method in interface javax.servlet.sip.URI
- Removes the named parameter from this URL.
S
- SC_ACCEPTED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (202) indicating that the request has been accepted for processing, but the processing has not been completed.
- SC_ADDRESS_INCOMPLETE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (484) indicating that the server received a request with a To (Section 6.37) address or Request-URI that was incomplete.
- SC_ALTERNATIVE_SERVICE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (380) indicating alternative service.
- SC_AMBIGUOUS - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (485) indicating that the callee address provided in the request was ambiguous.
- SC_BAD_EVENT - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (489) indicating that the server did not understand the event package specified in a "Event" header field.
- SC_BAD_EXTENSION - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (420) indicating that the server did not understand the protocol extension specified in a Require (Section 6.30) header field.
- SC_BAD_GATEWAY - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_BAD_IDENTITY_INFO - Static variable in interface javax.servlet.sip.SipServletResponse
- 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).
- SC_BAD_REQUEST - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (400) indicating Bad Request.
- SC_BUSY_EVERYWHERE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_BUSY_HERE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_CALL_BEING_FORWARDED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (181) indicating the call is being forwarded.
- SC_CALL_LEG_DONE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (481) indicating Call Leg/Transaction does not exist.
- SC_CALL_QUEUED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (182) indicating the call is queued.
- SC_CONDITIONAL_REQUEST_FAILED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (412) indicating that the precondition given for the request has failed.
- SC_DECLINE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (603) indicating that the callee's machine was successfully contacted but the user explicily does not wish to or cannot participate.
- SC_DOES_NOT_EXIT_ANYWHERE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (604) indicating that the server has authoritative information that the user indicated in the To request field does not exist anywhere.
- SC_EXTENSION_REQUIRED - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_FORBIDDEN - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (403) indicating that the caller is forbidden to make such requests.
- SC_GONE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (410) indicating that the requested resource is no longer available at the server an no forwarding address is known.
- SC_INTERVAL_TOO_BRIEF - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_INVALID_IDENTITY_HEADER - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_LOOP_DETECTED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (482) indicating that the server received a request with a Via (Section 6.40) path containing itself.
- SC_MESSAGE_TOO_LARGE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (513) indicating that the server was unable to process the request since the message length exceeded its capabilities.
- SC_METHOD_NOT_ALLOWED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (405) indicating that the method specified in the Request-Line is not allowed for the address identified byt the Request-URI.
- SC_MOVED_PERMANENTLY - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (301) indicating that the callee has moved permanantly.
- SC_MOVED_TEMPORARILY - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (302) indicating that the callee has moved temporarily.
- SC_MULTIPLE_CHOICES - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (300) indicating Multiple Choices.
- SC_NOT_ACCEPTABLE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_NOT_ACCEPTABLE_ANYWHERE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_NOT_ACCEPTABLE_HERE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_NOT_FOUND - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (404) indicating that the server had definitive information that the user does not exist at the domain specified in the Request-URI.
- SC_NOT_IMPLEMENTED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (501) indicating that the server does not support the functionality required to fulfill the request.
- SC_OK - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (200) indicating the request succeeded normally.
- SC_PAYMENT_REQUIRED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (402) indicating that the caller needs to make a payment.
- SC_PRECONDITION_FAILURE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (580) indicating failure to meet certain preconditions.
- SC_PROVIDE_REFERER_IDENTITY - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (429) indicating that the referee must provide a valid Referred-By token.
- SC_PROXY_AUTHENTICATION_REQUIRED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (407) indicating that the client MUST first authenticate itself with the proxy.
- SC_REQUEST_ENTITY_TOO_LARGE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_REQUEST_PENDING - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (491) indicating that the request was received by a UAS that had a pending request within the same dialog.
- SC_REQUEST_TERMINATED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (487) indicating that the request was terminated by a BYE or CANCEL request.
- SC_REQUEST_TIMEOUT - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_REQUEST_URI_TOO_LONG - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_RINGING - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (180) indicating the server has located the callee, and callee user agent is Ringing the callee.
- SC_SECURITY_AGREEMENT_REQUIRED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (494) indicating that the client must initiate a security mechanism as defined in RFC 3329.
- SC_SERVER_INTERNAL_ERROR - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (500) indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.
- SC_SERVER_TIMEOUT - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_SERVICE_UNAVAILABLE - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (503) indicating that the server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
- SC_SESSION_INTERVAL_TOO_SMALL - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (422) indicating that a request contained a Session-Expires header field with a duration below the minimum timer for the server.
- SC_SESSION_PROGRESS - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (183) carries miscellaneous call progress information.
- SC_TEMPORARLY_UNAVAILABLE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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).
- SC_TOO_MANY_HOPS - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_TRYING - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (100) indicating the server is trying to locate the callee.
- SC_UNAUTHORIZED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (401) indicating that the caller is unauthorized to make this request.
- SC_UNDECIPHERABLE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_UNSUPPORTED_CERTIFICATE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_UNSUPPORTED_URI_SCHEME - Static variable in interface javax.servlet.sip.SipServletResponse
- 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.
- SC_USE_IDENTITY_HEADER - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (428) indicating that the request should be re-sent with an Identity header.
- SC_USE_PROXY - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (305) indicating that he call can be better handled by the specified proxy server.
- SC_VERSION_NOT_SUPPORTED - Static variable in interface javax.servlet.sip.SipServletResponse
- Status code (505) indicating that the server does not support, the SIP protocol version that was used in the request message.
- scheduledExecutionTime() - Method in interface javax.servlet.sip.ServletTimer
- Returns the scheduled expiration time of the most recent actual expiration of this timer.
- send() - Method in interface javax.servlet.sip.SipServletMessage
- Sends this
SipServletMessage
.
- send() - Method in interface javax.servlet.sip.SipServletRequest
- Causes this request to be sent.
- send() - Method in interface javax.servlet.sip.SipServletResponse
- Causes this response to be sent.
- sendReliably() - Method in interface javax.servlet.sip.SipServletResponse
- Requests that this response be sent reliably using the 100rel extension defined in RFC 3262.
- service(ServletRequest, ServletResponse) - Method in class javax.servlet.sip.SipServlet
- Invoked to handle incoming SIP messages: requests or responses.
- servletInitialized(SipServletContextEvent) - Method in interface javax.servlet.sip.SipServletListener
- Notification that the servlet was succesfully initialized
- ServletParseException - Class in javax.servlet.sip
- Thrown by the container when an application attempts to parse a malformed header or addressing structure.
- ServletParseException() - Constructor for class javax.servlet.sip.ServletParseException
- Constructs a new parse exception, without any message.
- ServletParseException(String) - Constructor for class javax.servlet.sip.ServletParseException
- Constructs a new parse exception with the specified message.
- ServletParseException(String, Throwable) - Constructor for class javax.servlet.sip.ServletParseException
- Constructs a new parse exception with the specified detail message and cause.
- ServletParseException(Throwable) - Constructor for class javax.servlet.sip.ServletParseException
- 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).
- ServletTimer - Interface in javax.servlet.sip
- Created by the
TimerService
for servlet applications wishing to schedule future tasks.
- sessionCreated(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionListener
- Notification that a session was created.
- sessionCreated(SipSessionEvent) - Method in interface javax.servlet.sip.SipSessionListener
- Notification that a
SipSession
was created.
- sessionDestroyed(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionListener
- Notification that a session was invalidated.
- sessionDestroyed(SipSessionEvent) - Method in interface javax.servlet.sip.SipSessionListener
- Notification that a
SipSession
was destroyed.
- sessionDidActivate(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionActivationListener
- Notification that the application session has just been activated.
- sessionDidActivate(SipSessionEvent) - Method in interface javax.servlet.sip.SipSessionActivationListener
- Notification that the session has just been activated.
- sessionExpired(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionListener
- Notification that an application session has expired.
- sessionReadyToInvalidate(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionListener
- Notification that a
SipApplicationSession
is in the ready-to-invalidate state.
- sessionReadyToInvalidate(SipSessionEvent) - Method in interface javax.servlet.sip.SipSessionListener
- Notification that a
SipSession
is in the ready-to-invalidate state.
- sessionWillPassivate(SipApplicationSessionEvent) - Method in interface javax.servlet.sip.SipApplicationSessionActivationListener
- Notification that the application session is about to be passivated.
- sessionWillPassivate(SipSessionEvent) - Method in interface javax.servlet.sip.SipSessionActivationListener
- Notification that the session is about to be passivated.
- setAcceptLanguage(Locale) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the preferred
Locale
that this user agent will accept content, reason phrases, warnings, etc.
- setAddressHeader(String, Address) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the header with the specified name to have the value specified by the address argument.
- setAddToPath(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether branches initiated in this proxy operation should include a Path header for the REGISTER request for this servlet container or not.
- setAddToPath(boolean) - Method in interface javax.servlet.sip.ProxyBranch
- Specifies whether this branch should include a Path header for the REGISTER request for this servlet container or not.
- setAttribute(String, Object) - Method in interface javax.servlet.sip.SipApplicationSession
- Binds an object to this session, using the name specified.
- setAttribute(String, Object) - Method in interface javax.servlet.sip.SipServletMessage
- Stores an attribute in this message.
- setAttribute(String, Object) - Method in interface javax.servlet.sip.SipSession
- Binds an object to this session, using the name specified.
- setCharacterEncoding(String) - Method in interface javax.servlet.sip.SipServletMessage
- 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.
- setContent(Object, String) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the content of this message to the specified
Object
.
- setContentLanguage(Locale) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the locale of this message, setting the headers (Content-Language and the Content-Type's charset) as appropriate.
- setContentLength(int) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the value of the Content-Length header.
- setContentType(String) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the content type of the response being sent to the client.
- setDisplayName(String) - Method in interface javax.servlet.sip.Address
- Sets the display name of this
Address
.
- setExpires(int) - Method in interface javax.servlet.sip.Address
- Sets the value of the "expires" parameter.
- setExpires(int) - Method in interface javax.servlet.sip.SipApplicationSession
- Sets the time of expiry for this application session.
- setExpires(int) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the value of the Expires header in this message.
- setHandler(String) - Method in interface javax.servlet.sip.SipSession
- Sets the handler for this
SipSession
.
- setHeader(String, String) - Method in interface javax.servlet.sip.SipServletMessage
- Sets a header with the given name and value.
- setHeader(String, String) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the specified header in this
SipURI
.
- setHeaderForm(SipServletMessage.HeaderForm) - Method in interface javax.servlet.sip.SipServletMessage
- Indicates which of the compact or long form should the headers in this message have.
- setHost(String) - Method in interface javax.servlet.sip.SipURI
- Sets the host part of this
SipURI
.
- setInvalidateWhenReady(boolean) - Method in interface javax.servlet.sip.SipApplicationSession
- Specifies whether the container should notify the application when the SipApplicationSession is in the ready-to-invalidate state as defined above.
- setInvalidateWhenReady(boolean) - Method in interface javax.servlet.sip.SipSession
- Specifies whether the container should notify the application when the SipSession is in the ready-to-invalidate state as defined above.
- setLrParam(boolean) - Method in interface javax.servlet.sip.SipURI
- Sets or removes the "lr" parameter depending on the value of the flag.
- setMAddrParam(String) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the "maddr" parameter.
- setMaxForwards(int) - Method in interface javax.servlet.sip.SipServletRequest
- Sets the value of the Max-Forwards header.
- setMethodParam(String) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the "method" parameter.
- setNoCancel(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether the proxy should, or should not cancel outstanding branches upon receiving the first 2xx INVITE response as defined in RFC 3841.
- setOutboundInterface(InetSocketAddress) - Method in interface javax.servlet.sip.Proxy
- In multi-homed environment this method can be used to select the outbound interface and port number to use for proxy branches.
- setOutboundInterface(InetAddress) - Method in interface javax.servlet.sip.Proxy
- In multi-homed environment this method can be used to select the outbound interface to use when sending requests for proxy branches.
- setOutboundInterface(InetSocketAddress) - Method in interface javax.servlet.sip.ProxyBranch
- 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.
- setOutboundInterface(InetAddress) - Method in interface javax.servlet.sip.ProxyBranch
- In multi-homed environment this method can be used to select the outbound interface to use when sending requests for this proxy branch.
- setOutboundInterface(InetSocketAddress) - Method in interface javax.servlet.sip.SipSession
- 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.
- setOutboundInterface(InetAddress) - Method in interface javax.servlet.sip.SipSession
- In multi-homed environment this method can be used to select the outbound interface to use when sending requests for this SipSession.
- setParallel(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether to proxy in parallel or sequentially.
- setParameter(String, String) - Method in interface javax.servlet.sip.Parameterable
- Sets the value of the named parameter.
- setParameter(String, String) - Method in interface javax.servlet.sip.URI
- Sets the value of the named parameter.
- setParameterableHeader(String, Parameterable) - Method in interface javax.servlet.sip.SipServletMessage
- Sets the header with the specified name to have the value specified by the address argument.
- setPhoneNumber(String) - Method in interface javax.servlet.sip.TelURL
- Sets the (global) phone number of this
TelURL
.
- setPhoneNumber(String, String) - Method in interface javax.servlet.sip.TelURL
- Sets the (local) phone number of this
TelURL
.
- setPort(int) - Method in interface javax.servlet.sip.SipURI
- Sets the port number of this
SipURI
.
- setProxyBranchTimeout(int) - Method in interface javax.servlet.sip.ProxyBranch
- Sets the search timeout value for this
ProxyBranch
object.
- setProxyTimeout(int) - Method in interface javax.servlet.sip.Proxy
- Sets the overall proxy timeout.
- setQ(float) - Method in interface javax.servlet.sip.Address
- Sets this
Address
s qvalue.
- setRecordRoute(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether branches initiated in this proxy operation should include a Record-Route header for this servlet engine or not.
- setRecordRoute(boolean) - Method in interface javax.servlet.sip.ProxyBranch
- Specifies whether this branch should include a Record-Route header for this servlet engine or not.
- setRecurse(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether the servlet engine will automatically recurse or not.
- setRecurse(boolean) - Method in interface javax.servlet.sip.ProxyBranch
- Specifies whether the servlet engine will automatically recurse or not.
- setRequestURI(URI) - Method in interface javax.servlet.sip.SipServletRequest
- Sets the request URI of this request.
- setRoutingDirective(SipApplicationRoutingDirective, SipServletRequest) - Method in interface javax.servlet.sip.SipServletRequest
- Sets the application routing directive for an outgoing request.
- setSecure(boolean) - Method in interface javax.servlet.sip.SipURI
- Sets the scheme of this URI to
sip
or sips
depending on whether the argument is true or not.
- setSequentialSearchTimeout(int) - Method in interface javax.servlet.sip.Proxy
- Deprecated. use a more general purpose
Proxy.setProxyTimeout(int)
- setStateful(boolean) - Method in interface javax.servlet.sip.Proxy
- Deprecated. stateless proxy is no longer supported
- setStatus(int) - Method in interface javax.servlet.sip.SipServletResponse
- Sets the status code of this response object.
- setStatus(int, String) - Method in interface javax.servlet.sip.SipServletResponse
- Sets the status code and reason phrase of this response object.
- setSupervised(boolean) - Method in interface javax.servlet.sip.Proxy
- Specifies whether the controlling servlet is to be invoked for incoming responses relating to this proxying.
- setTransportParam(String) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the "transport" parameter.
- setTTLParam(int) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the "ttl" parameter.
- setURI(URI) - Method in interface javax.servlet.sip.Address
- Sets the URI of this
Address
.
- setUser(String) - Method in interface javax.servlet.sip.SipURI
- Sets the user part of this
SipURI
.
- setUserParam(String) - Method in interface javax.servlet.sip.SipURI
- Sets the value of the "user" parameter.
- setUserPassword(String) - Method in interface javax.servlet.sip.SipURI
- Sets the password of this
SipURI
.
- setValue(String) - Method in interface javax.servlet.sip.Parameterable
- Set the value of the field.
- SIP_FACTORY - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.SipFactory".
- SIP_SESSIONS_UTIL - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.SipSessionsUtil".
- SipApplication - Annotation Type in javax.servlet.sip.annotation
- The @SipApplication annotation is used to create an application level annotation for a collection of SipServlets
- SipApplicationKey - Annotation Type in javax.servlet.sip.annotation
- The @SipApplicationKey annotation is used when the application wants to associate the incoming request (and SipSession) with a certain SipApplicationSession.
- SipApplicationRouter - Interface in javax.servlet.sip.ar
- This interface class specifies the API between the container and the application router.
- SipApplicationRouterInfo - Class in javax.servlet.sip.ar
- 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.
- SipApplicationRouterInfo(String, SipApplicationRoutingRegion, String, String[], SipRouteModifier, Serializable) - Constructor for class javax.servlet.sip.ar.SipApplicationRouterInfo
- Creates a SipApplicationRouterInfo object containing the information necessary for the conatiner to perform its routing decision.
- SipApplicationRouterProvider - Class in javax.servlet.sip.ar.spi
- This class is used by the SIP Servlet container to load and instanciate the application router.
- SipApplicationRouterProvider() - Constructor for class javax.servlet.sip.ar.spi.SipApplicationRouterProvider
-
- SipApplicationRoutingDirective - Enum in javax.servlet.sip.ar
- Routing directives that an application can select to qualify its actions in some cases.
- SipApplicationRoutingRegion - Class in javax.servlet.sip.ar
- A class that represents the application routing region.
- SipApplicationRoutingRegion(String, SipApplicationRoutingRegionType) - Constructor for class javax.servlet.sip.ar.SipApplicationRoutingRegion
- Deployer may define new routing region by constructing a new SipApplicationRoutingRegion object.
- SipApplicationRoutingRegionType - Enum in javax.servlet.sip.ar
- Routing regions used in the application selection process.
- SipApplicationSession - Interface in javax.servlet.sip
- Represents application instances.
- SipApplicationSession.Protocol - Enum in javax.servlet.sip
- Possible protocols to which sessions contained in the
SipApplicationSession
belong to.
- SipApplicationSessionActivationListener - Interface in javax.servlet.sip
- 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 - Interface in javax.servlet.sip
- This listener interface can be implemented in order to get notifications of changes to the attribute lists of application sessions.
- SipApplicationSessionBindingEvent - Class in javax.servlet.sip
- 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.
- SipApplicationSessionBindingEvent(SipApplicationSession, String) - Constructor for class javax.servlet.sip.SipApplicationSessionBindingEvent
- Constructs an event that notifies an object that it has been bound to or unbound from an application session.
- SipApplicationSessionBindingListener - Interface in javax.servlet.sip
- Causes an object to be notified when it is bound to or unbound from a SipApplicationSession.
- SipApplicationSessionEvent - Class in javax.servlet.sip
- This is the class representing event notifications for changes to
SipApplicationSession
s within a SIP servlet application.
- SipApplicationSessionEvent(SipApplicationSession) - Constructor for class javax.servlet.sip.SipApplicationSessionEvent
- Creates a new
SipApplicationSessionEvent
object.
- SipApplicationSessionListener - Interface in javax.servlet.sip
- Implementations of this interface can receive notifications about invalidated and/or activated
SipApplicationSession
objects in the SIP application they are part of.
- SipErrorEvent - Class in javax.servlet.sip
- 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.
- SipErrorEvent(SipServletRequest, SipServletResponse) - Constructor for class javax.servlet.sip.SipErrorEvent
- Constructs a new
SipErrorEvent
.
- SipErrorListener - Interface in javax.servlet.sip
- Causes applications to be notified of various error conditions occurring during regular SIP transaction processing.
- SipFactory - Interface in javax.servlet.sip
- Factory interface for a variety of SIP Servlet API abstractions.
- SipListener - Annotation Type in javax.servlet.sip.annotation
- The @SipListener annotation allows the application developer to specify a listener without declaring it in the deployment descriptor of the application.
- SipRouteModifier - Enum in javax.servlet.sip.ar
- Route modifiers as returned by the Application Router, used to interpret the routes returned from the router.
- SipServlet - Annotation Type in javax.servlet.sip.annotation
- The @SipServlet annotation allows for the SipServlet metadata to be declared without having to create the deployment descriptor.
- SipServlet - Class in javax.servlet.sip
- Provides an abstract class to be subclassed to create a SIP servlet.
- SipServlet() - Constructor for class javax.servlet.sip.SipServlet
-
- SipServletContextEvent - Class in javax.servlet.sip
- SIP Servlet specific context event.
- SipServletContextEvent(ServletContext, SipServlet) - Constructor for class javax.servlet.sip.SipServletContextEvent
- Constructs a new
SipServletContextEvent
.
- SipServletListener - Interface in javax.servlet.sip
- Containers are required to invoke init() on the servlets before the servlets are ready for service.
- SipServletMessage - Interface in javax.servlet.sip
- Defines common aspects of SIP requests and responses.
- SipServletMessage.HeaderForm - Enum in javax.servlet.sip
- Type header forms.
- SipServletRequest - Interface in javax.servlet.sip
- Represents SIP request messages.
- SipServletResponse - Interface in javax.servlet.sip
- Represents SIP responses.
- SipSession - Interface in javax.servlet.sip
- Represents point-to-point SIP relationships.
- SipSession.State - Enum in javax.servlet.sip
- Possible SIP dialog states from SipSession FSM.
- SipSessionActivationListener - Interface in javax.servlet.sip
- 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 - Interface in javax.servlet.sip
- This listener interface can be implemented in order to get notifications of changes to the attribute lists of sessions within this SIP servlet application.
- SipSessionBindingEvent - Class in javax.servlet.sip
- 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.
- SipSessionBindingEvent(SipSession, String) - Constructor for class javax.servlet.sip.SipSessionBindingEvent
- Constructs an event that notifies an object that it has been bound to or unbound from a session.
- SipSessionBindingListener - Interface in javax.servlet.sip
- Causes an object to be notified when it is bound to or unbound from a SipSession.
- SipSessionEvent - Class in javax.servlet.sip
- This is the class representing event notifications for changes to
SipSession
s within a SIP servlet application.
- SipSessionEvent(SipSession) - Constructor for class javax.servlet.sip.SipSessionEvent
- Construct a session event from the given source.
- SipSessionListener - Interface in javax.servlet.sip
- Implementations of this interface are notified of changes to the list of active
SipSessions
in a SIP servlet application.
- SipSessionsUtil - Interface in javax.servlet.sip
- A utility class providing additional support for converged HTTP/SIP applications and converged Java EE / SIP applications.
- SipTargetedRequestInfo - Class in javax.servlet.sip.ar
- 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.
- SipTargetedRequestInfo(SipTargetedRequestType, String) - Constructor for class javax.servlet.sip.ar.SipTargetedRequestInfo
- Creates a SipTargetedRequestInfo object containing information necessary to help the application router make its application selection decision when the request is targeted.
- SipTargetedRequestType - Enum in javax.servlet.sip.ar
- Type of targeted request
- SipURI - Interface in javax.servlet.sip
- Represents
sip
and sips
URIs.
- startProxy() - Method in interface javax.servlet.sip.Proxy
- Proxies a SIP request to the set of destinations previously specified in
Proxy.createProxyBranches(java.util.List extends javax.servlet.sip.URI>
)
.
- SUPPORTED - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.supported".
- SUPPORTED_RFCs - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.supportedRfcs".
T
- TelURL - Interface in javax.servlet.sip
- Represents
tel
URLs as defined by RFC 3966.
- TERMINATING_REGION - Static variable in class javax.servlet.sip.ar.SipApplicationRoutingRegion
- The TERMINATING region contains applications that service the callee.
- timeout(ServletTimer) - Method in interface javax.servlet.sip.TimerListener
- Notifies the listener that the specified timer has expired.
- TIMER_SERVICE - Static variable in class javax.servlet.sip.SipServlet
- The string "javax.servlet.sip.TimerService".
- TimerListener - Interface in javax.servlet.sip
- Listener interface implemented by SIP servlet applications using timers.
- TimerService - Interface in javax.servlet.sip
- Allows SIP servlet applications to set timers in order to receive notifications on timer expiration.
- TooManyHopsException - Class in javax.servlet.sip
- Thrown when a SIP Servlet application attempts to obtain a
Proxy
object for a request with a Max-Forwards header with value 0.
- TooManyHopsException() - Constructor for class javax.servlet.sip.TooManyHopsException
- Constructs a new
TooManyHopsException
exception, without any message.
- TooManyHopsException(String) - Constructor for class javax.servlet.sip.TooManyHopsException
- Constructs a new
TooManyHopsException
exception with the specified message.
- TooManyHopsException(String, Throwable) - Constructor for class javax.servlet.sip.TooManyHopsException
- Constructs a new
TooManyHopsException
exception with the specified detail message and cause.
- TooManyHopsException(Throwable) - Constructor for class javax.servlet.sip.TooManyHopsException
- 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).
- toString() - Method in interface javax.servlet.sip.Address
- Returns the value of this address as a
String
.
- toString() - Method in class javax.servlet.sip.ar.SipApplicationRoutingRegion
-
- toString() - Method in interface javax.servlet.sip.SipURI
- Returns the
String
representation of this SipURI
.
- toString() - Method in interface javax.servlet.sip.TelURL
- Returns the
String
representation of this TelURL
.
- toString() - Method in interface javax.servlet.sip.URI
- Returns the value of this
URI
as a String
.
U
- UAMode - Enum in javax.servlet.sip
- User Agent modes, UAC (client) or UAS (server)
- unlinkSipSessions(SipSession) - Method in interface javax.servlet.sip.B2buaHelper
- If the specified SipSession is linked to another session, then unlinks the two sessions from each other.
- URI - Interface in javax.servlet.sip
- Base interface for any type of URI.
V
- valueBound(SipApplicationSessionBindingEvent) - Method in interface javax.servlet.sip.SipApplicationSessionBindingListener
- Notifies the object that it is being bound to an application session and identifies the application session.
- valueBound(SipSessionBindingEvent) - Method in interface javax.servlet.sip.SipSessionBindingListener
- Notifies the object that it is being bound to a session and identifies the session.
- valueOf(String) - Static method in enum javax.servlet.sip.ar.SipApplicationRoutingDirective
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.ar.SipApplicationRoutingRegionType
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.ar.SipRouteModifier
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.ar.SipTargetedRequestType
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.SipApplicationSession.Protocol
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.SipServletMessage.HeaderForm
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.SipSession.State
- Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum javax.servlet.sip.UAMode
- Returns the enum constant of this type with the specified name.
- values() - Static method in enum javax.servlet.sip.ar.SipApplicationRoutingDirective
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.ar.SipApplicationRoutingRegionType
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.ar.SipRouteModifier
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.ar.SipTargetedRequestType
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.SipApplicationSession.Protocol
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.SipServletMessage.HeaderForm
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.SipSession.State
- Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum javax.servlet.sip.UAMode
- Returns an array containing the constants of this enum type, in the order they are declared.
- valueUnbound(SipApplicationSessionBindingEvent) - Method in interface javax.servlet.sip.SipApplicationSessionBindingListener
- Notifies the object that it is being unbound from an application session and identifies the application session.
- valueUnbound(SipSessionBindingEvent) - Method in interface javax.servlet.sip.SipSessionBindingListener
- Notifies the object that it is being unbound from a session and identifies the session.
A B C D E G I J L N O P R S T U V
Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
Java SIP Servlet API 1.1 Reference
Part Number E17883-01