SipMessage

java.lang.Object
- org.mjsip.sip.message.BasicSipMessage
- - org.mjsip.sip.message.SipMessage

```
public class SipMessage
extends BasicSipMessage
```
Class SipMessage extends class BasicSipMessage providing methods for handling and parsing specific methods and header fields.
It supports all methods and header fields definened in RFC 3261, plus:
- method MESSAGE (RFC3428)
- method REFER (RFC3515)
- header Refer-To
- header Referred-By
- header Event

Field Summary
- Fields inherited from class org.mjsip.sip.message.BasicSipMessage
  body, connection_id, DEBUG, headers, MAX_PKT_SIZE, PROTO_SCTP, PROTO_TCP, PROTO_TLS, PROTO_UDP, remote_addr, remote_port, request_line, SIP_VERSION, status_line, transport_proto

Constructor Summary

Constructors
Constructor and Description
`SipMessage()` Creates a new empty Message
`SipMessage(byte[] buff, int offset, int len)` Creates a new Message
`SipMessage(RequestLine request_line, java.util.Vector headers, byte[] body)` Creates a new SIP request message.
`SipMessage(SipMessage msg)` Creates a new Message
`SipMessage(StatusLine status_line, java.util.Vector headers, byte[] body)` Creates a new SIP response message.
`SipMessage(java.lang.String str)` Creates a new Message

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContactHeader(ContactHeader ch)` Adds ContactHeader.
`void`	`addContacts(MultipleHeader contacts, boolean top)` Adds Contacts.
`void`	`addRecordRouteHeader(RecordRouteHeader rrh)` Adds a RecordRouteHeader at the top.
`void`	`addRecordRoutes(MultipleHeader routes)` Adds some Record-Route header fields at the top.
`void`	`addRouteHeader(RouteHeader rh)` Adds a RouteHeader at the top.
`void`	`addRoutes(MultipleHeader routes)` Adds some Route header fields at the top.
`void`	`addViaHeader(ViaHeader vh)` Adds a ViaHeader at the top.
`void`	`addVias(MultipleHeader vias, boolean top)` Adds some Via header fields.
`java.lang.Object`	`clone()` Creates and returns a clone of the Message
`AcceptEncodingHeader`	`getAcceptEncodingHeader()` Gets AcceptEncodingHeader.
`AcceptHeader`	`getAcceptHeader()` Gets AcceptHeader.
`AcceptLanguageHeader`	`getAcceptLanguageHeader()` Gets AcceptLanguageHeader.
`AlertInfoHeader`	`getAlertInfoHeader()` Gets AlertInfoHeader.
`AllowEventsHeader`	`getAllowEventsHeader()` Gets AllowEventsHeader
`AllowHeader`	`getAllowHeader()` Gets AllowHeader.
`AuthenticationInfoHeader`	`getAuthenticationInfoHeader()` Gets AuthenticationInfoHeader.
`AuthorizationHeader`	`getAuthorizationHeader()` Gets AuthorizationHeader.
`CallIdHeader`	`getCallIdHeader()` Gets CallIdHeader of Message.
`ContactHeader`	`getContactHeader()` Deprecated.
`MultipleHeader`	`getContacts()` Gets a MultipleHeader of Contacts.
`CSeqHeader`	`getCSeqHeader()` Gets CSeqHeader of Message.
`DateHeader`	`getDateHeader()` Gets DateHeader of Message.
`EventHeader`	`getEventHeader()` Gets EventHeader
`ExpiresHeader`	`getExpiresHeader()` Gets ExpiresHeader of Message.
`FromHeader`	`getFromHeader()` Gets FromHeader of Message.
`InfoPackageHeader`	`getInfoPackageHeader()` Gets InfoPackageHeader.
`MaxForwardsHeader`	`getMaxForwardsHeader()` Gets MaxForwardsHeader of Message.
`MinSEHeader`	`getMinSEHeader()` Gets MinSEHeader
`ProxyAuthenticateHeader`	`getProxyAuthenticateHeader()` Gets ProxyAuthenticateHeader.
`ProxyAuthorizationHeader`	`getProxyAuthorizationHeader()` Gets ProxyAuthorizationHeader.
`ProxyRequireHeader`	`getProxyRequireHeader()` Gets ProxyRequireHeader.
`RAckHeader`	`getRAckHeader()` Gets RAckHeader
`RecordRouteHeader`	`getRecordRouteHeader()` Gets the top RecordRouteHeader.
`MultipleHeader`	`getRecordRoutes()` Gets all Record-Route header fields.
`RecvInfoHeader`	`getRecvInfoHeader()` Gets RecvInfoHeader.
`ReferredByHeader`	`getReferredByHeader()` Gets ReferredByHeader
`ReferToHeader`	`getReferToHeader()` Gets ReferToHeader
`ReplacesHeader`	`getReplacesHeader()` Gets ReplacesHeader
`RequireHeader`	`getRequireHeader()` Gets RequireHeader.
`RouteHeader`	`getRouteHeader()` Gets the top RouteHeader.
`MultipleHeader`	`getRoutes()` Gets all Route header fields.
`RSeqHeader`	`getRSeqHeader()` Gets RSeqHeader
`ServerHeader`	`getServerHeader()` Gets ServerHeader.
`MultipleHeader`	`getServiceRoutes()` Gets all Service-Route header fields.
`SessionExpiresHeader`	`getSessionExpiresHeader()` Gets SessionExpiresHeader
`SubjectHeader`	`getSubjectHeader()` Gets SubjectHeader of Message.
`SubscriptionStateHeader`	`getSubscriptionStateHeader()` Gets SubscriptionStateHeader
`SupportedHeader`	`getSupportedHeader()` Gets SupportedHeader.
`ToHeader`	`getToHeader()` Gets ToHeader of Message.
`java.lang.String`	`getTransactionMethod()` Returns the transaction method.
`UnsupportedHeader`	`getUnsupportedHeader()` Gets UnsupportedHeader.
`UserAgentHeader`	`getUserAgentHeader()` Gets UserAgentHeader.
`ViaHeader`	`getViaHeader()` Gets the top ViaHeader.
`MultipleHeader`	`getVias()` Gets all Via header fields.
`WwwAuthenticateHeader`	`getWwwAuthenticateHeader()` Gets WwwAuthenticateHeader.
`boolean`	`hasAcceptEncodingHeader()` Whether has AcceptEncodingHeader.
`boolean`	`hasAcceptHeader()` Whether has AcceptHeader.
`boolean`	`hasAcceptLanguageHeader()` Whether has AcceptLanguageHeader.
`boolean`	`hasAlertInfoHeader()` Whether has AlertInfoHeader.
`boolean`	`hasAllowEventsHeader()` Whether the message has the AllowEventsHeader
`boolean`	`hasAllowHeader()` Whether has AllowHeader.
`boolean`	`hasAuthenticationInfoHeader()` Whether has AuthenticationInfoHeader.
`boolean`	`hasAuthorizationHeader()` Whether has AuthorizationHeader.
`boolean`	`hasCallIdHeader()` Whether has CallIdHeader.
`boolean`	`hasContactHeader()` Whether Message has Contact header field.
`boolean`	`hasCSeqHeader()` Whether Message has CSeqHeader.
`boolean`	`hasDateHeader()` Whether Message has DateHeader.
`boolean`	`hasEventHeader()` Whether the message has the EventHeader
`boolean`	`hasExpiresHeader()` Whether Message has ExpiresHeader.
`boolean`	`hasFromHeader()` Whether Message has FromHeader.
`boolean`	`hasInfoPackageHeader()` Whether has InfoPackageHeader.
`boolean`	`hasMaxForwardsHeader()` Whether Message has MaxForwardsHeader.
`boolean`	`hasMinSEHeader()` Whether the message has the MinSEHeader
`boolean`	`hasProxyAuthenticateHeader()` Whether has ProxyAuthenticateHeader.
`boolean`	`hasProxyAuthorizationHeader()` Whether has ProxyAuthorizationHeader.
`boolean`	`hasProxyRequireHeader()` Whether has ProxyRequireHeader.
`boolean`	`hasRAckHeader()` Whether the message has the RAckHeader
`boolean`	`hasRecordRouteHeader()` Whether Message has Record-Route header field.
`boolean`	`hasRecvInfoHeader()` Whether has RecvInfoHeader.
`boolean`	`hasReferredByHeader()` Whether the message has the Referred-By header
`boolean`	`hasReferToHeader()` Whether the message has the Refer-To header
`boolean`	`hasReplacesHeader()` Whether the message has the Replaces header
`boolean`	`hasRequireHeader()` Whether has RequireHeader.
`boolean`	`hasRouteHeader()` Whether Message has Route header field.
`boolean`	`hasRSeqHeader()` Whether the message has the RSeqHeader
`boolean`	`hasServerHeader()` Whether has ServerHeader.
`boolean`	`hasServiceRouteHeader()` Whether Message has Service-Route header field.
`boolean`	`hasSessionExpiresHeader()` Whether the message has the SessionExpiresHeader
`boolean`	`hasSubjectHeader()` Whether Message has SubjectHeader.
`boolean`	`hasSubscriptionStateHeader()` Whether the message has the Subscription-State header
`boolean`	`hasSupportedHeader()` Whether has SupportedHeader.
`boolean`	`hasToHeader()` Whether Message has ToHeader.
`boolean`	`hasUnsupportedHeader()` Whether has UnsupportedHeader.
`boolean`	`hasUserAgentHeader()` Whether has UserAgentHeader.
`boolean`	`hasViaHeader()` Whether Message has Via header field.
`boolean`	`hasWwwAuthenticateHeader()` Whether has WwwAuthenticateHeader.
`boolean`	`isAck()` Whether Message is an Ack.
`boolean`	`isBye()` Whether Message is a Bye.
`boolean`	`isCancel()` Whether Message is a Cancel.
`boolean`	`isInfo()` Returns boolean value to indicate if Message is a INFO request (RFC2976)
`boolean`	`isInvite()` Whether Message is an Invite.
`boolean`	`isMessage()` Returns boolean value to indicate if Message is a MESSAGE request (RFC3428)
`boolean`	`isNotify()` Returns boolean value to indicate if Message is a NOTIFY request (RFC3265)
`boolean`	`isOptions()` Whether Message is an Options.
`boolean`	`isPrack()` Returns boolean value to indicate if Message is a PRACK request (RFC3262)
`boolean`	`isPublish()` Returns boolean value to indicate if Message is a PUBLISH request (RFC3903)
`boolean`	`isRefer()` Returns boolean value to indicate if Message is a REFER request (RFC3515)
`boolean`	`isRegister()` Whether Message is a Register.
`boolean`	`isSubscribe()` Returns boolean value to indicate if Message is a SUBSCRIBE request (RFC3265)
`boolean`	`isUpdate()` Returns boolean value to indicate if Message is a UPDATE request (RFC3311)
`void`	`removeAcceptEncodingHeader()` Removes AcceptEncodingHeader.
`void`	`removeAcceptHeader()` Removes AcceptHeader.
`void`	`removeAcceptLanguageHeader()` Removes AcceptLanguageHeader.
`void`	`removeAlertInfoHeader()` Removes AlertInfoHeader.
`void`	`removeAllowEventsHeader()` Removes AllowEventsHeader from Message (if it exists)
`void`	`removeAllowHeader()` Removes AllowHeader.
`void`	`removeAuthenticationInfoHeader()` Removes AuthenticationInfoHeader.
`void`	`removeAuthorizationHeader()` Removes AuthorizationHeader.
`void`	`removeCallIdHeader()` Removes CallIdHeader from Message.
`void`	`removeContacts()` Removes ContactHeaders from Message.
`void`	`removeCSeqHeader()` Removes CSeqHeader from Message.
`void`	`removeDateHeader()` Removes DateHeader from Message (if it exists).
`void`	`removeEventHeader()` Removes EventHeader from Message (if it exists)
`void`	`removeExpiresHeader()` Removes ExpiresHeader from Message (if it exists).
`void`	`removeFromHeader()` Removes FromHeader from Message.
`void`	`removeInfoPackageHeader()` Removes InfoPackageHeader.
`void`	`removeMaxForwardsHeader()` Removes MaxForwardsHeader from Message.
`void`	`removeMinSEHeader()` Removes MinSEHeader from Message (if it exists)
`void`	`removeProxyAuthenticateHeader()` Removes ProxyAuthenticateHeader.
`void`	`removeProxyAuthorizationHeader()` Removes ProxyAuthorizationHeader.
`void`	`removeProxyRequireHeader()` Removes ProxyRequireHeader.
`void`	`removeRAckHeader()` Removes RAckHeader from Message (if it exists)
`void`	`removeRecordRouteHeader()` Removes the top RecordRouteHeader.
`void`	`removeRecordRoutes()` Removes all Record-Route header fields (if any).
`void`	`removeRecvInfoHeader()` Removes RecvInfoHeader.
`void`	`removeReferredByHeader()` Removes ReferredByHeader from Message (if it exists)
`void`	`removeReferToHeader()` Removes ReferToHeader from Message (if it exists)
`void`	`removeReplacesHeader()` Removes ReplacesHeader from Message (if it exists)
`void`	`removeRequireHeader()` Removes RequireHeader.
`void`	`removeRouteHeader()` Removes the top RouteHeader.
`void`	`removeRoutes()` Removes all Route header fields (if any).
`void`	`removeRSeqHeader()` Removes RSeqHeader from Message (if it exists)
`void`	`removeServerHeader()` Removes ServerHeader.
`void`	`removeServiceRoutes()` Removes all Service-Route header fields (if any).
`void`	`removeSessionExpiresHeader()` Removes SessionExpiresHeader from Message (if it exists)
`void`	`removeSubjectHeader()` Removes SubjectHeader from Message.
`void`	`removeSubscriptionStateHeader()` Removes SubscriptionStateHeader from Message (if it exists)
`void`	`removeSupportedHeader()` Removes SupportedHeader.
`void`	`removeToHeader()` Removes ToHeader from Message.
`void`	`removeUnsupportedHeader()` Removes UnsupportedHeader.
`void`	`removeUserAgentHeader()` Removes UserAgentHeader.
`void`	`removeViaHeader()` Removes the top ViaHeader.
`void`	`removeVias()` Removes all Via header fields from Message (if any).
`void`	`removeWwwAuthenticateHeader()` Removes WwwAuthenticateHeader.
`void`	`rfc2543RouteAdapt()` Checks whether the next Route is formed according to RFC2543 Strict Route and adapts the message.
`void`	`rfc2543toRfc3261RouteUpdate()` Changes form RFC2543 Strict Route to RFC3261 Lose Route.
`void`	`setAcceptEncodingHeader(AcceptEncodingHeader h)` Sets AcceptEncodingHeader.
`void`	`setAcceptHeader(AcceptHeader h)` Sets AcceptHeader.
`void`	`setAcceptLanguageHeader(AcceptLanguageHeader h)` Sets AcceptLanguageHeader.
`void`	`setAlertInfoHeader(AlertInfoHeader h)` Sets AlertInfoHeader.
`void`	`setAllowEventsHeader(AllowEventsHeader h)` Sets AllowEventsHeader
`void`	`setAllowHeader(AllowHeader h)` Sets AllowHeader.
`void`	`setAuthenticationInfoHeader(AuthenticationInfoHeader h)` Sets AuthenticationInfoHeader.
`void`	`setAuthorizationHeader(AuthorizationHeader h)` Sets AuthorizationHeader.
`void`	`setCallIdHeader(CallIdHeader cih)` Sets CallIdHeader of Message.
`void`	`setContactHeader(ContactHeader ch)` Sets ContactHeader.
`void`	`setContacts(MultipleHeader contacts)` Sets Contacts.
`void`	`setCSeqHeader(CSeqHeader csh)` Sets CSeqHeader of Message.
`void`	`setDateHeader(DateHeader dh)` Sets DateHeader of Message.
`void`	`setEventHeader(EventHeader h)` Sets EventHeader
`void`	`setExpiresHeader(ExpiresHeader eh)` Sets ExpiresHeader of Message.
`void`	`setFromHeader(FromHeader fh)` Sets FromHeader of Message.
`void`	`setInfoPackageHeader(InfoPackageHeader h)` Sets InfoPackageHeader.
`void`	`setMaxForwardsHeader(MaxForwardsHeader mfh)` Sets MaxForwardsHeader of Message.
`void`	`setMinSEHeader(MinSEHeader h)` Sets MinSEHeader
`void`	`setProxyAuthenticateHeader(ProxyAuthenticateHeader h)` Sets ProxyAuthenticateHeader.
`void`	`setProxyAuthorizationHeader(ProxyAuthorizationHeader h)` Sets ProxyAuthorizationHeader.
`void`	`setProxyRequireHeader(ProxyRequireHeader h)` Sets ProxyRequireHeader.
`void`	`setRAckHeader(RAckHeader h)` Sets RAckHeader
`void`	`setRecordRoutes(MultipleHeader routes)` Sets Record-Route header fields.
`void`	`setRecvInfoHeader(RecvInfoHeader h)` Sets RecvInfoHeader.
`void`	`setReferredByHeader(ReferredByHeader h)` Sets ReferredByHeader
`void`	`setReferToHeader(ReferToHeader h)` Sets ReferToHeader
`void`	`setReplacesHeader(ReplacesHeader h)` Sets ReplacesHeader
`void`	`setRequireHeader(RequireHeader h)` Sets RequireHeader.
`void`	`setRoutes(MultipleHeader routes)` Sets all Route header fields.
`void`	`setRSeqHeader(RSeqHeader h)` Sets RSeqHeader
`void`	`setServerHeader(ServerHeader h)` Sets ServerHeader.
`void`	`setServiceRoutes(MultipleHeader service_routes)` Sets Service-Route header fields.
`void`	`setSessionExpiresHeader(SessionExpiresHeader h)` Sets SessionExpiresHeader
`void`	`setSubjectHeader(SubjectHeader sh)` Sets SubjectHeader of Message.
`void`	`setSubscriptionStateHeader(SubscriptionStateHeader h)` Sets SubscriptionStateHeader
`void`	`setSupportedHeader(SupportedHeader h)` Sets SupportedHeader.
`void`	`setToHeader(ToHeader th)` Sets ToHeader of Message.
`void`	`setUnsupportedHeader(UnsupportedHeader h)` Sets UnsupportedHeader.
`void`	`setUserAgentHeader(UserAgentHeader h)` Sets UserAgentHeader.
`void`	`setVias(MultipleHeader vias)` Sets Via header fields.
`void`	`setWwwAuthenticateHeader(WwwAuthenticateHeader h)` Sets WwwAuthenticateHeader.

Methods inherited from class org.mjsip.sip.message.BasicSipMessage
addHeader, addHeaderAfter, addHeaderBefore, addHeaders, addHeaders, addHeadersAfter, addHeadersBefore, clearTransport, createsDialog, getBody, getBodyDisposition, getBodyType, getBytes, getConnectionId, getContentDispositionHeader, getContentLengthHeader, getContentTypeHeader, getFirstLine, getHeader, getHeaders, getHeaders, getLength, getRemoteAddress, getRemotePort, getRequestLine, getStatusLine, getStringBody, getTransportProtocol, hasBody, hasContentDispositionHeader, hasContentLengthHeader, hasContentTypeHeader, hasHeader, hasRequestLine, hasStatusLine, indexOfHeader, isRequest, isRequest, isResponse, removeAllHeaders, removeBody, removeContentDispositionHeader, removeContentLengthHeader, removeContentTypeHeader, removeFirstLine, removeHeader, removeHeader, removeRequestLine, removeStatusLine, setBody, setBody, setBody, setConnectionId, setContentDispositionHeader, setContentLengthHeader, setContentTypeHeader, setHeader, setHeaders, setMessage, setMessage, setMessage, setRemoteAddress, setRemotePort, setRequestLine, setSdpBody, setStatusLine, setTransportProtocol, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SipMessage
```
public SipMessage()
```
    Creates a new empty Message
  - SipMessage
```
public SipMessage(RequestLine request_line,
                  java.util.Vector headers,
                  byte[] body)
