Index (SipUnit API Reference)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

A

ACCEPTED - Static variable in class org.cafesip.sipunit.SipResponse
ACK - Static variable in class org.cafesip.sipunit.SipRequest
addBuddy(String, int, String, long) - Method in class org.cafesip.sipunit.SipPhone: This method adds a buddy to the buddy list and starts an ongoing subscription for purposes of tracking the buddy's presence information.
addBuddy(String, long) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as addBuddy(uri, duration, eventId, timeout) except that the duration is defaulted to the default period defined in the event package RFC (3600 seconds) and no event "id" parameter will be included.
addBuddy(String, int, long) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as addBuddy(uri, duration, eventId, timeout) except that no event "id" parameter will be included.
addBuddy(String, String, long) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as addBuddy(uri, duration, eventId, timeout) except that the duration is defaulted to the default period defined in the event package RFC (3600 seconds).
addNotifyHeaders(Request, String, String, String, String, String, int) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method adds each of the given parameters, if not null, to the given NOTIFY Request parameter which just contains the request line (created from a string).
ADDRESS_INCOMPLETE - Static variable in class org.cafesip.sipunit.SipResponse
addUpdateCredential(Credential) - Method in class org.cafesip.sipunit.SipPhone: This method adds a new credential to the credentials list or updates an existing credential in the list.
ALTERNATIVE_SERVICE - Static variable in class org.cafesip.sipunit.SipResponse
AMBIGUOUS - Static variable in class org.cafesip.sipunit.SipResponse
assertAnswered(SipCall) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given incoming or outgoing call leg was answered.
assertAnswered(String, SipCall) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given incoming or outgoing call leg was answered.
assertBodyContains(SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains a body that includes the given value.
assertBodyContains(String, SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains a body that includes the given value.
assertBodyNotContains(SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the body in the given SIP message does not contain the value given, or that there is no body in the message.
assertBodyNotContains(String, SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the body in the given SIP message does not contain the value given, or that there is no body in the message.
assertBodyNotPresent(SipMessage) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no body.
assertBodyNotPresent(String, SipMessage) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no body.
assertBodyPresent(SipMessage) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains a body.
assertBodyPresent(String, SipMessage) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains a body.
assertHeaderContains(SipMessage, String, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains at least one occurrence of the specified header and that at least one occurrence of this header contains the given value.
assertHeaderContains(String, SipMessage, String, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains at least one occurrence of the specified header and that at least one occurrence of this header contains the given value.
assertHeaderNotContains(SipMessage, String, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no occurrence of the specified header with the value given, or that there is no occurrence of the header in the message.
assertHeaderNotContains(String, SipMessage, String, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no occurrence of the specified header with the value given, or that there is no occurrence of the header in the message.
assertHeaderNotPresent(SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no occurrence of the specified header.
assertHeaderNotPresent(String, SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains no occurrence of the specified header.
assertHeaderPresent(SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains at least one occurrence of the specified header.
assertHeaderPresent(String, SipMessage, String) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given SIP message contains at least one occurrence of the specified header.
assertLastOperationFail(SipActionObject) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the last SIP operation performed by the given object failed.
assertLastOperationFail(String, SipActionObject) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the last SIP operation performed by the given object failed.
assertLastOperationSuccess(SipActionObject) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the last SIP operation performed by the given object was successful.
assertLastOperationSuccess(String, SipActionObject) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the last SIP operation performed by the given object was successful.
assertNoSubscriptionErrors(EventSubscriber) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given Subscription has not encountered any errors while processing received subscription responses and received NOTIFY requests.
assertNoSubscriptionErrors(String, EventSubscriber) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given Subscription has not encountered any errors while processing received subscription responses and received NOTIFY requests.
assertNotAnswered(SipCall) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given incoming or outgoing call leg has not been answered.
assertNotAnswered(String, SipCall) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given incoming or outgoing call leg has not been answered.
assertRequestNotReceived(String, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a request with the indicated request method.
assertRequestNotReceived(String, String, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a request with the indicated request method.
assertRequestNotReceived(String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a request with the indicated CSeq method and sequence number.
assertRequestNotReceived(String, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a request with the indicated CSeq method and sequence number.
assertRequestReceived(String, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a request with the indicated request method.
assertRequestReceived(String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a request with the indicated CSeq method and CSeq sequence number.
assertRequestReceived(String, String, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a request with the indicated request method.
assertRequestReceived(String, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a request with the indicated CSeq method and CSeq sequence number.
assertResponseNotReceived(int, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a response with the indicated status code.
assertResponseNotReceived(String, int, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a response with the indicated status code.
assertResponseNotReceived(int, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a response with the indicated status code, CSeq method and sequence number.
assertResponseNotReceived(String, int, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object has not received a response with the indicated status code, CSeq method and sequence number.
assertResponseReceived(int, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a response with the indicated status code.
assertResponseReceived(int, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a response with the indicated status code, CSeq method and CSeq sequence number.
assertResponseReceived(String, int, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a response with the indicated status code.
assertResponseReceived(String, int, String, long, MessageListener) - Method in class org.cafesip.sipunit.SipTestCase: Asserts that the given message listener object received a response with the indicated status code, CSeq method and CSeq sequence number.

B

BAD_EVENT - Static variable in class org.cafesip.sipunit.SipResponse
BAD_EXTENSION - Static variable in class org.cafesip.sipunit.SipResponse
BAD_GATEWAY - Static variable in class org.cafesip.sipunit.SipResponse
BAD_REQUEST - Static variable in class org.cafesip.sipunit.SipResponse
BlockObject - Class in org.cafesip.sipunit: FOR INTERNAL USE ONLY.
BlockObject() - Constructor for class org.cafesip.sipunit.BlockObject: FOR INTERNAL USE ONLY - A test class doesn't use this method.
BUSY_EVERYWHERE - Static variable in class org.cafesip.sipunit.SipResponse
BUSY_HERE - Static variable in class org.cafesip.sipunit.SipResponse
BYE - Static variable in class org.cafesip.sipunit.SipRequest

C

calculateResponse(String, String, String, String, String, String, String, String, String, String, String) - Static method in class org.cafesip.sipunit.MessageDigestAlgorithm: Calculates a response an http authentication response in accordance with rfc2617.
CALL_IS_BEING_FORWARDED - Static variable in class org.cafesip.sipunit.SipResponse
CALL_OR_TRANSACTION_DOES_NOT_EXIST - Static variable in class org.cafesip.sipunit.SipResponse
callTimeoutOrError() - Method in class org.cafesip.sipunit.SipCall: Indicates if the current outgoing call has encountered a response timeout or any kind of error.
CANCEL - Static variable in class org.cafesip.sipunit.SipRequest
clearCredentials() - Method in class org.cafesip.sipunit.SipPhone: This method empties out the credentials list - completely - for this SipPhone.
clearEventErrors() - Method in class org.cafesip.sipunit.EventSubscriber: This method clears errors accumulated while collecting responses and NOTIFY requests.
createSipCall() - Method in class org.cafesip.sipunit.SipPhone: This method is used to create a SipCall object for handling one leg of a call.
createSipPhone(String, String, int, String) - Method in class org.cafesip.sipunit.SipStack: This method is used to create a SipPhone object.
createSipPhone(String) - Method in class org.cafesip.sipunit.SipStack: This method is the equivalent to the other createSipPhone() methods but without a proxy server.
createSipPhone(String, String) - Method in class org.cafesip.sipunit.SipStack: This method is the equivalent to the other createSipPhone() method, but using the default transport (UDP/IP) and the default SIP port number (5060).
createSubscribeMessage(int, String, String) - Method in class org.cafesip.sipunit.EventSubscriber: This method creates and returns to the caller the next SUBSCRIBE message that would be sent out for this subscription, so that the user can modify it before it gets sent (to introduce errors - insert incorrect content, remove content, etc.).
createSubscribeMessage(int, String) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as EventSubscriber.createSubscribeMessage() except there's no need for the caller to supply the eventType parameter.
createSubscribeMessage(int, String) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as EventSubscriber.createSubscribeMessage() except there's no need for the caller to supply the eventType parameter.
Credential - Class in org.cafesip.sipunit: This class holds authentication information required for accessing a realm.
Credential(String, String, String) - Constructor for class org.cafesip.sipunit.Credential: A constructor for this class.
Credential() - Constructor for class org.cafesip.sipunit.Credential: A no-arg constructor for this class.

D

DECLINE - Static variable in class org.cafesip.sipunit.SipResponse
DEFAULT_PORT - Static variable in class org.cafesip.sipunit.SipStack
DEFAULT_PROTOCOL - Static variable in class org.cafesip.sipunit.SipStack
DEFAULT_SUBSCRIBE_DURATION - Static variable in class org.cafesip.sipunit.SipPhone
disconnect() - Method in class org.cafesip.sipunit.SipCall: This method sends a basic BYE message.
disconnect(ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic disconnect() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
disconnect(String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic disconnect() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
dispose() - Method in class org.cafesip.sipunit.PresenceNotifySender: Dispose of this object (but not the stack given to it).
dispose() - Method in class org.cafesip.sipunit.ReferSubscriber: Removes this object from the SipPhone referrer list.
dispose() - Method in class org.cafesip.sipunit.SipCall: This method releases all resources associated with this SipCall.
dispose() - Method in class org.cafesip.sipunit.SipPhone: This method releases all resources associated with this SipPhone.
dispose() - Method in class org.cafesip.sipunit.SipSession: This method idles this SipSession.
dispose() - Method in class org.cafesip.sipunit.SipStack: This method is used to tear down the SipStack object.
disposeNoBye() - Method in class org.cafesip.sipunit.SipCall: This method is the same as dispose() except no BYE is sent before idling the dialog.
DOES_NOT_EXIST_ANYWHERE - Static variable in class org.cafesip.sipunit.SipResponse
dumpMessage(String, Message) - Static method in class org.cafesip.sipunit.SipStack: Outputs to console the provided header string followed by the message.

E

ERROR_OF_UNKNOWN_ORIGIN - Static variable in class org.cafesip.sipunit.SipSession
EventSubscriber - Class in org.cafesip.sipunit: The EventSubscriber class represents a generic subscription conforming to the event subscription and asynchronous notification framework defined by RFC-3265.
EXCEPTION_ENCOUNTERED - Static variable in class org.cafesip.sipunit.SipSession
EXTENSION_REQUIRED - Static variable in class org.cafesip.sipunit.SipResponse

F

FAR_END_ERROR - Static variable in class org.cafesip.sipunit.SipSession
fetchPresenceInfo(String, String, long) - Method in class org.cafesip.sipunit.SipPhone: This method performs a presence 'fetch' on the given user, to get a one-time report on the user's presence status and information.
fetchPresenceInfo(String, long) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as fetchPresenceInfo(uri, eventId, timeout) except that no event "id" parameter will be included in the SUBSCRIBE message.
findMostRecentResponse(int) - Method in class org.cafesip.sipunit.SipCall: This method returns the last received response with status code matching the given parameter.
FORBIDDEN - Static variable in class org.cafesip.sipunit.SipResponse
format() - Method in class org.cafesip.sipunit.EventSubscriber
format() - Method in interface org.cafesip.sipunit.SipActionObject: The format() method can be used to obtain a human-readable string containing the result of the last operation - either a successful indication or all of the error information associated with the last operation performed.
format() - Method in class org.cafesip.sipunit.SipCall
format() - Method in class org.cafesip.sipunit.SipSession

G

generateNewTag() - Method in class org.cafesip.sipunit.SipSession: This method returns a newly generated unique tag ID.
getAddress() - Method in class org.cafesip.sipunit.SipPhone: This method returns the user Address for this SipPhone.
getAddressFactory() - Method in class org.cafesip.sipunit.SipCall: This method returns the AddressFactory associated with this object.
getAddressFactory() - Method in class org.cafesip.sipunit.SipStack: This method returns the JAIN-SIP AddressFactory associated with the SipStack.
getAllReceivedRequests() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns all the NOTIFY requests received on this subscription.
getAllReceivedRequests() - Method in interface org.cafesip.sipunit.MessageListener: This method returns all the requests received by this object and can be called directly by a test program.
getAllReceivedRequests() - Method in class org.cafesip.sipunit.PresenceNotifySender
getAllReceivedRequests() - Method in class org.cafesip.sipunit.SipCall: This method returns all the requests received on this call.
getAllReceivedResponses() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns all the responses received on this subscription, including any that required re-initiation of the subscription (ie, authentication challenge).
getAllReceivedResponses() - Method in interface org.cafesip.sipunit.MessageListener: This method returns all the responses received by this object and can be called directly by a test program.
getAllReceivedResponses() - Method in class org.cafesip.sipunit.PresenceNotifySender
getAllReceivedResponses() - Method in class org.cafesip.sipunit.SipCall: This method returns all the responses received on this call, including any that required re-initiation of the call (ie, authentication challenge).
getAuthorization(String, String, String, WWWAuthenticateHeader, String, String) - Method in class org.cafesip.sipunit.SipSession: The getAuthorization() method generates an authorisation header in response to an authentication challenge.
getBasicStatus() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the basic status for this presence device (ie, "open" or "closed").
getBuddyInfo(String) - Method in class org.cafesip.sipunit.SipPhone: This method returns the PresenceSubscriber object representing a buddy or user whose presence information was fetched at some previous point.
getBuddyList() - Method in class org.cafesip.sipunit.SipPhone: Returns a copy of the current buddy list on this SipPhone.
getClientTransaction() - Method in class org.cafesip.sipunit.SipTransaction
getContactHeader() - Method in class org.cafesip.sipunit.SipContact
getContactInfo() - Method in class org.cafesip.sipunit.SipPhone: The method getContactInfo() returns the contact information currently in effect for this user agent.
getContactPriority() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the priority of this presence device, relative to others, with respect to contact preference.
getContactURI() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the contact URI for this device.
getContent() - Method in class org.cafesip.sipunit.SipMessage: Obtains the body of the message as an Object.
getContentLength() - Method in class org.cafesip.sipunit.SipMessage: Gets the length of the message body.
getCurrentResponse() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the most recent response received from the network for this subscription.
getDeviceExtensions() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the extensions received in the last NOTIFY message, if any, pertaining to this presence device.
getDeviceNotes() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the notes received in the last NOTIFY message, if any, pertaining to this presence device.
getDialog() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the dialog associated with this subscription.
getDialog() - Method in class org.cafesip.sipunit.PresenceNotifySender
getDialog() - Method in class org.cafesip.sipunit.SipCall: This method returns the dialog associated with this call leg.
getDialogId() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the dialog ID associated with this subscription, or an empty string if the dialog isn't created yet.
getDialogId() - Method in class org.cafesip.sipunit.SipCall: This method returns the dialog ID associated with this call leg, or an empty string if the dialog isn't created yet.
getDisplayName() - Method in class org.cafesip.sipunit.SipContact: The method getDisplayName() returns the display name of this contact URI.
getErrorMessage() - Method in class org.cafesip.sipunit.EventSubscriber
getErrorMessage() - Method in class org.cafesip.sipunit.PresenceNotifySender: Returns the error message, if any, associated with the last operation.
getErrorMessage() - Method in interface org.cafesip.sipunit.SipActionObject: The getErrorMessage() method returns a descriptive, human-readable string indicating the cause of the problem encountered during the last operation performed.
getErrorMessage() - Method in class org.cafesip.sipunit.SipCall
getErrorMessage() - Method in class org.cafesip.sipunit.SipSession
getEventErrors() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns any errors accumulated during collection of responses and NOTIFY requests.
getException() - Method in class org.cafesip.sipunit.EventSubscriber
getException() - Method in interface org.cafesip.sipunit.SipActionObject: This method is used to get the Exception object generated during the last operation performed.
getException() - Method in class org.cafesip.sipunit.SipCall
getException() - Method in class org.cafesip.sipunit.SipSession
getExpiry() - Method in class org.cafesip.sipunit.SipContact: The method getExpiry() returns the expiry value for this contact URI.
getExpiry() - Method in class org.cafesip.sipunit.SipMessage: Gets the duration after which the message (or content) expires, relative to message receipt.
getHeaderFactory() - Method in class org.cafesip.sipunit.SipCall: This method returns the HeaderFactory associated with this object.
getHeaderFactory() - Method in class org.cafesip.sipunit.SipStack: This method returns the JAIN-SIP HeaderFactory associated with the SipStack.
getId() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the unique, arbitrary ID representing this particular presence device.
getLanguage() - Method in class org.cafesip.sipunit.PresenceNote: Gets the language property of this note.
getLastReceivedRequest() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the last request received on this subscription.
getLastReceivedRequest() - Method in interface org.cafesip.sipunit.MessageListener: This method returns the last request received by this object and can be called directly by a test program.
getLastReceivedRequest() - Method in class org.cafesip.sipunit.PresenceNotifySender
getLastReceivedRequest() - Method in class org.cafesip.sipunit.SipCall: This method returns the last request received on this call.
getLastReceivedResponse() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the last response received on this subscription.
getLastReceivedResponse() - Method in interface org.cafesip.sipunit.MessageListener: This method returns the last response received by this object and can be called directly by a test program.
getLastReceivedResponse() - Method in class org.cafesip.sipunit.PresenceNotifySender
getLastReceivedResponse() - Method in class org.cafesip.sipunit.SipCall: This method returns the last response received on this call.
getLastSentNotify() - Method in class org.cafesip.sipunit.PresenceNotifySender: Returns the NOTIFY request that was last sent, or null if none has ever been sent.
getLastSentRequest() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the last request that was sent out for this subscription.
getLastTransaction() - Method in class org.cafesip.sipunit.SipCall: Call this method if you need the JAIN SIP transaction for SipPhone.makeCall() or for other SipCall operations that result in a sent request, before a response to the request has been received (see exception* below).
getLocalContactInfo() - Method in class org.cafesip.sipunit.SipPhone: Deprecated. Use getContactInfo() instead of this method, the term 'local' in the method name is misleading if the SipUnit test is running behind a NAT.
getLocalViaHeaders() - Method in class org.cafesip.sipunit.SipSession: Deprecated. Use getViaHeaders() instead of this method, the term 'local' in the method name is misleading if the SipUnit test is running behind a NAT.
getMessage() - Method in class org.cafesip.sipunit.SipMessage: Obtains the underlying javax.sip.message.Message object.
getMessageFactory() - Method in class org.cafesip.sipunit.SipStack: This method returns the JAIN-SIP MessageFactory associated with the SipStack.
getParent() - Method in class org.cafesip.sipunit.SipCall: This method returns the SipPhone object associated with this call.
getParent() - Method in class org.cafesip.sipunit.SipSession: The getParent() method returns the org.cafesip.sipunit.SipStack object that is associated with this SipSession object.
getPassword() - Method in class org.cafesip.sipunit.Credential: This method returns the password.
getPresenceDevices() - Method in class org.cafesip.sipunit.PresenceSubscriber: Gets the list of known devices for this Subscription (buddy, watchee).
getPresenceExtensions() - Method in class org.cafesip.sipunit.PresenceSubscriber: Gets the list of extensions pertaining to this Subscription as received in the last NOTIFY message (at the top 'presence' element level).
getPresenceNotes() - Method in class org.cafesip.sipunit.PresenceSubscriber: Gets the list of notes pertaining to this Subscription as received in the last NOTIFY message (at the top 'presence' element level).
getPublicAddress() - Method in class org.cafesip.sipunit.SipSession: This method returns the IP address and port currently being used in this Sip agent's contact address, via, and listening point 'sentby' components.
getRawContent() - Method in class org.cafesip.sipunit.SipMessage: Gets the body content of the message as a byte array.
getRealm() - Method in class org.cafesip.sipunit.Credential: This method returns the realm.
getReason() - Method in class org.cafesip.sipunit.SubscriptionError
getReasonPhrase() - Method in class org.cafesip.sipunit.SipResponse: Obtains the reason phrase of this response message.
getRefererInfo(SipURI) - Method in class org.cafesip.sipunit.SipPhone: This method returns the subscription object(s) associated with the given referToUri.
getRefererInfoByDialog(String) - Method in class org.cafesip.sipunit.SipPhone: This method returns the subscription object(s) associated with the given dialog ID.
getRefererList() - Method in class org.cafesip.sipunit.SipPhone: Returns a copy of the list of subscriptions associated with outbound REFER requests from this SipPhone.
getReferToUri() - Method in class org.cafesip.sipunit.ReferSubscriber: Get the referTo URI for this subscription.
getRequest() - Method in class org.cafesip.sipunit.SipTransaction: The user test program MAY call this method to view the javax.sip.message.Request object that created this transaction.
getRequestEvent() - Method in class org.cafesip.sipunit.SipRequest: Use this method if you need the JAIN-SIP request event associated with a request received by high level SipUnit classes like SipCall and Subscription.
getRequestURI() - Method in class org.cafesip.sipunit.SipRequest: Returns the request URI line of the request message or an empty string if there isn't one.
getResponseEvent() - Method in class org.cafesip.sipunit.SipResponse: Use this method if you need the JAIN-SIP response event associated with a response received by high level SipUnit classes like SipCall and Subscription.
getRetiredBuddies() - Method in class org.cafesip.sipunit.SipPhone: Returns a copy of the list of subscriptions associated with this SipPhone which are not in the current buddy list.
getReturnCode() - Method in class org.cafesip.sipunit.EventSubscriber
getReturnCode() - Method in interface org.cafesip.sipunit.SipActionObject: This method returns the status code of the current or last operation performed.
getReturnCode() - Method in class org.cafesip.sipunit.SipCall
getReturnCode() - Method in class org.cafesip.sipunit.SipSession
getServerTransaction() - Method in class org.cafesip.sipunit.SipTransaction
getSipProvider() - Method in class org.cafesip.sipunit.SipStack: This method returns the JAIN-SIP SipProvider associated with the SipStack.
getSipStack() - Method in class org.cafesip.sipunit.SipStack: This method returns the JAIN-SIP SipStack associated with this JUnit SipStack.
getStackAddress() - Method in class org.cafesip.sipunit.SipSession: Call this method to get the IP address being used by this user agent (ie, the address it is putting in its contact header, via header, etc.
getStatusCode() - Method in class org.cafesip.sipunit.SipResponse: Obtains the status code of this response message.
getStatusCode() - Method in class org.cafesip.sipunit.SubscriptionError
getStatusExtensions() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the extensions received in the last NOTIFY message, if any, pertaining to this device's status.
getTargetUri() - Method in class org.cafesip.sipunit.EventSubscriber: This method returns the URI of the user that this Subscription is for.
getTerminationReason() - Method in class org.cafesip.sipunit.EventSubscriber: Returns the subscription termination reason for this subscription.
getTimeLeft() - Method in class org.cafesip.sipunit.EventSubscriber: Returns the number of seconds left in the subscription, if active, or the number of seconds that were remaining at the time the subscription was terminated.
getTimestamp() - Method in class org.cafesip.sipunit.PresenceDeviceInfo: Gets the timestamp of when this device's information was set.
getURI() - Method in class org.cafesip.sipunit.SipContact: The method getURI() returns the contact URI as a String.
getUri(String, String, String, String, Map<String, String>, String, String, String, Map<String, String>) - Method in class org.cafesip.sipunit.SipPhone: Creates an URI object useful for passing into methods such as SipPhone.refer().
getURIScheme() - Method in class org.cafesip.sipunit.SipContact: The method getURIScheme() returns the scheme of this contact URI ("sip", "sips", etc.).
getUser() - Method in class org.cafesip.sipunit.Credential: This method returns the user.
getValue() - Method in class org.cafesip.sipunit.PresenceNote: Gets the text value of this note.
getViaHeaders() - Method in class org.cafesip.sipunit.SipSession: This method returns the Via Header currently in effect for this user agent, needed for sending requests such as INVITE.
GONE - Static variable in class org.cafesip.sipunit.SipResponse

I

INFO - Static variable in class org.cafesip.sipunit.SipRequest
initiateOutgoingCall(String, String, String) - Method in class org.cafesip.sipunit.SipCall: This basic method is used to initiate an outgoing call.
initiateOutgoingCall(String, String, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic initiateOutgoingCall() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
initiateOutgoingCall(String, String, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic initiateOugoingCall() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
initiateOutgoingCall(String, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic initiateOutgoingCall() method, without the 'from URI' parameter which will be defaulted to the 'from' address (me) specified when the SipPhone object was created (SipStack.createSipPhone()).
INTERNAL_ERROR - Static variable in class org.cafesip.sipunit.SipSession
INTERVAL_TOO_BRIEF - Static variable in class org.cafesip.sipunit.SipResponse
INVALID_ARGUMENT - Static variable in class org.cafesip.sipunit.SipSession
INVALID_OPERATION - Static variable in class org.cafesip.sipunit.SipSession
INVALID_UNREGISTERED_OPERATION - Static variable in class org.cafesip.sipunit.SipSession
INVITE - Static variable in class org.cafesip.sipunit.SipRequest: Request methods **********
isAck() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request method is ACK or not.
isBye() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request method is BYE or not.
isCallAnswered() - Method in class org.cafesip.sipunit.SipCall: Indicates if the current call (incoming or outgoing) has been answered.
isInternal(int) - Static method in class org.cafesip.sipunit.SipSession: This method indicates if the given return code is an internal SipUnit return code or not.
isInvite() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request method is INVITE or not.
isLoopback() - Method in class org.cafesip.sipunit.SipSession
isNotify() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request method is NOTIFY or not.
isRemovalComplete() - Method in class org.cafesip.sipunit.EventSubscriber: This method, called after an operation that ends a subscription (such as PresenceSubscriber.removeBuddy() or ReferSubscriber.unsubscribe()), indicates if an unsubscribe sequence was initiated due to the operation or not.
isSipURI() - Method in class org.cafesip.sipunit.SipContact: This method indicates if this contact URI has a scheme of "sip" or "sips", or not.
isSipURI() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request URI in the request message is a URI with a scheme of "sip" or "sips".
isSubscribe() - Method in class org.cafesip.sipunit.SipRequest: Indicates if the request method is SUBSCRIBE or not.
isSubscriptionActive() - Method in class org.cafesip.sipunit.EventSubscriber: Indicates if the subscription state is ACTIVE.
isSubscriptionPending() - Method in class org.cafesip.sipunit.EventSubscriber: Indicates if the subscription state is PENDING.
isSubscriptionTerminated() - Method in class org.cafesip.sipunit.EventSubscriber: Indicates if the subscription state is TERMINATED.
isTraceEnabled() - Static method in class org.cafesip.sipunit.SipStack: Indicates if the SipUnit stack trace has been enabled.

L

listenForAck() - Method in class org.cafesip.sipunit.SipCall: Start listening for an ACK request.
listenForCancel() - Method in class org.cafesip.sipunit.SipCall: Start listening for a CANCEL request.
listenForDisconnect() - Method in class org.cafesip.sipunit.SipCall: Start listening for a BYE request.
listenForIncomingCall() - Method in class org.cafesip.sipunit.SipCall: Start listening for an INVITE request.
listenForReinvite() - Method in class org.cafesip.sipunit.SipCall: Start listening for a RE-INVITE request.
listenRequestMessage() - Method in class org.cafesip.sipunit.SipSession: This method prepares the SipSession for reception of a request message addressed to this SipSession's URI.
LOOP_DETECTED - Static variable in class org.cafesip.sipunit.SipResponse

M

makeCall(String, int, long, String) - Method in class org.cafesip.sipunit.SipPhone: This blocking basic method is used to make an outgoing call.
makeCall(String, int, long, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic blocking makeCall() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
makeCall(String, int, long, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic blocking makeCall() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound INVITE message.
makeCall(String, String) - Method in class org.cafesip.sipunit.SipPhone: This nonblocking basic method is used to make an outgoing call.
makeCall(String, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic nonblocking makeCall() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound INVITE message.
makeCall(String, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic nonblocking makeCall() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
MAX_FORWARDS_DEFAULT - Static variable in class org.cafesip.sipunit.SipSession
MESSAGE - Static variable in class org.cafesip.sipunit.SipRequest
MESSAGE_TOO_LARGE - Static variable in class org.cafesip.sipunit.SipResponse
MessageDigestAlgorithm - Class in org.cafesip.sipunit: FOR INTERNAL USE, but available to test programs if needed.
MessageDigestAlgorithm() - Constructor for class org.cafesip.sipunit.MessageDigestAlgorithm
MessageListener - Interface in org.cafesip.sipunit: MessageListener represents certain SipUnit objects (such as SipCall) that perform SIP messaging on behalf of a user program.
METHOD_NOT_ALLOWED - Static variable in class org.cafesip.sipunit.SipResponse
MISSING_CREDENTIAL - Static variable in class org.cafesip.sipunit.SipSession
MOVED_PERMANENTLY - Static variable in class org.cafesip.sipunit.SipResponse
MOVED_TEMPORARILY - Static variable in class org.cafesip.sipunit.SipResponse
MULTIPLE_CHOICES - Static variable in class org.cafesip.sipunit.SipResponse

N

needAuthorization(ResponseEvent) - Method in class org.cafesip.sipunit.PresenceNotifySender: Called to find out if a sent NOTIFY was challenged.
NONE_YET - Static variable in class org.cafesip.sipunit.SipSession
NOT_ACCEPTABLE - Static variable in class org.cafesip.sipunit.SipResponse
NOT_ACCEPTABLE_HERE - Static variable in class org.cafesip.sipunit.SipResponse
NOT_FOUND - Static variable in class org.cafesip.sipunit.SipResponse
NOT_IMPLEMENTED - Static variable in class org.cafesip.sipunit.SipResponse
NOTIFY - Static variable in class org.cafesip.sipunit.SipRequest
notifyEvent() - Method in class org.cafesip.sipunit.BlockObject: FOR INTERNAL USE ONLY - A test class doesn't use this method.

O

OK - Static variable in class org.cafesip.sipunit.SipResponse
OPTIONS - Static variable in class org.cafesip.sipunit.SipRequest
org.cafesip.sipunit - package org.cafesip.sipunit

P

PAYMENT_REQUIRED - Static variable in class org.cafesip.sipunit.SipResponse
PRACK - Static variable in class org.cafesip.sipunit.SipRequest
PresenceDeviceInfo - Class in org.cafesip.sipunit: This class represents a single Tuple element received in a NOTIFY SIP message - it contains all information about a single active device associated with the presentity (buddy, watchee).
PresenceNote - Class in org.cafesip.sipunit: This class represents a single Note element received in a NOTIFY SIP message.
PresenceNotifySender - Class in org.cafesip.sipunit: The primary purpose of this class is as a test utility, to verify other UA's NOTIFY reception processing.
PresenceNotifySender(SipPhone) - Constructor for class org.cafesip.sipunit.PresenceNotifySender: A constructor for this class.
PresenceSubscriber - Class in org.cafesip.sipunit: The PresenceSubscriber class represents a buddy from a SipPhone buddy list or a single-shot presence fetch performed by a SipPhone.
PresenceSubscriber(String, SipPhone) - Constructor for class org.cafesip.sipunit.PresenceSubscriber: A constructor for this class.
processAuthChallenge(Response, Request, String, String) - Method in class org.cafesip.sipunit.SipPhone: This method is public for test purposes and for use when using low level SipSession methods for sending/receiving messages.
processAuthChallenge(Response, Request) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the other processAuthChallenge() without the user/password option.
processDialogTerminated(DialogTerminatedEvent) - Method in class org.cafesip.sipunit.SipSession
processDialogTerminated(DialogTerminatedEvent) - Method in class org.cafesip.sipunit.SipStack
processEvent(EventObject) - Method in class org.cafesip.sipunit.EventSubscriber
processEvent(EventObject) - Method in class org.cafesip.sipunit.PresenceNotifySender
processEvent(EventObject) - Method in interface org.cafesip.sipunit.RequestListener: For internal SipUnit use only.
processEvent(EventObject) - Method in class org.cafesip.sipunit.SipCall
processEvent(EventObject) - Method in class org.cafesip.sipunit.SipPhone
processIOException(IOExceptionEvent) - Method in class org.cafesip.sipunit.SipSession
processIOException(IOExceptionEvent) - Method in class org.cafesip.sipunit.SipStack
processNotify(RequestEvent) - Method in class org.cafesip.sipunit.EventSubscriber: This method validates the given (received) NOTIFY request, updates the subscription information based on the NOTIFY contents, and creates and returns the correctly formed response that should be sent back in reply to the NOTIFY, based on the NOTIFY content that was received.
processRefer() - Method in class org.cafesip.sipunit.ReferNotifySender: This method waits for up to 10 seconds to receive a REFER and if received, it sends an OK response.
processRefer(long, int, String) - Method in class org.cafesip.sipunit.ReferNotifySender: This method starts a thread that waits for up to 'timeout' milliseconds to receive a REFER and if received, it sends a response with 'statusCode' and 'reasonPhrase' (if not null).
processRefer(long, int, String, int, EventHeader) - Method in class org.cafesip.sipunit.ReferNotifySender: Same as the other processRefer() except allows for a couple of overrides for testing error handling by the far end outbound REFER side: (a) takes a duration for adding ExpiresHeader to the REFER response (the response shouldn't have an expires header), and (b) this method takes an EventHeader for overriding what would normally/correctly be sent back in the response (normally same as what was received in the request).
processReferSendNotifyBeforeResponse(long, int, String, String, String, String, int) - Method in class org.cafesip.sipunit.ReferNotifySender: This method starts a thread that waits for up to 'timeout' milliseconds to receive a REFER and if received, it sends NOTIFY with the given notify parms and 500ms later, it sends a response with 'statusCode' and 'reasonPhrase' (if not null).
processRequest(RequestEvent) - Method in class org.cafesip.sipunit.SipSession: FOR INTERNAL USE ONLY.
processRequest(RequestEvent) - Method in class org.cafesip.sipunit.SipStack: FOR INTERNAL USE ONLY.
processResponse(long) - Method in class org.cafesip.sipunit.EventSubscriber: This method processes the initial response received after sending a SUBSCRIBE or REFER request and takes the transaction to its completion by collecting any remaining responses from the far end for this transaction, handling authentication challenges if needed, and updating this object with the results of the request/response sequence.
processResponse(ResponseEvent) - Method in class org.cafesip.sipunit.SipSession: FOR INTERNAL USE ONLY.
processResponse(ResponseEvent) - Method in class org.cafesip.sipunit.SipStack: FOR INTERNAL USE ONLY.
processSubscribe() - Method in class org.cafesip.sipunit.PresenceNotifySender: This method waits for up to 10 seconds to receive a SUBSCRIBE and if received, it sends an OK response.
processSubscribe(long, int, String) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method starts a thread that waits for up to 'timeout' milliseconds to receive a SUBSCRIBE and if received, it sends a response with 'statusCode' and 'reasonPhrase' (if not null).
processSubscribe(long, int, String, int, EventHeader) - Method in class org.cafesip.sipunit.PresenceNotifySender: Same as the other processSubscribe() except allows for a couple of overrides for testing error handling by the far end outbound SUBSCRIBE side: (a) this method takes a duration for overriding what would normally/correctly be sent back in the response (which is the same as what was received in the SUBSCRIBE request or default 3600 if none was received).
processTimeout(TimeoutEvent) - Method in class org.cafesip.sipunit.SipSession: FOR INTERNAL USE ONLY.
processTimeout(TimeoutEvent) - Method in class org.cafesip.sipunit.SipStack: FOR INTERNAL USE ONLY.
processTransactionTerminated(TransactionTerminatedEvent) - Method in class org.cafesip.sipunit.SipSession
processTransactionTerminated(TransactionTerminatedEvent) - Method in class org.cafesip.sipunit.SipStack
PROTOCOL_TCP - Static variable in class org.cafesip.sipunit.SipStack: PROTOCOL_TCP Specifies TCP/IP transport.
PROTOCOL_UDP - Static variable in class org.cafesip.sipunit.SipStack: PROTOCOL_UDP Specifies UDP/IP transport.
PROXY_AUTHENTICATION_REQUIRED - Static variable in class org.cafesip.sipunit.SipResponse

Q

QUEUED - Static variable in class org.cafesip.sipunit.SipResponse

R

refer(String, SipURI, String, long, String) - Method in class org.cafesip.sipunit.SipPhone: This basic refer method creates an out-of-dialog REFER request message, sends it out, and waits for a first response to be received.
refer(String, SipURI, String, long, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic out-of-dialog refer() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
refer(String, SipURI, String, long, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic out-of-dialog refer() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
refer(Dialog, SipURI, String, long) - Method in class org.cafesip.sipunit.SipPhone: This basic refer method creates an in-dialog REFER request message, sends it out, and waits for a first response to be received.
refer(Dialog, SipURI, String, long, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic in-dialog refer() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
refer(Dialog, SipURI, String, long, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the basic in-dialog refer() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
REFER - Static variable in class org.cafesip.sipunit.SipRequest
ReferNotifySender - Class in org.cafesip.sipunit: The primary purpose of this class is as a test utility, to verify other UA's NOTIFY reception processing.
ReferNotifySender(SipPhone) - Constructor for class org.cafesip.sipunit.ReferNotifySender: A constructor for this class.
ReferSubscriber - Class in org.cafesip.sipunit: The ReferSubscriber class represents the implicit subscription created by sending a REFER request via the SipPhone.refer() method.
ReferSubscriber(String, SipURI, SipPhone) - Constructor for class org.cafesip.sipunit.ReferSubscriber: A constructor for this class.
ReferSubscriber(String, SipURI, SipPhone, Dialog) - Constructor for class org.cafesip.sipunit.ReferSubscriber: A constructor for this class.
refresh(int, String, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method initiates a SUBSCRIBE/NOTIFY sequence for the purpose of refreshing this subscription.
refresh(String, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as refresh(duration, eventId, timeout) except that the SUBSCRIBE duration sent will be however much time is left on the current subscription.
refresh(int, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as refresh(duration, eventId, timeout) except that the eventId remains unchanged from whatever it already was.
refresh(long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as refresh(duration, eventId, timeout) except that the eventId remains unchanged from whatever it already was and the SUBSCRIBE duration sent will be however much time is left on the current subscription.
refresh(Request, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as refresh(duration, eventId, timeout) except that instead of creating the SUBSCRIBE request from parameters passed in, the given request message parameter is used for sending out the SUBSCRIBE message.
refreshBuddy(int, String, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method initiates a SUBSCRIBE/NOTIFY sequence for the purpose of updating the presence information for this buddy.
refreshBuddy(String, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as refreshBuddy(duration, eventId, timeout) except that the SUBSCRIBE duration sent will be however much time is left on the current subscription.
refreshBuddy(int, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as refreshBuddy(duration, eventId, timeout) except that the eventId remains unchanged from whatever it already was.
refreshBuddy(long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as refreshBuddy(duration, eventId, timeout) except that the eventId remains unchanged from whatever it already was and the SUBSCRIBE duration sent will be however much time is left on the current subscription.
refreshBuddy(Request, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as refreshBuddy(duration, eventId, timeout) except that instead of creating the SUBSCRIBE request from parameters passed in, the given request message parameter is used for sending out the SUBSCRIBE message.
register(Credential) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method registers this notify sender as a UA with the proxy/registrar used to create the SipPhone passed to this object's contructor.
register(String, String, String, int, long) - Method in class org.cafesip.sipunit.SipPhone: This method is used for SIP registration.
register(SipURI, String, String, String, int, long) - Method in class org.cafesip.sipunit.SipPhone: This method is the same as the register(String user, String password, String contact, int expiry, long timeout) method except for the Request-URI used in the outgoing REGISTER method.
register(String, int) - Method in class org.cafesip.sipunit.SipPhone: This method is equivalent to the register(String user, String password, String contact, int expiry, long timeout) method except with no authorization parameters specified.
REGISTER - Static variable in class org.cafesip.sipunit.SipRequest
removeBuddy(String, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method removes this buddy from the SipPhone buddy list and initiates a SUBSCRIBE/NOTIFY sequence to terminate the subscription unless the subscription is already terminated.
removeBuddy(long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as removeBuddy(eventId, timeout) except that no event "id" parameter will be included in the unSUBSCRIBE message.
removeBuddy(Request, long) - Method in class org.cafesip.sipunit.PresenceSubscriber: This method is the same as removeBuddy(eventId, timeout) except that instead of creating the SUBSCRIBE request from parameters passed in, the given request message parameter is used for sending out the SUBSCRIBE message if the subscription is active.
removeCredential(Credential) - Method in class org.cafesip.sipunit.SipPhone: This method removes a credential from the credentials list.
removeCredential(String) - Method in class org.cafesip.sipunit.SipPhone: This method removes a credential from the credentials list.
replyToNotify(RequestEvent, Response) - Method in class org.cafesip.sipunit.EventSubscriber: This method sends the given response to the network in reply to the given request that was previously received.
REQUEST_ENTITY_TOO_LARGE - Static variable in class org.cafesip.sipunit.SipResponse
REQUEST_PENDING - Static variable in class org.cafesip.sipunit.SipResponse
REQUEST_TERMINATED - Static variable in class org.cafesip.sipunit.SipResponse
REQUEST_TIMEOUT - Static variable in class org.cafesip.sipunit.SipResponse
REQUEST_URI_TOO_LONG - Static variable in class org.cafesip.sipunit.SipResponse
RequestListener - Interface in org.cafesip.sipunit: This class is only used internally by SipUnit.
resendWithAuthorization(ResponseEvent) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method resends a NOTIFY statefully and with required authorization headers.
respondToCancel(SipTransaction, int, String, int) - Method in class org.cafesip.sipunit.SipCall: This method sends a basic response to a previously received CANCEL request.
respondToCancel(SipTransaction, int, String, int, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic respondToCancel() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
respondToCancel(SipTransaction, int, String, int, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic respondToCancel() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
respondToDisconnect() - Method in class org.cafesip.sipunit.SipCall: This method sends a basic response to a previously received BYE request.
respondToDisconnect(int, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic respondToDisconnect() method except that it uses the given parameters for the status code and reason in the response message sent out.
respondToDisconnect(int, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic respondToDisconnect() method except that it uses the given parameters for the status code and reason in the response message sent out and allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
respondToDisconnect(int, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic respondToDisconnect() method except that it uses the given parameters for the status code and reason in the response message sent out and allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
respondToReinvite(SipTransaction, int, String, int, String, String, String, String, String) - Method in class org.cafesip.sipunit.SipCall: This method sends a basic response to a previously received RE-INVITE request.
respondToReinvite(SipTransaction, int, String, int, String, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic respondToReinvite() plus it additionally allows the caller to specify additional message headers to add to or replace in the response message without requiring knowledge of the JAIN-SIP API.
respondToReinvite(SipTransaction, int, String, int, String, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic respondToReinvite() method except that it allows the caller to specify additional JAIN-SIP API message headers to add to or replace in the outbound message.
RINGING - Static variable in class org.cafesip.sipunit.SipResponse

S

sendCancel() - Method in class org.cafesip.sipunit.SipCall: This method sends a basic CANCEL in a new transaction on the current dialog.
sendCancel(ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic sendCancel() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendCancel(String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic sendCancel() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendIncomingCallResponse(int, String, int) - Method in class org.cafesip.sipunit.SipCall: This method sends a basic response to a previously received INVITE request.
sendIncomingCallResponse(int, String, int, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendIncomingCallResponse() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendIncomingCallResponse(int, String, int, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendIncomingCallResponse() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendInviteOkAck() - Method in class org.cafesip.sipunit.SipCall: This method sends a basic ACK in response to an OK received in response to a sent INVITE.
sendInviteOkAck(ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendInviteOkAck() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendInviteOkAck(String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendInviteOkAck() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendNotify(String, String, String, int, boolean) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method creates a NOTIFY message using the given parameters and sends it to the subscriber.
sendNotify(String, String, String, int, EventHeader, SubscriptionStateHeader, AcceptHeader, ContentTypeHeader, boolean) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method creates a NOTIFY message using the given parameters and sends it to the subscriber.
sendNotify(Request, boolean) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method sends the given request to the subscriber.
sendNotify(String, String, String, int, boolean) - Method in class org.cafesip.sipunit.ReferNotifySender: This method creates a NOTIFY message using the given parameters and sends it to the subscriber.
sendNotify(String, String, String, int, EventHeader, SubscriptionStateHeader, AcceptHeader, ContentTypeHeader, boolean) - Method in class org.cafesip.sipunit.ReferNotifySender: This method creates a NOTIFY message using the given parameters and sends it to the subscriber.
sendReinvite(String, String, String, String, String) - Method in class org.cafesip.sipunit.SipCall: This method sends a basic RE-INVITE on the current dialog.
sendReinvite(String, String, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is equivalent to the basic sendReinvite() method except that it allows the caller to specify additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendReinvite(String, String, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendReinvite() method except that it allows the caller to specify additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendReinviteOkAck(SipTransaction) - Method in class org.cafesip.sipunit.SipCall: This basic method sends an ACK in response to an OK received in response to a sent RE-INVITE.
sendReinviteOkAck(SipTransaction, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendReinviteOkAck() method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendReinviteOkAck(SipTransaction, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipCall: This method is the same as the basic sendReinviteOkAck() method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendReply(RequestEvent, int, String, String, Address, int) - Method in class org.cafesip.sipunit.SipSession: This method sends a basic, stateful response to a previously received request.
sendReply(RequestEvent, int, String, String, Address, int, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendReply(RequestEvent, ...) method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendReply(RequestEvent, int, String, String, Address, int, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendReply(RequestEvent, ...) method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message, without requiring knowledge of the JAIN-SIP API.
sendReply(RequestEvent, Response) - Method in class org.cafesip.sipunit.SipSession: This method sends a stateful response to a previously received request.
sendReply(SipTransaction, int, String, String, Address, int) - Method in class org.cafesip.sipunit.SipSession: This method sends a basic, stateful response to a previously received request.
sendReply(SipTransaction, int, String, String, Address, int, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendReply(SipTransaction, ...) method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message, without requiring knowledge of the JAIN-SIP API.
sendReply(SipTransaction, int, String, String, Address, int, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendReply(SipTransaction, ...) method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendReply(SipTransaction, Response) - Method in class org.cafesip.sipunit.SipSession: This method sends a stateful response to a previously received request.
sendRequestWithTransaction(String, boolean, Dialog) - Method in class org.cafesip.sipunit.SipSession: This basic method sends out a request message as part of a transaction.
sendRequestWithTransaction(String, boolean, Dialog, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendRequestWithTransaction(String,...) method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendRequestWithTransaction(String, boolean, Dialog, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendRequestWithTransaction(String,...) method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendRequestWithTransaction(Request, boolean, Dialog) - Method in class org.cafesip.sipunit.SipSession: This basic method sends out a request message as part of a transaction.
sendRequestWithTransaction(Request, boolean, Dialog, ArrayList<Header>, ArrayList<Header>, String) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendRequestWithTransaction(Request,...) method except that it allows the caller to specify a message body and/or additional JAIN-SIP API message headers to add to or replace in the outbound message.
sendRequestWithTransaction(Request, boolean, Dialog, String, String, String, ArrayList<String>, ArrayList<String>) - Method in class org.cafesip.sipunit.SipSession: This method is the same as the basic sendRequestWithTransaction(Request,...) method except that it allows the caller to specify a message body and/or additional message headers to add to or replace in the outbound message without requiring knowledge of the JAIN-SIP API.
sendStatefulNotify(Request, boolean) - Method in class org.cafesip.sipunit.PresenceNotifySender: This method sends the given request to the subscriber.
sendUnidirectionalRequest(String, boolean) - Method in class org.cafesip.sipunit.SipSession: This sendUnidirectionalRequest() method sends out a request message with no response expected.
sendUnidirectionalRequest(Request, boolean) - Method in class org.cafesip.sipunit.SipSession: This sendUnidirectionalRequest() method sends out a request message with no response expected.
sendUnidirectionalResponse(Response) - Method in class org.cafesip.sipunit.SipSession: The sendUnidirectionalResponse() method sends out a stateless response message.
sendUnidirectionalResponse(RequestEvent, int, String, String, Address, int) - Method in class org.cafesip.sipunit.SipSession: This method sends out a stateless response to the given request.
SERVER_INTERNAL_ERROR - Static variable in class org.cafesip.sipunit.SipResponse
SERVER_TIMEOUT - Static variable in class org.cafesip.sipunit.SipResponse
SERVICE_UNAVAILABLE - Static variable in class org.cafesip.sipunit.SipResponse
SESSION_NOT_ACCEPTABLE - Static variable in class org.cafesip.sipunit.SipResponse
SESSION_PROGRESS - Static variable in class org.cafesip.sipunit.SipResponse
setDialog(Dialog) - Method in class org.cafesip.sipunit.PresenceNotifySender
setLoopback(boolean) - Method in class org.cafesip.sipunit.SipSession: Under normal circumstances, the SipUnit SipPhone/SipSession shouldn't accept a request if the Request URI doesn't match it's contact address, even if the 'To' header matches the SipPhone's address.
setPassword(String) - Method in class org.cafesip.sipunit.Credential: This method sets the password to use when authentication is required.
setPublicAddress(String, int) - Method in class org.cafesip.sipunit.SipSession: This method replaces the host/port values currently being used in this Sip agent's contact address, via, and listening point 'sentby' components with the given host and port parameters.
setRealm(String) - Method in class org.cafesip.sipunit.Credential: This method sets the realm associated with the user name and password.
setReason(String) - Method in class org.cafesip.sipunit.SubscriptionError
setRequestEvent(RequestEvent) - Method in class org.cafesip.sipunit.SipRequest: A setter for the request event.
setResponseEvent(ResponseEvent) - Method in class org.cafesip.sipunit.SipResponse: A setter for the response event.
setStatusCode(int) - Method in class org.cafesip.sipunit.SubscriptionError
setTraceEnabled(boolean) - Static method in class org.cafesip.sipunit.SipStack: Turn on or off the SipUnit stack tracing.
setUp() - Method in class org.cafesip.sipunit.SipTestCase: Sets up the environment for each test method prior to execution.
setUser(String) - Method in class org.cafesip.sipunit.Credential: This method sets the user name to use when authentication is required.
SipActionObject - Interface in org.cafesip.sipunit: A SipActionObject represents any SipUnit object that performs SIP operations on behalf of a user program.
SipCall - Class in org.cafesip.sipunit: This class is used for handling one leg of a call.
SipContact - Class in org.cafesip.sipunit: This class holds information pertaining to a contact URI and provides associated getter methods.
SipMessage - Class in org.cafesip.sipunit: SipMessage represents a SipRequest or a SipResponse.
SipPhone - Class in org.cafesip.sipunit: This class provides a test program with User Agent (UA) access to the SIP protocol in the form of a SIP phone.
SipRequest - Class in org.cafesip.sipunit: The SipRequest class provides high level getter methods for a request received from the network.
SipRequest(Request) - Constructor for class org.cafesip.sipunit.SipRequest: A constructor for this class, applicable when using the low-level SipUnit API.
SipRequest(RequestEvent) - Constructor for class org.cafesip.sipunit.SipRequest: A constructor for this class used by SipUnit classes such as SipCall and Subscription to save the request event information so that the test program can get JAIN-SIP objects from it, if needed - ServerTransaction, Dialog, etc.
SipResponse - Class in org.cafesip.sipunit: The SipResponse class provides static response status code definitions and text, and it also provides high level getter methods for a response received from the network.
SipResponse(Response) - Constructor for class org.cafesip.sipunit.SipResponse: A constructor for this class, applicable when using the low-level SipUnit API.
SipResponse(ResponseEvent) - Constructor for class org.cafesip.sipunit.SipResponse: A constructor for this class used by SipUnit classes such as SipCall and Subscription to save the response event information so that the test program can get JAIN-SIP objects from it, if needed - ClientTransaction, Dialog, etc.
SipSession - Class in org.cafesip.sipunit: Methods of this class provide the test program with low-level access to a SIP session.
SipStack - Class in org.cafesip.sipunit: This class is the starting point for a SipUnit test.
SipStack(String, int, Properties) - Constructor for class org.cafesip.sipunit.SipStack: A constructor for this class.
SipStack(String, int) - Constructor for class org.cafesip.sipunit.SipStack: Equivalent to the other constructor without any properties specified.
SipTestCase - Class in org.cafesip.sipunit: The SipTestCase class provides a test environment and set of assert methods geared toward unit testing Java SIP applications.
SipTestCase(String) - Constructor for class org.cafesip.sipunit.SipTestCase: A constructor for this test case.
SipTestCase() - Constructor for class org.cafesip.sipunit.SipTestCase: A no-arg constructor to enable serialization.
SipTransaction - Class in org.cafesip.sipunit: SipTransaction is primarily used by the SipUnit API classes to manage some SIP operations.
SIPUNIT_INTERNAL_RETURNCODE_MIN - Static variable in class org.cafesip.sipunit.SipSession: Comment for SIPUNIT_INTERNAL_RETURNCODE_MIN A constant marking the lowest possible SipUnit internal return code value.
statusCodeDescription - Static variable in class org.cafesip.sipunit.SipResponse: Comment for statusCodeDescription This map yields a reason phrase, given a SIP network response message status code.
statusCodeDescription - Static variable in class org.cafesip.sipunit.SipSession: Comment for statusCodeDescription This map yields a descriptive string, given an internal sipunit return code.
stopListeningForRequests() - Method in class org.cafesip.sipunit.SipCall: Stop listening for requests on this user agent.
SUBSCRIBE - Static variable in class org.cafesip.sipunit.SipRequest
SubscriptionError - Class in org.cafesip.sipunit
SubscriptionError(int, String) - Constructor for class org.cafesip.sipunit.SubscriptionError

T

tearDown() - Method in class org.cafesip.sipunit.SipTestCase: Cleans up from the test method just executed.
TEMPORARILY_UNAVAILABLE - Static variable in class org.cafesip.sipunit.SipResponse
TIMEOUT_OCCURRED - Static variable in class org.cafesip.sipunit.SipSession
TOO_MANY_HOPS - Static variable in class org.cafesip.sipunit.SipResponse
toString() - Method in class org.cafesip.sipunit.SipMessage: Converts this message object to its String equivalent.
trace(String) - Static method in class org.cafesip.sipunit.SipStack: Outputs the given string to console, if SipStack.setTraceEnabled(true) has been called.
TRYING - Static variable in class org.cafesip.sipunit.SipResponse: Response status codes **********

U

UNAUTHORIZED - Static variable in class org.cafesip.sipunit.SipResponse
UNDECIPHERABLE - Static variable in class org.cafesip.sipunit.SipResponse
unlistenRequestMessage() - Method in class org.cafesip.sipunit.SipSession: The unlistenRequestMessage() method cancels out a previous directive to listen for reception of a request addressed to this SipSession's URI.
unregister(String, long) - Method in class org.cafesip.sipunit.SipPhone: This method performs the SIP unregistration process.
unsubscribe(String, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method initiates a SUBSCRIBE/NOTIFY sequence to terminate the subscription unless the subscription is already terminated.
unsubscribe(long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as unsubscribe(eventId, timeout) except that no event "id" parameter will be included in the unSUBSCRIBE message.
unsubscribe(Request, long) - Method in class org.cafesip.sipunit.ReferSubscriber: This method is the same as unsubscribe(eventId, timeout) except that instead of creating the SUBSCRIBE request from parameters passed in, the given request message parameter is used for sending out the SUBSCRIBE message if the subscription is active.
UNSUPPORTED_MEDIA_TYPE - Static variable in class org.cafesip.sipunit.SipResponse
UNSUPPORTED_URI_SCHEME - Static variable in class org.cafesip.sipunit.SipResponse
UNSUPPORTED_URI_SCHEME - Static variable in class org.cafesip.sipunit.SipSession
UPDATE - Static variable in class org.cafesip.sipunit.SipRequest
USE_PROXY - Static variable in class org.cafesip.sipunit.SipResponse

V

VERSION_NOT_SUPPORTED - Static variable in class org.cafesip.sipunit.SipResponse

W

waitForAck(long) - Method in class org.cafesip.sipunit.SipCall: The waitForAck() method waits for an ACK request addressed to this user agent to be received from the network.
waitForAnswer(long) - Method in class org.cafesip.sipunit.SipCall: The waitForAnswer() method waits for answer(OK) to be received from the network.
waitForCancel(long) - Method in class org.cafesip.sipunit.SipCall: The waitForCancel() method waits for a CANCEL request addressed to this user agent to be received from the network.
waitForCancelResponse(SipTransaction, long) - Method in class org.cafesip.sipunit.SipCall: The waitForCancelResponse() method waits for a response to be received from the network for a sent CANCEL.
waitForDisconnect(long) - Method in class org.cafesip.sipunit.SipCall: The waitForDisconnect() method waits for a BYE request addressed to this user agent to be received from the network.
waitForEvent(long) - Method in class org.cafesip.sipunit.BlockObject: FOR INTERNAL USE ONLY - A test class doesn't use this method.
waitForIncomingCall(long) - Method in class org.cafesip.sipunit.SipCall: The waitForIncomingCall() method waits for an INVITE request addressed to this user agent to be received from the network.
waitForReinvite(long) - Method in class org.cafesip.sipunit.SipCall: The waitForReinvite() method waits for a RE-INVITE request addressed to this user agent to be received from the network.
waitNotify(long) - Method in class org.cafesip.sipunit.EventSubscriber: The waitNotify() method allows received NOTIFY messages to be examined and processed by the test program, one by one.
waitOutgoingCallResponse() - Method in class org.cafesip.sipunit.SipCall: This method is the same as the other waitOutgoingCallResponse() method with an indefinite (no) wait timeout.
waitOutgoingCallResponse(long) - Method in class org.cafesip.sipunit.SipCall: The waitOutgoingCallResponse() method waits for a response to be received from the network for a sent INVITE.
waitReinviteResponse(SipTransaction, long) - Method in class org.cafesip.sipunit.SipCall: The waitReinviteResponse() method waits for a response to be received from the network for a sent RE-INVITE.
waitRequest(long) - Method in class org.cafesip.sipunit.SipSession: The waitRequest() method waits for a request addressed to this SipSession's URI to be received from the network.
waitResponse(SipTransaction, long) - Method in class org.cafesip.sipunit.PresenceNotifySender: The waitResponse() method waits for a response to a previously sent transactional request message.
waitResponse(SipTransaction, long) - Method in class org.cafesip.sipunit.SipSession: The waitResponse() method waits for a response to a previously sent transactional request message.

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

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

http://www.cafesip.org