io.pkts.packet.sip.impl

Class SipResponseImpl

java.lang.Object

io.pkts.packet.sip.impl.SipMessageImpl

io.pkts.packet.sip.impl.SipResponseImpl

All Implemented Interfaces:

SipMessage, SipResponse, Cloneable

public final class SipResponseImpl
extends SipMessageImpl
implements SipResponse

Author:

jonas@jonasborjesson.com

Field Summary

Fields inherited from class io.pkts.packet.sip.impl.SipMessageImpl

Call_ID_HEADER, CSEQ_HEADER, FROM_HEADER, TO_HEADER

Constructor Summary

Constructors

Constructor and Description
SipResponseImpl(Buffer initialLine, Buffer headers, Buffer payload)
SipResponseImpl(SipResponseLine initialLine, Buffer headers, Buffer payload)

Method Summary

Modifier and Type	Method and Description
SipResponse	clone() Perform a deep clone of this SipMessage.
Buffer	getMethod() Get the method of this sip message
Buffer	getReasonPhrase() Get the reason phrase of this SipResponse
int	getStatus() Get the status code of this SIP response
boolean	is100Trying() Convenience method for checking whether this is a 100 Trying response or not.
boolean	isClientError() Convenience method for checking whether this is a 4xx response or not.
boolean	isFinal() Convenience method for checking whether this response is a final response, i.e.
boolean	isGlobalError() Convenience method for checking whether this is a 6xx response or not.
boolean	isProvisional() Convenience method for checking whether this is a 1xx response or not.
boolean	isRedirect() Convenience method for checking whether this is a 3xx response or not.
boolean	isRinging() Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.
boolean	isServerError() Convenience method for checking whether this is a 5xx response or not.
boolean	isSuccess() Convenience method for checking whether this is a 2xx response or not.
boolean	isTimeout() Convenience method for checking whether this is a 480 Timeout response or not.
ViaHeader	popViaHeader() Pop the top-most ViaHeader.
SipResponse	toResponse() Got tired of casting the SipMessage into a SipResponse so you can use this method instead.

Methods inherited from class io.pkts.packet.sip.impl.SipMessageImpl

addHeader, addHeaderFirst, cloneHeaders, clonePayload, createResponse, getCallIDHeader, getContactHeader, getContent, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getInitialLine, getMaxForwards, getRawContent, getRecordRouteHeader, getRecordRouteHeaders, getRequestLine, getResponseLine, getRouteHeader, getRouteHeaders, getSipHeader, getToHeader, getViaHeader, getViaHeaders, hasContent, isAck, isBye, isCancel, isInfo, isInitial, isInvite, isMessage, isOptions, isRegister, isRequest, isResponse, popHeader, setHeader, toBuffer, toRequest, toString, transferHeaders, verify

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

addHeader, addHeaderFirst, createResponse, frame, frame, getCallIDHeader, getContactHeader, getContent, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getInitialLine, getMaxForwards, getRawContent, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, isAck, isBye, isCancel, isInfo, isInitial, isInvite, isMessage, isOptions, isRegister, isRequest, isResponse, popHeader, setHeader, toBuffer, toRequest, verify

Constructor Detail

SipResponseImpl

public SipResponseImpl(Buffer initialLine,
                       Buffer headers,
                       Buffer payload)

Parameters:

initialLine -

headers -

payload -

SipResponseImpl

public SipResponseImpl(SipResponseLine initialLine,
                       Buffer headers,
                       Buffer payload)

Method Detail

getReasonPhrase

public Buffer getReasonPhrase()

Description copied from interface: SipResponse

Get the reason phrase of this SipResponse

Specified by:

getReasonPhrase in interface SipResponse

Returns:

getMethod

public Buffer getMethod()
                 throws SipParseException

Get the method of this sip message

Specified by:

getMethod in interface SipMessage

Specified by:

getMethod in class SipMessageImpl

Returns:

Throws:

SipParseException

getStatus

public int getStatus()

Get the status code of this SIP response

Specified by:

getStatus in interface SipResponse

Returns:

isProvisional

public boolean isProvisional()

Convenience method for checking whether this is a 1xx response or not.

Specified by:

isProvisional in interface SipResponse

Returns:

isFinal

public boolean isFinal()

Convenience method for checking whether this response is a final response, i.e. any response >= 200.

Specified by:

isFinal in interface SipResponse

Returns:

isSuccess

public boolean isSuccess()

Convenience method for checking whether this is a 2xx response or not.

Specified by:

isSuccess in interface SipResponse

Returns:

isRedirect

public boolean isRedirect()

Convenience method for checking whether this is a 3xx response or not.

Specified by:

isRedirect in interface SipResponse

Returns:

isClientError

public boolean isClientError()

Convenience method for checking whether this is a 4xx response or not.

Specified by:

isClientError in interface SipResponse

Returns:

isServerError

public boolean isServerError()

Convenience method for checking whether this is a 5xx response or not.

Specified by:

isServerError in interface SipResponse

Returns:

isGlobalError

public boolean isGlobalError()

Convenience method for checking whether this is a 6xx response or not.

Specified by:

isGlobalError in interface SipResponse

Returns:

is100Trying

public boolean is100Trying()

Convenience method for checking whether this is a 100 Trying response or not.

Specified by:

is100Trying in interface SipResponse

Returns:

isRinging

public boolean isRinging()

Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.

Specified by:

isRinging in interface SipResponse

Returns:

true if this response is a 180 or a 183 response, false otherwise

isTimeout

public boolean isTimeout()

Convenience method for checking whether this is a 480 Timeout response or not.

Specified by:

isTimeout in interface SipResponse

Returns:

toResponse

public SipResponse toResponse()
                       throws 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

Overrides:

toResponse in class SipMessageImpl

Returns:

this but casted into a SipResponse

Throws:

ClassCastException - in case this SipMessage is actually a SipResponse.

clone

public SipResponse clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Specified by:

clone in interface SipResponse

Specified by:

clone in class SipMessageImpl

Returns:

popViaHeader

public ViaHeader popViaHeader()
                       throws SipParseException

Description copied from interface: SipResponse

Pop the top-most ViaHeader. This is a convenience method for calling SipMessage.popHeader(Buffer).

Specified by:

popViaHeader in interface SipResponse

Returns:

the top-most ViaHeader or null if this SipResponse contained no ViaHeaders.

Throws:

SipParseException