Index (Mobicents Sip Servlets Client 4.0.53 API)

A C D E G H I O P R S T V

A

addAuthHeader(SipServletResponse, AuthInfo, boolean) - Method in interface org.mobicents.javax.servlet.sip.SipServletRequestExt: This method allows the addition of the appropriate authentication header(s) to the request that was challenged with a challenge response.
It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header
addAuthHeader(SipServletResponse, String, String, boolean) - Method in interface org.mobicents.javax.servlet.sip.SipServletRequestExt: 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.
It allows also to cache the credentials so that if a response containing an Authentication-Info header with a nextnonce, the credentials can be reused to generate the correct header

C

closeAllSockets() - Method in class org.mobicents.servlet.sip.SipConnector: Cleans up all cached TCP/TLS/SCTP sockets in case they are stalled.
closeReliableConnection(String, int) - Method in class org.mobicents.servlet.sip.SipConnector: Allow to close a given TCP/TLS/SCTP connection
CongestionControlEvent - Class in org.mobicents.javax.servlet: Defines a Congestion Control Event when the congestion control is triggered by the Container It allows to get the Reason whether the memory usage or CPU usage or any other condition in the future has triggered the callback
CongestionControlEvent(CongestionControlEvent.Reason, String) - Constructor for class org.mobicents.javax.servlet.CongestionControlEvent
CongestionControlEvent.Reason - Enum in org.mobicents.javax.servlet
CongestionControlPolicy - Enum in org.mobicents.javax.servlet: Congestion Control Policy for the Mobicents Sip Servlets Server.
ContainerListener - Interface in org.mobicents.javax.servlet: Causes applications to be notified of various events occuring the Container.
createApplicationSession(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipFactoryExt: Returns a new SipApplicationSession.
createApplicationSessionByKey(String, boolean) - Method in interface org.mobicents.javax.servlet.sip.SipFactoryExt: Returns a new SipApplicationSession identified by the specified SipApplicationKey.

D

DNSResolver - Interface in org.mobicents.javax.servlet.sip.dns: Allows for an application to perform DNS queries to modify the SIP Message before it is sent out.
To get the DNSResolver from your application just use
doAsynchronousWork(SipApplicationSession) - Method in interface org.mobicents.javax.servlet.sip.SipApplicationSessionAsynchronousWork: The container guarantees that the business logic contained within this method will be executed in a thread-safe manner when using Mobicents Concurrency Control in SipApplicationSession mode
doAsynchronousWork(SipSession) - Method in interface org.mobicents.javax.servlet.sip.SipSessionAsynchronousWork: The container guarantees that the business logic contained within this method will be executed in a thread-safe manner when using Mobicents Concurrency Control in SipSession mode

E

equals(Object) - Method in class org.mobicents.servlet.sip.SipConnector

G

getApplicationSessionById(String, boolean) - Method in interface org.mobicents.javax.servlet.sip.SipSessionsUtilExt: Returns the SipApplicationSession for a given applicationSessionId.
getApplicationSessionByKey(String, boolean, boolean) - Method in interface org.mobicents.javax.servlet.sip.SipSessionsUtilExt: Returns the SipApplicationSession for a given session applicationSessionKey.
getBypassLoadBalancer() - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for application to bypass routing to LoadBalancer for a request (if LoadBalancer is in use) This is useful to cope with NAT issues, where sip client has open NAT port to container but not to LoadBalancer
getBypassProxy() - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for application to bypass routing to Proxy for a request (if Proxy is in use) This is useful to cope with NAT issues, where sip client has open NAT port to container but not to Proxy
getCause() - Method in class org.mobicents.servlet.sip.notification.SipApplicationSessionActivationEvent: Returns the cause on why the listener is called for the application session.
getCause() - Method in class org.mobicents.servlet.sip.notification.SipSessionActivationEvent: Returns the cause on why the listener is called for the application session.
getCopyRecordRouteHeadersOnSubsequentResponses() - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for applications to copy the record route headers on the responses to subsequent INVITE requests where the dialog route set shouldn't normally be changed to cope with non compliant RFC 3261 servers.
getDnsTimeout() - Method in interface org.mobicents.javax.servlet.sip.dns.DNSResolver
getHostNames() - Method in class org.mobicents.servlet.sip.SipConnector
getIpAddress() - Method in class org.mobicents.servlet.sip.SipConnector
getMessage() - Method in class org.mobicents.javax.servlet.CongestionControlEvent: Gives the reason message on what exactly triggered the callback
getPort() - Method in class org.mobicents.servlet.sip.SipConnector
getProxy1xxTimeout() - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: The current value of the overall proxy 1xx timeout value.
getProxyBranch1xxTimeout() - Method in interface org.mobicents.javax.servlet.sip.ProxyBranchExt: Returns the current value of the search 1xx timeout associated with this ProxyBranch object.
getReason() - Method in class org.mobicents.javax.servlet.CongestionControlEvent: Gives the reason on whether the memory usage or CPU usage or any other condition in the future has triggered the callback
getSipOutboundSupport() - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: Returns true if this proxy object is set to support the RFC 5626 Sip Outbound or false otherwise.
getSipURI(URI) - Method in interface org.mobicents.javax.servlet.sip.dns.DNSResolver: From the uri passed in parameter, try to find the corresponding SipURI.
getStaticServerAddress() - Method in class org.mobicents.servlet.sip.SipConnector
getStaticServerPort() - Method in class org.mobicents.servlet.sip.SipConnector
getStunServerAddress() - Method in class org.mobicents.servlet.sip.SipConnector
getStunServerPort() - Method in class org.mobicents.servlet.sip.SipConnector
getTransport() - Method in class org.mobicents.servlet.sip.SipConnector

H

hashCode() - Method in class org.mobicents.servlet.sip.SipConnector

I

isOrphan() - Method in interface org.mobicents.javax.servlet.sip.SipServletRequestExt: This flag indicates that the sessions for this request has been lost.
isOrphan() - Method in interface org.mobicents.javax.servlet.sip.SipServletResponseExt: This flag indicates that the sessions for this request has been lost.
isReplaceStaticServerAddressForInternalRoutingRequest() - Method in class org.mobicents.servlet.sip.SipConnector
isRouteOrphanRequests() - Method in interface org.mobicents.javax.servlet.sip.SipFactoryExt: This flag specifies if the current application can receive subsequent requests after their session has been lost or invalidated.
isUseLoadBalancer() - Method in class org.mobicents.servlet.sip.SipConnector
isUseStaticAddress() - Method in class org.mobicents.servlet.sip.SipConnector
isUseStun() - Method in class org.mobicents.servlet.sip.SipConnector

O

onCongestionControlStarted(CongestionControlEvent) - Method in interface org.mobicents.javax.servlet.ContainerListener: As soon as congestion starts in the underlying source, it calls this method to notify about it.
onCongestionControlStopped(CongestionControlEvent) - Method in interface org.mobicents.javax.servlet.ContainerListener: As soon as congestion abates in the underlying source, it calls this method to notify about it.
onKeepAliveTimeout(SipConnector, String, int) - Method in interface org.mobicents.servlet.sip.listener.SipConnectorListener: if a RFC 5626 KeepAlive timeout has fired which gives the connector on which it happened and the peer information involved.
onProxyBranchResponseTimeout(ResponseType, ProxyBranch) - Method in interface org.mobicents.javax.servlet.sip.ProxyBranchListener: When a search timeout timer expires on a proxy branch, either on final responses or 1xx response, this triggers a call to this method on all classes implementing this listener interface
onRequestThrottled(SipServletRequest, CongestionControlEvent) - Method in interface org.mobicents.javax.servlet.ContainerListener: When a request that comes in is not passed up to the application because of congestion control.
org.mobicents.javax.servlet - package org.mobicents.javax.servlet
org.mobicents.javax.servlet.sip - package org.mobicents.javax.servlet.sip
org.mobicents.javax.servlet.sip.dns - package org.mobicents.javax.servlet.sip.dns
org.mobicents.servlet.sip - package org.mobicents.servlet.sip
org.mobicents.servlet.sip.listener - package org.mobicents.servlet.sip.listener
org.mobicents.servlet.sip.notification - package org.mobicents.servlet.sip.notification

P

ProxyBranchExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 ProxyBranch interface.
It adds the following capabilities : Allows for applications to set a timeout on 1xx responses as JSR 289 defines a timeout only for final responses.
ProxyBranchListener - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 ProxyBranch capabilities.
ProxyExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 Proxy interface.
It adds the following capabilities : Allows for applications to set a timeout on 1xx responses as JSR 289 defines a timeout only for final responses.

R

resolveHost(String) - Method in interface org.mobicents.javax.servlet.sip.dns.DNSResolver: From the host in parameter, perform an A and AAAA Lookup and also use local host name to IP Address mapping (as DNSJava bypass the /etc/hosts) to find the list of IP Address corresponding to that hostname
ResponseType - Enum in org.mobicents.javax.servlet.sip

S

scheduleAsynchronousWork(SipApplicationSessionAsynchronousWork) - Method in interface org.mobicents.javax.servlet.sip.SipApplicationSessionExt: Deprecated.
in favor of SipSessionsUtilExt.scheduleAsynchronousWork(String sipApplicationSessionId, SipApplicationSessionAsynchronousWork work);
scheduleAsynchronousWork(SipSessionAsynchronousWork) - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Deprecated.
in favor of SipSessionsUtilExt.scheduleAsynchronousWork(String sipSessionId, SipSessionAsynchronousWork work)
scheduleAsynchronousWork(String, SipSessionAsynchronousWork) - Method in interface org.mobicents.javax.servlet.sip.SipSessionsUtilExt: This method allows an application to access a SipSession in an asynchronous manner.
scheduleAsynchronousWork(String, SipApplicationSessionAsynchronousWork) - Method in interface org.mobicents.javax.servlet.sip.SipSessionsUtilExt: This method allows an application to access a SipApplicationSession in an asynchronous manner.
sendHeartBeat(String, int) - Method in class org.mobicents.servlet.sip.SipConnector: Send a heartbeat to the specified Ip address and port via this listening point.
SessionActivationNotificationCause - Enum in org.mobicents.servlet.sip.notification: Reasons why an activation spec notification for a clustered session is being generated.
setBypassLoadBalancer(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for application to bypass routing to LoadBalancer for a request (if LoadBalancer is in use) This is useful to cope with NAT issues, where sip client has open NAT port to container but not to LoadBalancer
setBypassProxy(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for application to bypass routing to Proxy for a request (if Proxy is in use) This is useful to cope with NAT issues, where sip client has open NAT port to container but not to Proxy
setCopyRecordRouteHeadersOnSubsequentResponses(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: Allows for applications to copy the record route headers on the responses to subsequent INVITE requests where the dialog route set shouldn't normally be changed to cope with non compliant RFC 3261 servers.
setDnsTimeout(int) - Method in interface org.mobicents.javax.servlet.sip.dns.DNSResolver
setHostNames(String) - Method in class org.mobicents.servlet.sip.SipConnector
setIpAddress(String) - Method in class org.mobicents.servlet.sip.SipConnector
setKeepAliveTimeout(String, int, long) - Method in class org.mobicents.servlet.sip.SipConnector: Allow to reset the RFC5626 Section 4.4.1 keeplive on a given TCP/TLS/SCTP connection
setOrphan(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipServletRequestExt: This flag indicates that the sessions for this request has been lost.
setOrphan(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipServletResponseExt: This flag indicates that the sessions for this request has been lost.
setOutboundInterface(SipURI) - Method in interface org.mobicents.javax.servlet.sip.ProxyBranchExt: In multi-homed environment this method can be used to select the outbound interface and port number and transport to use for proxy branches.
setOutboundInterface(SipURI) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: In multi-homed environment this method can be used to select the outbound interface and port number and transport to use for proxy branches.
setOutboundInterface(SipURI) - Method in interface org.mobicents.javax.servlet.sip.SipSessionExt: In multi-homed environment this method can be used to select the outbound interface to use when sending requests for this SipSession.
setPort(int) - Method in class org.mobicents.servlet.sip.SipConnector
setProxy1xxTimeout(int) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: This is the amount of time, in seconds, the container waits for an informational response when proxying.
If the proxy is sequential, when the timer expires and no 1xx response nor final response has been received, the container CANCELs the current branch and proxies to the next element in the target set.
setProxyBranch1xxTimeout(int) - Method in interface org.mobicents.javax.servlet.sip.ProxyBranchExt: Sets the search timeout value for this ProxyBranch object for 1xx responses.
setRecordRouteURI(SipURI) - Method in interface org.mobicents.javax.servlet.sip.ProxyBranchExt: Allow setting/modifying RecordRoute Header on a SipServletRequest to allow interoperability with Lync.
setRecordRouteURI(SipURI) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: Allow setting/modifying RecordRoute Header on a SipServletRequest to allow interoperability with Lync.
setReplaceStaticServerAddressForInternalRoutingRequest(boolean) - Method in class org.mobicents.servlet.sip.SipConnector
setRouteOrphanRequests(boolean) - Method in interface org.mobicents.javax.servlet.sip.SipFactoryExt: This flag specifies if the current application can receive subsequent requests after their session has been lost or invalidated.
setSipOutboundSupport(boolean) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: Specifies whether this proxy object is set to support the RFC 5626 Sip Outbound or not.
setStaticServerAddress(String) - Method in class org.mobicents.servlet.sip.SipConnector
setStaticServerPort(int) - Method in class org.mobicents.servlet.sip.SipConnector
setStunServerAddress(String) - Method in class org.mobicents.servlet.sip.SipConnector
setStunServerPort(int) - Method in class org.mobicents.servlet.sip.SipConnector
setTransport(String) - Method in class org.mobicents.servlet.sip.SipConnector
setUseLoadBalancer(boolean) - Method in class org.mobicents.servlet.sip.SipConnector
setUseStaticAddress(boolean) - Method in class org.mobicents.servlet.sip.SipConnector
setUseStun(boolean) - Method in class org.mobicents.servlet.sip.SipConnector
SipApplicationSessionActivationEvent - Class in org.mobicents.servlet.sip.notification: Events of this type are sent to an object that implements SipApplicationSessionActivationListener.
SipApplicationSessionActivationEvent(SipApplicationSession, SessionActivationNotificationCause) - Constructor for class org.mobicents.servlet.sip.notification.SipApplicationSessionActivationEvent: Constructs an event that notifies an object that it has been activated/passivated for a session.
SipApplicationSessionAsynchronousWork - Interface in org.mobicents.javax.servlet.sip: Applications that wants to schedule asynchronous work against a SipApplicationSession in a thread safe manner should implement this interface.
SipApplicationSessionExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipApplicationSession interface.
It adds the following capabilities : Allows for applications to schedule work asynchronously against a SipApplicationSession in a thread-safe manner if used in conjunction with the Mobicents Concurrency Control Mechanism Here is some sample code to show how the asynchronous work can be used :
SipConnector - Class in org.mobicents.servlet.sip: Represents a Mobicents Sip Servlets SIP connector and its various attributes
SipConnector() - Constructor for class org.mobicents.servlet.sip.SipConnector
sipConnectorAdded(SipConnector) - Method in interface org.mobicents.servlet.sip.listener.SipConnectorListener: a Sip Connector has been added
SipConnectorListener - Interface in org.mobicents.servlet.sip.listener: Interface to implement by the class to be notified of sip connector management events.
sipConnectorRemoved(SipConnector) - Method in interface org.mobicents.servlet.sip.listener.SipConnectorListener: a Sip Connector has been removed
SipFactoryExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipFactory interface to allow proxying of orphaned requests.
It adds the following capabilities : Requests and responses that do NOT have associated SipSession or SipApplicationSession will still be delivered to the main servlet of the application this factory belongs to.
SipServletRequestExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipServetRequest interface.
It adds the following capabilities :
SipServletResponseExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipServetResponse interface.
It adds the following capabilities :
SipSessionActivationEvent - Class in org.mobicents.servlet.sip.notification: Events of this type are sent to an object that implements SipSessionActivationListener.
SipSessionActivationEvent(SipSession, SessionActivationNotificationCause) - Constructor for class org.mobicents.servlet.sip.notification.SipSessionActivationEvent: Constructs an event that notifies an object that it has been activated/passivated for a session.
SipSessionAsynchronousWork - Interface in org.mobicents.javax.servlet.sip: Applications that wants to schedule asynchronous work against a SipSession in a thread safe manner should implement this interface.
SipSessionExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipSession interface.
It adds the following capabilities : Allows for applications to set the outbound interface based on SipURI, to allow routing based on transport protocol as well.
SipSessionsUtilExt - Interface in org.mobicents.javax.servlet.sip: Interface Extension that adds extra features to the JSR 289 SipFactory interface to allow creation of Sip Application Session outside the scope of container managed threads.
storeTerminationInformation(boolean) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: Enable (or disable) the storing of routing information required to terminate a proxy using terminateSession.

T

terminateSession(SipSession, int, String, int, String) - Method in interface org.mobicents.javax.servlet.sip.ProxyExt: Terminates an established session by sending BYE requests in both directions.
toString() - Method in class org.mobicents.servlet.sip.SipConnector

V

valueOf(String) - Static method in enum org.mobicents.javax.servlet.CongestionControlEvent.Reason: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mobicents.javax.servlet.CongestionControlPolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mobicents.javax.servlet.sip.ResponseType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mobicents.servlet.sip.notification.SessionActivationNotificationCause: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mobicents.javax.servlet.CongestionControlEvent.Reason: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mobicents.javax.servlet.CongestionControlPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mobicents.javax.servlet.sip.ResponseType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mobicents.servlet.sip.notification.SessionActivationNotificationCause: Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I O P R S T V