io.pkts.packet.sip.impl

Class SipPacketImpl

java.lang.Object

io.pkts.packet.impl.AbstractPacket

io.pkts.packet.sip.impl.SipPacketImpl

All Implemented Interfaces:

ApplicationPacket, Packet, SipPacket, Cloneable

Direct Known Subclasses:

SipRequestPacketImpl, SipResponsePacketImpl

public abstract class SipPacketImpl
extends AbstractPacket
implements SipPacket

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
SipPacketImpl(TransportPacket parent, SipMessage msg)

Method Summary

Modifier and Type	Method and Description
abstract SipPacket	clone()
long	getArrivalTime() The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970).
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
Packet	getNextPacket() Get the next frame, or null if there is none.
Buffer	getPayload() Get the payload of the frame.
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.
protected SipMessage	getSipMessage()
ToHeader	getToHeader() Convenience method for fetching the to-header
protected TransportPacket	getTransportPacket()
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.
String	toString()
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.
void	write(OutputStream out, Buffer payload) Writes this packet to the OutputStream with the supplied payload.

Methods inherited from class io.pkts.packet.impl.AbstractPacket

checkParent, getName, getPacket, getParentPacket, getProtocol, hasProtocol, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.Packet

getName, getPacket, getParentPacket, getProtocol, hasProtocol, write

Constructor Detail

SipPacketImpl

public SipPacketImpl(TransportPacket parent,
                     SipMessage msg)

Method Detail

getTransportPacket

protected TransportPacket getTransportPacket()

getSipMessage

protected SipMessage getSipMessage()

getArrivalTime

public long getArrivalTime()

Description copied from interface: Packet

The arrival time of this packet in microseconds relative to epoch (midnight UTC of January 1, 1970). Note, since this returns with microseconds precision (which may or may not be relevant depending on the hardware on which the packet was captured on) and you wish to format this arrival time into a more human readable format you could use the SimpleDateFormat but it can only handle milliseconds precision (you will have to write your own date formatter if you want microseconds). Here is a snippet illustrating how to turn the arrival time of the packet into a human readable date

 Packet p = ...;
 SimpleDateFormat formatter = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss.SSS");
 Date date = new Date(p.getArrivalTime() / 1000);
 System.out.println("Arrival time: " + formatter.format(date));
 

Note how an integer devision is performed on the arrival time to "cut off" the microseconds from the time stamp

Specified by:

getArrivalTime in interface Packet

Returns:

the arrival time of the packet in microseconds since the start of the epoch

write

public void write(OutputStream out,
                  Buffer payload)
           throws IOException

Description copied from interface: Packet

Writes this packet to the OutputStream with the supplied payload. You can use this method to e.g. write a raw UDPPacket to the stream with this payload. Note, if the UDPPacket already had a payload it will be ignored so use this method with care.

Specified by:

write in interface Packet

Throws:

IOException

getInitialLine

public Buffer getInitialLine()

Description copied from interface: SipPacket

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

Specified by:

getInitialLine in interface SipPacket

Returns:

toRequest

public SipRequestPacket toRequest()
                           throws ClassCastException

Description copied from interface: SipPacket

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

Specified by:

toRequest in interface SipPacket

Returns:

this but casted into a SipRequestPacket

Throws:

ClassCastException - in case this SipPacket is actually a SipResponsePacket.

toResponse

public SipResponsePacket toResponse()
                             throws ClassCastException

Description copied from interface: SipPacket

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

Specified by:

toResponse in interface SipPacket

Returns:

this but casted into a SipResponsePacket

Throws:

ClassCastException - in case this SipPacket is actually a SipResponsePacket.

isResponse

public boolean isResponse()

Description copied from interface: SipPacket

Check whether this sip message is a response or not

Specified by:

isResponse in interface SipPacket

Returns:

isRequest

public boolean isRequest()

Description copied from interface: SipPacket

Check whether this sip message is a request or not

Specified by:

isRequest in interface SipPacket

Returns:

getContent

public Object getContent()
                  throws SipPacketParseException

Description copied from interface: SipPacket

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.

Specified by:

getContent in interface SipPacket

Returns:

Throws:

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

getRawContent

public Buffer getRawContent()

Description copied from interface: SipPacket

Get the content as a Buffer.

Specified by:

getRawContent in interface SipPacket

Returns:

hasContent

public boolean hasContent()

Description copied from interface: SipPacket

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

Specified by:

hasContent in interface SipPacket

Returns:

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

getMethod

public Buffer getMethod()
                 throws SipPacketParseException

Description copied from interface: SipPacket

Get the method of this sip message

Specified by:

getMethod in interface SipPacket

Returns:

Throws:

SipPacketParseException

getHeaders

public List<SipHeader> getHeaders()

Get all headers as a list of SipHeader

Specified by:

getHeaders in interface SipPacket

Returns:

a list of SipHeader

getHeaderValues

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

Get all headers as keyed by header name

Specified by:

getHeaderValues in interface SipPacket

Returns:

a map of header names with a list of SipHeader

