A B C D E F G H I J L M N O P Q R S T U V W _

A

ACCEPTED - Static variable in interface javax.sip.message.Response

The Acceptable extension response code signifies that the request has been accepted for processing, but the processing has not been completed.

AcceptEncodingHeader - interface javax.sip.header.AcceptEncodingHeader.

This interface represents the Accept-Encoding request-header.

AcceptHeader - interface javax.sip.header.AcceptHeader.

This interface represents an Accept request-header.

AcceptLanguageHeader - interface javax.sip.header.AcceptLanguageHeader.

The Accept-Language header field is used in requests to indicate the preferred languages for reason phrases, session descriptions, or status responses carried as message bodies in the response.

ACK - Static variable in interface javax.sip.message.Request

An ACK is used to acknowledge the successful receipt of a message in a transaction.

ACTIVE - Static variable in interface javax.sip.header.SubscriptionStateHeader

State: The subscription has been accepted and (in general) has been authorized.

addHeader(Header) - Method in interface javax.sip.message.Message

Adds the new Header to the existing list of Headers contained in this Message.

Address - interface javax.sip.address.Address.

This interface represents a user's display name and URI address.

ADDRESS_INCOMPLETE - Static variable in interface javax.sip.message.Response

The server received a request with a Request-URI that was incomplete.

AddressFactory - interface javax.sip.address.AddressFactory.

This interface provides factory methods that allow an application to create Address objects, URI's, SipURI's and TelURL's from a particular implementation of this specification.

addSipListener(SipListener) - Method in interface javax.sip.SipProvider

This method registers the SipListener object to this SipProvider, once registered the SIP Listener recieve events emitted from the SipProvider.

ALERT - Static variable in interface javax.sip.header.ContentDispositionHeader

Alert Disposition Type Constant

AlertInfoHeader - interface javax.sip.header.AlertInfoHeader.

When present in an INVITE request, the Alert-Info header field specifies an alternative ring tone to the UAS.

AllowEventsHeader - interface javax.sip.header.AllowEventsHeader.

This interface represents the AllowEvents SIP header, as defined by RFC3265, this header is not part of RFC3261.

AllowHeader - interface javax.sip.header.AllowHeader.

The Allow header field lists the set of methods supported by the User Agent generating the message.

allowsAllContentSubTypes() - Method in interface javax.sip.header.AcceptHeader

Gets boolean value to indicate if the AcceptHeader allows all media sub-types, that is the content sub-type is "*".

allowsAllContentTypes() - Method in interface javax.sip.header.AcceptHeader

Gets boolean value to indicate if the AcceptHeader allows all media types, that is the content type is "*".

ALTERNATIVE_SERVICE - Static variable in interface javax.sip.message.Response

The call was not successful, but alternative services are possible.

AMBIGUOUS - Static variable in interface javax.sip.message.Response

The Request-URI was ambiguous.

ATTRIBUTE_NOT_UNDERSTOOD - Static variable in interface javax.sip.header.WarningHeader

One or more of the media attributes in the session description are not supported.

AuthenticationInfoHeader - interface javax.sip.header.AuthenticationInfoHeader.

The Authentication-Info header field provides for mutual authentication with HTTP Digest.

AuthorizationHeader - interface javax.sip.header.AuthorizationHeader.

The Authorization header is used when a user agent wishes to authenticate itself with a server - usually, but not necessarily, after receiving an UNAUTHORIZED Response - by including an AuthorizationHeader with the Request.

B

BAD_EVENT - Static variable in interface javax.sip.message.Response

The Bad Event extension response code is used to indicate that the server did not understand the event package specified in a "Event" header field.

BAD_EXTENSION - Static variable in interface javax.sip.message.Response

The server did not understand the protocol extension specified in a Proxy-Require or Require header field.

BAD_GATEWAY - Static variable in interface javax.sip.message.Response

The server, while acting as a gateway or proxy, received an invalid response from the downstream server it accessed in attempting to fulfill the request.

BAD_REQUEST - Static variable in interface javax.sip.message.Response

The request could not be understood due to malformed syntax.

BUSY_EVERYWHERE - Static variable in interface javax.sip.message.Response

The callee's end system was contacted successfully but the callee is busy and does not wish to take the call at this time.

BUSY_HERE - Static variable in interface javax.sip.message.Response

The callee's end system was contacted successfully, but the callee is currently not willing or able to take additional calls at this end system.

BYE - Static variable in interface javax.sip.message.Request

The BYE request is used to terminate a specific session or attempted session.

C

CALL_IS_BEING_FORWARDED - Static variable in interface javax.sip.message.Response

A server MAY use this status code to indicate that the call is being forwarded to a different set of destinations.

CALL_OR_TRANSACTION_DOES_NOT_EXIST - Static variable in interface javax.sip.message.Response

This status indicates that the UAS received a request that does not match any existing dialog or transaction.

CallIdHeader - interface javax.sip.header.CallIdHeader.

The Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.

CallInfoHeader - interface javax.sip.header.CallInfoHeader.

The Call-Info header field provides additional information about the caller or callee, depending on whether it is found in a request or response.

CALLING - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Calling".

CANCEL - Static variable in interface javax.sip.message.Request

The CANCEL request is used to cancel a previous request sent by a client.

ClientTransaction - interface javax.sip.ClientTransaction.

A client transaction is used by a User Agent Client application to send Request messages to a User Agent Server application.

clone() - Method in interface javax.sip.address.URI

Creates and returns a deep copy of the URI.

clone() - Method in interface javax.sip.header.Header

Creates and returns a deep copy of the Header.

clone() - Method in interface javax.sip.message.Message

Creates and returns a deep copy of the Message.

COMPLETED - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Completed".

COMPLETED - Static variable in class javax.sip.DialogState

This constant value indicates that the dialog state is "Completed".

CONFIRMED - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Confirmed".

CONFIRMED - Static variable in class javax.sip.DialogState

This constant value indicates that the dialog state is "Confirmed".

ContactHeader - interface javax.sip.header.ContactHeader.

A Contact header field value provides a URI whose meaning depends on the type of request or response it is in.

ContentDispositionHeader - interface javax.sip.header.ContentDispositionHeader.

The Content-Disposition header field describes how the message body or, for multipart messages, a message body part is to be interpreted by the UAC or UAS.

ContentEncodingHeader - interface javax.sip.header.ContentEncodingHeader.

A ContentEncodingHeader is used as a modifier to the "media-type".

ContentLanguageHeader - interface javax.sip.header.ContentLanguageHeader.

The Content-Language header field is used to indicate the language of the message body.

ContentLengthHeader - interface javax.sip.header.ContentLengthHeader.

The Content-Length header field indicates the size of the message-body, in decimal number of octets, sent to the recipient.

ContentTypeHeader - interface javax.sip.header.ContentTypeHeader.

The Content-Type header field indicates the media type of the message-body sent to the recipient.

createAcceptEncodingHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AcceptEncodingHeader based on the newly supplied encoding value.