```
    Creates a new SIP request message.
    
    Parameters:
    
    request_line - the request-line
    
    headers - vector of SIP header fields
    
    body - the message body
  - SipMessage
```
public SipMessage(StatusLine status_line,
                  java.util.Vector headers,
                  byte[] body)
```
    Creates a new SIP response message.
    
    Parameters:
    
    status_line - the response status-line
    
    headers - vector of SIP header fields
    
    body - the message body
  - SipMessage
```
public SipMessage(java.lang.String str)
```
    Creates a new Message
  - SipMessage
```
public SipMessage(byte[] buff,
                  int offset,
                  int len)
```
    Creates a new Message
  - SipMessage
```
public SipMessage(SipMessage msg)
```
    Creates a new Message
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a clone of the Message
    
    Specified by:
    
    clone in class BasicSipMessage
  - isInvite
```
public boolean isInvite()
```
    Whether Message is an Invite.
  - isAck
```
public boolean isAck()
```
    Whether Message is an Ack.
  - isOptions
```
public boolean isOptions()
```
    Whether Message is an Options.
  - isBye
```
public boolean isBye()
```
    Whether Message is a Bye.
  - isCancel
```
public boolean isCancel()
```
    Whether Message is a Cancel.
  - isRegister
```
public boolean isRegister()
```
    Whether Message is a Register.
  - getTransactionMethod
```
public java.lang.String getTransactionMethod()
```
    Returns the transaction method.
  - hasMaxForwardsHeader
```
public boolean hasMaxForwardsHeader()
```
    Whether Message has MaxForwardsHeader.
  - getMaxForwardsHeader
```
public MaxForwardsHeader getMaxForwardsHeader()
```
    Gets MaxForwardsHeader of Message.
  - setMaxForwardsHeader
```
public void setMaxForwardsHeader(MaxForwardsHeader mfh)
```
    Sets MaxForwardsHeader of Message.
  - removeMaxForwardsHeader
```
public void removeMaxForwardsHeader()
```
    Removes MaxForwardsHeader from Message.
  - hasFromHeader
```
public boolean hasFromHeader()
```
    Whether Message has FromHeader.
  - getFromHeader
```
public FromHeader getFromHeader()
```
    Gets FromHeader of Message.
  - setFromHeader
```
public void setFromHeader(FromHeader fh)
```
    Sets FromHeader of Message.
  - removeFromHeader
```
public void removeFromHeader()
```
    Removes FromHeader from Message.
  - hasToHeader
```
public boolean hasToHeader()
```
    Whether Message has ToHeader.
  - getToHeader
```
public ToHeader getToHeader()
```
    Gets ToHeader of Message.
  - setToHeader
```
public void setToHeader(ToHeader th)
```
    Sets ToHeader of Message.
  - removeToHeader
```
public void removeToHeader()
```
    Removes ToHeader from Message.
  - hasContactHeader
```
public boolean hasContactHeader()
```
    Whether Message has Contact header field.
    
    Returns:
    
    true if it has Contact header field (false otherwise)
  - getContactHeader
```
public ContactHeader getContactHeader()
```
    Deprecated. Gets ContactHeader of Message. Use getContacts instead.
    
    Returns:
    
    the top Contact header field
  - getContacts
```
public MultipleHeader getContacts()
```
    Gets a MultipleHeader of Contacts.
    
    Returns:
    
    all contacts (MultipleHeader of ContactHeader)
  - addContactHeader
```
public void addContactHeader(ContactHeader ch)
```
    Adds ContactHeader.
    
    Parameters:
    
    ch - the Contact header field
  - addContacts
```
public void addContacts(MultipleHeader contacts,
                        boolean top)
