SipMessage (SIP Framer and Parser Library 3.0.6 API)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

SipRequest, SipResponse

All Known Implementing Classes:

ImmutableSipMessage, ImmutableSipRequest, ImmutableSipResponse
```
public interface SipMessage
extends Cloneable
```
Packet representing a SIP message.

Author:

[email protected]

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SipMessage.Builder<T extends SipMessage>` Whenever you create a new `SipMessage` you will end up with a `SipMessage.Builder`.

Field Summary

Fields
Modifier and Type Field and Description

static String UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Fields
Modifier and Type	Field and Description
`static String`	`UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`SipMessage`	`clone()` Perform a deep clone of this SipMessage.
`SipMessage.Builder<? extends SipMessage>`	`copy()`
`default int`	`countNoOfHeaders()`
`default SipResponse.Builder`	`createResponse(int responseCode)` Create a new response based on this `SipRequest`.
`default SipResponse.Builder`	`createResponse(int responseCode, Buffer content)`
`static SipMessage`	`frame(Buffer buffer)` Frame the supplied buffer into a `SipMessage`.
`static SipMessage`	`frame(byte[] buffer)`
`static SipMessage`	`frame(String buffer)`
`default 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.
`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
`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()`
`default boolean`	`is100Trying()` Convenience method for checking whether this is a 100 Trying response or not.
`default boolean`	`isAck()` Convenience method for determining whether the method of this message is an ACK or not.
`default boolean`	`isBye()` Convenience method for determining whether the method of this message is a BYE or not.
`default boolean`	`isByeRequest()`
`default boolean`	`isCancel()` Convenience method for determining whether the method of this message is a CANCEL or not
`default boolean`	`isCancelRequest()`
`default boolean`	`isClientError()` Convenience method for checking whether this is a 4xx response or not.
`default boolean`	`isError()` Convenience method for checking whether this an error response is >= 400.
`default boolean`	`isFinal()` Convenience method for checking whether this response is a final response, i.e.
`default boolean`	`isFinalNon2xx()` Convenience method for checking whether this is a 300 - 699.
`default boolean`	`isGlobalError()` Convenience method for checking whether this is a 6xx response or not.
`default boolean`	`isInfo()` Convenience method for determining whether the method of this message is a INFO or not.
`default boolean`	`isInfoRequest()`
`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.
`default boolean`	`isInvite()` Convenience method for determining whether the method of this message is an INVITE or not.
`default boolean`	`isInviteRequest()`
`default boolean`	`isMessage()` Convenience method for determining whether the method of this message is a MESSAGE or not.
`default boolean`	`isMessageRequest()`
`default boolean`	`isOptions()` Convenience method for determining whether the method of this message is a OPTIONS or not.
`default boolean`	`isOptionsRequest()`
`default boolean`	`isProvisional()` Convenience method for checking whether this is a 1xx response or not.
`default boolean`	`isRedirect()` Convenience method for checking whether this is a 3xx response or not.
`default boolean`	`isRegister()` Convenience method for determining whether the method of this message is an REGISTER or not.
`default boolean`	`isRegisterRequest()`
`default boolean`	`isRequest()` Check whether this sip message is a request or not
`default boolean`	`isResponse()` Check whether this sip message is a response or not
`default boolean`	`isRinging()` Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.
`default boolean`	`isServerError()` Convenience method for checking whether this is a 5xx response or not.
`default boolean`	`isSubsequent()`
`default boolean`	`isSuccess()` Convenience method for checking whether this is a 2xx response or not.
`default boolean`	`isTimeout()` Convenience method for checking whether this is a 480 Timeout response or not.
`Buffer`	`toBuffer()` Get the `Buffer` that is representing this `SipMessage`.
`default SipRequest`	`toRequest()` Got tired of casting the `SipMessage` into a `SipRequest` so you can use this method instead.
`default 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.

- Field Detail
  - UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION
```
static final String UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInitialLine
```
Buffer getInitialLine()
```
    The first line of a sip message, which is either a request or a response line
    
    Returns:
  - initialLine
```
SipInitialLine initialLine()
```
  - toRequest
```
default 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
```
default 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.
  - createResponse
```
default SipResponse.Builder createResponse(int responseCode)
                                    throws SipParseException,
                                           ClassCastException
```
    Create a new response based on this SipRequest. If this SipMessage is not a SipRequest then a ClassCastException will be thrown. Only the mandatory headers from the SipRequest are copied. Those mandatory headers are:
    Parameters:
    
    responseCode -
    
    Returns:
    
    Throws:
    
    SipParseException - in case anything goes wrong when parsing out headers from the SipRequest
    
    ClassCastException
  - createResponse
```
default SipResponse.Builder createResponse(int responseCode,
                                           Buffer content)
                                    throws SipParseException,
                                           ClassCastException