createAcceptHeader(String, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AcceptHeader based on the newly supplied contentType and contentSubType values.

createAcceptLanguageHeader(Locale) - Method in interface javax.sip.header.HeaderFactory

Creates a new AcceptLanguageHeader based on the newly supplied language value.

createAck() - Method in interface javax.sip.ClientTransaction

Creates a new Ack message from the Request associated with this client transaction.

createAddress(String) - Method in interface javax.sip.address.AddressFactory

Creates an Address with the new address string value.

createAddress(String, URI) - Method in interface javax.sip.address.AddressFactory

Creates an Address with the new display name and URI attribute values.

createAddress(URI) - Method in interface javax.sip.address.AddressFactory

Creates an Address with the new URI attribute value.

createAddressFactory() - Method in class javax.sip.SipFactory

Creates an instance of the AddressFactory implementation.

createAlertInfoHeader(URI) - Method in interface javax.sip.header.HeaderFactory

Creates a new AlertInfoHeader based on the newly supplied alertInfo value.

createAllowEventsHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AllowEventsHeader based on the newly supplied event type value.

createAllowHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AllowHeader based on the newly supplied method value.

createAuthenticationInfoHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AuthenticationInfoHeader based on the newly supplied response value.

createAuthorizationHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new AuthorizationHeader based on the newly supplied scheme value.

createCallIdHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new CallIdHeader based on the newly supplied callId value.

createCallInfoHeader(URI) - Method in interface javax.sip.header.HeaderFactory

Creates a new CallInfoHeader based on the newly supplied callInfo value.

createCancel() - Method in interface javax.sip.ClientTransaction

Creates a new Cancel message from the Request associated with this client transaction.

createContactHeader() - Method in interface javax.sip.header.HeaderFactory

Creates a new wildcard ContactHeader.

createContactHeader(Address) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContactHeader based on the newly supplied address value.

createContentDispositionHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContentDispositionHeader based on the newly supplied contentDisposition value.

createContentEncodingHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContentEncodingHeader based on the newly supplied encoding value.

createContentLanguageHeader(Locale) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContentLanguageHeader based on the newly supplied contentLanguage value.

createContentLengthHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContentLengthHeader based on the newly supplied contentLength value.

createContentTypeHeader(String, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ContentTypeHeader based on the newly supplied contentType and contentSubType values.

createCSeqHeader(int, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new CSeqHeader based on the newly supplied sequence number and method values.

createDateHeader(Calendar) - Method in interface javax.sip.header.HeaderFactory

Creates a new DateHeader based on the newly supplied date value.

createErrorInfoHeader(URI) - Method in interface javax.sip.header.HeaderFactory

Creates a new ErrorInfoHeader based on the newly supplied errorInfo value.

createEventHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new EventHeader based on the newly supplied eventType value.

createExpiresHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new ExpiresHeader based on the newly supplied expires value.

createFromHeader(Address, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new FromHeader based on the newly supplied address and tag values.

createHeader(String, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new Header based on the newly supplied name and value values.

createHeaderFactory() - Method in class javax.sip.SipFactory

Creates an instance of the HeaderFactory implementation.

createHeaders(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new List of Headers based on the newly supplied comma seperated list of headers.

createInReplyToHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new InReplyToHeader based on the newly supplied callId value.

createListeningPoint(int, String) - Method in interface javax.sip.SipStack

Creates a new ListeningPoint on this SipStack on a specified port and transport, and returns a reference to the newly created ListeningPoint object.

createMaxForwardsHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new MaxForwardsHeader based on the newly supplied maxForwards value.

createMessageFactory() - Method in class javax.sip.SipFactory

Creates an instance of the MessageFactory implementation.

createMimeVersionHeader(int, int) - Method in interface javax.sip.header.HeaderFactory

Creates a new MimeVersionHeader based on the newly supplied mimeVersion values.

createMinExpiresHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new MinExpiresHeader based on the newly supplied minExpires value.

createOrganizationHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new OrganizationHeader based on the newly supplied organization value.

createPriorityHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new PriorityHeader based on the newly supplied priority value.

createProxyAuthenticateHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ProxyAuthenticateHeader based on the newly supplied scheme value.

createProxyAuthorizationHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ProxyAuthorizationHeader based on the newly supplied scheme value.

createProxyRequireHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ProxyRequireHeader based on the newly supplied optionTag value.

createRAckHeader(int, int, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new RAckHeader based on the newly supplied rSeqNumber, cSeqNumber and method values.

createReasonHeader(String, int, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ReasonHeader based on the newly supplied reason value.

createRecordRouteHeader(Address) - Method in interface javax.sip.header.HeaderFactory

Creates a new RecordRouteHeader based on the newly supplied address value.

createReferToHeader(Address) - Method in interface javax.sip.header.HeaderFactory

Creates a new ReferToHeader based on the newly supplied address value.

createReplyToHeader(Address) - Method in interface javax.sip.header.HeaderFactory

Creates a new ReplyToHeader based on the newly supplied address value.

createRequest(String) - Method in interface javax.sip.Dialog

Creates a new Request message based on the dialog creating request.

createRequest(String) - Method in interface javax.sip.message.MessageFactory

Create a new SIP Request object based on a specific string value.

createRequest(URI, String, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader) - Method in interface javax.sip.message.MessageFactory

Creates a new Request message of type specified by the method paramater, containing the URI of the Request, the mandatory headers of the message.

createRequest(URI, String, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader, ContentTypeHeader, byte[]) - Method in interface javax.sip.message.MessageFactory

Creates a new Request message of type specified by the method paramater, containing the URI of the Request, the mandatory headers of the message with a body in the form of a byte array and body content type.

createRequest(URI, String, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader, ContentTypeHeader, Object) - Method in interface javax.sip.message.MessageFactory

Creates a new Request message of type specified by the method paramater, containing the URI of the Request, the mandatory headers of the message with a body in the form of a Java object and the body content type.

createRequireHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new RequireHeader based on the newly supplied optionTag value.

createResponse(int, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message.

createResponse(int, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader, ContentTypeHeader, byte[]) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message with a body in the form of a byte array and the body content type.

createResponse(int, CallIdHeader, CSeqHeader, FromHeader, ToHeader, List, MaxForwardsHeader, ContentTypeHeader, Object) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message with a body in the form of a Java object and the body content type.

createResponse(int, Request) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, based on a specific Request message.

createResponse(int, Request, ContentTypeHeader, byte[]) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, based on a specific Request with a new body in the form of a byte array and the body content type.

createResponse(int, Request, ContentTypeHeader, Object) - Method in interface javax.sip.message.MessageFactory

Creates a new Response message of type specified by the statusCode paramater, based on a specific Request with a new body in the form of a Java object and the body content type.

createRetryAfterHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new RetryAfterHeader based on the newly supplied retryAfter value.

createRouteHeader(Address) - Method in interface javax.sip.header.HeaderFactory

Creates a new RouteHeader based on the newly supplied address value.

createRSeqHeader(int) - Method in interface javax.sip.header.HeaderFactory

Creates a new RSeqHeader based on the newly supplied sequenceNumber value.

createServerHeader(List) - Method in interface javax.sip.header.HeaderFactory

Creates a new ServerHeader based on the newly supplied List of product values.

createSipProvider(ListeningPoint) - Method in interface javax.sip.SipStack

Creates a new peer SipProvider on this SipStack on a specified ListeningPoint and returns a reference to the newly created SipProvider object.

createSipStack(Properties) - Method in class javax.sip.SipFactory

Creates an instance of a SipStack implementation based on the configuration properties object passed to this method.

createSipURI(String, String) - Method in interface javax.sip.address.AddressFactory

Creates a SipURI based on the given user and host components.

createSubjectHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new SubjectHeader based on the newly supplied subject value.

createSubscriptionStateHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new SubscriptionStateHeader based on the newly supplied subscriptionState value.

createSupportedHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new SupportedHeader based on the newly supplied optionTag value.

createTelURL(String) - Method in interface javax.sip.address.AddressFactory

Creates a TelURL based on given URI string.

createTimeStampHeader(float) - Method in interface javax.sip.header.HeaderFactory

Creates a new TimeStampHeader based on the newly supplied timeStamp value.

createToHeader(Address, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ToHeader based on the newly supplied address and tag values.

createUnsupportedHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new UnsupportedHeader based on the newly supplied optionTag value.

createURI(String) - Method in interface javax.sip.address.AddressFactory

Creates a URI based on given URI string.

createUserAgentHeader(List) - Method in interface javax.sip.header.HeaderFactory

Creates a new UserAgentHeader based on the newly supplied List of product values.

createViaHeader(String, int, String, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new ViaHeader based on the newly supplied uri and branch values.

createWarningHeader(String, int, String) - Method in interface javax.sip.header.HeaderFactory

Creates a new WarningHeader based on the newly supplied agent, code and comment values.

createWWWAuthenticateHeader(String) - Method in interface javax.sip.header.HeaderFactory

Creates a new WWWAuthenticateHeader based on the newly supplied scheme value.

CSeqHeader - interface javax.sip.header.CSeqHeader.

A CSeq header field in a request contains a single decimal sequence number and the request method.

D

DateHeader - interface javax.sip.header.DateHeader.

The Date header field reflects the time when the request or response is first sent.

DEACTIVATED - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated, but the subscriber SHOULD retry immediately with a new subscription.

DECLINE - Static variable in interface javax.sip.message.Response

The callee's machine was successfully contacted but the user explicitly does not wish to or cannot participate.

decrementMaxForwards() - Method in interface javax.sip.header.MaxForwardsHeader

This convenience function decrements the number of max-forwards by one.

delete() - Method in interface javax.sip.Dialog

This method will release all resources associated with this dialog that are tracked by the SipProvider.

deleteListeningPoint(ListeningPoint) - Method in interface javax.sip.SipStack

Deletes the specified ListeningPoint attached to this SipStack.

deleteSipProvider(SipProvider) - Method in interface javax.sip.SipStack

Deletes the specified peer SipProvider attached to this SipStack.

Dialog - interface javax.sip.Dialog.

A dialog represents a peer-to-peer SIP relationship between two user agents that persists for some time.

DialogState - class javax.sip.DialogState.

This class contains the enumerations that define the underlying state of an existing dialog.

DOES_NOT_EXIST_ANYWHERE - Static variable in interface javax.sip.message.Response

The server has authoritative information that the user indicated in the Request-URI does not exist anywhere.

E

EARLY - Static variable in class javax.sip.DialogState

This constant value indicates that the dialog state is "Early".

EMERGENCY - Static variable in interface javax.sip.header.PriorityHeader

Emergency priority constant - It is RECOMMENDED that the value of "emergency" only be used when life, limb, or property are in imminent danger.

Encoding - interface javax.sip.header.Encoding.

This interface represents encoding methods for any header that contains an encoding value.

equals(Object) - Method in interface javax.sip.ListeningPoint

This method indicates whether the specified object is equal to this Listening Point.

equals(Object) - Method in interface javax.sip.address.Address

Indicates whether some other Object is "equal to" this Address.

equals(Object) - Method in interface javax.sip.header.Header

Compare this SIP Header for equality with another.

equals(Object) - Method in interface javax.sip.message.Message

Compare this SIP Message for equality with another.

ErrorInfoHeader - interface javax.sip.header.ErrorInfoHeader.

The Error-Info header field provides a pointer to additional information about the error status response.

EventHeader - interface javax.sip.header.EventHeader.

This interface represents the Event SIP header, as defined by RFC3265, this header is not part of RFC3261.

ExpiresHeader - interface javax.sip.header.ExpiresHeader.

The Expires header field gives the relative time after which the message (or content) expires.

EXTENSION_REQUIRED - Static variable in interface javax.sip.message.Response

The UAS needs a particular extension to process the request, but this extension is not listed in a Supported header field in the request.

ExtensionHeader - interface javax.sip.header.ExtensionHeader.

This interface represents an Extension SIP header that is not currently defined by JAIN SIP.

F

FORBIDDEN - Static variable in interface javax.sip.message.Response

The server understood the request, but is refusing to fulfill it.

FromHeader - interface javax.sip.header.FromHeader.

The From header field indicates the logical identity of the initiator of the request, possibly the user's address-of-record.

G

getAcceptLanguage() - Method in interface javax.sip.header.AcceptLanguageHeader

Gets the language value of the AcceptLanguageHeader.

getAddress() - Method in interface javax.sip.header.HeaderAddress

Gets the address parameter of this Address.

getAgent() - Method in interface javax.sip.header.WarningHeader

Gets the agent of the server that created this WarningHeader.

getAlertInfo() - Method in interface javax.sip.header.AlertInfoHeader

Returns the AlertInfo value of this AlertInfoHeader.

getAlgorithm() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Algorithm value of this WWWAuthenicateHeader.

getAlgorithm() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Algorithm value of this AuthorizationHeader.

getApplicationData() - Method in interface javax.sip.Dialog

Gets the application specific data specific to this dialog.

getBranch() - Method in interface javax.sip.header.ViaHeader

Gets the branch paramater of the ViaHeader.

getBranchId() - Method in interface javax.sip.Transaction

Returns a unique branch identifer that identifies this transaction.

getCallId() - Method in interface javax.sip.Dialog

Returns the Call-Id for this SipSession.

getCallId() - Method in interface javax.sip.header.InReplyToHeader

Returns the Call-Id of InReplyToHeader.

getCallId() - Method in interface javax.sip.header.CallIdHeader

Returns the Call-Id of CallIdHeader.

getCause() - Method in class javax.sip.SipException

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

getCause() - Method in class javax.sip.InvalidArgumentException

Returns the cause of this throwable or null if the cause is nonexistent or unknown.

getCause() - Method in interface javax.sip.header.ReasonHeader

Gets the cause value of the ReasonHeader

getClientTransaction() - Method in class javax.sip.TimeoutEvent

Gets the client transaction associated with this TimeoutEvent.

getClientTransaction() - Method in class javax.sip.ResponseEvent

Gets the client transaction associated with this ResponseEvent

getCNonce() - Method in interface javax.sip.header.AuthorizationHeader

Returns the CNonce value of this AuthorizationHeader.

getCNonce() - Method in interface javax.sip.header.AuthenticationInfoHeader

Returns the CNonce value of this AuthenticationInfoHeader.

getCode() - Method in interface javax.sip.header.WarningHeader

Gets the code of the WarningHeader.

getComment() - Method in interface javax.sip.header.RetryAfterHeader

Gets the comment of RetryAfterHeader.

getContent() - Method in interface javax.sip.message.Message

Gets the body content of the Message as an Object.

getContentDisposition() - Method in interface javax.sip.message.Message

Gets the ContentDispositionHeader of this Message.

getContentEncoding() - Method in interface javax.sip.message.Message

Gets the ContentEncodingHeader of this Message.

getContentLanguage() - Method in interface javax.sip.header.ContentLanguageHeader

Gets the language value of the ContentLanguageHeader.

getContentLanguage() - Method in interface javax.sip.message.Message

Gets the ContentLanguageHeader of this Message.

getContentLength() - Method in interface javax.sip.header.ContentLengthHeader

Gets content-length of the message body.

getContentLength() - Method in interface javax.sip.message.Message

Gets the ContentLengthHeader of the body content of this Message.

getContentSubType() - Method in interface javax.sip.header.MediaType

Gets media sub-type of Header with Content sub-type.

getContentType() - Method in interface javax.sip.header.MediaType

Gets media type of Header with Content type.

getCSeqNumber() - Method in interface javax.sip.header.RAckHeader

Gets the CSeq sequence number of this RAckHeader.

getDate() - Method in interface javax.sip.header.DateHeader

Gets the date of DateHeader.

getDelay() - Method in interface javax.sip.header.TimeStampHeader

Gets delay of TimeStampHeader.

getDialog() - Method in interface javax.sip.Transaction

Gets the dialog object of this transaction object.

getDialogId() - Method in interface javax.sip.Dialog

Get the dialog identifer of this dialog.

getDisplayName() - Method in interface javax.sip.address.Address

Gets the display name of this Address, or null if the attribute is not set.

getDispositionType() - Method in interface javax.sip.header.ContentDispositionHeader

Gets the interpretation of the message body or message body part of this ContentDispositionHeader.

getDomain() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Domain value of this WWWAuthenicateHeader.

getDuration() - Method in interface javax.sip.header.RetryAfterHeader

Gets the duration value of the RetryAfterHeader.

getEncoding() - Method in interface javax.sip.header.Encoding

Gets the encoding of an EncodingHeader.

getErrorInfo() - Method in interface javax.sip.header.ErrorInfoHeader

Returns the ErrorInfo value of this ErrorInfoHeader.

getErrorMessage() - Method in interface javax.sip.header.ErrorInfoHeader

Get the Error information message of this ErrorInfoHeader.

getEventId() - Method in interface javax.sip.header.EventHeader

Gets the id of the EventHeader.

getEventType() - Method in interface javax.sip.header.AllowEventsHeader

Gets the eventType of the AllowEventsHeader.

getEventType() - Method in interface javax.sip.header.EventHeader

Gets the eventType of the EventHeader.

getExpires() - Method in interface javax.sip.header.SubscriptionStateHeader

Gets the expires value of the SubscriptionStateHeader.

getExpires() - Method in interface javax.sip.header.ExpiresHeader

Gets the expires value of the ExpiresHeader.

getExpires() - Method in interface javax.sip.header.ContactHeader

Returns the value of the expires parameter.

getExpires() - Method in interface javax.sip.message.Message

Gets the ExpiresHeader of this Message.

getFirstTransaction() - Method in interface javax.sip.Dialog

This method retrieves the transaction which resulted in the creation of this Dialog.

getHandling() - Method in interface javax.sip.header.ContentDispositionHeader

Gets the handling information of the unknown content disposition of the ContentDispositionHeader.

getHeader(String) - Method in interface javax.sip.address.SipURI

Returns the value of the named header, or null if it is not set.

getHeader(String) - Method in interface javax.sip.message.Message

Gets the Header of the specified name in this Message.

getHeaderNames() - Method in interface javax.sip.address.SipURI

Returns an Iterator over the String names of all headers present in this SipURI.

getHeaderNames() - Method in interface javax.sip.message.Message

Gets a ListIterator over all the header names in this Message.

getHeaders(String) - Method in interface javax.sip.message.Message

Gets a ListIterator over all the Headers of the newly specified name in this Message.

getHost() - Method in interface javax.sip.address.Hop

Returns the host part of this Hop.

getHost() - Method in interface javax.sip.address.SipURI

Returns the host part of this SipURI.

getHost() - Method in interface javax.sip.header.ViaHeader

Returns the host part of this ViaHeader.

getInfo() - Method in interface javax.sip.header.CallInfoHeader

Gets the URI that represents the location of the info of the caller or callee.

getInstance() - Static method in class javax.sip.SipFactory

Returns an instance of a SipFactory.

getIPAddress() - Method in interface javax.sip.SipStack

Gets the IP Address that identifies this SipStack instance.

getIsdnSubAddress() - Method in interface javax.sip.address.TelURL

Returns the value of the isdnSubAddress parameter, or null if it is not set.

getListeningPoint() - Method in interface javax.sip.SipProvider

Returns the ListeningPoint of this SipProvider.

getListeningPoints() - Method in interface javax.sip.SipStack

Returns an Iterator of existing ListeningPoints created by this SipStack.

getLocalParty() - Method in interface javax.sip.Dialog

Returns the Address identifying the local party.

getLocalSequenceNumber() - Method in interface javax.sip.Dialog

The local sequence number is used to order requests from this User Agent Client to its peer User Agent Server.

getLocalTag() - Method in interface javax.sip.Dialog

Get the Local Tag of this Dialog.

getMAddr() - Method in interface javax.sip.header.ViaHeader

Returns the value of the maddr parameter, or null if this is not set.

getMAddrParam() - Method in interface javax.sip.address.SipURI

Returns the value of the maddr parameter, or null if this is not set.

getMajorVersion() - Method in interface javax.sip.header.MimeVersionHeader

Gets the Major version value of this MimeVersionHeader.

getMaxForwards() - Method in interface javax.sip.header.MaxForwardsHeader

Gets the maximum number of forwards value of this MaxForwardsHeader.

getMethod() - Method in interface javax.sip.header.RAckHeader

Gets the method of RAckHeader.

getMethod() - Method in interface javax.sip.header.CSeqHeader

Gets the method of CSeqHeader

getMethod() - Method in interface javax.sip.header.AllowHeader

Gets the method of the AllowHeader.

getMethod() - Method in interface javax.sip.message.Request

Gets method string of this Request message.

getMethodParam() - Method in interface javax.sip.address.SipURI

Returns the value of the method parameter, or null if this is not set.

getMinorVersion() - Method in interface javax.sip.header.MimeVersionHeader

Gets the Minor version value of this MimeVersionHeader.

getName() - Method in interface javax.sip.header.Header

Gets the unique string name of this Header.

getNewCallId() - Method in interface javax.sip.SipProvider

Returns a unique CallIdHeader for identifying dialogues between two SIP applications.

getNewClientTransaction(Request) - Method in interface javax.sip.SipProvider

Before an application can send a new request it must first request a new client transaction to handle that Request.

getNewServerTransaction(Request) - Method in interface javax.sip.SipProvider

An application has the responsibility of deciding to respond to a Request that does not match an existing server transaction.

getNextHops(Request) - Method in interface javax.sip.address.Router

Gets the ListIterator of the hops of the default Route.

getNextNonce() - Method in interface javax.sip.header.AuthenticationInfoHeader

Returns the nextNonce value of this AuthenticationInfoHeader.

getNonce() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Nonce value of this WWWAuthenicateHeader.

getNonce() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Nonce value of this AuthorizationHeader.

getNonceCount() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Nonce Count value of this AuthorizationHeader.

getNonceCount() - Method in interface javax.sip.header.AuthenticationInfoHeader

Returns the Nonce Count value of this AuthenticationInfoHeader.

getObject(int) - Static method in class javax.sip.TransactionState

This method returns the object value of the TransactionState

getObject(int) - Method in class javax.sip.Timeout

This method returns the object value of the Timeout

getObject(int) - Static method in class javax.sip.DialogState

This method returns the object value of the DialogState

getOpaque() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Opaque value of this WWWAuthenicateHeader.

getOpaque() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Opaque value of this AuthorizationHeader.

getOptionTag() - Method in interface javax.sip.header.OptionTag

Gets the option tag of this OptionTag class.

getOrganization() - Method in interface javax.sip.header.OrganizationHeader

Gets the organization value of OrganizationHeader.

getOutboundProxy() - Method in interface javax.sip.address.Router

Gets the Outbound Proxy parameter of this Router, this method may return null if no outbound proxy is defined.

getParameter(String) - Method in interface javax.sip.header.Parameters

Returns the value of the named parameter, or null if it is not set.

getParameterNames() - Method in interface javax.sip.header.Parameters

Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.

getPathName() - Method in class javax.sip.SipFactory

Returns the current pathname of the SipFactory.

getPhoneNumber() - Method in interface javax.sip.address.TelURL

Returns the value of the phoneNumber parameter.

getPort() - Method in interface javax.sip.ListeningPoint

Gets the port of the ListeningPoint.

getPort() - Method in interface javax.sip.address.Hop

Returns the port part of this Hop.

getPort() - Method in interface javax.sip.address.SipURI

Returns the port part of this SipURI.

getPort() - Method in interface javax.sip.header.ViaHeader

Returns the port part of this ViaHeader.

getPostDial() - Method in interface javax.sip.address.TelURL

Returns the value of the postDial parameter, or null if it is not set.

getPriority() - Method in interface javax.sip.header.PriorityHeader

Gets the string priority value of the PriorityHeader.

getProduct() - Method in interface javax.sip.header.UserAgentHeader

Returns the List of product values.

getProduct() - Method in interface javax.sip.header.ServerHeader

Returns a ListIterator over the List of product values.

getProtocol() - Method in interface javax.sip.header.ReasonHeader

Gets the protocol value of the ReasonHeader

getProtocol() - Method in interface javax.sip.header.ViaHeader

Returns the value of the protocol used.

getPurpose() - Method in interface javax.sip.header.CallInfoHeader

Gets the purpose of the information supplied in this CallInfoHeader.

getQop() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Qop value of this WWWAuthenicateHeader.

getQop() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Qop value of this AuthorizationHeader.

getQop() - Method in interface javax.sip.header.AuthenticationInfoHeader

Returns the messageQop value of this AuthenticationInfoHeader.

getQValue() - Method in interface javax.sip.header.ContactHeader

Returns the value of the q-value parameter of this ContactHeader.

getQValue() - Method in interface javax.sip.header.AcceptLanguageHeader

Gets q-value of the media-range in AcceptLanguageHeader.

getQValue() - Method in interface javax.sip.header.AcceptHeader

Gets q-value of media-range in AcceptHeader.

getQValue() - Method in interface javax.sip.header.AcceptEncodingHeader

Gets q-value of the encoding in this encoding value.

getRawContent() - Method in interface javax.sip.message.Message

Gets the body content of the Message as a byte array.

getRealm() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the Realm value of this WWWAuthenicateHeader.

getRealm() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Realm value of this AuthorizationHeader.

getReasonCode() - Method in interface javax.sip.header.SubscriptionStateHeader

Gets the reason code of SubscriptionStateHeader.

getReasonPhrase() - Method in interface javax.sip.message.Response

Gets the reason phrase of this Response message.

getReceived() - Method in interface javax.sip.header.ViaHeader

Gets the received paramater of the ViaHeader.

getRemoteParty() - Method in interface javax.sip.Dialog

Returns the Address identifying the remote party.

getRemoteSequenceNumber() - Method in interface javax.sip.Dialog

The remote sequence number is used to order requests from its peer User Agent Client to this User Agent Server.

getRemoteTag() - Method in interface javax.sip.Dialog

Gets the Remote Tag of this Dialog.

getRemoteTarget() - Method in interface javax.sip.Dialog

Returns the Address identifying the remote target.

getRequest() - Method in interface javax.sip.Transaction

Returns the request that created this transaction.

getRequest() - Method in class javax.sip.RequestEvent

Gets the Request message associated with this RequestEvent.

getRequestURI() - Method in interface javax.sip.message.Request

Gets the URI Object identifying the request URI of this Request, which indicates the user or service to which this request is addressed.

getResponse() - Method in class javax.sip.ResponseEvent

Gets the Response message encapsulated in this ResponseEvent.

getResponse() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Response value of this AuthorizationHeader.

getResponse() - Method in interface javax.sip.header.AuthenticationInfoHeader

Returns the Response value of this AuthenticationInfoHeader.

getRetransmitTimer() - Method in interface javax.sip.Transaction

Returns the current value of the retransmit timer in milliseconds used to retransmit messages over unreliable transports for this transaction.

getRetryAfter() - Method in interface javax.sip.header.SubscriptionStateHeader

Gets the retry after value of the SubscriptionStateHeader.

getRetryAfter() - Method in interface javax.sip.header.RetryAfterHeader

Gets the retry after value of the RetryAfterHeader.

getRouter() - Method in interface javax.sip.SipStack

Gets the Router object that identifies the default Router information of this SipStack, including the outbound proxy.

getRouteSet() - Method in interface javax.sip.Dialog

When acting as an User Agent Server the routeset MUST be set to the list of URIs in the Record-Route header field from the request, taken in order and preserving all URI parameters.

getRSeqNumber() - Method in interface javax.sip.header.RAckHeader

Gets the RSeq sequence number of this RAckHeader.

getScheme() - Method in interface javax.sip.address.URI

Returns the value of the "scheme" of this URI, for example "sip", "sips" or "tel".

getScheme() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the scheme of the challenge information for this WWWAuthenticateHeader.

getScheme() - Method in interface javax.sip.header.AuthorizationHeader

Returns the scheme of the Response information for this AuthorizationHeader.

getSequenceNumber() - Method in interface javax.sip.header.RSeqHeader

Gets the sequence number of this RSeqHeader.

getSequenceNumber() - Method in interface javax.sip.header.CSeqHeader

Gets the sequence number of this CSeqHeader.

getServerTransaction() - Method in class javax.sip.TimeoutEvent

Gets the server transaction associated with this TimeoutEvent.

getServerTransaction() - Method in class javax.sip.RequestEvent

Gets the server transaction associated with this RequestEvent

getSipProviders() - Method in interface javax.sip.SipStack

Returns an Iterator of existing SipProviders that have been created by this SipStack.

getSipStack() - Method in interface javax.sip.SipProvider

Returns the SipStack that created this SipProvider.

getSIPVersion() - Method in interface javax.sip.message.Message

Gets the protocol version of SIP being used by this Message.

getStackName() - Method in interface javax.sip.SipStack

Gets the user friendly name that identifies this SipStack instance.

getState() - Method in interface javax.sip.Transaction

Returns the current state of the transaction.

getState() - Method in interface javax.sip.Dialog

Returns the current state of the dialog.

getState() - Method in interface javax.sip.header.SubscriptionStateHeader

Gets the state of SubscriptionStateHeader.

getStatusCode() - Method in interface javax.sip.message.Response

Gets the integer value of the status code of Response, which identifies the outcome of the request to which this response is related.

getSubject() - Method in interface javax.sip.header.SubjectHeader

Gets the subject value of SubjectHeader.

getTag() - Method in interface javax.sip.header.ToHeader

Gets tag of ToHeader.

getTag() - Method in interface javax.sip.header.FromHeader

Gets the tag of FromHeader.

getText() - Method in interface javax.sip.header.ReasonHeader

Gets the text value of the ReasonHeader

getText() - Method in interface javax.sip.header.WarningHeader

Gets text of WarningHeader.

getTimeout() - Method in class javax.sip.TimeoutEvent

Gets the event type of this TimeoutEvent.

getTimeStamp() - Method in interface javax.sip.header.TimeStampHeader

Gets the timestamp value of this TimeStampHeader.

getTransport() - Method in interface javax.sip.ListeningPoint

Gets the transport of the ListeningPoint.

getTransport() - Method in interface javax.sip.address.Hop

Returns the transport part of this Hop.

getTransport() - Method in interface javax.sip.header.ViaHeader

Returns the value of the transport parameter.

getTransportParam() - Method in interface javax.sip.address.SipURI

Returns the value of the "transport" parameter, or null if this is not set.

getTTL() - Method in interface javax.sip.header.ViaHeader

Returns the value of the ttl parameter, or -1 if this is not set.

getTTLParam() - Method in interface javax.sip.address.SipURI

Returns the value of the "ttl" parameter, or -1 if this is not set.

getUnrecognizedHeaders() - Method in interface javax.sip.message.Message

Gets a ListIterator over all the UnrecognizedHeaders in this Message.

getURI() - Method in interface javax.sip.address.Address

Returns the URI of this Address.

getURI() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the URI value of this WWWAuthenicateHeader, for example DigestURI.

getURI() - Method in interface javax.sip.header.AuthorizationHeader

Returns the URI value of this AuthorizationHeader, for example DigestURI.

getUser() - Method in interface javax.sip.address.SipURI

Returns the user part of this SipURI.

getUsername() - Method in interface javax.sip.header.AuthorizationHeader

Returns the Username value of this AuthorizationHeader.

getUserParam() - Method in interface javax.sip.address.SipURI

Returns the value of the userParam, or null if this is not set.

getUserPassword() - Method in interface javax.sip.address.SipURI

Gets user password of SipURI, or null if it is not set.

getValue() - Method in class javax.sip.TransactionState

This method returns the integer value of the TransactionState

getValue() - Method in class javax.sip.Timeout

This method returns the integer value of the Timeout

getValue() - Method in class javax.sip.DialogState

This method returns the integer value of the DialogState

getValue() - Method in interface javax.sip.header.ExtensionHeader

Gets the value of the ExtensionHeader.

GIVE_UP - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated because the notifier could not obtain authorization in a timely fashion.

GONE - Static variable in interface javax.sip.message.Response

The requested resource is no longer available at the server and no forwarding address is known.

H

hasLrParam() - Method in interface javax.sip.address.SipURI

Returns whether the the lr parameter is set.

Header - interface javax.sip.header.Header.

This interface is the super interface of all SIP headers supported explicitly by JAIN SIP.

HeaderAddress - interface javax.sip.header.HeaderAddress.

This interface represents methods for manipulating Address object values for any header that contains a Address value.

HeaderFactory - interface javax.sip.header.HeaderFactory.

This interface provides factory methods that allow an application to create Header object from a particular implementation of JAIN SIP.

Hop - interface javax.sip.address.Hop.

The Hop interface defines a location a request can transit on the way to its destination, i.e. a route.

I

ICON - Static variable in interface javax.sip.header.ContentDispositionHeader

Icon Disposition Type Constant

INCOMPATIBLE_BANDWIDTH_UNITS - Static variable in interface javax.sip.header.WarningHeader

One or more bandwidth measurement units contained in the session description were not understood.

INCOMPATIBLE_MEDIA_FORMAT - Static variable in interface javax.sip.header.WarningHeader

One or more media formats contained in the session description are not available.

INCOMPATIBLE_NETWORK_ADDRESS_FORMATS - Static variable in interface javax.sip.header.WarningHeader

One or more network address formats contained in the session description are not available.

INCOMPATIBLE_NETWORK_PROTOCOL - Static variable in interface javax.sip.header.WarningHeader

One or more network protocols contained in the session description are not available.

INCOMPATIBLE_TRANSPORT_PROTOCOL - Static variable in interface javax.sip.header.WarningHeader

One or more transport protocols described in the session description are not available.

incrementLocalSequenceNumber() - Method in interface javax.sip.Dialog

This method may be used to increment the local sequence number of the dialog when an application wishes to switch from dialog stateful mode to transaction stateful mode for client transactions and back again to dialog stateful mode.

INFO - Static variable in interface javax.sip.message.Request

INFO is an extension method which allows for the carrying of session related control information that is generated during a session.

InReplyToHeader - interface javax.sip.header.InReplyToHeader.

The In-Reply-To header field enumerates the Call-IDs that this call references or returns.

INSUFFICIENT_BANDWIDTH - Static variable in interface javax.sip.header.WarningHeader

The bandwidth specified in the session description or defined by the media exceeds that known to be available.

INTERVAL_TOO_BRIEF - Static variable in interface javax.sip.message.Response

The server is rejecting the request because the expiration time of the resource refreshed by the request is too short.

InvalidArgumentException - exception javax.sip.InvalidArgumentException.

This exception class is thrown by an implementation when given an invalid argument such as a invalid numerical value.

InvalidArgumentException() - Constructor for class javax.sip.InvalidArgumentException

Create an InvalidArgumentException with no detail message.

InvalidArgumentException(String) - Constructor for class javax.sip.InvalidArgumentException

Create an InvalidArgumentException with a detail message.

InvalidArgumentException(String, Throwable) - Constructor for class javax.sip.InvalidArgumentException

Constructs a new InvalidArgumentException with the specified error message and specialized cause that triggered this error condition.

INVITE - Static variable in interface javax.sip.message.Request

The INVITE method is used by an user agent client that desires to initiate a session, session examples include, audio, video, or a game.

isGlobal() - Method in interface javax.sip.address.TelURL

Returns true if this TelURL is global i.e. if the TelURI has a global phone user.

isRetransmissionFilterActive() - Method in interface javax.sip.SipStack

This method returns the value of the retransmission filter helper function for User Agent applications.

isSecure() - Method in interface javax.sip.Dialog

Returns true if this Dialog is secure i.e. if the request was sent over a "sips:" scheme, or a "sip:" scheme over TLS.

isSecure() - Method in interface javax.sip.address.SipURI

Returns true if this SipURI is secure i.e. if this SipURI represents a sips URI.

isServer() - Method in interface javax.sip.Dialog

Returns whether this Dialog is a server dialog.

isServerTransaction() - Method in class javax.sip.TimeoutEvent

Indicates if the transaction associated with this TimeoutEvent is a server transaction.

isSipURI() - Method in interface javax.sip.address.URI

This method determines if this is a URI with a scheme of "sip" or "sips".

isStale() - Method in interface javax.sip.header.WWWAuthenticateHeader

Returns the boolean value of the state paramater of this WWWAuthenicateHeader.

isWildcard() - Method in interface javax.sip.address.Address

This determines if this address is a wildcard address.

J

javax.sip - package javax.sip

This package contains the main interfaces that model the JAIN SIP architectute from both an application developer and a stack vendor view.

javax.sip.address - package javax.sip.address

This package contains interfaces that represent the Addressing components of the SIP protocol.

javax.sip.header - package javax.sip.header

This package contains all the headers interfaces supported by this specification.

javax.sip.message - package javax.sip.message

This package contains the interfaces representing SIP messages.

L

ListeningPoint - interface javax.sip.ListeningPoint.

This interface represents a unique IP network listening point, which consists of port and transport.

LOOP_DETECTED - Static variable in interface javax.sip.message.Response

The server has detected a loop.

M

m_Cause - Variable in class javax.sip.SipException

The specialized cause that triggered this Exception.

m_Cause - Variable in class javax.sip.InvalidArgumentException

The specialized cause that triggered this Exception.

MaxForwardsHeader - interface javax.sip.header.MaxForwardsHeader.

The Max-Forwards header field must be used with any SIP method to limit the number of proxies or gateways that can forward the request to the next downstream server.

MEDIA_TYPE_NOT_AVAILABLE - Static variable in interface javax.sip.header.WarningHeader

One or more media types contained in the session description are not available.

MediaType - interface javax.sip.header.MediaType.

This interface represents media type methods for any header that contain content type and content sub-type values.

Message - interface javax.sip.message.Message.

A SIP message is either a request from a client to a server, or a response from a server to a client.

MESSAGE - Static variable in interface javax.sip.message.Request

Message is an extension method that allows the transfer of Instant Messages.

MESSAGE_TOO_LARGE - Static variable in interface javax.sip.message.Response

The server was unable to process the request since the message length exceeded its capabilities.

MessageFactory - interface javax.sip.message.MessageFactory.

This interface provides factory methods that allow an application to create Request and Response messages from a particular implementation of JAIN SIP.

METHOD_NOT_ALLOWED - Static variable in interface javax.sip.message.Response

The method specified in the Request-Line is understood, but not allowed for the address identified by the Request-URI.

MimeVersionHeader - interface javax.sip.header.MimeVersionHeader.

SIP messages MAY include a single MIME-Version general-header field to indicate what version of the MIME protocol was used to construct the message.

MinExpiresHeader - interface javax.sip.header.MinExpiresHeader.

The Min-Expires header field conveys the minimum refresh interval supported for soft-state elements managed by that server.

MISCELLANEOUS_WARNING - Static variable in interface javax.sip.header.WarningHeader

The warning text can include arbitrary information to be presented to a human user, or logged.

MOVED_PERMANENTLY - Static variable in interface javax.sip.message.Response

The user can no longer be found at the address in the Request-URI, and the requesting client SHOULD retry at the new address given by the Contact header field.

MOVED_TEMPORARILY - Static variable in interface javax.sip.message.Response

The requesting client SHOULD retry the request at the new address(es) given by the Contact header field.

MULTICAST_NOT_AVAILABLE - Static variable in interface javax.sip.header.WarningHeader

The site where the user is located does not support multicast.

MULTIPLE_CHOICES - Static variable in interface javax.sip.message.Response

The address in the request resolved to several choices, each with its own specific location, and the user (or UA) can select a preferred communication end point and redirect its request to that location.

N

NAME - Static variable in interface javax.sip.header.AllowEventsHeader

Name of AllowEventsHeader

NAME - Static variable in interface javax.sip.header.SubscriptionStateHeader

Name of SubscriptionStateHeader

NAME - Static variable in interface javax.sip.header.EventHeader

Name of EventHeader

NAME - Static variable in interface javax.sip.header.ReferToHeader

Name of ReferToHeader

NAME - Static variable in interface javax.sip.header.RSeqHeader

Name of RSeqHeader

NAME - Static variable in interface javax.sip.header.RAckHeader

Name of RAckHeader.

NAME - Static variable in interface javax.sip.header.ReasonHeader

Name of ReasonHeader

NAME - Static variable in interface javax.sip.header.WarningHeader

Name of WarningHeader

NAME - Static variable in interface javax.sip.header.WWWAuthenticateHeader

Name of WWWAuthenticateHeader

NAME - Static variable in interface javax.sip.header.ViaHeader

Name of ViaHeader

NAME - Static variable in interface javax.sip.header.UserAgentHeader

Name of UserAgentHeader

NAME - Static variable in interface javax.sip.header.UnsupportedHeader

Name of UnsupportedHeader

NAME - Static variable in interface javax.sip.header.ToHeader

Name of the ToHeader

NAME - Static variable in interface javax.sip.header.TimeStampHeader

Name of TimeStampHeader

NAME - Static variable in interface javax.sip.header.SupportedHeader

Name of SupportedHeader

NAME - Static variable in interface javax.sip.header.SubjectHeader

Name of SubjectHeader

NAME - Static variable in interface javax.sip.header.ServerHeader

Name of ServerHeader

NAME - Static variable in interface javax.sip.header.RouteHeader

Name of RouteHeader

NAME - Static variable in interface javax.sip.header.RetryAfterHeader

Name of RetryAfterHeader

NAME - Static variable in interface javax.sip.header.RequireHeader

Name of RequireHeader

NAME - Static variable in interface javax.sip.header.ReplyToHeader

Name of ReplyToHeader

NAME - Static variable in interface javax.sip.header.RecordRouteHeader

Name of RecordRouteHeader

NAME - Static variable in interface javax.sip.header.ProxyRequireHeader

Name of ProxyRequireHeader

NAME - Static variable in interface javax.sip.header.ProxyAuthorizationHeader

Name of ProxyAuthorizationHeader

NAME - Static variable in interface javax.sip.header.ProxyAuthenticateHeader

Name of ProxyAuthenticateHeader

NAME - Static variable in interface javax.sip.header.PriorityHeader

Name of PriorityHeader

NAME - Static variable in interface javax.sip.header.OrganizationHeader

Name of OrganizationHeader

NAME - Static variable in interface javax.sip.header.MinExpiresHeader

Name of ExpiresHeader

NAME - Static variable in interface javax.sip.header.MimeVersionHeader

Name of MimeVersionHeader

NAME - Static variable in interface javax.sip.header.MaxForwardsHeader

Name of MaxForwardsHeader

NAME - Static variable in interface javax.sip.header.InReplyToHeader

Name of InReplyToHeader

NAME - Static variable in interface javax.sip.header.FromHeader

Name of FromHeader

NAME - Static variable in interface javax.sip.header.ExpiresHeader

Name of ExpiresHeader

NAME - Static variable in interface javax.sip.header.ErrorInfoHeader

Name of the ErroInfoHeader

NAME - Static variable in interface javax.sip.header.DateHeader

Name of DateHeader

NAME - Static variable in interface javax.sip.header.ContentTypeHeader

Name of ContentTypeHeader

NAME - Static variable in interface javax.sip.header.ContentLengthHeader

Name of ContentLengthHeader

NAME - Static variable in interface javax.sip.header.ContentLanguageHeader

Name of ContentLanguageHeader

NAME - Static variable in interface javax.sip.header.ContentEncodingHeader

Name of ContentEncodingHeader

NAME - Static variable in interface javax.sip.header.ContentDispositionHeader

Name of ContentDispositionHeader

NAME - Static variable in interface javax.sip.header.ContactHeader

Name of ContactHeader

NAME - Static variable in interface javax.sip.header.CallInfoHeader

Name of CallInfoHeader

NAME - Static variable in interface javax.sip.header.CallIdHeader

Name of CallIdHeader

NAME - Static variable in interface javax.sip.header.CSeqHeader

Name of the CSeqHeader

NAME - Static variable in interface javax.sip.header.AuthorizationHeader

Name of AuthorizationHeader

NAME - Static variable in interface javax.sip.header.AuthenticationInfoHeader

Name of the AlertInfoHeader

NAME - Static variable in interface javax.sip.header.AllowHeader

Name of AllowHeader

NAME - Static variable in interface javax.sip.header.AlertInfoHeader

Name of the AlertInfoHeader

NAME - Static variable in interface javax.sip.header.AcceptLanguageHeader

Name of AcceptLanguageHeader

NAME - Static variable in interface javax.sip.header.AcceptHeader

Name of AcceptHeader

NAME - Static variable in interface javax.sip.header.AcceptEncodingHeader

Name of AcceptEncodingHeader

NO_RESOURCE - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated because the resource state which was being monitored no longer exists.

NON_URGENT - Static variable in interface javax.sip.header.PriorityHeader

Non-urgent priority constant

NORMAL - Static variable in interface javax.sip.header.PriorityHeader

Normal priority constant

NOT_ACCEPTABLE - Static variable in interface javax.sip.message.Response

The resource identified by the request is only capable of generating response entities that have content characteristics not acceptable according to the Accept header field sent in the request.

NOT_ACCEPTABLE_HERE - Static variable in interface javax.sip.message.Response

The response has the same meaning as 606 (Not Acceptable), but only applies to the specific resource addressed by the Request-URI and the request may succeed elsewhere.

NOT_FOUND - Static variable in interface javax.sip.message.Response

The server has definitive information that the user does not exist at the domain specified in the Request-URI.

NOT_IMPLEMENTED - Static variable in interface javax.sip.message.Response

The server does not support the functionality required to fulfill the request.

NOTIFY - Static variable in interface javax.sip.message.Request

Notify is an extension method that informs subscribers of changes in state to which the subscriber has a subscription.

O

ObjectInUseException - exception javax.sip.ObjectInUseException.

This exception is thrown by a method that is unable to delete a specified Object because the Object is still in use by the underlying implementation.

ObjectInUseException() - Constructor for class javax.sip.ObjectInUseException

Constructs a new ObjectInUseException.

ObjectInUseException(String) - Constructor for class javax.sip.ObjectInUseException

Constructs a new ObjectInUseException with the specified error message.

ObjectInUseException(String, Throwable) - Constructor for class javax.sip.ObjectInUseException

Constructs a new ObjectInUseException with the specified error message and specialized cause that triggered this error condition.

OK - Static variable in interface javax.sip.message.Response

The request has succeeded.

OPTIONS - Static variable in interface javax.sip.message.Request

The OPTIONS method allows a User Agent to query another User Agent or a proxy server as to its capabilities.

OptionTag - interface javax.sip.header.OptionTag.

This interface represents methods for manipulating OptionTags values for any header that contains an OptionTag value.

OrganizationHeader - interface javax.sip.header.OrganizationHeader.

The OrganizationHeader conveys the name of the organization to which the entity issuing the Request or Response belongs.

P

Parameters - interface javax.sip.header.Parameters.

This interface defines methods for accessing generic parameters for Headers that contain generic parameter values.

PAYMENT_REQUIRED - Static variable in interface javax.sip.message.Response

Reserved for future use.

PeerUnavailableException - exception javax.sip.PeerUnavailableException.

The PeerUnavailableException indicates that a vendor's implementation of a JAIN SIP interface could not be created for some reason.

PeerUnavailableException() - Constructor for class javax.sip.PeerUnavailableException

Constructs a new PeerUnavailableException.

PeerUnavailableException(String) - Constructor for class javax.sip.PeerUnavailableException

Constructs a new PeerUnavailableException with the specified error message.

PeerUnavailableException(String, Throwable) - Constructor for class javax.sip.PeerUnavailableException

Constructs a new PeerUnavailableException with the specified error message and specialized cause that triggered this error condition.

PENDING - Static variable in interface javax.sip.header.SubscriptionStateHeader

State: The subscription has been received by the notifier, but there is insufficient policy information to grant or deny the subscription yet.

PORT_5060 - Static variable in interface javax.sip.ListeningPoint

Port Constant: Default port 5060.

PORT_5061 - Static variable in interface javax.sip.ListeningPoint

Port Constant: Default port 5061.

PRACK - Static variable in interface javax.sip.message.Request

PRACK is an extension method that plays the same role as ACK, but for provisional responses.

PriorityHeader - interface javax.sip.header.PriorityHeader.

The Priority header field indicates the urgency of the request as perceived by the client.

PROBATION - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated, but the client SHOULD retry at some later time.

PROCEEDING - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Proceeding".

processRequest(RequestEvent) - Method in interface javax.sip.SipListener

Processes a Request received on a SipProvider upon which this SipListener is registered.

processResponse(ResponseEvent) - Method in interface javax.sip.SipListener

Processes a Response received on a SipProvider upon which this SipListener is registered.

processTimeout(TimeoutEvent) - Method in interface javax.sip.SipListener

Processes a retransmit or expiration Timeout of an underlying Transaction handled by this SipListener.

PROXY_AUTHENTICATION_REQUIRED - Static variable in interface javax.sip.message.Response

This code is similar to 401 (Unauthorized), but indicates that the client MUST first authenticate itself with the proxy.

ProxyAuthenticateHeader - interface javax.sip.header.ProxyAuthenticateHeader.

A Proxy-Authenticate header field value contains an authentication challenge.

ProxyAuthorizationHeader - interface javax.sip.header.ProxyAuthorizationHeader.

The Proxy-Authorization header field allows the client to identify itself (or its user) to a proxy that requires authentication.

ProxyRequireHeader - interface javax.sip.header.ProxyRequireHeader.

The Proxy-Require header field is used to indicate proxy-sensitive features that must be supported by the proxy.

Q

QUEUED - Static variable in interface javax.sip.message.Response

The called party is temporarily unavailable, but the server has decided to queue the call rather than reject it.

R

RAckHeader - interface javax.sip.header.RAckHeader.

This interface represents the RAck header, as defined by RFC3262, this header is not part of RFC3261.

ReasonHeader - interface javax.sip.header.ReasonHeader.

This interface represents the Reason header, as defined by RFC3326, this header is not part of RFC3261.

RecordRouteHeader - interface javax.sip.header.RecordRouteHeader.

The Record-Route header field is inserted by proxies in a request to force future requests in the dialog to be routed through the proxy.

REFER - Static variable in interface javax.sip.message.Request

Refer is an extension method that requests that the recipient REFER to a resource provided in the request, this can be used to enable many applications such as Call Transfer.

ReferToHeader - interface javax.sip.header.ReferToHeader.

This interface represents the ReferTo SIP header, as defined by RFC3515, this header is not part of RFC3261.

REGISTER - Static variable in interface javax.sip.message.Request

The REGISTER method requests the addition, removal, and query of bindings.

REJECTED - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated due to change in authorization policy.

removeContent() - Method in interface javax.sip.message.Message

Removes the body content from this Message and all associated entity headers, if a body exists, this method returns sliently if no body exists.

removeHeader(String) - Method in interface javax.sip.message.Message

Removes the Header of the supplied name from the list of headers in this Message.

removeParameter(String) - Method in interface javax.sip.header.Parameters

Removes the specified parameter from Parameters of this ParametersHeader.

removePort() - Method in interface javax.sip.address.SipURI

Removes the port part of this SipURI.

removeSipListener(SipListener) - Method in interface javax.sip.SipProvider

Removes the specified SipListener from this SipProvider.

RENDER - Static variable in interface javax.sip.header.ContentDispositionHeader

Render Disposition Type Constant

ReplyToHeader - interface javax.sip.header.ReplyToHeader.

The Reply-To header field contains a logical return URI that may be different from the From header field.

Request - interface javax.sip.message.Request.

A SIP Request is a request from a client to a server.

REQUEST_ENTITY_TOO_LARGE - Static variable in interface javax.sip.message.Response

The server is refusing to process a request because the request entity-body is larger than the server is willing or able to process.

REQUEST_PENDING - Static variable in interface javax.sip.message.Response

The request was received by a UAS that had a pending request within the same dialog.

REQUEST_TERMINATED - Static variable in interface javax.sip.message.Response

The request was terminated by a BYE or CANCEL request.

REQUEST_TIMEOUT - Static variable in interface javax.sip.message.Response

The server could not produce a response within a suitable amount of time, for example, if it could not determine the location of the user in time.

REQUEST_URI_TOO_LONG - Static variable in interface javax.sip.message.Response

The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret.

RequestEvent - class javax.sip.RequestEvent.

This class represents an Request event that is passed from a SipProvider to its SipListener.

RequestEvent(Object, ServerTransaction, Request) - Constructor for class javax.sip.RequestEvent

Constructs a RequestEvent encapsulating the Request that has been received by the underlying SipProvider.

RequireHeader - interface javax.sip.header.RequireHeader.

The Require header field is used by UACs to tell UASs about options that the UAC expects the UAS to support in order to process the request.

resetFactory() - Method in class javax.sip.SipFactory

This method reset's the SipFactory's references to the object's it has created.

Response - interface javax.sip.message.Response.

A Response message is sent by a recipient of Request once it has received and interpreted the Request.

ResponseEvent - class javax.sip.ResponseEvent.

This class represents a Response event that is passed from a SipProvider to its SipListener.

ResponseEvent(Object, ClientTransaction, Response) - Constructor for class javax.sip.ResponseEvent

Constructs a ResponseEvent encapsulating the Response that has been received by the underlying SipProvider.

RETRANSMIT - Static variable in class javax.sip.Timeout

This constant value indicates the "Retransmit" timeout.

RetryAfterHeader - interface javax.sip.header.RetryAfterHeader.

The Retry-After header field identifies the time to retry the request after recipt of the response.

RINGING - Static variable in interface javax.sip.message.Response

The User Agent receiving the INVITE is trying to alert the user.

RouteHeader - interface javax.sip.header.RouteHeader.

The Route header field is used to force routing for a request through the listed set of proxies.

Router - interface javax.sip.address.Router.

The Router interface defines accessor methods to retrieve the default Route and Outbound Proxy of this SipStack.

RSeqHeader - interface javax.sip.header.RSeqHeader.

This interface represents the RSeq header, as defined by RFC3262, this header is not part of RFC3261.

S

SCTP - Static variable in interface javax.sip.ListeningPoint

Transport constant: SCTP

sendAck(Request) - Method in interface javax.sip.Dialog

Sends ACK Request to the remote party of this dialog.

sendRequest() - Method in interface javax.sip.ClientTransaction

Sends the Request which created this ClientTransaction.

sendRequest(ClientTransaction) - Method in interface javax.sip.Dialog

Sends a Request to the remote party of this dialog.

sendRequest(Request) - Method in interface javax.sip.SipProvider

Sends the Request statelessly, that is no transaction record is associated with this action.

sendResponse(Response) - Method in interface javax.sip.SipProvider

Sends the Response statelessly, that is no transaction record is associated with this action.

sendResponse(Response) - Method in interface javax.sip.ServerTransaction

Sends the Response to a Request which is identified by this ServerTransaction.

SERVER_INTERNAL_ERROR - Static variable in interface javax.sip.message.Response

The server encountered an unexpected condition that prevented it from fulfilling the request.

SERVER_TIMEOUT - Static variable in interface javax.sip.message.Response

The server did not receive a timely response from an external server it accessed in attempting to process the request. 408 (Request Timeout) should be used instead if there was no response within the period specified in the Expires header field from the upstream server.

ServerHeader - interface javax.sip.header.ServerHeader.

The Server header field contains information about the software used by the UAS to handle the request.

ServerTransaction - interface javax.sip.ServerTransaction.

A server transaction is used by a SipProvider to handle incoming Request messages to fire Request events to the SipListener on a specific server transaction and by a User Agent Server application to send Response messages to a User Agent Client application.

SERVICE_UNAVAILABLE - Static variable in interface javax.sip.message.Response

The server is temporarily unable to process the request due to a temporary overloading or maintenance of the server.

SESSION - Static variable in interface javax.sip.header.ContentDispositionHeader

Session Disposition Type Constant

SESSION_DESCRIPTION_PARAMETER_NOT_UNDERSTOOD - Static variable in interface javax.sip.header.WarningHeader

A parameter other than those listed above was not understood.

SESSION_NOT_ACCEPTABLE - Static variable in interface javax.sip.message.Response

The user's agent was contacted successfully but some aspects of the session description such as the requested media, bandwidth, or addressing style were not acceptable.

SESSION_PROGRESS - Static variable in interface javax.sip.message.Response

The 183 (Session Progress) response is used to convey information about the progress of the call that is not otherwise classified.

setAcceptLanguage(Locale) - Method in interface javax.sip.header.AcceptLanguageHeader

Sets the language parameter of this AcceptLanguageHeader.

setAddress(Address) - Method in interface javax.sip.header.HeaderAddress

Sets the Address parameter of this Address.

setAgent(String) - Method in interface javax.sip.header.WarningHeader

Sets the agent value of the WarningHeader to the new value passed to the method.

setAlertInfo(URI) - Method in interface javax.sip.header.AlertInfoHeader

Sets the AlertInfo of the AlertInfoHeader to the alertInfo parameter value.

setAlgorithm(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Algorithm of the WWWAuthenicateHeader to the new algorithm parameter value.

setAlgorithm(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Algorithm of the AuthorizationHeader to the new algorithm parameter value.

setApplicationData(Object) - Method in interface javax.sip.Dialog

Sets application specific data to this dialog.

setBranch(String) - Method in interface javax.sip.header.ViaHeader

Sets the branch parameter of the ViaHeader to the newly supplied branch value.

setCallId(String) - Method in interface javax.sip.header.InReplyToHeader

Sets the Call-Id of the InReplyToHeader.

setCallId(String) - Method in interface javax.sip.header.CallIdHeader

Sets the Call-Id of the CallIdHeader.

setCause(int) - Method in interface javax.sip.header.ReasonHeader

Sets the cause value of the ReasonHeader.

setCNonce(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the CNonce of the AuthorizationHeader to the cNonce parameter value.

setCNonce(String) - Method in interface javax.sip.header.AuthenticationInfoHeader

Sets the CNonce of the AuthenticationInfoHeader to the cNonce parameter value.

setCode(int) - Method in interface javax.sip.header.WarningHeader

Sets the code of the WarningHeader.

setComment(String) - Method in interface javax.sip.header.RetryAfterHeader

Sets the comment value of the RetryAfterHeader.

setContent(Object, ContentTypeHeader) - Method in interface javax.sip.message.Message

Sets the body of this Message, with the ContentType defined by the new ContentTypeHeader object and the string value of the content.

setContentDisposition(ContentDispositionHeader) - Method in interface javax.sip.message.Message

Sets the ContentDispositionHeader of this Message.

setContentEncoding(ContentEncodingHeader) - Method in interface javax.sip.message.Message

Sets the ContentEncodingHeader of this Message.

setContentLanguage(ContentLanguageHeader) - Method in interface javax.sip.message.Message

Sets the ContentLanguageHeader of this Message.

setContentLanguage(Locale) - Method in interface javax.sip.header.ContentLanguageHeader

Sets the language parameter of this ContentLanguageHeader.

setContentLength(ContentLengthHeader) - Method in interface javax.sip.message.Message

Set the ContentLengthHeader of this Message.

setContentLength(int) - Method in interface javax.sip.header.ContentLengthHeader

Set content-length of ContentLengthHeader.

setContentSubType(String) - Method in interface javax.sip.header.MediaType

Sets value of media subtype of Header with Content sub-type.

setContentType(String) - Method in interface javax.sip.header.MediaType

Sets value of media type of Header with Content Type.

setCSeqNumber(int) - Method in interface javax.sip.header.RAckHeader

Sets the sequence number value of the CSeqHeader of the provisional response being acknowledged.

setDate(Calendar) - Method in interface javax.sip.header.DateHeader

Sets date of DateHeader.

setDelay(float) - Method in interface javax.sip.header.TimeStampHeader

Sets the new delay value of the TimestampHeader to the delay parameter passed to this method

setDisplayName(String) - Method in interface javax.sip.address.Address

Sets the display name of the Address.

setDispositionType(String) - Method in interface javax.sip.header.ContentDispositionHeader

Sets the interpretation value of the message body or message body part for this ContentDispositionHeader.

setDomain(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Domain of the WWWAuthenicateHeader to the domain parameter value.

setDuration(int) - Method in interface javax.sip.header.RetryAfterHeader

Sets the duration value of the RetryAfterHeader.

setEncoding(String) - Method in interface javax.sip.header.Encoding

Sets the encoding of an EncodingHeader.

setErrorInfo(URI) - Method in interface javax.sip.header.ErrorInfoHeader

Sets the ErrorInfo of the ErrorInfoHeader to the errorInfo parameter value.

setErrorMessage(String) - Method in interface javax.sip.header.ErrorInfoHeader

Sets the Error information message to the new message value supplied to this method.

setEventId(String) - Method in interface javax.sip.header.EventHeader

Sets the id to the newly supplied eventId string.

setEventType(String) - Method in interface javax.sip.header.AllowEventsHeader

Sets the eventType defined in this AllowEventsHeader.

setEventType(String) - Method in interface javax.sip.header.EventHeader

Sets the eventType to the newly supplied eventType string.

setExpires(ExpiresHeader) - Method in interface javax.sip.message.Message

Sets the ExpiresHeader of this Message.

setExpires(int) - Method in interface javax.sip.header.SubscriptionStateHeader

Sets the relative expires value of the SubscriptionStateHeader.

setExpires(int) - Method in interface javax.sip.header.ExpiresHeader

Sets the relative expires value of the ExpiresHeader.

setExpires(int) - Method in interface javax.sip.header.ContactHeader

Returns the value of the expires parameter as delta-seconds.

setGlobal(boolean) - Method in interface javax.sip.address.TelURL

Sets phone user of this TelURL to be either global or local.

setHandling(String) - Method in interface javax.sip.header.ContentDispositionHeader

The handling parameter describes how the UAS should react if it receives a message body whose content type or disposition type it does not understand.

setHeader(Header) - Method in interface javax.sip.message.Message

Sets the new Header to replace existings Header of that type in the message.

setHeader(String, String) - Method in interface javax.sip.address.SipURI

Sets the value of the specified header fields to be included in a request constructed from the URI.

setHost(String) - Method in interface javax.sip.address.SipURI

Set the host part of this SipURI to the newly supplied host parameter.

setHost(String) - Method in interface javax.sip.header.ViaHeader

Set the host part of this ViaHeader to the newly supplied host parameter.

setInfo(URI) - Method in interface javax.sip.header.CallInfoHeader

Sets the Information parameter of this CallInfoHeader.

setIsdnSubAddress(String) - Method in interface javax.sip.address.TelURL

Sets ISDN subaddress of this TelURL.

setListeningPoint(ListeningPoint) - Method in interface javax.sip.SipProvider

This method sets the ListeningPoint of the SipProvider.

setLrParam() - Method in interface javax.sip.address.SipURI

Sets the value of the lr parameter of this SipURI.

setMAddr(String) - Method in interface javax.sip.header.ViaHeader

Sets the value of the maddr parameter of this ViaHeader.

setMAddrParam(String) - Method in interface javax.sip.address.SipURI

Sets the value of the maddr parameter of this SipURI.

setMajorVersion(int) - Method in interface javax.sip.header.MimeVersionHeader

Sets the Major-Version argument of this MimeVersionHeader to the supplied majorVersion value.

setMaxForwards(int) - Method in interface javax.sip.header.MaxForwardsHeader

Sets the max-forwards argument of this MaxForwardsHeader to the supplied maxForwards value.

setMethod(String) - Method in interface javax.sip.header.RAckHeader

Sets the method of RAckHeader, which correlates to the method of the CSeqHeader of the provisional response being acknowledged.

setMethod(String) - Method in interface javax.sip.header.CSeqHeader

Sets the method of CSeqHeader

setMethod(String) - Method in interface javax.sip.header.AllowHeader

Sets the method supported by this AllowHeader.

setMethod(String) - Method in interface javax.sip.message.Request

Sets the method of Request to the newly supplied value.

setMethodParam(String) - Method in interface javax.sip.address.SipURI

Sets the value of the method parameter.

setMinorVersion(int) - Method in interface javax.sip.header.MimeVersionHeader

Sets the Minor-Version argument of this MimeVersionHeader to the supplied minorVersion value.

setNextNonce(String) - Method in interface javax.sip.header.AuthenticationInfoHeader

Sets the NextNonce of the AuthenticationInfoHeader to the nextNonce parameter value.

setNonce(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Nonce of the WWWAuthenicateHeader to the nonce parameter value.

setNonce(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Nonce of the AuthorizationHeader to the nonce parameter value.

setNonceCount(int) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Nonce Count of the AuthorizationHeader to the nonceCount parameter value.

setNonceCount(int) - Method in interface javax.sip.header.AuthenticationInfoHeader

Sets the Nonce Count of the AuthenticationInfoHeader to the nonceCount parameter value.

setOpaque(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Opaque value of the WWWAuthenicateHeader to the new opaque parameter value.

setOpaque(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Opaque value of the AuthorizationHeader to the new opaque parameter value.

setOptionTag(String) - Method in interface javax.sip.header.OptionTag

Sets the option tag value to the new supplied optionTag parameter.

setOrganization(String) - Method in interface javax.sip.header.OrganizationHeader

Sets the organization value of the OrganizationHeader to the organization parameter supplied.

setParameter(String, String) - Method in interface javax.sip.header.Parameters

Sets the value of the specified parameter.

setPathName(String) - Method in class javax.sip.SipFactory

Sets the pathname that identifies the location of a particular vendor's implementation of this specification.

setPhoneNumber(String) - Method in interface javax.sip.address.TelURL

Sets phone number of this TelURL.

setPort(int) - Method in interface javax.sip.address.SipURI

Set the port part of this SipURI to the newly supplied port parameter.

setPort(int) - Method in interface javax.sip.header.ViaHeader

Set the port part of this ViaHeader to the newly supplied port parameter.

setPostDial(String) - Method in interface javax.sip.address.TelURL

Sets post dial of this TelURL.

setPriority(String) - Method in interface javax.sip.header.PriorityHeader

Set priority of PriorityHeader

setProduct(List) - Method in interface javax.sip.header.UserAgentHeader

Sets the List of product values of the ServerHeader.

setProduct(List) - Method in interface javax.sip.header.ServerHeader

Sets the List of product values of the ServerHeader.

setProtocol(String) - Method in interface javax.sip.header.ReasonHeader

Sets the protocol of the ReasonHeader, for example SIP or Q.850.

setProtocol(String) - Method in interface javax.sip.header.ViaHeader

Sets the value of the protocol parameter.

setPurpose(String) - Method in interface javax.sip.header.CallInfoHeader

Sets the purpose parameter of the info of this CallInfoHeader.

setQop(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Qop value of the WWWAuthenicateHeader to the new qop parameter value.

setQop(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the MessageQop value of the AuthorizationHeader to the new qop parameter value.

setQop(String) - Method in interface javax.sip.header.AuthenticationInfoHeader

Sets the Qop value of the AuthenticationInfoHeader to the new qop parameter value.

setQValue(float) - Method in interface javax.sip.header.ContactHeader

Sets the qValue value of the Name Address.

setQValue(float) - Method in interface javax.sip.header.AcceptLanguageHeader

Sets q-value for media-range in AcceptLanguageHeader.

setQValue(float) - Method in interface javax.sip.header.AcceptHeader

Sets q-value for media-range in AcceptHeader.

setQValue(float) - Method in interface javax.sip.header.AcceptEncodingHeader

Sets q-value for the encoding in this encoding value.

setRealm(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the Realm of the WWWAuthenicateHeader to the realm parameter value.

setRealm(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Realm of the AuthorizationHeader to the realm parameter value.

setReasonCode(String) - Method in interface javax.sip.header.SubscriptionStateHeader

Sets the reason code value of the SubscriptionStateHeader.

setReasonPhrase(String) - Method in interface javax.sip.message.Response

Sets reason phrase of Response.

setReceived(String) - Method in interface javax.sip.header.ViaHeader

Sets the received parameter of ViaHeader.

setRequestURI(URI) - Method in interface javax.sip.message.Request

Sets the RequestURI of Request.

setResponse(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Response of the AuthorizationHeader to the new response parameter value.

setResponse(String) - Method in interface javax.sip.header.AuthenticationInfoHeader

Sets the Response of the AuthenticationInfoHeader to the new response parameter value.

setRetransmitTimer(int) - Method in interface javax.sip.Transaction

Sets the value of the retransmit timer to the newly supplied timer value.

setRetryAfter(int) - Method in interface javax.sip.header.SubscriptionStateHeader

Sets the retry after value of the SubscriptionStateHeader.

setRetryAfter(int) - Method in interface javax.sip.header.RetryAfterHeader

Sets the retry after value of the RetryAfterHeader.

setRSeqNumber(int) - Method in interface javax.sip.header.RAckHeader

Sets the sequence number value of the RSeqHeader of the provisional response being acknowledged.

setScheme(String) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the scheme of the challenge information for this WWWAuthenticateHeader.

setScheme(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the scheme of the Response information for this AuthorizationHeader.

setSecure(boolean) - Method in interface javax.sip.address.SipURI

Sets the scheme of this URI to sip or sips depending on whether the argument is true or false.

setSequenceNumber(int) - Method in interface javax.sip.header.RSeqHeader

Sets the sequence number value of the RSeqHeader of the provisional response.

setSequenceNumber(int) - Method in interface javax.sip.header.CSeqHeader

Sets the sequence number value of the CSeqHeader.

setSIPVersion(String) - Method in interface javax.sip.message.Message

Sets the protocol version of SIP being used by this Message.

setStale(boolean) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the value of the stale parameter of the WWWAuthenicateHeader to the stale parameter value.

setState(String) - Method in interface javax.sip.header.SubscriptionStateHeader

Sets the state value of the SubscriptionStateHeader.

setStatusCode(int) - Method in interface javax.sip.message.Response

Sets the status-code of Response.

setSubject(String) - Method in interface javax.sip.header.SubjectHeader

Sets the subject value of the SubjectHeader to the supplied string subject value.

setTag(String) - Method in interface javax.sip.header.ToHeader

Sets the tag parameter of the ToHeader.

setTag(String) - Method in interface javax.sip.header.FromHeader

Sets the tag parameter of the FromHeader.

setText(String) - Method in interface javax.sip.header.ReasonHeader

Sets the text value of the ReasonHeader.

setText(String) - Method in interface javax.sip.header.WarningHeader

Sets the text of WarningHeader to the newly supplied text value.

setTimeStamp(float) - Method in interface javax.sip.header.TimeStampHeader

Sets the timestamp value of this TimeStampHeader to the new timestamp value passed to this method.

setTransport(String) - Method in interface javax.sip.header.ViaHeader

Sets the value of the transport.

setTransportParam(String) - Method in interface javax.sip.address.SipURI

Sets the value of the "transport" parameter.

setTTL(int) - Method in interface javax.sip.header.ViaHeader

Sets the value of the ttl parameter.

setTTLParam(int) - Method in interface javax.sip.address.SipURI

Sets the value of the ttl parameter.

setURI(URI) - Method in interface javax.sip.address.Address

Sets the URI of this Address.

setURI(URI) - Method in interface javax.sip.header.WWWAuthenticateHeader

Sets the URI of the WWWAuthenicateHeader to the uri parameter value.

setURI(URI) - Method in interface javax.sip.header.AuthorizationHeader

Sets the URI of the AuthorizationHeader to the uri parameter value.

setUser(String) - Method in interface javax.sip.address.SipURI

Sets the user of SipURI.

setUsername(String) - Method in interface javax.sip.header.AuthorizationHeader

Sets the Username of the AuthorizationHeader to the username parameter value.

setUserParam(String) - Method in interface javax.sip.address.SipURI

Sets the value of the user parameter.

setUserPassword(String) - Method in interface javax.sip.address.SipURI

Sets the user password associated with the user of SipURI.

setValue(String) - Method in interface javax.sip.header.ExtensionHeader

Sets the value parameter of the ExtensionHeader.

SipException - exception javax.sip.SipException.

A SipException is thrown when a general SIP exception is encountered, when no other specialized exception defined in this specification can handle the error.

SipException() - Constructor for class javax.sip.SipException

Constructs a new SipException

SipException(String) - Constructor for class javax.sip.SipException

Constructs a new SipException with the specified error message.

SipException(String, Throwable) - Constructor for class javax.sip.SipException

Constructs a new SipException with the specified error message and specialized cause that triggered this error condition.

SipFactory - class javax.sip.SipFactory.

The SipFactory is a singleton class which applications can use a single access point to obtain proprietary implementations of this specification.

SipListener - interface javax.sip.SipListener.

This interface represents the application view to a SIP stack therefore defines the application's communication channel to the SIP stack.

SipProvider - interface javax.sip.SipProvider.

This interface represents the messaging entity of a SIP stack and as such is the interface that defines the messaging and transactional component view of the SIP stack.

SipStack - interface javax.sip.SipStack.

This interface represents the management interface of a SIP stack implementing this specification and as such is the interface that defines the management/architectural view of the SIP stack.

SipURI - interface javax.sip.address.SipURI.

This class represents SIP URIs, that may have either a sip: or sips: scheme.

SubjectHeader - interface javax.sip.header.SubjectHeader.

The Subject header field provides a summary or indicates the nature of the call, allowing call filtering without having to parse the session description.

SUBSCRIBE - Static variable in interface javax.sip.message.Request

Subscribe is an extension method that is used to request current state and state updates from a remote node.

SubscriptionStateHeader - interface javax.sip.header.SubscriptionStateHeader.

This interface represents the Subscription State header, as defined by RFC3265, this header is not part of RFC3261.

SupportedHeader - interface javax.sip.header.SupportedHeader.

The Supported header field enumerates all the extensions supported by the UAC or UAS.

T

TCP - Static variable in interface javax.sip.ListeningPoint

Transport constant: TCP

TelURL - interface javax.sip.address.TelURL.

This class represents Tel URLs, which are used for addressing.

TEMPORARILY_UNAVAILABLE - Static variable in interface javax.sip.message.Response

The callee's end system was contacted successfully but the callee is currently unavailable (for example, is not logged in, logged in but in a state that precludes communication with the callee, or has activated the "do not disturb" feature).

TERMINATED - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Terminated".

TERMINATED - Static variable in class javax.sip.DialogState

This constant value indicates that the dialog state is "Terminated".

TERMINATED - Static variable in interface javax.sip.header.SubscriptionStateHeader

State: The subscription has been terminated, if a reason code is present, the client should behave as described in the reason code.

Timeout - class javax.sip.Timeout.

This class contains the enumerations that define whether a timeout has occured in the underlying implementation.

TIMEOUT - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The subscription has been terminated because it was not refreshed before it expired.

TimeoutEvent - class javax.sip.TimeoutEvent.

This class represents an Timeout event that is passed from a SipProvider to its SipListener.

TimeoutEvent(Object, ClientTransaction, Timeout) - Constructor for class javax.sip.TimeoutEvent

Constructs a TimeoutEvent to indicate a client retransmission or transaction timeout.

TimeoutEvent(Object, ServerTransaction, Timeout) - Constructor for class javax.sip.TimeoutEvent

Constructs a TimeoutEvent to indicate a server retransmission or transaction timeout.

TimeStampHeader - interface javax.sip.header.TimeStampHeader.

The Timestamp header field describes when the UAC sent the request to the UAS.

TLS - Static variable in interface javax.sip.ListeningPoint

Transport constant: TLS over TCP

ToHeader - interface javax.sip.header.ToHeader.

The To header field first and foremost specifies the desired "logical" recipient of the request, or the address-of-record of the user or resource that is the target of this request.

TOO_MANY_HOPS - Static variable in interface javax.sip.message.Response

The server received a request that contains a Max-Forwards header field with the value zero.

TooManyHopsException - exception javax.sip.header.TooManyHopsException.

This Exception is thrown when a user attempts decrement the Hop count when the message as already reached its max number of forwards.

TooManyHopsException() - Constructor for class javax.sip.header.TooManyHopsException

Constructs a new TooManyHopsException

TooManyHopsException(String) - Constructor for class javax.sip.header.TooManyHopsException

Constructs a new TooManyHopsException with the specified error message.

TooManyHopsException(String, Throwable) - Constructor for class javax.sip.header.TooManyHopsException

Constructs a new TooManyHopsException with the specified error message and specialized cause that triggered this error condition.

toString() - Method in class javax.sip.TransactionState

This method returns a string version of this class.

toString() - Method in class javax.sip.Timeout

This method returns a string version of this class.

toString() - Method in class javax.sip.DialogState

This method returns a string version of this class.

toString() - Method in interface javax.sip.address.Hop

This method returns the Hop as a string.

toString() - Method in interface javax.sip.address.URI

This method returns the URI as a string.

toString() - Method in interface javax.sip.address.TelURL

This method returns the URI as a string.

toString() - Method in interface javax.sip.address.SipURI

This method returns the URI as a string.

toString() - Method in interface javax.sip.address.Address

Returns a string representation of this Address.

toString() - Method in interface javax.sip.header.Header

Gets a string representation of the Header.

toString() - Method in interface javax.sip.message.Message

Gets string representation of Message

Transaction - interface javax.sip.Transaction.

Transactions are a fundamental component of SIP.

TRANSACTION - Static variable in class javax.sip.Timeout

This constant value indicates the "Transaction" timeout.

TransactionAlreadyExistsException - exception javax.sip.TransactionAlreadyExistsException.

This Exception is thrown when a user attempts to get a transaction to handle a message when infact a transaction is already handling this message.

TransactionAlreadyExistsException() - Constructor for class javax.sip.TransactionAlreadyExistsException

Constructs a new TransactionAlreadyExistsException

TransactionAlreadyExistsException(String) - Constructor for class javax.sip.TransactionAlreadyExistsException

Constructs a new TransactionAlreadyExistsException with the specified error message.

TransactionAlreadyExistsException(String, Throwable) - Constructor for class javax.sip.TransactionAlreadyExistsException

Constructs a new TransactionAlreadyExistsException with the specified error message and specialized cause that triggered this error condition.

TransactionDoesNotExistException - exception javax.sip.TransactionDoesNotExistException.

This Exception is thrown when a user attempts to reference a client or server transaction that does currently not exist in the underlying SipProvider

TransactionDoesNotExistException() - Constructor for class javax.sip.TransactionDoesNotExistException

Constructs a new TransactionDoesNotExistException

TransactionDoesNotExistException(String) - Constructor for class javax.sip.TransactionDoesNotExistException

Constructs a new TransactionDoesNotExistException with the specified error message.

TransactionDoesNotExistException(String, Throwable) - Constructor for class javax.sip.TransactionDoesNotExistException

Constructs a new TransactionDoesNotExistException with the specified error message and specialized cause that triggered this error condition.

TransactionState - class javax.sip.TransactionState.

This class contains the enumerations that define the underlying state of an existing transaction.

TransactionUnavailableException - exception javax.sip.TransactionUnavailableException.

The TransactionUnavailableException indicates that a vendor's implementation could not create a Transaction for some reason.

TransactionUnavailableException() - Constructor for class javax.sip.TransactionUnavailableException

Constructs a new TransactionUnavailableException.

TransactionUnavailableException(String) - Constructor for class javax.sip.TransactionUnavailableException

Constructs a new TransactionUnavailableException with the specified error message.

TransactionUnavailableException(String, Throwable) - Constructor for class javax.sip.TransactionUnavailableException

Constructs a new TransactionUnavailableException with the specified error message and specialized cause that triggered this error condition.

TransportNotSupportedException - exception javax.sip.TransportNotSupportedException.

The TransportNotSupportedException indicates that a specific transport is not supported by a vendor's implementation of this specification.

TransportNotSupportedException() - Constructor for class javax.sip.TransportNotSupportedException

Constructs a new TransportNotSupportedException.

TransportNotSupportedException(String) - Constructor for class javax.sip.TransportNotSupportedException

Constructs a new TransportNotSupportedException with the specified error message.

TransportNotSupportedException(String, Throwable) - Constructor for class javax.sip.TransportNotSupportedException

Constructs a new TransportNotSupportedException with the specified error message and specialized cause that triggered this error condition.

TRYING - Static variable in class javax.sip.TransactionState

This constant value indicates that the transaction state is "Trying".

TRYING - Static variable in interface javax.sip.message.Response

This response indicates that the request has been received by the next-hop server and that some unspecified action is being taken on behalf of this call (for example, a database is being consulted).

U

UDP - Static variable in interface javax.sip.ListeningPoint

Transport constant: UDP

UNAUTHORIZED - Static variable in interface javax.sip.message.Response

The request requires user authentication.

UNDECIPHERABLE - Static variable in interface javax.sip.message.Response

The request was received by a UAS that contained an encrypted MIME body for which the recipient does not possess or will not provide an appropriate decryption key.

UNICAST_NOT_AVAILABLE - Static variable in interface javax.sip.header.WarningHeader

The site where the user is located does not support unicast communication (usually due to the presence of a firewall).

UNKNOWN - Static variable in interface javax.sip.header.SubscriptionStateHeader

Reason Code: The reason why the subscription was terminated is Unknown.

UNSUPPORTED_MEDIA_TYPE - Static variable in interface javax.sip.message.Response

The server is refusing to service the request because the message body of the request is in a format not supported by the server for the requested method.

UNSUPPORTED_URI_SCHEME - Static variable in interface javax.sip.message.Response

The server cannot process the request because the scheme of the URI in the Request-URI is unknown to the server.

UnsupportedHeader - interface javax.sip.header.UnsupportedHeader.

The Unsupported header field lists the features not supported by the UAS.

UPDATE - Static variable in interface javax.sip.message.Request

UPDATE is an extension method that allows a client to update parameters of a session (such as the set of media streams and their codecs) but has no impact on the state of a dialog.

URGENT - Static variable in interface javax.sip.header.PriorityHeader

Urgent priority constant

URI - interface javax.sip.address.URI.

This class represents a generic URI.

USE_PROXY - Static variable in interface javax.sip.message.Response

The requested resource MUST be accessed through the proxy given by the Contact field.

UserAgentHeader - interface javax.sip.header.UserAgentHeader.

The User-Agent header field contains information about the UAC originating the request.

V

VERSION_NOT_SUPPORTED - Static variable in interface javax.sip.message.Response

The server does not support, or refuses to support, the SIP protocol version that was used in the request.

ViaHeader - interface javax.sip.header.ViaHeader.

The Via header field indicates the transport used for the transaction and identifies the location where the response is to be sent.

W

WarningHeader - interface javax.sip.header.WarningHeader.

The Warning header field is used to carry additional information about the status of a response.

WWWAuthenticateHeader - interface javax.sip.header.WWWAuthenticateHeader.

This interface represents the WWW-Authenticate response-header.

_

_CALLING - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Calling" constant.

_COMPLETED - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Completed" constant.

_COMPLETED - Static variable in class javax.sip.DialogState

This constant value indicates the internal value of the "Completed" constant.

_CONFIRMED - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Confirmed" constant.

_CONFIRMED - Static variable in class javax.sip.DialogState

This constant value indicates the internal value of the "Confirmed" constant.

_EARLY - Static variable in class javax.sip.DialogState

This constant value indicates the internal value of the "Early" constant.

_PROCEEDING - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Proceeding" constant.

_RETRANSMIT - Static variable in class javax.sip.Timeout

This constant value indicates the internal value of the Retransmit timeout.

_TERMINATED - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Terminated" constant.

_TERMINATED - Static variable in class javax.sip.DialogState

This constant value indicates the internal value of the "Terminated" constant.

_TRANSACTION - Static variable in class javax.sip.Timeout

This constant value indicates the internal value of the Transaction timeout.

_TRYING - Static variable in class javax.sip.TransactionState

This constant value indicates the internal value of the "Trying" constant.

A B C D E F G H I J L M N O P Q R S T U V W _