KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.util.EventObject JavaDoc;
37
38 import javax.servlet.http.HttpSession JavaDoc;
39
40 /**
41  * The <code>AbstractSessionEvent</code> class provides a default implementation
42  * of a session event. Standard behaviors like the get methods of HTTP session
43  * and ICEfaces ID properties are defined here.
44  */
45 public abstract class AbstractSessionEvent
46         extends EventObject JavaDoc
47         implements ContextEvent {
48     protected String JavaDoc iceFacesId;
49
50     /**
51      * Constructs an <code>AbstractSessionEvent</code> with the specified
52      * <code>source</code> and <code>iceFacesId</code>. </p>
53      *
54      * @param source the source of this <code>AbstractSessionEvent</code>.
55      * @param iceFacesId the ICEfaces ID.
56      * @throws IllegalArgumentException if the one of the following happens:
57      * <ul> <li> the specified
58      * <code>source</code> is
59      * <code>null</code>. </li> <li> the
60      * specified <code>iceFacesId</code> is
61      * either <code>null</code> or empty. </li>
62      * </ul>
63      */
64     protected AbstractSessionEvent(HttpSession JavaDoc source, String JavaDoc iceFacesId)
65             throws IllegalArgumentException JavaDoc {
66         super(source);
67         if (iceFacesId == null) {
68             throw new IllegalArgumentException JavaDoc("iceFacesId is null");
69         }
70         if (iceFacesId.trim().length() == 0) {
71             throw new IllegalArgumentException JavaDoc("iceFacesId is empty");
72         }
73         this.iceFacesId = iceFacesId;
74     }
75
76     /**
77      * Gets the HTTP session of this <code>AbstractSessionEvent</code>. </p>
78      *
79      * @return the HTTP session.
80      */
81     public HttpSession JavaDoc getHttpSession() {
82         return (HttpSession JavaDoc) source;
83     }
84
85     /**
86      * Gets the ICEfaces ID of this <code>AbstractSessionEvent</code>. </p>
87      *
88      * @return the ICEfaces ID.
89      */
90     public String JavaDoc getICEfacesID() {
91         return iceFacesId;
92     }
93 }
94
Popular Tags