org.glassfish.cafe.spi
Interface ProtocolMessageHandler

public interface ProtocolMessageHandler

A ProtocolMessageHandler object encapsulates the Communication or UserProcedure. This object is set the SipApplicationSession as the attribute NAME When the CAFE framework finds this as the attribute of the SipApplicationSession, of the incoming SIP request, it will let this ProtocolMessageHandler handle the message.

Field Summary

static String	LINK Name of the SipApplicationSession attribute using which CAFE framework will retrieve the linked SipApplicationSession which holds the ProtocolMessageHandler
static String	NAME Name of the SipApplicationSession attribute using which CAFE framework will retrieve the ProtocolMessageHandler

Method Summary

void	handleRequest(ProtocolMessage msg) CAFE framework will execute this method to handle incoming SIP request.
void	handleResponse(ProtocolMessage msg) CAFE framework will execute this method to handle incoming SIP response.
void	handleTimeout(ProtocolMessage msg) CAFE framework will execute this method to handle ServletTimer timeouts.

Field Detail

NAME

static final String NAME

Name of the SipApplicationSession attribute using which CAFE framework will retrieve the ProtocolMessageHandler

See Also:

Constant Field Values

LINK

static final String LINK

Name of the SipApplicationSession attribute using which CAFE framework will retrieve the linked SipApplicationSession which holds the ProtocolMessageHandler

See Also:

Constant Field Values

Method Detail

handleRequest

void handleRequest(ProtocolMessage msg)

CAFE framework will execute this method to handle incoming SIP request.

Parameters:

msg - Instance of ProtocolMessage that holds SIP Request.

handleResponse

void handleResponse(ProtocolMessage msg)

CAFE framework will execute this method to handle incoming SIP response.

Parameters:

msg - Instance of ProtocolMessage that holds SIP response.

handleTimeout

void handleTimeout(ProtocolMessage msg)

CAFE framework will execute this method to handle ServletTimer timeouts.

Parameters:

msg - Instance of ProtocolMessage that holds ServletTimer object..