jain.protocol.ip.sip.message
Class OptionsMessage

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ip.sip.message.Message
              |
              +--jain.protocol.ip.sip.message.RequestMessage
                    |
                    +--jain.protocol.ip.sip.message.OptionsMessage

public final class OptionsMessage

extends RequestMessage

This class represents an OPTIONS request message. An OptionsMessage means the server is being queried as to its capabilities. A server that believes it can contact the user, such as a user agent where the user is logged in and has been recently active, may respond to the OptionsMessage with a capability set. A called user agent may return a status reflecting how it would have responded to an invitation, e.g., BUSY_EVERYWHERE Such a server should return an AllowHeader indicating the methods that it supports. Proxy and redirect servers simply forward the OptionsMessage without indicating their capabilities.

OptionsMessages must be supported by SIP proxy, redirect and user agent servers, registrars and clients.

Version:

0.6

See Also:

AllowHeader, Serialized Form

Field Summary

static java.lang.String

method OptionsMessage's method

Constructor Summary

OptionsMessage(java.lang.Object source, URI requestURI, CallIdHeader callIdHeader, CSeqHeader cSeqHeader, FromHeader fromHeader, ToHeader toHeader, ViaHeader[] viaHeaders)
Constructor of OptionsMessage without body

OptionsMessage(java.lang.Object source, URI requestURI, CallIdHeader callIdHeader, CSeqHeader cSeqHeader, FromHeader fromHeader, ToHeader toHeader, ViaHeader[] viaHeaders, java.lang.Object body, ContentTypeHeader contentTypeHeader)
Constructor of OptionsMessage with body

Methods inherited from class jain.protocol.ip.sip.message.RequestMessage

addViaHeader, getAuthorizationHeader, getHideHeader, getMaxForwardsHeader, getMethod, getProxyAuthorizationHeader, getProxyRequireHeaders, getRequestURI, getRequireHeaders, getResponseKeyHeader, getRouteHeaders, getStartLine, hasAuthorizationHeader, hasHideHeader, hasMaxForwardsHeader, hasProxyAuthorizationHeader, hasProxyRequireHeaders, hasRequireHeaders, hasResponseKeyHeader, hasRouteHeaders, removeAuthorizationHeader, removeHideHeader, removeMaxForwardsHeader, removeProxyAuthorizationHeader, removeProxyRequireHeaders, removeRequireHeaders, removeResponseKeyHeader, removeRouteHeaders, setAuthorizationHeader, setHideHeader, setMaxForwardsHeader, setProxyAuthorizationHeader, setProxyRequireHeaders, setRequestURI, setRequireHeaders, setResponseKeyHeader, setRouteHeaders

Methods inherited from class jain.protocol.ip.sip.message.Message

addHeader, addHeaders, clone, equals, getAcceptEncodingHeaders, getAcceptHeaders, getAcceptLanguageHeaders, getAllHeaders, getBody, getCallIdHeader, getContactHeaders, getContentEncodingHeaders, getContentLengthHeader, getContentTypeHeader, getCSeqHeader, getDateHeader, getEncryptionHeader, getExpiresHeader, getFromHeader, getHeader, getHeaders, getOrganizationHeader, getRecordRouteHeaders, getRetryAfterHeader, getTimestampHeader, getToHeader, getUserAgentHeaders, getVersionMajor, getVersionMinor, getViaHeaders, hasAcceptEncodingHeaders, hasAcceptHeaders, hasAcceptLanguageHeaders, hasBody, hasContactHeaders, hasContentEncodingHeaders, hasContentLengthHeader, hasContentTypeHeader, hasDateHeader, hasEncryptionHeader, hasExpiresHeader, hasHeaders, hasOrganizationHeader, hasRecordRouteHeaders, hasRetryAfterHeader, hasTimestampHeader, hasUserAgentHeaders, isRequest, removeAcceptEncodingHeaders, removeAcceptHeaders, removeAcceptLanguageHeaders, removeBody, removeContactHeaders, removeContentEncodingHeaders, removeContentLengthHeader, removeDateHeader, removeEncryptionHeader, removeExpiresHeader, removeHeader, removeHeaders, removeOrganizationHeader, removeRecordRouteHeaders, removeRetryAfterHeader, removeTimestampHeader, removeUserAgentHeaders, setAcceptEncodingHeaders, setAcceptHeaders, setAcceptLanguageHeaders, setBody, setCallIdHeader, setContactHeaders, setContentEncodingHeaders, setContentLengthHeader, setContentTypeHeader, setCSeqHeader, setDateHeader, setEncryptionHeader, setExpiresHeader, setFromHeader, setHeader, setHeaders, setOrganizationHeader, setRecordRouteHeaders, setRetryAfterHeader, setTimestampHeader, setToHeader, setUserAgentHeaders, setVersion, setViaHeaders, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

method

public static final java.lang.String method

OptionsMessage's method

Constructor Detail

OptionsMessage

public OptionsMessage(java.lang.Object source,
                      URI requestURI,
                      CallIdHeader callIdHeader,
                      CSeqHeader cSeqHeader,
                      FromHeader fromHeader,
                      ToHeader toHeader,
                      ViaHeader[] viaHeaders)
               throws java.lang.IllegalArgumentException

Constructor of OptionsMessage without body

Parameters:

source - source of the OptionsMessage

requestURI - Request URI

callIdHeader - CallIdHeader

cSeqHeader - CSeqHeader

fromHeader - FromHeader

toHeader - ToHeader

viaHeaders - ViaHeaders

Throws:

java.lang.IllegalArgumentException - if any arguments are invalid

OptionsMessage

public OptionsMessage(java.lang.Object source,
                      URI requestURI,
                      CallIdHeader callIdHeader,
                      CSeqHeader cSeqHeader,
                      FromHeader fromHeader,
                      ToHeader toHeader,
                      ViaHeader[] viaHeaders,
                      java.lang.Object body,
                      ContentTypeHeader contentTypeHeader)
               throws java.lang.IllegalArgumentException

Constructor of OptionsMessage with body

Parameters:

source - source of the OptionsMessage

requestURI - Request URI

callIdHeader - CallIdHeader

cSeqHeader - CSeqHeader

fromHeader - FromHeader

toHeader - ToHeader

viaHeaders - ViaHeaders

body - body

contentTypeHeader - ContentTypeHeader

Throws:

java.lang.IllegalArgumentException - if any arguments are invalid