```
    Adds Contacts.
    
    Parameters:
    
    contacts - the Contact header fields to be added
    
    top - whether they will be added at top (or bottom)
  - setContactHeader
```
public void setContactHeader(ContactHeader ch)
```
    Sets ContactHeader.
  - setContacts
```
public void setContacts(MultipleHeader contacts)
```
    Sets Contacts.
    
    Parameters:
    
    contacts - contacts (MultipleHeader of Contact)
  - removeContacts
```
public void removeContacts()
```
    Removes ContactHeaders from Message.
  - hasViaHeader
```
public boolean hasViaHeader()
```
    Whether Message has Via header field.
    
    Returns:
    
    true if it has Via header field (false otherwise)
  - getViaHeader
```
public ViaHeader getViaHeader()
```
    Gets the top ViaHeader.
    
    Returns:
    
    the top Via header field
  - getVias
```
public MultipleHeader getVias()
```
    Gets all Via header fields.
    
    Returns:
    
    all Via header fields (MultipleHeader of ViaHeader)
  - addViaHeader
```
public void addViaHeader(ViaHeader vh)
```
    Adds a ViaHeader at the top.
    
    Parameters:
    
    vh - the Via header field
  - addVias
```
public void addVias(MultipleHeader vias,
                    boolean top)
```
    Adds some Via header fields.
    
    Parameters:
    
    vias - the Via header fields to be added
    
    top - whether they will be added at top (or bottom)
  - setVias
```
public void setVias(MultipleHeader vias)
```
    Sets Via header fields.
    
    Parameters:
    
    vias - Via header fields (MultipleHeader of Via)
  - removeViaHeader
```
public void removeViaHeader()
```
    Removes the top ViaHeader.
  - removeVias
```
public void removeVias()
```
    Removes all Via header fields from Message (if any).
  - hasRouteHeader
```
public boolean hasRouteHeader()
```
    Whether Message has Route header field.
    
    Returns:
    
    true if it has Route header field (false otherwise)
  - getRouteHeader
```
public RouteHeader getRouteHeader()
```
    Gets the top RouteHeader.
    
    Returns:
    
    the top Route header field
  - getRoutes
```
public MultipleHeader getRoutes()
```
    Gets all Route header fields.
    
    Returns:
    
    all routes (MultipleHeader of RouteHeader)
  - addRouteHeader
```
public void addRouteHeader(RouteHeader rh)
```
    Adds a RouteHeader at the top.
    
    Parameters:
    
    rh - the Route header field
  - addRoutes
```
public void addRoutes(MultipleHeader routes)
```
    Adds some Route header fields at the top.
    
    Parameters:
    
    routes - the Route header fields to be added
  - setRoutes
```
public void setRoutes(MultipleHeader routes)
```
    Sets all Route header fields.
    
    Parameters:
    
    routes - routes (MultipleHeader of RouteHeader)
  - removeRouteHeader
```
public void removeRouteHeader()
```
    Removes the top RouteHeader.
  - removeRoutes
```
public void removeRoutes()
```
    Removes all Route header fields (if any).
  - hasRecordRouteHeader
```
public boolean hasRecordRouteHeader()
```
    Whether Message has Record-Route header field.
    
    Returns:
    
    true if it has Record-Route header field (false otherwise)
  - getRecordRouteHeader
```
public RecordRouteHeader getRecordRouteHeader()
```
    Gets the top RecordRouteHeader.
    
    Returns:
    
    the top Record-Route header field
  - getRecordRoutes
```
public MultipleHeader getRecordRoutes()
```
    Gets all Record-Route header fields.
    
    Returns:
    
    all routes (MultipleHeader of RecordRouteHeader)
  - addRecordRouteHeader
```
public void addRecordRouteHeader(RecordRouteHeader rrh)
```
    Adds a RecordRouteHeader at the top.
    
    Parameters:
    
    rrh - the Record-Route header field
  - addRecordRoutes
```
public void addRecordRoutes(MultipleHeader routes)
```
    Adds some Record-Route header fields at the top.
    
    Parameters:
    
    routes - the Record-Route header fields to be added
  - setRecordRoutes
```
public void setRecordRoutes(MultipleHeader routes)
```
    Sets Record-Route header fields.
    
    Parameters:
    
    routes - routes (MultipleHeader of RecordRouteHeader)
  - removeRecordRouteHeader
```
public void removeRecordRouteHeader()
```
    Removes the top RecordRouteHeader.
  - removeRecordRoutes
```
public void removeRecordRoutes()
```
    Removes all Record-Route header fields (if any).
  - hasServiceRouteHeader
```
public boolean hasServiceRouteHeader()
```
    Whether Message has Service-Route header field.
    
    Returns:
    
    true if it has Service-Route header field (false otherwise)
  - getServiceRoutes
```
public MultipleHeader getServiceRoutes()
```
    Gets all Service-Route header fields.
    
    Returns:
    
    all service routes (MultipleHeader of ServiceRouteHeader)
  - setServiceRoutes
```
public void setServiceRoutes(MultipleHeader service_routes)
```
    Sets Service-Route header fields.
    
    Parameters:
    
    service_routes - service routes (MultipleHeader of ServiceRouteHeader)
  - removeServiceRoutes
```
public void removeServiceRoutes()
```
    Removes all Service-Route header fields (if any).
  - hasCSeqHeader
```
public boolean hasCSeqHeader()
```
    Whether Message has CSeqHeader.
  - getCSeqHeader
```
public CSeqHeader getCSeqHeader()
```
    Gets CSeqHeader of Message.
  - setCSeqHeader
```
public void setCSeqHeader(CSeqHeader csh)
```
    Sets CSeqHeader of Message.
  - removeCSeqHeader
```
public void removeCSeqHeader()
```
    Removes CSeqHeader from Message.
  - hasCallIdHeader
```
public boolean hasCallIdHeader()
```
    Whether has CallIdHeader.
  - setCallIdHeader
```
public void setCallIdHeader(CallIdHeader cih)
```
    Sets CallIdHeader of Message.
  - getCallIdHeader
```
public CallIdHeader getCallIdHeader()
```
    Gets CallIdHeader of Message.
  - removeCallIdHeader
```
public void removeCallIdHeader()
```
    Removes CallIdHeader from Message.
  - hasSubjectHeader
```
public boolean hasSubjectHeader()
```
    Whether Message has SubjectHeader.
  - setSubjectHeader
```
public void setSubjectHeader(SubjectHeader sh)
```
    Sets SubjectHeader of Message.
  - getSubjectHeader
```
public SubjectHeader getSubjectHeader()
```
    Gets SubjectHeader of Message.
  - removeSubjectHeader
```
public void removeSubjectHeader()
```
    Removes SubjectHeader from Message.
  - hasDateHeader
```
public boolean hasDateHeader()
```
    Whether Message has DateHeader.
  - getDateHeader
```
public DateHeader getDateHeader()
```
    Gets DateHeader of Message.
  - setDateHeader
```
public void setDateHeader(DateHeader dh)
```
    Sets DateHeader of Message.
  - removeDateHeader
```
public void removeDateHeader()
```
    Removes DateHeader from Message (if it exists).
  - hasUserAgentHeader
```
public boolean hasUserAgentHeader()
```
    Whether has UserAgentHeader.
  - setUserAgentHeader
```
public void setUserAgentHeader(UserAgentHeader h)
```
    Sets UserAgentHeader.
  - getUserAgentHeader
```
public UserAgentHeader getUserAgentHeader()
```
    Gets UserAgentHeader.
  - removeUserAgentHeader
```
public void removeUserAgentHeader()
```
    Removes UserAgentHeader.
  - hasServerHeader
```
public boolean hasServerHeader()
```
    Whether has ServerHeader.
  - setServerHeader
```
public void setServerHeader(ServerHeader h)
```
    Sets ServerHeader.
  - getServerHeader
```
public ServerHeader getServerHeader()
```
    Gets ServerHeader.
  - removeServerHeader
```
public void removeServerHeader()
```
    Removes ServerHeader.
  - hasAcceptHeader
```
public boolean hasAcceptHeader()
```
    Whether has AcceptHeader.
  - setAcceptHeader
```
public void setAcceptHeader(AcceptHeader h)
```
    Sets AcceptHeader.
  - getAcceptHeader
```
public AcceptHeader getAcceptHeader()
```
    Gets AcceptHeader.
  - removeAcceptHeader
```
public void removeAcceptHeader()
```
    Removes AcceptHeader.
  - hasAcceptEncodingHeader
```
public boolean hasAcceptEncodingHeader()
```
    Whether has AcceptEncodingHeader.
  - setAcceptEncodingHeader
```
public void setAcceptEncodingHeader(AcceptEncodingHeader h)
```
    Sets AcceptEncodingHeader.
  - getAcceptEncodingHeader
```
public AcceptEncodingHeader getAcceptEncodingHeader()
```
    Gets AcceptEncodingHeader.
  - removeAcceptEncodingHeader
```
public void removeAcceptEncodingHeader()
```
    Removes AcceptEncodingHeader.
  - hasAcceptLanguageHeader
```
public boolean hasAcceptLanguageHeader()
```
    Whether has AcceptLanguageHeader.
  - setAcceptLanguageHeader
```
public void setAcceptLanguageHeader(AcceptLanguageHeader h)
```
    Sets AcceptLanguageHeader.
  - getAcceptLanguageHeader
```
public AcceptLanguageHeader getAcceptLanguageHeader()
```
    Gets AcceptLanguageHeader.
  - removeAcceptLanguageHeader
```
public void removeAcceptLanguageHeader()
```
    Removes AcceptLanguageHeader.
  - hasAlertInfoHeader
```
public boolean hasAlertInfoHeader()
```
    Whether has AlertInfoHeader.
  - setAlertInfoHeader
```
public void setAlertInfoHeader(AlertInfoHeader h)
```
    Sets AlertInfoHeader.
  - getAlertInfoHeader
```
public AlertInfoHeader getAlertInfoHeader()
```
    Gets AlertInfoHeader.
  - removeAlertInfoHeader
```
public void removeAlertInfoHeader()
```
    Removes AlertInfoHeader.
  - hasAllowHeader
```
public boolean hasAllowHeader()
```
    Whether has AllowHeader.
  - setAllowHeader
```
public void setAllowHeader(AllowHeader h)
```
    Sets AllowHeader.
  - getAllowHeader
```
public AllowHeader getAllowHeader()
```
    Gets AllowHeader.
  - removeAllowHeader
```
public void removeAllowHeader()
```
    Removes AllowHeader.
  - hasExpiresHeader
```
public boolean hasExpiresHeader()
```
    Whether Message has ExpiresHeader.
  - getExpiresHeader
```
public ExpiresHeader getExpiresHeader()
```
    Gets ExpiresHeader of Message.
  - setExpiresHeader
```
public void setExpiresHeader(ExpiresHeader eh)
```
    Sets ExpiresHeader of Message.
  - removeExpiresHeader
```
public void removeExpiresHeader()
```
    Removes ExpiresHeader from Message (if it exists).
  - hasAuthenticationInfoHeader
```
public boolean hasAuthenticationInfoHeader()
```
    Whether has AuthenticationInfoHeader.
  - setAuthenticationInfoHeader
```
public void setAuthenticationInfoHeader(AuthenticationInfoHeader h)
```
    Sets AuthenticationInfoHeader.
  - getAuthenticationInfoHeader
```
public AuthenticationInfoHeader getAuthenticationInfoHeader()
```
    Gets AuthenticationInfoHeader.
  - removeAuthenticationInfoHeader
```
public void removeAuthenticationInfoHeader()
```
    Removes AuthenticationInfoHeader.
  - hasAuthorizationHeader
```
public boolean hasAuthorizationHeader()
```
    Whether has AuthorizationHeader.
  - setAuthorizationHeader
```
public void setAuthorizationHeader(AuthorizationHeader h)
```
    Sets AuthorizationHeader.
  - getAuthorizationHeader
```
public AuthorizationHeader getAuthorizationHeader()
```
    Gets AuthorizationHeader.
  - removeAuthorizationHeader
```
public void removeAuthorizationHeader()
```
    Removes AuthorizationHeader.
  - hasWwwAuthenticateHeader
```
public boolean hasWwwAuthenticateHeader()
```
    Whether has WwwAuthenticateHeader.
  - setWwwAuthenticateHeader
```
public void setWwwAuthenticateHeader(WwwAuthenticateHeader h)
```
    Sets WwwAuthenticateHeader.
  - getWwwAuthenticateHeader
```
public WwwAuthenticateHeader getWwwAuthenticateHeader()
```
    Gets WwwAuthenticateHeader.
  - removeWwwAuthenticateHeader
```
public void removeWwwAuthenticateHeader()
```
    Removes WwwAuthenticateHeader.
  - hasProxyAuthenticateHeader
```
public boolean hasProxyAuthenticateHeader()
```
    Whether has ProxyAuthenticateHeader.
  - setProxyAuthenticateHeader
```
public void setProxyAuthenticateHeader(ProxyAuthenticateHeader h)
```
    Sets ProxyAuthenticateHeader.
  - getProxyAuthenticateHeader
```
public ProxyAuthenticateHeader getProxyAuthenticateHeader()
```
    Gets ProxyAuthenticateHeader.
  - removeProxyAuthenticateHeader
```
public void removeProxyAuthenticateHeader()
```
    Removes ProxyAuthenticateHeader.
  - hasProxyAuthorizationHeader
```
public boolean hasProxyAuthorizationHeader()
```
    Whether has ProxyAuthorizationHeader.
  - setProxyAuthorizationHeader
```
public void setProxyAuthorizationHeader(ProxyAuthorizationHeader h)
```
    Sets ProxyAuthorizationHeader.
  - getProxyAuthorizationHeader
```
public ProxyAuthorizationHeader getProxyAuthorizationHeader()
```
    Gets ProxyAuthorizationHeader.
  - removeProxyAuthorizationHeader
```
public void removeProxyAuthorizationHeader()
```
    Removes ProxyAuthorizationHeader.
  - hasSupportedHeader
```
public boolean hasSupportedHeader()
```
    Whether has SupportedHeader.
  - setSupportedHeader
```
public void setSupportedHeader(SupportedHeader h)
```
    Sets SupportedHeader.
  - getSupportedHeader
```
public SupportedHeader getSupportedHeader()
```
    Gets SupportedHeader.
  - removeSupportedHeader
```
public void removeSupportedHeader()
```
    Removes SupportedHeader.
  - hasRequireHeader
```
public boolean hasRequireHeader()
```
    Whether has RequireHeader.
  - setRequireHeader
```
public void setRequireHeader(RequireHeader h)
```
    Sets RequireHeader.
  - getRequireHeader
```
public RequireHeader getRequireHeader()
```
    Gets RequireHeader.
  - removeRequireHeader
```
public void removeRequireHeader()
```
    Removes RequireHeader.
  - hasUnsupportedHeader
```
public boolean hasUnsupportedHeader()
```
    Whether has UnsupportedHeader.
  - setUnsupportedHeader
```
public void setUnsupportedHeader(UnsupportedHeader h)
```
    Sets UnsupportedHeader.
  - getUnsupportedHeader
```
public UnsupportedHeader getUnsupportedHeader()
```
    Gets UnsupportedHeader.
  - removeUnsupportedHeader
```
public void removeUnsupportedHeader()
```
    Removes UnsupportedHeader.
  - hasProxyRequireHeader
```
public boolean hasProxyRequireHeader()
```
    Whether has ProxyRequireHeader.
  - setProxyRequireHeader
```
public void setProxyRequireHeader(ProxyRequireHeader h)
```
    Sets ProxyRequireHeader.
  - getProxyRequireHeader
```
public ProxyRequireHeader getProxyRequireHeader()
```
    Gets ProxyRequireHeader.
  - removeProxyRequireHeader
```
public void removeProxyRequireHeader()
```
    Removes ProxyRequireHeader.
  - rfc2543RouteAdapt
```
public void rfc2543RouteAdapt()
```
    Checks whether the next Route is formed according to RFC2543 Strict Route and adapts the message.
  - rfc2543toRfc3261RouteUpdate
```
public void rfc2543toRfc3261RouteUpdate()
```
    Changes form RFC2543 Strict Route to RFC3261 Lose Route.
    The Request-URI is replaced with the last value from the Route header, and that value is removed from the Route header.
  - isInfo
```
public boolean isInfo()
               throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a INFO request (RFC2976)
    
    Throws:
    
    java.lang.NullPointerException
  - isPrack
