io.pkts.packet.sip.impl

Class ImmutableSipMessage

java.lang.Object

io.pkts.packet.sip.impl.ImmutableSipMessage

All Implemented Interfaces:

SipMessage, Cloneable

Direct Known Subclasses:

ImmutableSipRequest, ImmutableSipResponse

public abstract class ImmutableSipMessage
extends Object
implements SipMessage

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested classes/interfaces inherited from interface io.pkts.packet.sip.SipMessage

SipMessage.Builder<T extends SipMessage>

Field Summary

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

UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableSipMessage(Buffer message, SipInitialLine initialLine, Map<String,List<SipHeader>> headers, SipHeader toHeader, SipHeader fromHeader, SipHeader cSeqHeader, SipHeader callIdHeader, SipHeader maxForwardsHeader, SipHeader viaHeader, SipHeader routeHeader, SipHeader recordRouteHeader, SipHeader contactHeader, Buffer body)

Method Summary

Modifier and Type	Method and Description
SipMessage	clone() Perform a deep clone of this SipMessage.
int	countNoOfHeaders()
boolean	equals(Object o)
List<SipHeader>	getAllHeaders()
CallIdHeader	getCallIDHeader() Convenience method for fetching the call-id-header
ContactHeader	getContactHeader() Get the ContactHeader
Buffer	getContent() Get the content as a Buffer.
int	getContentLength() Return the content length.
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
Optional<SipHeader>	getHeader(Buffer headerName) Get the header as a buffer
Optional<SipHeader>	getHeader(String headerName) Same as #getHeader(Buffers.wrap(keyParameter).
List<SipHeader>	getHeaders(Buffer headerName)
List<SipHeader>	getHeaders(String headerName) Get all headers with the given name.
Map<String,List<SipHeader>>	getHeaderValues()
Buffer	getInitialLine() The first line of a sip message, which is either a request or a response line
protected SipInitialLine	getInitialLineAsObject()
MaxForwardsHeader	getMaxForwards()
RecordRouteHeader	getRecordRouteHeader() Get the top-most RecordRouteHeader header if present.
List<RecordRouteHeader>	getRecordRouteHeaders() Get all the RecordRoute-headers in this SipMessage.
RouteHeader	getRouteHeader() Get the top-most RouteHeader header if present.
List<RouteHeader>	getRouteHeaders() Get all the Route-headers in this SipMessage.
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.
SipInitialLine	initialLine()
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.
Buffer	toBuffer() Get the Buffer that is representing this SipMessage.
String	toString()
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

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

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

copy, createResponse, createResponse, frame, frame, frame, getMethod, is100Trying, isAck, isBye, isByeRequest, isCancel, isCancelRequest, isClientError, isError, isFinal, isFinalNon2xx, isGlobalError, isInfo, isInfoRequest, isInvite, isInviteRequest, isMessage, isMessageRequest, isOptions, isOptionsRequest, isProvisional, isRedirect, isRegister, isRegisterRequest, isRequest, isResponse, isRinging, isServerError, isSubsequent, isSuccess, isTimeout, toRequest, toResponse

Constructor Detail

ImmutableSipMessage

protected ImmutableSipMessage(Buffer message,
                              SipInitialLine initialLine,
                              Map<String,List<SipHeader>> headers,
                              SipHeader toHeader,
                              SipHeader fromHeader,
                              SipHeader cSeqHeader,
                              SipHeader callIdHeader,
                              SipHeader maxForwardsHeader,
                              SipHeader viaHeader,
                              SipHeader routeHeader,
                              SipHeader recordRouteHeader,
                              SipHeader contactHeader,
                              Buffer body)

Parameters:

message - the full immutable buffer which has the entire SIP message in it, including all headers, body initial line etc.

initialLine - the parsed initial line (which is just a reference into the message buffer)

headers -

body -

Method Detail

initialLine

public SipInitialLine initialLine()

Specified by:

initialLine in interface SipMessage

toString

public String toString()

Overrides:

toString in class Object

getAllHeaders

public List<SipHeader> getAllHeaders()

Specified by:

getAllHeaders in interface SipMessage

getHeaderValues

