org.apache.catalina.Session Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina;
import jakarta.servlet.http.HttpSession;
import java.security.Principal;
import java.util.*;
/**
* A Session is the Catalina-internal facade for an
* HttpSession that is used to maintain state information
* between requests for a particular user of a web application.
*
* @author Craig R. McClanahan
* @version $Revision: 1.3 $ $Date: 2005/12/08 01:27:20 $
*/
public interface Session {
// ----------------------------------------------------- Manifest Constants
/**
* The SessionEvent event type when a session is created.
*/
public static final String SESSION_CREATED_EVENT = "createSession";
/**
* The SessionEvent event type when a session is destroyed.
*/
public static final String SESSION_DESTROYED_EVENT = "destroySession";
// ------------------------------------------------------------- Properties
/**
* Return the authentication type used to authenticate our cached
* Principal, if any.
*/
public String getAuthType();
/**
* Set the authentication type used to authenticate our cached
* Principal, if any.
*
* @param authType The new cached authentication type
*/
public void setAuthType(String authType);
/**
* Return the creation time for this session.
*/
public long getCreationTime();
/**
* Set the creation time for this session. This method is called by the
* Manager when an existing Session instance is reused.
*
* @param time The new creation time
*/
public void setCreationTime(long time);
/**
* Return the session identifier for this session.
*/
public String getId();
/**
* Return the session identifier for this session.
*/
public String getIdInternal();
/**
* Set the session identifier for this session.
*
* @param id The new session identifier
*/
public void setId(String id);
/**
* Return descriptive information about this Session implementation and
* the corresponding version number, in the format
* <description>/<version>.
*/
public String getInfo();
/**
* Return the last time the client sent a request associated with this
* session, as the number of milliseconds since midnight, January 1, 1970
* GMT. Actions that your application takes, such as getting or setting
* a value associated with the session, do not affect the access time.
*/
public long getLastAccessedTime();
/**
* Return the Manager within which this Session is valid.
*/
public Manager getManager();
/**
* Set the Manager within which this Session is valid.
*
* @param manager The new Manager
*/
public void setManager(Manager manager);
/**
* Return the maximum time interval, in seconds, between client requests
* before the servlet container will invalidate the session. A negative
* time indicates that the session should never time out.
*/
public int getMaxInactiveInterval();
/**
* Set the maximum time interval, in seconds, between client requests
* before the servlet container will invalidate the session. A negative
* time indicates that the session should never time out.
*
* @param interval The new maximum interval
*/
public void setMaxInactiveInterval(int interval);
/**
* Set the isNew flag for this session.
*
* @param isNew The new value for the isNew flag
*/
public void setNew(boolean isNew);
/**
* Return the authenticated Principal that is associated with this Session.
* This provides an Authenticator with a means to cache a
* previously authenticated Principal, and avoid potentially expensive
* Realm.authenticate() calls on every request. If there
* is no current associated Principal, return null.
*/
public Principal getPrincipal();
/**
* Set the authenticated Principal that is associated with this Session.
* This provides an Authenticator with a means to cache a
* previously authenticated Principal, and avoid potentially expensive
* Realm.authenticate() calls on every request.
*
* @param principal The new Principal, or null if none
*/
public void setPrincipal(Principal principal);
/**
* Return the HttpSession for which this object
* is the facade.
*/
public HttpSession getSession();
/**
* Set the isValid flag for this session.
*
* @param isValid The new value for the isValid flag
*/
public void setValid(boolean isValid);
/**
* Expire the expired session if necessary and
* return the isValid flag for this session.
*/
public boolean isValid();
/**
* Return the isValid flag for this session.
*/
public boolean getIsValid();
// --------------------------------------------------------- Public Methods
/**
* Update the accessed time information for this session. This method
* should be called by the context when a request comes in for a particular
* session, even if the application does not reference it.
*/
public void access();
/**
* Add a session event listener to this component.
*/
public void addSessionListener(SessionListener listener);
/**
* End access to the session.
*/
public void endAccess();
/**
* Perform the internal processing required to invalidate this session,
* without triggering an exception if the session has already expired.
*/
public void expire();
/**
* Return the object bound with the specified name to the internal notes
* for this session, or null if no such binding exists.
*
* @param name Name of the note to be returned
*/
public Object getNote(String name);
/**
* Return an Iterator containing the String names of all notes bindings
* that exist for this session.
*/
public Iterator getNoteNames();
/**
* Release all object references, and initialize instance variables, in
* preparation for reuse of this object.
*/
public void recycle();
/**
* Remove any object bound to the specified name in the internal notes
* for this session.
*
* @param name Name of the note to be removed
*/
public void removeNote(String name);
/**
* Remove a session event listener from this component.
*/
public void removeSessionListener(SessionListener listener);
/**
* Bind an object to a specified name in the internal notes associated
* with this session, replacing any existing binding for this name.
*
* @param name Name to which the object should be bound
* @param value Object to be bound to the specified name
*/
public void setNote(String name, Object value);
// START SJSAS 6329289
/**
* Checks whether this Session has expired.
*
* @return true if this Session has expired, false otherwise
*/
public boolean hasExpired();
// END SJSAS 6329289
/**
* Gets the version number of this Session
*/
public long getVersion();
/**
* Gets the attributes of this session.
*
* @return the attributes of this session
*/
public Map getAttributes();
/**
* Return the single sign on id.
* It is null if there is no SSO.
*/
public String getSsoId();
/**
* Set the single sign on id.
*/
public void setSsoId(String ssoId);
/**
* Return the single sign on version.
*/
public long getSsoVersion();
/**
* Set the single sign on version.
*/
public void setSsoVersion(long ssoVersion);
/**
* lock the session for background
* returns true if successful; false if unsuccessful
*/
public boolean lockForeground();
/**
* unlock the session from foreground
*/
public void unlockForeground();
}