```
public boolean isPrack()
                throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a PRACK request (RFC3262)
    
    Throws:
    
    java.lang.NullPointerException
  - isUpdate
```
public boolean isUpdate()
                 throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a UPDATE request (RFC3311)
    
    Throws:
    
    java.lang.NullPointerException
  - isMessage
```
public boolean isMessage()
                  throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a MESSAGE request (RFC3428)
    
    Throws:
    
    java.lang.NullPointerException
  - isRefer
```
public boolean isRefer()
                throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a REFER request (RFC3515)
    
    Throws:
    
    java.lang.NullPointerException
  - isNotify
```
public boolean isNotify()
                 throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a NOTIFY request (RFC3265)
    
    Throws:
    
    java.lang.NullPointerException
  - isSubscribe
```
public boolean isSubscribe()
                    throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a SUBSCRIBE request (RFC3265)
    
    Throws:
    
    java.lang.NullPointerException
  - isPublish
```
public boolean isPublish()
                  throws java.lang.NullPointerException
```
    Returns boolean value to indicate if Message is a PUBLISH request (RFC3903)
    
    Throws:
    
    java.lang.NullPointerException
  - hasRSeqHeader
```
public boolean hasRSeqHeader()
```
    Whether the message has the RSeqHeader
  - getRSeqHeader
