org.lastbamboo.common.sip.stack.message
Interface SipMessage

All Superinterfaces:

org.lastbamboo.common.offer.answer.OfferAnswerMessage

All Known Implementing Classes:

AbstractSipMessage, DoubleCrlfKeepAlive, Invite, Register, RequestTimeoutResponse, SipResponse, UnknownSipRequest

public interface SipMessage
extends org.lastbamboo.common.offer.answer.OfferAnswerMessage

Interface for a single SIP message.

Method Summary

void	accept(SipMessageVisitor visitor) Accepts the specified message visitor.
org.littleshoot.mina.common.ByteBuffer	getBody() Accessor for the message body.
String	getBranchId() Accessor for the branch ID for the topmost Via header of this message.
SipHeader	getHeader(String headerName) Accessor for the complete header with the specified name.
Map<String,SipHeader>	getHeaders() Accessor for all headers in the message.
SipMethod	getMethod() The method the SIP message, such as "INVITE" or "REGISTER".
List<SipHeaderValue>	getRouteSet() Accessor for the list of routes for this message.
String	getStartLine() Accessor the first line of the message.

Methods inherited from interface org.lastbamboo.common.offer.answer.OfferAnswerMessage

getTransactionKey

Method Detail

getBranchId

String getBranchId()

Accessor for the branch ID for the topmost Via header of this message.

Returns:

The branch ID for this message from the topmost Via header.

getMethod

SipMethod getMethod()

The method the SIP message, such as "INVITE" or "REGISTER".

Returns:

The method of the message.

getHeader

SipHeader getHeader(String headerName)

Accessor for the complete header with the specified name.

Parameters:

headerName - The name of the header to access.

Returns:

The complete header instance.

getRouteSet

List<SipHeaderValue> getRouteSet()

Accessor for the list of routes for this message.

Returns:

The list of routes for this message.

getBody

org.littleshoot.mina.common.ByteBuffer getBody()

Accessor for the message body.

Specified by:

getBody in interface org.lastbamboo.common.offer.answer.OfferAnswerMessage

Returns:

The message body.

accept

void accept(SipMessageVisitor visitor)

Accepts the specified message visitor.

Parameters:

visitor - The visitor to accept.

getStartLine

String getStartLine()

Accessor the first line of the message. For requests, this is the request line containing the request URI. For responses, this is the status line.

Returns:

The first line of the message, as in the request line for requests and the status line for responses.

getHeaders

Map<String,SipHeader> getHeaders()

Accessor for all headers in the message.

Returns:

All headers in the message.