io.pkts.packet.sip.impl

Class SipMessageImpl

java.lang.Object

io.pkts.packet.sip.impl.SipMessageImpl

All Implemented Interfaces:

SipMessage, java.lang.Cloneable

Direct Known Subclasses:

SipRequestImpl, SipResponseImpl

public abstract class SipMessageImpl
extends java.lang.Object
implements SipMessage

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	Call_ID_HEADER
static Buffer	CSEQ_HEADER
static Buffer	FROM_HEADER
static Buffer	TO_HEADER

Constructor Summary

Constructors

Constructor and Description
SipMessageImpl(Buffer rawInitialBuffer, Buffer headers, Buffer payload)
SipMessageImpl(SipInitialLine initialLine, Buffer headers, Buffer payload)

Method Summary

Modifier and Type	Method and Description
void	addHeader(SipHeader header)
void	addHeaderFirst(SipHeader header)
abstract SipMessage	clone() Perform a deep clone of this SipMessage.
protected Buffer	cloneHeaders() Helper method to clone all the headers into one continuous buffer.
protected Buffer	clonePayload() Helper method to clone the payload.
SipResponse	createResponse(int responseCode) Create a new response based on this SipRequest.
CallIdHeader	getCallIDHeader() Convenience method for fetching the call-id-header
ContactHeader	getContactHeader() Get the ContactHeader
java.lang.Object	getContent() Returns the content (payload) of the SipMessage as an Object.
ContentTypeHeader	getContentTypeHeader() Get the ContentTypeHeader for this message.
CSeqHeader	getCSeqHeader() Convenience method for fetching the CSeq header
ExpiresHeader	getExpiresHeader() Get the ExpiresHeader
FromHeader	getFromHeader() Convenience method for fetching the from-header
SipHeader	getHeader(Buffer headerName) Get the header as a buffer
SipHeader	getHeader(java.lang.String headerName) Same as #getHeader(Buffers.wrap(keyParameter).
Buffer	getInitialLine() The first line of a sip message, which is either a request or a response line
MaxForwardsHeader	getMaxForwards()
abstract Buffer	getMethod() Get the method of this sip message
Buffer	getRawContent() Get the content as a Buffer.
RecordRouteHeader	getRecordRouteHeader() Get the top-most RecordRouteHeader header if present.
java.util.List<RecordRouteHeader>	getRecordRouteHeaders() Get all the RecordRoute-headers in this SipMessage.
protected SipRequestLine	getRequestLine() Since everything is done lazily, this method will parse and return the initial line as a SipRequestLine.
protected SipResponseLine	getResponseLine() Same as getRequestLine() but for SipResponseLine instead.
RouteHeader	getRouteHeader() Get the top-most RouteHeader header if present.
java.util.List<RouteHeader>	getRouteHeaders() Get all the Route-headers in this SipMessage.
SipHeader	getSipHeader(Buffer name)
ToHeader	getToHeader() Convenience method for fetching the to-header
ViaHeader	getViaHeader() Get the top-most ViaHeader if present.
java.util.List<ViaHeader>	getViaHeaders() Get all the Via-headers in this SipMessage.
boolean	hasContent() Checks whether this SipMessage is carrying anything in its message body.
boolean	isAck() Convenience method for determining whether the method of this message is an ACK or not.
boolean	isBye() Convenience method for determining whether the method of this message is a BYE or not.
boolean	isCancel() Convenience method for determining whether the method of this message is a CANCEL or not
boolean	isInfo() Convenience method for determining whether the method of this message is a INFO or not.
boolean	isInitial() Checks whether or not this request is considered to be an "initial" request, i.e., a request that does not go within a dialog.
boolean	isInvite() Convenience method for determining whether the method of this message is an INVITE or not.
boolean	isMessage() Convenience method for determining whether the method of this message is a MESSAGE or not.
boolean	isOptions() Convenience method for determining whether the method of this message is a OPTIONS or not.
boolean	isRegister() Convenience method for determining whether the method of this message is an REGISTER or not.
boolean	isRequest() Check whether this sip message is a request or not
boolean	isResponse() Check whether this sip message is a response or not
SipHeader	popHeader(Buffer headerName) Remove and return the top-most header.
void	setHeader(SipHeader header) Set the specified header, which will replace the existing header of the same name.
Buffer	toBuffer() Get the Buffer that is representing this SipMessage.
SipRequest	toRequest() Got tired of casting the SipMessage into a SipRequest so you can use this method instead.
SipResponse	toResponse() Got tired of casting the SipMessage into a SipResponse so you can use this method instead.
java.lang.String	toString()
protected void	transferHeaders(Buffer dst) Transfer the data of all headers into the supplied buffer.
void	verify() ruri sip version - checks if the SIP version in the request URI is supported, currently only 2.0. ruri scheme - checks if the URI scheme of the request URI is supported (sip[s]|tel[s]) by SIP-router. required headers - checks if the minimum set of required headers to, from, cseq, callid and via is present in the request. via sip version - not working because parser fails already when another version then 2.0 is present. via protocol - not working because parser fails already if an unsupported transport is present. cseq method - checks if the method from the cseq header is equal to the request method. cseq value - checks if the number in the cseq header is a valid unsigned integer. content length - checks if the size of the body matches with the value from the content length header. expires value - checks if the value of the expires header is a valid unsigned integer. proxy require - checks if all items of the proxy require header are present in the list of the extensions from the module parameter proxy_require. parse uri's - checks if the specified URIs are present and parseable by the SIP-router parsers digest credentials - Check all instances of digest credentials in a message.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.pkts.packet.sip.SipMessage

