001: /**
002: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
004: *
005: * This program is free software; you can redistribute it and/or
006: * modify it under the terms of the GNU General Public License version
007: * 2 only, as published by the Free Software Foundation.
008: *
009: * This program is distributed in the hope that it will be useful, but
010: * WITHOUT ANY WARRANTY; without even the implied warranty of
011: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012: * General Public License version 2 for more details (a copy is
013: * included at /legal/license.txt).
014: *
015: * You should have received a copy of the GNU General Public License
016: * version 2 along with this work; if not, write to the Free Software
017: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
018: * 02110-1301 USA
019: *
020: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
021: * Clara, CA 95054 or visit www.sun.com if you need additional
022: * information or have any questions.
023: *
024: *
025: * Module Name : JAIN SIP Specification
026: * File Name : RequestEvent.java
027: *
028: * HISTORY
029: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
030: */package gov.nist.siplite;
031:
032: import gov.nist.siplite.message.Request;
033: import gov.nist.siplite.stack.*;
034: import gov.nist.siplite.SipListener;
035:
036: /**
037: * This class represents an Request event that is passed from a SipProvider to
038: * its SipListener. This specification handles the passing of request
039: * messages to the
040: * application use the event model. An application (SipListener) will register
041: * with the SIP protocol stack (SipProvider) and listen for Request events
042: * from the SipProvider.
043: * <p>
044: * This specification defines a single Request event object to handle
045: * all Request
046: * messages. The Request event encapsulates the Request message that can be
047: * retrieved from {@link RequestEvent#getRequest()}. Therefore the event type
048: * of a Request event can be determined as follows:
049: * <p>
050: * <i>eventType == RequestEvent.getRequest().getMethod();</i>
051: * <p>
052: * A Request event also encapsulates the server transaction which handles the
053: * Request.
054: * <p>
055: * RequestEvent contains the following elements:
056: * <ul>
057: * <li>source - the source of the event i.e. the SipProvider sending the
058: * RequestEvent
059: * <li>serverTransaction - the server transaction this RequestEvent is
060: * associated with.
061: * <li>Request - the Request message received on the SipProvider
062: * that needs passed to the application encapsulated in a RequestEvent.
063: * </ul>
064: *
065: * @since v1.1
066: */
067: public class RequestEvent extends SipEvent {
068:
069: /**
070: * Constructs a RequestEvent encapsulating the Request that has
071: * been received by the underlying SipProvider. This RequestEvent
072: * once created is passed to
073: * {@link gov.nist.siplite.SipListener#processRequest(RequestEvent)}
074: * method of the SipListener for application processing.
075: *
076: * @param source - the source of ResponseEvent i.e. the SipProvider
077: * @param serverTransaction - server transaction upon which
078: * this Request was sent
079: * @param request - the Request message received by the SipProvider
080: */
081: public RequestEvent(Object source,
082: ServerTransaction serverTransaction, Request request) {
083: super (source);
084: m_transaction = serverTransaction;
085: m_request = request;
086: }
087:
088: /**
089: * Gets the server transaction associated with this RequestEvent
090: *
091: * @return the server transaction associated with this RequestEvent
092: */
093: public ServerTransaction getServerTransaction() {
094: return m_transaction;
095: }
096:
097: /**
098: * Gets the Request message associated with this RequestEvent.
099: *
100: * @return the message associated with this RequestEvent.
101: */
102: public Request getRequest() {
103: return m_request;
104: }
105:
106: /** Curent request. */
107: private Request m_request;
108: /** Current transaction. */
109: private ServerTransaction m_transaction;
110: }
|