getHeader

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

Description copied from interface: SipPacket

Get the header as a buffer

Specified by:

getHeader in interface SipPacket

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

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

Description copied from interface: SipPacket

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

Specified by:

getHeader in interface SipPacket

Parameters:

headerName - the name of the header we wish to fetch

Returns:

the header as a SipHeader

Throws:

SipPacketParseException

getFromHeader

public FromHeader getFromHeader()
                         throws SipPacketParseException

Description copied from interface: SipPacket

Convenience method for fetching the from-header

Specified by:

getFromHeader in interface SipPacket

Returns:

the from header as a buffer

Throws:

SipPacketParseException - TODO

getToHeader

public ToHeader getToHeader()
                     throws SipPacketParseException

Description copied from interface: SipPacket

Convenience method for fetching the to-header

Specified by:

getToHeader in interface SipPacket

Returns:

the to header as a buffer

Throws:

SipPacketParseException

getViaHeader

public ViaHeader getViaHeader()
                       throws SipPacketParseException

Description copied from interface: SipPacket

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.

Specified by:

getViaHeader in interface SipPacket

Returns:

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

Throws:

SipPacketParseException

getViaHeaders

public List<ViaHeader> getViaHeaders()
                              throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

Returns:

Throws:

SipPacketParseException

getMaxForwards

public MaxForwardsHeader getMaxForwards()
                                 throws SipPacketParseException

Specified by:

getMaxForwards in interface SipPacket

Returns:

Throws:

SipPacketParseException

getRecordRouteHeader

public RecordRouteHeader getRecordRouteHeader()
                                       throws SipPacketParseException

Description copied from interface: SipPacket

Get the top-most RecordRouteHeader header if present.

Specified by:

getRecordRouteHeader in interface SipPacket

Returns:

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

Throws:

SipPacketParseException

getRecordRouteHeaders

public List<RecordRouteHeader> getRecordRouteHeaders()
                                              throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

Returns:

Throws:

SipPacketParseException

getRouteHeader

public RouteHeader getRouteHeader()
                           throws SipPacketParseException

Description copied from interface: SipPacket

Get the top-most RouteHeader header if present.

Specified by:

getRouteHeader in interface SipPacket

Returns:

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

Throws:

SipPacketParseException

getRouteHeaders

public List<RouteHeader> getRouteHeaders()
                                  throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

Returns:

Throws:

SipPacketParseException

getContactHeader

public ContactHeader getContactHeader()
                               throws SipPacketParseException

Description copied from interface: SipPacket

Get the ContactHeader

Specified by:

getContactHeader in interface SipPacket

Returns:

Throws:

SipPacketParseException

getContentTypeHeader

public ContentTypeHeader getContentTypeHeader()
                                       throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

Returns:

the ContentTypeHeader or null if there is none.

Throws:

SipPacketParseException

getCallIDHeader

public CallIdHeader getCallIDHeader()
                             throws SipPacketParseException

Description copied from interface: SipPacket

Convenience method for fetching the call-id-header

Specified by:

getCallIDHeader in interface SipPacket

Returns:

the call-id header as a buffer

Throws:

SipPacketParseException

getCSeqHeader

public CSeqHeader getCSeqHeader()
                         throws SipPacketParseException

Description copied from interface: SipPacket

Convenience method for fetching the CSeq header

Specified by:

getCSeqHeader in interface SipPacket

Returns:

Throws:

SipPacketParseException

isInvite

public boolean isInvite()
                 throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isBye()
              throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isAck()
              throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isOptions()
                  throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isMessage()
                  throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isInfo()
               throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

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

public boolean isCancel()
                 throws SipPacketParseException

Description copied from interface: SipPacket

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

Specified by:

isCancel in interface SipPacket

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

public boolean isInitial()
                  throws SipPacketParseException

Description copied from interface: SipPacket

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 SipPacket

Returns:

Throws:

SipPacketParseException

verify

public void verify()

Description copied from interface: Packet

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"

Specified by:

verify in interface Packet

Specified by:

verify in interface SipPacket

Overrides:

verify in class AbstractPacket

toBuffer

public Buffer toBuffer()

Description copied from interface: SipPacket

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

Specified by:

toBuffer in interface SipPacket

Returns:

clone

public abstract SipPacket clone()

Specified by:

clone in interface Packet

Specified by:

clone in interface SipPacket

Specified by:

clone in class AbstractPacket

getNextPacket

public Packet getNextPacket()
                     throws IOException

Description copied from interface: Packet

Get the next frame, or null if there is none. Note, if there isn't another frame but there is still raw data within this frame, it only means that we didn't recognize the payload.

Specified by:

getNextPacket in interface Packet

Returns:

Throws:

IOException

getPayload

public Buffer getPayload()

Description copied from interface: Packet

Get the payload of the frame. If null, then this frame doesn't have any payload

Specified by:

getPayload in interface Packet

Overrides:

getPayload in class AbstractPacket

Returns:

toString

public String toString()

Overrides:

toString in class Object