```
public RSeqHeader getRSeqHeader()
```
    Gets RSeqHeader
  - setRSeqHeader
```
public void setRSeqHeader(RSeqHeader h)
```
    Sets RSeqHeader
  - removeRSeqHeader
```
public void removeRSeqHeader()
```
    Removes RSeqHeader from Message (if it exists)
  - hasRAckHeader
```
public boolean hasRAckHeader()
```
    Whether the message has the RAckHeader
  - getRAckHeader
```
public RAckHeader getRAckHeader()
```
    Gets RAckHeader
  - setRAckHeader
```
public void setRAckHeader(RAckHeader h)
```
    Sets RAckHeader
  - removeRAckHeader
```
public void removeRAckHeader()
```
    Removes RAckHeader from Message (if it exists)
  - hasSessionExpiresHeader
```
public boolean hasSessionExpiresHeader()
```
    Whether the message has the SessionExpiresHeader
  - getSessionExpiresHeader
```
public SessionExpiresHeader getSessionExpiresHeader()
```
    Gets SessionExpiresHeader
  - setSessionExpiresHeader
```
public void setSessionExpiresHeader(SessionExpiresHeader h)
```
    Sets SessionExpiresHeader
  - removeSessionExpiresHeader
```
public void removeSessionExpiresHeader()
```
    Removes SessionExpiresHeader from Message (if it exists)
  - hasMinSEHeader