```
    Throws:
    
    SipParseException
    
    ClassCastException
  - isResponse
```
default boolean isResponse()
```
    Check whether this sip message is a response or not
    
    Returns:
  - isRequest
```
default boolean isRequest()
```
    Check whether this sip message is a request or not
    
    Returns:
  - isInviteRequest
```
default boolean isInviteRequest()
```
  - isByeRequest
```
default boolean isByeRequest()
```
  - isCancelRequest
```
default boolean isCancelRequest()
```
  - isRegisterRequest
```
default boolean isRegisterRequest()
```
  - isOptionsRequest
```
default boolean isOptionsRequest()
```
  - isInfoRequest
```
default boolean isInfoRequest()
```
  - isMessageRequest
```
default boolean isMessageRequest()
```
  - isError
```
default boolean isError()
```
    Convenience method for checking whether this an error response is >= 400.
    
    Returns:
  - isProvisional
```
default boolean isProvisional()
```
    Convenience method for checking whether this is a 1xx response or not.
    
    Returns:
  - isFinal
```
default boolean isFinal()
```
    Convenience method for checking whether this response is a final response, i.e. any response >= 200.
    
    Returns:
  - isSuccess
```
default boolean isSuccess()
```
    Convenience method for checking whether this is a 2xx response or not.
    
    Returns:
  - isFinalNon2xx
```
default boolean isFinalNon2xx()
```
    Convenience method for checking whether this is a 300 - 699. I.e. it's a final non-2xx response.
    
    Returns:
  - isRedirect
```
default boolean isRedirect()
```
    Convenience method for checking whether this is a 3xx response or not.
    
    Returns:
  - isClientError
```
default boolean isClientError()
```
    Convenience method for checking whether this is a 4xx response or not.
    
    Returns:
  - isServerError
```
default boolean isServerError()
```
    Convenience method for checking whether this is a 5xx response or not.
    
    Returns:
  - isGlobalError
```
default boolean isGlobalError()
```
    Convenience method for checking whether this is a 6xx response or not.
    
    Returns:
  - is100Trying
```
default boolean is100Trying()
```
    Convenience method for checking whether this is a 100 Trying response or not.
    
    Returns:
  - isRinging
```
default boolean isRinging()
```
    Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.
    
    Returns:
    
    true if this response is a 180 or a 183 response, false otherwise
  - isTimeout
```
default boolean isTimeout()
```
    Convenience method for checking whether this is a 480 Timeout response or not.
    
    Returns:
  - getContent
```
Buffer getContent()
```
    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
```
Optional<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
```
Optional<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
  - getHeaders
```
List<SipHeader> getHeaders(String headerName)
                    throws SipParseException
```
    Get all headers with the given name.
    
    Parameters:
    
    headerName -
    
    Returns:
    
    a list of all headers or an empty list if none is found.
    
    Throws:
    
    SipParseException
  - getHeaders
```
List<SipHeader> getHeaders(Buffer headerName)
                    throws SipParseException
```
    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 there are no ViaHeaders then an empty list will be returned.
    
    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
  - getRecordRouteHeaders
```
List<RecordRouteHeader> getRecordRouteHeaders()
                                       throws SipParseException
```
    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:
    
    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
  - getRouteHeaders
```
List<RouteHeader> getRouteHeaders()
                           throws SipParseException
```
    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:
    
    SipParseException
  - getExpiresHeader
```
ExpiresHeader getExpiresHeader()
                        throws SipParseException
```
    Get the ExpiresHeader
    
    Returns:
    
    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
  - getContentLength
```
int getContentLength()
              throws SipParseException
```
    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.
    
    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
```
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
```
default boolean isInvite()
                  throws SipParseException
```
    Convenience method for determining whether the method of this message is an INVITE or not. Note, this method only determined if it is an INVITE, which then could be either a request or a response, which you can check with isRequest() and isResponse()
    
    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.
  - isRegister
```
default boolean isRegister()
                    throws SipParseException
```
    Convenience method for determining whether the method of this message is an REGISTER or not.
    
    Returns:
    
    true if the method of this message is a REGISTER, false otherwise.
    
    Throws:
    
    SipParseException - in case the method could not be parsed out of the underlying buffer.
  - isBye
```
default 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
```
default 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.
  - isCancel
```
default 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.
  - isOptions
```
default 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
```
default 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
```
default 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.
  - 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
  - isSubsequent
```
default boolean isSubsequent()
                      throws SipParseException
```
    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.
    
    Returns:
  - clone
```
SipMessage clone()
```
    Perform a deep clone of this SipMessage.
    
    Returns:
  - frame
```
static SipMessage frame(Buffer buffer)
                 throws SipParseException,
                        IOException
```
    Frame the supplied buffer into a SipMessage. No deep analysis of the message will be performed so there is no guarantee that this SipMessage is actually a well formed message.
    
    Parameters:
    
    buffer -
    
    Returns:
    
    the framed SipMessage
    
    Throws:
    
    SipParseException
    
    IOException
  - frame
```
static SipMessage frame(String buffer)
                 throws SipParseException,
                        IOException
```
    Parameters:
    
    buffer -
    
    Returns:
    
    Throws:
    
    IOException
    
    SipParseException
  - frame
```
static SipMessage frame(byte[] buffer)
                 throws SipParseException,
                        IOException
```
    Throws:
    
    SipParseException
    
    IOException
  - countNoOfHeaders
```
default int countNoOfHeaders()
```
  - getAllHeaders
```
default List<SipHeader> getAllHeaders()
```
  - copy
```
SipMessage.Builder<? extends SipMessage> copy()
```

Interface SipMessage

Nested Class Summary

Field Summary

Method Summary

Field Detail

UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Detail

getInitialLine

initialLine

toRequest

toResponse

createResponse

createResponse

isResponse

isRequest

isInviteRequest

isByeRequest

isCancelRequest

isRegisterRequest

isOptionsRequest

isInfoRequest

isMessageRequest

isError

isProvisional

isFinal

isSuccess

isFinalNon2xx

isRedirect

isClientError

isServerError

isGlobalError

is100Trying

isRinging

isTimeout

getContent

hasContent

getMethod

getHeader

getHeader

getHeaders

getHeaders

getFromHeader

getToHeader

getViaHeader

getViaHeaders

getMaxForwards

getRecordRouteHeader

getRecordRouteHeaders

getRouteHeader

getRouteHeaders

getExpiresHeader

getContactHeader

getContentTypeHeader

getContentLength

getCallIDHeader

getCSeqHeader

isInvite

isRegister

isBye

isAck

isCancel

isOptions

isMessage

isInfo

isInitial

isSubsequent

verify

toBuffer

clone

frame

frame

frame

countNoOfHeaders

getAllHeaders

copy