NIST SIP Parser and Stack (v1.2) API

javax.sip
Class RequestEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--javax.sip.RequestEvent
All Implemented Interfaces:
Serializable

public class RequestEvent
extends EventObject

This class represents an Request event that is passed from a SipProvider to its SipListener. This specification handles the passing of request messages to the application use the event model. An application (SipListener) will register with the SIP protocol stack (SipProvider) and listen for Request events from the SipProvider.

This specification defines a single Request event object to handle all Request messages. The Request event encapsulates the Request message that can be retrieved from getRequest(). Therefore the event type of a Request event can be determined as follows:

eventType == RequestEvent.getRequest().getMethod();

A Request event also encapsulates the server transaction which handles the Request.

RequestEvent contains the following elements:

Since:
v1.1
Author:
Sun Microsystems
See Also:
Serialized Form

Constructor Summary
RequestEvent(Object source, ServerTransaction serverTransaction, Request request)
          Constructs a RequestEvent encapsulating the Request that has been received by the underlying SipProvider.
 
Method Summary
 Request getRequest()
          Gets the Request message associated with this RequestEvent.
 ServerTransaction getServerTransaction()
          Gets the server transaction associated with this RequestEvent
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RequestEvent

public RequestEvent(Object source,
                    ServerTransaction serverTransaction,
                    Request request)
Constructs a RequestEvent encapsulating the Request that has been received by the underlying SipProvider. This RequestEvent once created is passed to SipListener.processRequest(RequestEvent) method of the SipListener for application processing.

Parameters:
source - - the source of ResponseEvent i.e. the SipProvider
serverTransaction - - server transaction upon which this Request was sent
request - - the Request message received by the SipProvider
Method Detail

getServerTransaction

public ServerTransaction getServerTransaction()
Gets the server transaction associated with this RequestEvent

Returns:
the server transaction associated with this RequestEvent

getRequest

public Request getRequest()
Gets the Request message associated with this RequestEvent.

Returns:
the message associated with this RequestEvent.

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.