```
public boolean hasMinSEHeader()
```
    Whether the message has the MinSEHeader
  - getMinSEHeader
```
public MinSEHeader getMinSEHeader()
```
    Gets MinSEHeader
  - setMinSEHeader
```
public void setMinSEHeader(MinSEHeader h)
```
    Sets MinSEHeader
  - removeMinSEHeader
```
public void removeMinSEHeader()
```
    Removes MinSEHeader from Message (if it exists)
  - hasReferToHeader
```
public boolean hasReferToHeader()
```
    Whether the message has the Refer-To header
  - getReferToHeader
```
public ReferToHeader getReferToHeader()
```
    Gets ReferToHeader
  - setReferToHeader
```
public void setReferToHeader(ReferToHeader h)
```
    Sets ReferToHeader
  - removeReferToHeader
```
public void removeReferToHeader()
```
    Removes ReferToHeader from Message (if it exists)
  - hasReplacesHeader
```
public boolean hasReplacesHeader()
```
    Whether the message has the Replaces header
  - getReplacesHeader
```
public ReplacesHeader getReplacesHeader()
```
    Gets ReplacesHeader
  - setReplacesHeader
```
public void setReplacesHeader(ReplacesHeader h)
```
    Sets ReplacesHeader
  - removeReplacesHeader
