KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > icesoft > faces > util > event > servlet > SessionDestroyedEvent


1 /*
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * "The contents of this file are subject to the Mozilla Public License
5  * Version 1.1 (the "License"); you may not use this file except in
6  * compliance with the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS"
10  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
11  * License for the specific language governing rights and limitations under
12  * the License.
13  *
14  * The Original Code is ICEfaces 1.5 open source software code, released
15  * November 5, 2006. The Initial Developer of the Original Code is ICEsoft
16  * Technologies Canada, Corp. Portions created by ICEsoft are Copyright (C)
17  * 2004-2006 ICEsoft Technologies Canada, Corp. All Rights Reserved.
18  *
19  * Contributor(s): _____________________.
20  *
21  * Alternatively, the contents of this file may be used under the terms of
22  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"
23  * License), in which case the provisions of the LGPL License are
24  * applicable instead of those above. If you wish to allow use of your
25  * version of this file only under the terms of the LGPL License and not to
26  * allow others to use your version of this file under the MPL, indicate
27  * your decision by deleting the provisions above and replace them with
28  * the notice and other provisions required by the LGPL License. If you do
29  * not delete the provisions above, a recipient may use your version of
30  * this file under either the MPL or the LGPL License."
31  *
32  */
33
34 package com.icesoft.faces.util.event.servlet;
35
36 import javax.servlet.http.HttpSession JavaDoc;
37 import javax.servlet.http.HttpSessionEvent JavaDoc;
38
39 /**
40  * The <code>SessionDestroyedEvent</code> class represents an event that should
41  * be fired when a session is destroyed in order to give registered listeners
42  * time to do proper clean-up and/or other appropriate actions. </p>
43  */
44 public class SessionDestroyedEvent
45         extends AbstractSessionEvent
46         implements ContextEvent {
47     private HttpSessionEvent JavaDoc httpSessionEvent;
48
49     /**
50      * Constructs a <code>SessionDestroyedEvent</code> with the specified
51      * <code>httpSessionEvent</code> as the nested event. </p>
52      *
53      * @param httpSessionEvent the nested HTTP session event.
54      * @throws IllegalArgumentException if the one of the following happens:
55      * <ul> <li> the specified
56      * <code>source</code> is
57      * <code>null</code>. </li> <li> the
58      * specified <code>iceFacesId</code> is
59      * either <code>null</code> or empty. </li>
60      * </ul>
61      * @throws NullPointerException if the specified
62      * <code>httpSessionEvent</code> is
63      * <code>null</code>.
64      */
65     public SessionDestroyedEvent(
66             HttpSessionEvent JavaDoc httpSessionEvent, String JavaDoc iceFacesId)
67             throws IllegalArgumentException JavaDoc, NullPointerException JavaDoc {
68         super((HttpSession JavaDoc) httpSessionEvent.getSource(), iceFacesId);
69         this.httpSessionEvent = httpSessionEvent;
70     }
71
72     /**
73      * Gets the nested HTTP Session event of this
74      * <code>SessionDestroyedEvent</code>. </p>
75      *
76      * @return the nested HTTP Session event.
77      */
78     public HttpSessionEvent JavaDoc getNestedHttpSessionEvent() {
79         return httpSessionEvent;
80     }
81 }
82
Popular Tags