Package jain.protocol.ip.sip

This package contains the main interfaces required to represent JAIN SIP protocol stacks, JAIN SIP applications, as well as the classes and exceptions needed to send and receive JAIN SIP messages.

See:
Description

Interface Summary

JainSipListener	This interface defines the methods required by all SIP user applications to receive and process JAIN SIP Events that are emitted by an object implementing the JainSipProvider interface.
JainSipProvider	This interface must be implemented by any Object representing a JAIN SIP Provider that interacts directly with a proprietary (stack vendor specific) implementation of a SIP stack.
JainSipStack	This interface defines the methods required to represent a proprietary JAIN SIP protocol stack, the implementation of which will be vendor specific.

Class Summary

BasicChallenge	This class represents a Basic Authentication scheme Challenge.
BasicCredentials	This class represents Basic Authentication scheme Credentials.
Challenge	This class represents a generic SIP authentication challenge.
Credentials	This class represents generic credentials for an authentication scheme.
DigestChallenge	This class represents a Digest Authentication scheme Challenge.
DigestCredentials	This class represents Digest Authentication scheme Credentials.
ListeningPoint	This class represents a unique IP network listening point, and consists of host, port and transport
NameAddress	This class represents a user's display name and address.
SipURL	This class represents a SIP URL.
URI	This class represents a Universal Resource Identifier.

Exception Summary

BodyNotSetException	This exception is thrown if an attempt is made to perform any method on a bodyless Message that relies on the existemce of a Message body.
HeaderNotSetException	This exception is thrown if an attempt is made to access a non-existent Header of a Message
ListeningPointUnavailableException	This Exception is thrown when an attempt is made to create a JainSipProvider with a ListeningPoint which is not owned by the JainSipStack, or if another JainSipProvider is already using the ListeningPoint
ParameterNotSetException	This exception is thrown if an attempt is made to access a non-existent parameter of a Header
ResponseDoesNotExistException	This Exception is thrown when a user attempts to get a ResponseMessage for a transaction which has no ResponseMessage
SipException	This JAIN SIP Exception is thrown when a general JAIN SIP Error is encountered, and may be used when no other specific Jain SIP Exception is relevant.
TransactionDoesNotExistException	This Exception is thrown when a user attempts to reference a transaction that does not exist
UnableToDeleteProviderException	This exception is thrown if the deleteProvider method of a JainSipStack is invoked to delete a JainSipProvider but the deletion is not allowed.

Package jain.protocol.ip.sip Description

This package contains the main interfaces required to represent JAIN SIP protocol stacks, JAIN SIP applications, as well as the classes and exceptions needed to send and receive JAIN SIP messages. The implementation of the two stack vendor specific interfaces, namely JainSipStack and JainSipProvider will be vendor specific, however the naming of these proprietory implementations is mandated. The class name of the vendor specific implementations must be "JainSip<Interface class implements>Impl". For example a vendor implementation of the JainSipStack Interface must be called "JainSipStackImpl". Therefore once each vendor has implemented the JAIN SIP API specification they must has two proprietary classes called JainSipStackImpl.class and JainSipProviderImpl.class. The characteristics of the three main interfaces are listed below:

• JainSipStack: This Interface defines the minimal management properties that enables the JAIN SIP API specification to operate independently. Therefore the JainTSipStack Object is a representation of the main management functionality of the SIP stack, as well as the central point for the creation of JainSipProviders. From within the JainSipStack Object it is possible for any application to get a list of JainSipProvider objects that are attached to the underlying JainSipStack by using the getProviders method with the JainSipStack Object. This method returns an array of JainSipProvider references of which a JainSipListener Object may register. Similiarly if the JainSipStack Object has no JainSipProviders attached to it, the JainSipListener may use the createProvider method to create a new JainSipProvider object.







• JainSipProvider: This Interface defines the methods for adding JainSipListeners to, and removing JainSipListeners from a list of registered JainSipListeners held within the JainSipProvider. Other methods defined within the JainSipProvider provide the functionality for a JainSipListener to obtain a session with another JainSipListener based on a Call-Id. The JainSipProvider also defines the functionality to obtain CSeq numbers based on a specific Call-Id, that enables a JainSipListener to send requests to another JainSipListener to which a session has been initiated. In order for communication to take place between a local JainSipListener and a remote JainSipListener, the local JainSipListener must send a number of Messages to it's associated JainSipProvider.









• JainSipListener: This Interface defines the methods required by all JainSipListeners to receive and process Messages that are emitted by a JainSipProvider. A remote JainSipProvider which receives Messages (which were sent by the local JainSipListener) from its underlying SIP stack, encapsulates them as Message and passes them to the remote JainSipListener. As mentioned above this occurs by Event passing, were the remote JainSipProvider invokes the processRequest , processResponse , processAck , processCancel , or processTimeout as appropriate and passes the relevant Event within the method to the remote JainSipListener. The same process occurs when the local JainSipProvider passes Message Events (received from the remote JainSipListener) to the local JainSipListener.


• A JainSipListener registers with a JainSipProvider to become an Event Listener of that JainSipProvider - it registers with an object reference to itself. This value is stored by the JainSipProvider and is used to refer to its registered JainSipListeners.


• A JainSipListener may be registered with multiple JainSipProviders, which enables it to operate over a number of ListeningPoints.

Note:

The cardinality of the relationship between JainSipListeners and JainSipProviders is not restricted in any way. The restriction of this cardinality is dependent on a vendors specific implementation of the JAIN SIP API, were the necessary exceptions are thrown if the specificied cardinality is violated. However it is mandated that there may only be one JainTcapStack Object for each SIP stack, and only one JainSipProvider for each ListeningPoint of a JainSipStack.