frame, frame

Field Detail

FROM_HEADER

public static final Buffer FROM_HEADER

TO_HEADER

public static final Buffer TO_HEADER

Call_ID_HEADER

public static final Buffer Call_ID_HEADER

CSEQ_HEADER

public static final Buffer CSEQ_HEADER

Constructor Detail

SipMessageImpl

public SipMessageImpl(Buffer rawInitialBuffer,
                      Buffer headers,
                      Buffer payload)

Parameters:

rawInitialBuffer - the raw initial line, which is either a request or a response line (hopefully anyway, we won't know until we try!_

headers - all the headers (un-parsed) of the SIP message

payload - the payload or null if there is none

SipMessageImpl

public SipMessageImpl(SipInitialLine initialLine,
                      Buffer headers,
                      Buffer payload)

Parameters:

initialLine - the initial line, which is either a request or a response line

headers - all the headers (un-parsed) of the SIP message

payload - the payload or null if there is none

Method Detail

getInitialLine

public Buffer getInitialLine()

The first line of a sip message, which is either a request or a response line

Specified by:

getInitialLine in interface SipMessage

Returns:

isResponse

public final boolean isResponse()

Check whether this sip message is a response or not

Specified by:

isResponse in interface SipMessage

Returns:

isRequest

public final boolean isRequest()

Check whether this sip message is a request or not

Specified by:

isRequest in interface SipMessage

Returns:

getRequestLine

protected SipRequestLine getRequestLine()
                                 throws SipParseException,
                                        java.lang.ClassCastException

Since everything is done lazily, this method will parse and return the initial line as a SipRequestLine. Only meant to be used by the sub-classes. Of course, this method could throw both ClassCastException in case this is actually a response and the parsing of the request line could also fail.

Returns:

Throws:

SipParseException

java.lang.ClassCastException

getResponseLine

protected SipResponseLine getResponseLine()
                                   throws SipParseException,
                                          java.lang.ClassCastException

Same as getRequestLine() but for SipResponseLine instead.

Returns:

Throws:

SipParseException

java.lang.ClassCastException

getSipHeader

public SipHeader getSipHeader(Buffer name)

getHeader

public SipHeader getHeader(Buffer headerName)
                    throws SipParseException

Get the header as a buffer

Specified by:

getHeader in interface SipMessage

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader or null if not found

Throws:

SipParseException

popHeader

public SipHeader popHeader(Buffer headerName)
                    throws SipParseException

Description copied from interface: SipMessage

Remove and return the top-most header.

Specified by:

popHeader in interface SipMessage

Returns:

the removed header or null if there was no such header.

Throws:

SipParseException

addHeader

public void addHeader(SipHeader header)

Specified by:

addHeader in interface SipMessage

addHeaderFirst

public void addHeaderFirst(SipHeader header)
                    throws SipParseException

Specified by:

addHeaderFirst in interface SipMessage

Throws:

SipParseException

setHeader

public void setHeader(SipHeader header)
               throws SipParseException

Description copied from interface: SipMessage

Set the specified header, which will replace the existing header of the same name. If there are multiple headers of this header, then all "old" ones are removed.

Specified by:

setHeader in interface SipMessage

Throws:

SipParseException

getHeader

public SipHeader getHeader(java.lang.String headerName)
                    throws SipParseException

Same as #getHeader(Buffers.wrap(keyParameter).

Specified by:

getHeader in interface SipMessage

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader or null if not found

Throws:

SipParseException

getFromHeader

public FromHeader getFromHeader()
                         throws SipParseException

Convenience method for fetching the from-header

Specified by:

getFromHeader in interface SipMessage

Returns:

the from header as a buffer

Throws:

SipParseException - TODO

getViaHeader

public ViaHeader getViaHeader()
                       throws SipParseException

Get the top-most ViaHeader if present. If this is a request that has been sent then there should always be a ViaHeader present. However, you just created a SipMessage youself then this method may return null so please check for it.

Specified by:

getViaHeader in interface SipMessage

Returns:

the top-most ViaHeader or null if there are no ViaHeaders on this message just yet.

Throws:

SipParseException

getViaHeaders

public java.util.List<ViaHeader> getViaHeaders()
                                        throws SipParseException

Description copied from interface: SipMessage

Get all the Via-headers in this SipMessage. If this is a request that just was created then this may return an empty list.

Specified by:

getViaHeaders in interface SipMessage

Returns:

Throws:

SipParseException

getRouteHeaders

public java.util.List<RouteHeader> getRouteHeaders()
                                            throws SipParseException

Description copied from interface: SipMessage

Get all the Route-headers in this SipMessage. If there are no RouteHeaders in this SipMessage then an empty list will be returned.

Specified by:

getRouteHeaders in interface SipMessage

Returns:

Throws:

SipParseException

getRecordRouteHeader

public RecordRouteHeader getRecordRouteHeader()
                                       throws SipParseException

Get the top-most RecordRouteHeader header if present.

Specified by:

getRecordRouteHeader in interface SipMessage

Returns:

the top-most RecordRouteHeader header or null if there are no RecordRouteHeader headers found in this SipMessage.

Throws:

SipParseException

getRecordRouteHeaders

public java.util.List<RecordRouteHeader> getRecordRouteHeaders()
                                                        throws SipParseException

Description copied from interface: SipMessage

Get all the RecordRoute-headers in this SipMessage. If there are no RecordRouteHeaders in this SipMessage then an empty list will be returned.

Specified by:

getRecordRouteHeaders in interface SipMessage

Returns:

Throws:

SipParseException

getRouteHeader

public RouteHeader getRouteHeader()
                           throws SipParseException

Get the top-most RouteHeader header if present.

Specified by:

getRouteHeader in interface SipMessage

Returns:

the top-most RouteHeader header or null if there are no RouteHeader headers found in this SipMessage.

Throws:

SipParseException

getMaxForwards

public MaxForwardsHeader getMaxForwards()
                                 throws SipParseException

Specified by:

getMaxForwards in interface SipMessage

Returns:

Throws:

SipParseException

getExpiresHeader

public ExpiresHeader getExpiresHeader()
                               throws SipParseException

Get the ExpiresHeader

Specified by:

getExpiresHeader in interface SipMessage

Returns:

Throws:

SipParseException

getContactHeader

public ContactHeader getContactHeader()
                               throws SipParseException

Get the ContactHeader

Specified by:

getContactHeader in interface SipMessage

Returns:

Throws:

SipParseException

getContentTypeHeader

public ContentTypeHeader getContentTypeHeader()
                                       throws SipParseException

Description copied from interface: SipMessage

Get the ContentTypeHeader for this message. If there is no Content-Type header in this SIP message then null will be returned.

Specified by:

getContentTypeHeader in interface SipMessage

Returns:

the ContentTypeHeader or null if there is none.

Throws:

SipParseException

getToHeader

public ToHeader getToHeader()
                     throws SipParseException

Convenience method for fetching the to-header

Specified by:

getToHeader in interface SipMessage

Returns:

the to header as a buffer

Throws:

SipParseException

getCSeqHeader

public CSeqHeader getCSeqHeader()
                         throws SipParseException

Description copied from interface: SipMessage

Convenience method for fetching the CSeq header

Specified by:

getCSeqHeader in interface SipMessage

Returns:

Throws:

SipParseException

getCallIDHeader

public CallIdHeader getCallIDHeader()
                             throws SipParseException

Convenience method for fetching the call-id-header

Specified by:

getCallIDHeader in interface SipMessage

Returns:

the call-id header as a buffer

Throws:

SipParseException

getMethod

public abstract Buffer getMethod()
                          throws SipParseException

Get the method of this sip message

Specified by:

getMethod in interface SipMessage

Returns:

Throws:

SipParseException

verify

public void verify()

• ruri sip version - checks if the SIP version in the request URI is supported, currently only 2.0.
• ruri scheme - checks if the URI scheme of the request URI is supported (sip[s]|tel[s]) by SIP-router.
• required headers - checks if the minimum set of required headers to, from, cseq, callid and via is present in the request.
• via sip version - not working because parser fails already when another version then 2.0 is present.
• via protocol - not working because parser fails already if an unsupported transport is present.
• cseq method - checks if the method from the cseq header is equal to the request method.
• cseq value - checks if the number in the cseq header is a valid unsigned integer.
• content length - checks if the size of the body matches with the value from the content length header.
• expires value - checks if the value of the expires header is a valid unsigned integer.
• proxy require - checks if all items of the proxy require header are present in the list of the extensions from the module parameter proxy_require.
• parse uri's - checks if the specified URIs are present and parseable by the SIP-router parsers
• digest credentials - Check all instances of digest credentials in a message. The test checks whether there are all required digest parameters and have meaningful values.

This list is taken from Kamailio.org

Specified by:

verify in interface SipMessage

isInitial

public boolean isInitial()
                  throws SipParseException

Checks whether or not this request is considered to be an "initial" request, i.e., a request that does not go within a dialog.

Specified by:

isInitial in interface SipMessage

Returns:

Throws:

SipParseException

isInvite

public boolean isInvite()
                 throws SipParseException

Convenience method for determining whether the method of this message is an INVITE or not. Hence, this is NOT to the method to determine whether this is a INVITE Request or not!

Specified by:

isInvite in interface SipMessage

Returns:

true if the method of this message is a INVITE, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isRegister

public boolean isRegister()
                   throws SipParseException

Convenience method for determining whether the method of this message is an REGISTER or not.

Specified by:

isRegister in interface SipMessage

Returns:

true if the method of this message is a REGISTER, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isBye

public boolean isBye()
              throws SipParseException

Convenience method for determining whether the method of this message is a BYE or not. Hence, this is NOT to the method to determine whether this is a BYE Request or not!

Specified by:

isBye in interface SipMessage

Returns:

true if the method of this message is a BYE, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isAck

public boolean isAck()
              throws SipParseException

Convenience method for determining whether the method of this message is an ACK or not. Hence, this is NOT to the method to determine whether this is an ACK Request or not!

Specified by:

isAck in interface SipMessage

Returns:

true if the method of this message is a ACK, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isCancel

public boolean isCancel()
                 throws SipParseException

Convenience method for determining whether the method of this message is a CANCEL or not

Specified by:

isCancel in interface SipMessage

Returns:

true if the method of this message is a CANCEL, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isOptions

public boolean isOptions()
                  throws SipParseException

Description copied from interface: SipMessage

Convenience method for determining whether the method of this message is a OPTIONS or not. Hence, this is NOT to the method to determine whether this is an OPTIONS Request or not!

Specified by:

isOptions in interface SipMessage

Returns:

true if the method of this message is a OPTIONS, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isMessage

public boolean isMessage()
                  throws SipParseException

Description copied from interface: SipMessage

Convenience method for determining whether the method of this message is a MESSAGE or not. Hence, this is NOT to the method to determine whether this is an MESSAGE Request or not!

Specified by:

isMessage in interface SipMessage

Returns:

true if the method of this message is a MESSAGE, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

isInfo

public boolean isInfo()
               throws SipParseException

Description copied from interface: SipMessage

Convenience method for determining whether the method of this message is a INFO or not. Hence, this is NOT to the method to determine whether this is an INFO Request or not!

Specified by:

isInfo in interface SipMessage

Returns:

true if the method of this message is a INFO, false otherwise.

Throws:

SipParseException - in case the method could not be parsed out of the underlying buffer.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContent

public final java.lang.Object getContent()
                                  throws SipParseException

Description copied from interface: SipMessage

Returns the content (payload) of the SipMessage as an Object. If the ContentTypeHeader indicates a content type that is known (such as an sdp) then an attempt to parse the content into that type is made. If the payload is unknown then a Buffer representing the payload will be returned.

Specified by:

getContent in interface SipMessage

Returns:

Throws:

SipParseException - in case anything goes wrong when trying to frame the content in any way.

getRawContent

public final Buffer getRawContent()

Description copied from interface: SipMessage

Get the content as a Buffer.

Specified by:

getRawContent in interface SipMessage

Returns:

hasContent

public final boolean hasContent()

Description copied from interface: SipMessage

Checks whether this SipMessage is carrying anything in its message body.

Specified by:

hasContent in interface SipMessage

Returns:

true if this SipMessage has a message body, false otherwise.

toRequest

public SipRequest toRequest()
                     throws java.lang.ClassCastException

Description copied from interface: SipMessage

Got tired of casting the SipMessage into a SipRequest so you can use this method instead. Just a short cut for: (SipRequest)sipMessage;

Specified by:

toRequest in interface SipMessage

Returns:

this but casted into a SipRequest

Throws:

java.lang.ClassCastException - in case this SipMessage is actually a SipResponse.

toResponse

public SipResponse toResponse()
                       throws java.lang.ClassCastException

Description copied from interface: SipMessage

Got tired of casting the SipMessage into a SipResponse so you can use this method instead. Just a short cut for: (SipResponse)sipMessage;

Specified by:

toResponse in interface SipMessage

Returns:

this but casted into a SipResponse

Throws:

java.lang.ClassCastException - in case this SipMessage is actually a SipResponse.

createResponse

public SipResponse createResponse(int responseCode)
                           throws SipParseException,
                                  java.lang.ClassCastException

Description copied from interface: SipMessage

Create a new response based on this SipRequest. If this SipMessage is not a SipRequest then a ClassCastException will be thrown. Only the mandatory headers from the SipRequest are copied. Those mandatory headers are:

• ToHeader
• FromHeader
• CallIdHeader.
• CSeqHeader
• MaxForwardsHeader

Specified by:

createResponse in interface SipMessage

Returns:

Throws:

SipParseException - in case anything goes wrong when parsing out headers from the SipRequest

java.lang.ClassCastException

toBuffer

public Buffer toBuffer()

Description copied from interface: SipMessage

Get the Buffer that is representing this SipMessage. Note, the data behind the buffer is shared with the actual SipMessage so any changes to the Buffer will affect this SipMessage. Hence, by changing this buffer directly, you bypass all checks for valid inputs and the end-result of doing so is undefined (most likely you will either blow up at some point or you will end up sending garbage across the network).

Specified by:

toBuffer in interface SipMessage

Returns:

cloneHeaders

protected Buffer cloneHeaders()

Helper method to clone all the headers into one continuous buffer.

Returns:

clonePayload

protected Buffer clonePayload()

Helper method to clone the payload.

Returns:

transferHeaders

protected void transferHeaders(Buffer dst)

Transfer the data of all headers into the supplied buffer.

Parameters:

dst -

clone

public abstract SipMessage clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Overrides:

clone in class java.lang.Object

Returns: