io.pkts.packet.sip

Interface SipMessage

All Superinterfaces:

Cloneable

All Known Subinterfaces:

SipRequest, SipResponse

All Known Implementing Classes:

SipMessageImpl, SipRequestImpl, SipResponseImpl

public interface SipMessage
extends Cloneable

Packet representing a SIP message.

Author:

[email protected]

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(SipHeader header)
void	addHeaderFirst(SipHeader header)
SipMessage	clone() Perform a deep clone of this SipMessage.
CallIdHeader	getCallIDHeader() Convenience method for fetching the call-id-header
ContactHeader	getContactHeader() Get the ContactHeader
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
FromHeader	getFromHeader() Convenience method for fetching the from-header
SipHeader	getHeader(Buffer headerName) Get the header as a buffer
SipHeader	getHeader(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()
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.
RouteHeader	getRouteHeader() Get the top-most RouteHeader header if present.
ToHeader	getToHeader() Convenience method for fetching the to-header
ViaHeader	getViaHeader() Get the top-most ViaHeader if present.
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	isRequest() Check whether this sip message is a request or not
boolean	isResponse() Check whether this sip message is a response or not
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.
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.

Method Detail

getInitialLine

Buffer getInitialLine()

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

Returns:

toRequest

SipRequest toRequest()
                     throws ClassCastException

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

Returns:

this but casted into a SipRequest

Throws:

ClassCastException - in case this SipMessage is actually a SipResponse.

toResponse

SipResponse toResponse()
                       throws ClassCastException

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

Returns:

this but casted into a SipResponse

Throws:

ClassCastException - in case this SipMessage is actually a SipResponse.

isResponse

boolean isResponse()

Check whether this sip message is a response or not

Returns:

isRequest

boolean isRequest()

Check whether this sip message is a request or not

Returns:

getContent

Object getContent()
                  throws SipParseException

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.

Returns:

Throws:

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

getRawContent

Buffer getRawContent()

Get the content as a Buffer.

Returns:

hasContent

boolean hasContent()

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

Returns:

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

getMethod

Buffer getMethod()
                 throws SipParseException

Get the method of this sip message

Returns:

Throws:

SipParseException

getHeader

SipHeader getHeader(Buffer headerName)
                    throws SipParseException

Get the header as a buffer

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader or null if not found

Throws:

SipParseException

getHeader

SipHeader getHeader(String headerName)
                    throws SipParseException

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

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader or null if not found

Throws:

SipParseException

addHeader

void addHeader(SipHeader header)
               throws SipParseException

Throws:

SipParseException

addHeaderFirst

void addHeaderFirst(SipHeader header)
                    throws SipParseException

Throws:

SipParseException

setHeader

void setHeader(SipHeader header)
               throws SipParseException

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.

Parameters:

header -

Throws:

SipParseException

getFromHeader

FromHeader getFromHeader()
                         throws SipParseException

Convenience method for fetching the from-header

Returns:

the from header as a buffer

Throws:

SipParseException - TODO

getToHeader

ToHeader getToHeader()
                     throws SipParseException

Convenience method for fetching the to-header

Returns:

the to header as a buffer

Throws:

SipParseException

getViaHeader

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.

Returns:

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

Throws:

SipParseException

getViaHeaders

List<ViaHeader> getViaHeaders()
                              throws SipParseException

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

Returns:

Throws:

SipParseException

getMaxForwards

MaxForwardsHeader getMaxForwards()
                                 throws SipParseException

Returns:

Throws:

SipParseException

getRecordRouteHeader

RecordRouteHeader getRecordRouteHeader()
                                       throws SipParseException

Get the top-most RecordRouteHeader header if present.

Returns:

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

Throws:

SipParseException

getRouteHeader

RouteHeader getRouteHeader()
                           throws SipParseException

Get the top-most RouteHeader header if present.

Returns:

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

Throws:

SipParseException

getContactHeader

ContactHeader getContactHeader()
                               throws SipParseException

Get the ContactHeader

Returns:

Throws:

SipParseException

getContentTypeHeader

ContentTypeHeader getContentTypeHeader()
                                       throws SipParseException

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

Returns:

the ContentTypeHeader or null if there is none.

Throws:

SipParseException

getCallIDHeader

CallIdHeader getCallIDHeader()
                             throws SipParseException

Convenience method for fetching the call-id-header

Returns:

the call-id header as a buffer

Throws:

SipParseException

getCSeqHeader

CSeqHeader getCSeqHeader()
                         throws SipParseException

Convenience method for fetching the CSeq header

Returns:

Throws:

SipParseException

isInvite

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!

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.

isBye

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!

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

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!

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.

isOptions

boolean isOptions()
                  throws SipParseException

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!

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

boolean isMessage()
                  throws SipParseException

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!

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

boolean isInfo()
               throws SipParseException

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!

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.

isCancel

boolean isCancel()
                 throws SipParseException

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

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.

isInitial

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.

Returns:

Throws:

SipParseException

verify

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

toBuffer

Buffer toBuffer()

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).

Returns:

clone

SipMessage clone()

Perform a deep clone of this SipMessage.

Returns: