javax.servlet.sip

Interface SipWebSocketContext

public interface SipWebSocketContext

Each SIP WebSocket connection established to a SIP Servlet container has an associated instance of SipWebSocketContext interface. Application may access this object either from SipServletMessage or from SipServletContext.

Since:

2.0

See Also:

SipServletMessage.getLocalSipWebSocketContext(), SipServletContext.getSipWebSocketContext(String)

Method Summary

Methods

Modifier and Type	Method and Description
Flow	getFlow() Returns the Flow of the SIP WebSocket connection.
String	getHttpHeader(String header) Returns the http header saved by the sip container at the time of websocket handshake.
String	getURL() Returns the fully qualified http URL used to complete the SIP WebSocket handshake.
Principal	getWebSecurityPrincipal() Returns a java.security.Principal object containing the name of the authenticated user at the time of websocket handshake.

Method Detail

getURL

String getURL()

Returns the fully qualified http URL used to complete the SIP WebSocket handshake.

Returns:

Fully qualified http URL.

getFlow

Flow getFlow()

Returns the Flow of the SIP WebSocket connection. A Flow represents the transport association between the UA and the server.

Returns:

the Flow of the SIP WebSocket connection.

getWebSecurityPrincipal

Principal getWebSecurityPrincipal()

Returns a java.security.Principal object containing the name of the authenticated user at the time of websocket handshake.

Returns:

a java.security.Principal containing the name of the web user; null if the user has not been authenticated.

getHttpHeader

String getHttpHeader(String header)

Returns the http header saved by the sip container at the time of websocket handshake. A sip container that support sip over websockets is required to allow administrators to configure the names of http headers that will be saved.

Returns:

a serializable information object created by the application.