```
public void removeReplacesHeader()
```
    Removes ReplacesHeader from Message (if it exists)
  - hasReferredByHeader
```
public boolean hasReferredByHeader()
```
    Whether the message has the Referred-By header
  - getReferredByHeader
```
public ReferredByHeader getReferredByHeader()
```
    Gets ReferredByHeader
  - setReferredByHeader
```
public void setReferredByHeader(ReferredByHeader h)
```
    Sets ReferredByHeader
  - removeReferredByHeader
```
public void removeReferredByHeader()
```
    Removes ReferredByHeader from Message (if it exists)
  - hasEventHeader
```
public boolean hasEventHeader()
```
    Whether the message has the EventHeader
  - getEventHeader
```
public EventHeader getEventHeader()
```
    Gets EventHeader
  - setEventHeader
```
public void setEventHeader(EventHeader h)
```
    Sets EventHeader
  - removeEventHeader
```
public void removeEventHeader()
```
    Removes EventHeader from Message (if it exists)
  - hasAllowEventsHeader
```
public boolean hasAllowEventsHeader()
```
    Whether the message has the AllowEventsHeader
  - getAllowEventsHeader
```
public AllowEventsHeader getAllowEventsHeader()
```
    Gets AllowEventsHeader
  - setAllowEventsHeader