public Map<String,List<SipHeader>> getHeaderValues()

Specified by:

getHeaderValues in interface SipMessage

countNoOfHeaders

public int countNoOfHeaders()

Specified by:

countNoOfHeaders in interface SipMessage

getInitialLine

public Buffer getInitialLine()

Description copied from interface: SipMessage

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

Specified by:

getInitialLine in interface SipMessage

Returns:

getInitialLineAsObject

protected SipInitialLine getInitialLineAsObject()

getContent

public Buffer getContent()

Description copied from interface: SipMessage

Get the content as a Buffer.

Specified by:

getContent in interface SipMessage

Returns:

hasContent

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

getHeader

public Optional<SipHeader> getHeader(Buffer headerName)
                              throws SipParseException

Description copied from interface: SipMessage

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

getHeaders

public List<SipHeader> getHeaders(Buffer headerName)
                           throws SipParseException

Specified by:

getHeaders in interface SipMessage

Throws:

SipParseException

getHeaders

public List<SipHeader> getHeaders(String headerName)
                           throws SipParseException

Description copied from interface: SipMessage

Get all headers with the given name.

Specified by:

getHeaders in interface SipMessage

Returns:

a list of all headers or an empty list if none is found.

Throws:

SipParseException

getHeader

public Optional<SipHeader> getHeader(String headerName)
                              throws SipParseException

Description copied from interface: SipMessage

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

Description copied from interface: SipMessage

Convenience method for fetching the from-header

Specified by:

getFromHeader in interface SipMessage

Returns:

the from header as a buffer

Throws:

SipParseException - TODO

getToHeader

public ToHeader getToHeader()
                     throws SipParseException

Description copied from interface: SipMessage

Convenience method for fetching the to-header

Specified by:

getToHeader in interface SipMessage

Returns:

the to header as a buffer

Throws:

SipParseException

getViaHeader

public ViaHeader getViaHeader()
                       throws SipParseException

Description copied from interface: SipMessage

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 List<ViaHeader> getViaHeaders()
                              throws SipParseException

Description copied from interface: SipMessage

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

Specified by:

getViaHeaders in interface SipMessage

Returns:

Throws:

SipParseException

getMaxForwards

public MaxForwardsHeader getMaxForwards()
                                 throws SipParseException

Specified by:

getMaxForwards in interface SipMessage

Returns:

Throws:

SipParseException

getRecordRouteHeader

public RecordRouteHeader getRecordRouteHeader()
                                       throws SipParseException

Description copied from interface: SipMessage

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

Description copied from interface: SipMessage

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

getRouteHeaders

public 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

getExpiresHeader

public ExpiresHeader getExpiresHeader()
                               throws SipParseException

Description copied from interface: SipMessage

Get the ExpiresHeader

Specified by:

getExpiresHeader in interface SipMessage

Returns:

Throws:

SipParseException

getContactHeader

public ContactHeader getContactHeader()
                               throws SipParseException

Description copied from interface: SipMessage

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

getContentLength

public int getContentLength()
                     throws SipParseException

Description copied from interface: SipMessage

Return the content length. If the header isn't present then zero will be returned which DOES NOT mean that there isn't a body. Remember, this API doesn't enforce any rules regarding what headers you must/must not include in the message, this have to be enforced by business logic.

Specified by:

getContentLength in interface SipMessage

Returns:

the value of the Content-Length header if present or zero if there was no such header (or of course if the Content-Length header was present but actually had the value of zero)

Throws:

SipParseException

getCallIDHeader

public CallIdHeader getCallIDHeader()
                             throws SipParseException

Description copied from interface: SipMessage

Convenience method for fetching the call-id-header

Specified by:

getCallIDHeader in interface SipMessage

Returns:

the call-id 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

isInitial

public boolean isInitial()
                  throws SipParseException

Description copied from interface: SipMessage

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

verify

public void verify()

Description copied from interface: SipMessage

• 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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toBuffer

public Buffer toBuffer()

Description copied from interface: SipMessage

Get the Buffer that is representing this SipMessage.

Specified by:

toBuffer in interface SipMessage

Returns:

clone

public SipMessage clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Overrides:

clone in class Object

Returns: