/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.ws.runtime.util;
import com.sun.xml.ws.rm.Sequence;
import com.sun.xml.ws.security.SecurityContextTokenInfo;

/**
 * The <code> Session </Session> object is used to manage state between multiple requests
 * from the same client. It contains a session key field to uniquely identify the Session, 
 * a <code>SecurityInfo</code> field that contains the security parameters used to
 * protect the session and  userdata field that can store the state for multiple 
 * requests from the client.
 *
 * @author Bhakti Mehta
 * @author Mike Grogan
 */
public  class Session {
    
    /**
     * Well-known invocationProperty names
     */
    public static final String SESSION_ID_KEY = "com.sun.xml.ws.sessionid";
    public static final String SESSION_KEY = "com.sun.xml.ws.session";

    /**
     * Session manager that can handle Sessions of this exact type.
     * (Different SessionManagers might use different subclasses of this Class)
     */
    private final SessionManager manager;
    
    /*
     * These fields might be persisted
     */
    /**
     * Unique key based either on the SCT or RM sequence id for the session
     */
    private final String key;
    
    /**
     * A container for user-defined data that will be exposed in WebServiceContext.
     */
    private final Object userData;
    
    
    private SecurityContextTokenInfo securityInfo;
    private Sequence sequence;
    
    /*
     * These fields are for internal use
     */
    private final long creationTime;
    private long lastAccessedTime;
    
    /**
     * Public constructor
     *
     * @param manager - A <code>SessionManager</code> that can handle <code>Sessions</code>
     * of this type.  
     * @param key - The unique session id
     * @param data - Holder for user-defined data.
     */
    public Session(SessionManager manager, String key, Object userData) {
        this.manager = manager;
        this.userData = userData;
        this.key = key;
        creationTime = lastAccessedTime = 
              System.currentTimeMillis();
    }
    

    /**
     * Accessor for Session Key.
     *
     * @returns The session key
     */
    public String getSessionKey() {
        return key;
    }
    
    /**
     * Accessor for the <code>userData</code> field.
     *
     * @return The value of the field.
     */
    public Object getUserData() {
        return userData;
    }
    
    
    /**
    * Accessor for the <code>securityInfo</code> field.
    * 
    * @returns The value of the field.
    */
    public SecurityContextTokenInfo getSecurityInfo() {
        return securityInfo;
    }
    
   /**
    * Mutator for the <code>securityInfo</code> field.
    * 
    * @returns The value of the field.
    */
    public void setSecurityInfo(SecurityContextTokenInfo securityInfo) {
        this.securityInfo = securityInfo;
    }
    
    
   /**
    * Accessor for the <code>sequence</code> field.
    * 
    * @return The value of the field.
    */
    public Sequence getSequence() {
        return sequence;
    }
    
    /**
    * Mutator for the <code>securityInfo</code> field.
    * 
    * @returns The value of the field.
    */
    public void setSequence(Sequence sequence) {
        this.sequence = sequence;
    }
    
    /**
     * Accessor for creation time.
     *
     * @returns The creation time.
     */
    public  long getCreationTime() {
        return creationTime;
    }

    /**
     * Accessor for lastAccessed time, which can be used to invalidate Sessions 
     * have not been active since a certain time.
     *
     * @returns The lastAccessedTime
     */
    public  long getLastAccessedTime() {
        return lastAccessedTime;
    }
    
    /**
     * Resets the lastAccessedTime to the current time.
     */
    public void resetLastAccessedTime() {
        lastAccessedTime = System.currentTimeMillis();
    }
    
    /**
     * Saves the state of the session using whatever persistence mechanism the
     * <code>SessionManager</code> offers.
     */
    public void save() {
        manager.saveSession(getSessionKey());
    }

}