javax.servlet.sip

Interface InviteBranch

All Superinterfaces:

AttributeStore

public interface InviteBranch
extends AttributeStore

Represents an initial invite transaction branch in the context of a single session or dialog. It allows the developer to store attributes that are related to the invite transaction / dialog pair. It also allows responses to be created and retrieved that are related to that invite branch.

Since:

2.0

See Also:

AttributeStore

Method Summary

Methods

Modifier and Type	Method and Description
SipServletResponse	createResponse(int statusCode, String reasonPhrase) This method allows a provisional or final response to be created for the branch at a UAS.
SipServletResponse	getFinalResponse() This method will retrieve the final response that corresponds to the branch or null if there is no such response.
UAMode	getMode() Return the UAMode of the InviteBranch.
SipServletRequest	getRequest() Return the SipServletRequest of the InviteBranch
SipSession	getSession() Return the SipSession object where the InviteBranch belongs to

Methods inherited from interface javax.servlet.sip.AttributeStore

clearAttributes, getAttribute, getAttributeNameSet, removeAttribute, setAttribute

Method Detail

getSession

SipSession getSession()

Return the SipSession object where the InviteBranch belongs to

Returns:

the SipSession object

getRequest

SipServletRequest getRequest()

Return the SipServletRequest of the InviteBranch

Returns:

the SipServletRequest object

getMode

UAMode getMode()

Return the UAMode of the InviteBranch. If the original invite was incoming this method will return UAS, if the invite was outgoing the method will return UAC.

Returns:

UAMode of the invite request.

getFinalResponse

SipServletResponse getFinalResponse()

This method will retrieve the final response that corresponds to the branch or null if there is no such response.

Returns:

SipServletResponse object.

createResponse

SipServletResponse createResponse(int statusCode,
                                String reasonPhrase)

This method allows a provisional or final response to be created for the branch at a UAS.

Parameters:

statusCode - status code for the response

reasonPhrase - reason phrase to appear in response line

Returns:

response object with specified status code and reason phrase

Throws:

IllegalArgumentException - if the statuscode is not a valid SIP status code

IllegalStateException - if the request has already been responded to with a final status code or if the container is not acting as the UAS for the INVITE transaction