io.pkts.packet.sip

Interface SipPacket

All Superinterfaces:

ApplicationPacket, Cloneable, Packet

All Known Subinterfaces:

SipRequestPacket, SipResponsePacket

All Known Implementing Classes:

SipPacketImpl, SipRequestPacketImpl, SipResponsePacketImpl

public interface SipPacket
extends ApplicationPacket

Packet representing a SIP message.

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
SipPacket	clone()
CallIdHeader	getCallIDHeader() Convenience method for fetching the call-id-header
ContactHeader	getContactHeader() Get the ContactHeader
Object	getContent() Returns the content (payload) of the SipPacket 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
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() Get all headers as a list of SipHeader
Map<String,List<SipHeader>>	getHeaderValues() Get all headers as keyed by header name
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.
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 SipPacket 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
Buffer	toBuffer() Get the Buffer that is representing this SipPacket.
SipRequestPacket	toRequest() Got tired of casting the SipPacket into a SipRequestPacket so you can use this method instead.
SipResponsePacket	toResponse() Got tired of casting the SipPacket into a SipResponsePacket so you can use this method instead.
void	verify() Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow.

Methods inherited from interface io.pkts.packet.Packet

getArrivalTime, getName, getNextPacket, getPacket, getParentPacket, getPayload, getProtocol, hasProtocol, write, write

Method Detail

getInitialLine

Buffer getInitialLine()

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

Returns:

toRequest

SipRequestPacket toRequest()
                    throws ClassCastException

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

Returns:

this but casted into a SipRequestPacket

Throws:

ClassCastException - in case this SipPacket is actually a SipResponsePacket.

toResponse

SipResponsePacket toResponse()
                      throws ClassCastException

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

Returns:

this but casted into a SipResponsePacket

Throws:

ClassCastException - in case this SipPacket is actually a SipResponsePacket.

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 SipPacketParseException

Returns the content (payload) of the SipPacket 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:

SipPacketParseException - 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 SipPacket is carrying anything in its message body.

Returns:

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

getMethod

Buffer getMethod()
          throws SipPacketParseException

Get the method of this sip message

Returns:

Throws:

SipPacketParseException

getHeaders

List<SipHeader> getHeaders()

Get all headers as a list of SipHeader

Returns:

a list of SipHeader

getHeaderValues

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

Get all headers as keyed by header name

Returns:

a map of header names with a list of SipHeader

getHeader

Optional<SipHeader> getHeader(Buffer headerName)
                       throws SipPacketParseException

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:

SipPacketParseException

getHeader

Optional<SipHeader> getHeader(String headerName)
                       throws SipPacketParseException

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

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader

Throws:

SipPacketParseException

getFromHeader

FromHeader getFromHeader()
                  throws SipPacketParseException

Convenience method for fetching the from-header

Returns:

the from header as a buffer

Throws:

SipPacketParseException - TODO

getToHeader

ToHeader getToHeader()
              throws SipPacketParseException

Convenience method for fetching the to-header

Returns:

the to header as a buffer

Throws:

SipPacketParseException

getViaHeader

ViaHeader getViaHeader()
                throws SipPacketParseException

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 SipPacket yourself 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:

SipPacketParseException

getViaHeaders

List<ViaHeader> getViaHeaders()
                       throws SipPacketParseException

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:

SipPacketParseException

getMaxForwards

MaxForwardsHeader getMaxForwards()
                          throws SipPacketParseException

Returns:

Throws:

SipPacketParseException

getRecordRouteHeader

RecordRouteHeader getRecordRouteHeader()
                                throws SipPacketParseException

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

Throws:

SipPacketParseException

getRecordRouteHeaders

List<RecordRouteHeader> getRecordRouteHeaders()
                                       throws SipPacketParseException

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

Returns:

Throws:

SipPacketParseException

getRouteHeader

RouteHeader getRouteHeader()
                    throws SipPacketParseException

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

Throws:

SipPacketParseException

getRouteHeaders

List<RouteHeader> getRouteHeaders()
                           throws SipPacketParseException

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

Returns:

Throws:

SipPacketParseException

getContactHeader

ContactHeader getContactHeader()
                        throws SipPacketParseException

Get the ContactHeader

Returns:

Throws:

SipPacketParseException

getContentTypeHeader

ContentTypeHeader getContentTypeHeader()
                                throws SipPacketParseException

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:

SipPacketParseException

getCallIDHeader

CallIdHeader getCallIDHeader()
                      throws SipPacketParseException

Convenience method for fetching the call-id-header

Returns:

the call-id header as a buffer

Throws:

SipPacketParseException

getCSeqHeader

CSeqHeader getCSeqHeader()
                  throws SipPacketParseException

Convenience method for fetching the CSeq header

Returns:

Throws:

SipPacketParseException

isInvite

boolean isInvite()
          throws SipPacketParseException

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:

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

isBye

boolean isBye()
       throws SipPacketParseException

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:

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

isAck

boolean isAck()
       throws SipPacketParseException

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:

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

isOptions

boolean isOptions()
           throws SipPacketParseException

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:

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

isMessage

boolean isMessage()
           throws SipPacketParseException

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:

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

isInfo

boolean isInfo()
        throws SipPacketParseException

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:

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

isCancel

boolean isCancel()
          throws SipPacketParseException

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:

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

isInitial

boolean isInitial()
           throws SipPacketParseException

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:

SipPacketParseException

verify

void verify()

Calling this method will force the packet to completely parse its data and check so that all the information conforms to whatever rules this packet needs to follow. E.g., if this happens to be a SIP packet, then it will check if it has the mandatory headers etc. Some simpler packets, such as the IPPacket, hardly does anything in this method but more complex protocols such as SIP (once again), HTTP etc can spend quite some time verifying everything, which is why you don't want to do it unless you really have to. In general, yajpcap has the philosophy of "assume that everything is ok until things blow up and then deal with it"

In the case of a SIP message the following checks are conducted: The following checks are available:

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

toBuffer

Buffer toBuffer()

Get the Buffer that is representing this SipPacket. Note, the data behind the buffer is shared with the actual SipPacket so any changes to the Buffer will affect this SipPacket. 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

SipPacket clone()

Specified by:

clone in interface Packet