001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package com.sun.rave.web.ui.appbase;
043:
044: import java.io.Serializable;
045:
046: /**
047: * <p><strong>AbstractSessionBean</strong> is the abstract base class for
048: * data bean(s) that are stored in session scope attributes. It extends
049: * {@link FacesBean}, so it inherits all of the default behavior
050: * found there. In addition, the following lifecycle methods are called
051: * automatically when the corresponding events occur:</p>
052: * <ul>
053: * <li><code>init()</code> - Called when this bean is initially added
054: * as a session attribute (typically as the result of evaluating a
055: * value binding or method binding expression).</li>
056: * <li><code>passivate()</code> - Called when the servlet container is about
057: * to serialize and remove this session from its current container.</li>
058: * <li><code>activate()</code> - Called when the servlet container has
059: * finished deserializing this session and making it available in a
060: * (potentially different) container.</li>
061: * <li><code>destroy()</code> - Called when the bean is removed from the
062: * session attributes (typically as a result of the session timing out
063: * or being terminated by the application).</li>
064: * </ul>
065: */
066: public abstract class AbstractSessionBean extends FacesBean implements
067: Serializable {
068:
069: // ------------------------------------------------------------- Constructor
070:
071: /**
072: * <p>Create a new session scope bean.</p>
073: */
074: public AbstractSessionBean() {
075: }
076:
077: // ------------------------------------------------------- Lifecycle Methods
078:
079: /**
080: * <p>This method is called when this bean is initially added to
081: * session scope. Typically, this occurs as a result of evaluating
082: * a value binding or method binding expression, which utilizes the
083: * managed bean facility to instantiate this bean and store it into
084: * session scope.</p>
085: *
086: * <p>You may customize this method to initialize and cache data values
087: * or resources that are required for the lifetime of a particular
088: * user session.</p>
089: */
090: public void init() {
091:
092: // The default implementation does nothing
093:
094: }
095:
096: /**
097: * <p>This method is called when the session containing it is about to be
098: * passivated. Typically, this occurs in a distributed servlet container
099: * when the session is about to be transferred to a different
100: * container instance, after which the <code>activate()</code> method
101: * will be called to indicate that the transfer is complete.</p>
102: *
103: * <p>You may customize this method to release references to session data
104: * or resources that can not be serialized with the session itself.</p>
105: */
106: public void passivate() {
107:
108: // The default implementation does nothing
109:
110: }
111:
112: /**
113: * <p>This method is called when the session containing it was
114: * reactivated.</p>
115: *
116: * <p>You may customize this method to reacquire references to session
117: * data or resources that could not be serialized with the
118: * session itself.</p>
119: */
120: public void activate() {
121:
122: // The default implementation does nothing
123:
124: }
125:
126: /**
127: * <p>This method is called when this bean is removed from
128: * session scope. Typically, this occurs as a result of
129: * the session timing out or being terminated by the application.</p>
130: *
131: * <p>You may customize this method to clean up resources allocated
132: * during the execution of the <code>init()</code> method, or
133: * at any later time during the lifetime of the application.</p>
134: */
135: public void destroy() {
136:
137: // The default implementation does nothing
138:
139: }
140:
141: }
|