```
public void setAllowEventsHeader(AllowEventsHeader h)
```
    Sets AllowEventsHeader
  - removeAllowEventsHeader
```
public void removeAllowEventsHeader()
```
    Removes AllowEventsHeader from Message (if it exists)
  - hasSubscriptionStateHeader
```
public boolean hasSubscriptionStateHeader()
```
    Whether the message has the Subscription-State header
  - getSubscriptionStateHeader
```
public SubscriptionStateHeader getSubscriptionStateHeader()
```
    Gets SubscriptionStateHeader
  - setSubscriptionStateHeader
```
public void setSubscriptionStateHeader(SubscriptionStateHeader h)
```
    Sets SubscriptionStateHeader
  - removeSubscriptionStateHeader
```
public void removeSubscriptionStateHeader()
```
    Removes SubscriptionStateHeader from Message (if it exists)
  - hasInfoPackageHeader
```
public boolean hasInfoPackageHeader()
```
    Whether has InfoPackageHeader.
  - setInfoPackageHeader
```
public void setInfoPackageHeader(InfoPackageHeader h)
```
    Sets InfoPackageHeader.
  - getInfoPackageHeader
```
public InfoPackageHeader getInfoPackageHeader()
```
    Gets InfoPackageHeader.
  - removeInfoPackageHeader
```
public void removeInfoPackageHeader()
```
    Removes InfoPackageHeader.
  - hasRecvInfoHeader
```
public boolean hasRecvInfoHeader()
```
    Whether has RecvInfoHeader.
  - setRecvInfoHeader
```
public void setRecvInfoHeader(RecvInfoHeader h)
```
    Sets RecvInfoHeader.
  - getRecvInfoHeader
```
public RecvInfoHeader getRecvInfoHeader()
```
    Gets RecvInfoHeader.
  - removeRecvInfoHeader
```
public void removeRecvInfoHeader()
```
    Removes RecvInfoHeader.

Class SipMessage

Field Summary

Fields inherited from class org.mjsip.sip.message.BasicSipMessage

Constructor Summary

Method Summary

Methods inherited from class org.mjsip.sip.message.BasicSipMessage

Methods inherited from class java.lang.Object

Constructor Detail

SipMessage

SipMessage

SipMessage

SipMessage

SipMessage

SipMessage

Method Detail

clone

isInvite

isAck

isOptions

isBye

isCancel

isRegister

getTransactionMethod

hasMaxForwardsHeader

getMaxForwardsHeader

setMaxForwardsHeader

removeMaxForwardsHeader

hasFromHeader

getFromHeader

setFromHeader

removeFromHeader

hasToHeader

getToHeader

setToHeader

removeToHeader

hasContactHeader

getContactHeader

getContacts

addContactHeader

addContacts

setContactHeader

setContacts

removeContacts

hasViaHeader

getViaHeader

getVias

addViaHeader

addVias

setVias

removeViaHeader

removeVias

hasRouteHeader

getRouteHeader

getRoutes

addRouteHeader

addRoutes

setRoutes

removeRouteHeader

removeRoutes

hasRecordRouteHeader

getRecordRouteHeader

getRecordRoutes

addRecordRouteHeader

addRecordRoutes

setRecordRoutes

removeRecordRouteHeader

removeRecordRoutes

hasServiceRouteHeader

getServiceRoutes

setServiceRoutes

removeServiceRoutes

hasCSeqHeader

getCSeqHeader

setCSeqHeader

removeCSeqHeader

hasCallIdHeader

setCallIdHeader

getCallIdHeader

removeCallIdHeader

hasSubjectHeader