com.aspectran.core.component.session.SessionHandler Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* 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 com.aspectran.core.component.session;
import com.aspectran.core.component.Component;
import com.aspectran.core.util.thread.Scheduler;
/**
* The session handler is responsible for session start, session exists, session write,
* time to live and session destroy.
*
* Created: 2017. 6. 12.
*/
public interface SessionHandler extends Component {
Scheduler getScheduler();
String getWorkerName();
SessionIdGenerator getSessionIdGenerator();
SessionCache getSessionCache();
int getDefaultMaxIdleSecs();
void setDefaultMaxIdleSecs(int defaultMaxIdleSecs);
/**
* Get a known existing session.
* @param id the session id
* @return a Session or null if none exists
*/
DefaultSession getSession(String id);
/**
* Create an entirely new Session.
* @param id identity of session to create
* @return the new session object
*/
DefaultSession createSession(String id);
void releaseSession(DefaultSession session);
/**
* Create a new Session ID.
* @param seedTerm the seed for RNG
* @return the new session id
*/
String createSessionId(long seedTerm);
/**
* Change the id of a Session.
* @param oldId the current session id
* @param newId the new session id
* @return the Session after changing its id
*/
String renewSessionId(String oldId, String newId);
/**
* Remove session from manager.
* @param id the session to remove
* @param invalidate if false, only remove from cache
* @return if the session was removed
*/
DefaultSession removeSession(String id, boolean invalidate);
DefaultSession removeSession(String id, boolean invalidate, Session.DestroyedReason reason);
/**
* Called when a session has expired.
* @param id the id to invalidate
*/
void invalidate(String id);
void invalidate(String id, Session.DestroyedReason reason);
/**
* Each session has a timer that is configured to go off
* when either the session has not been accessed for a
* configurable amount of time, or the session itself
* has passed its expiry.
*
* If it has passed its expiry, then we will mark it for
* scavenging by next run of the HouseKeeper; if it has
* been idle longer than the configured eviction period,
* we evict from the cache.
*
* If none of the above are true, then the System timer
* is inconsistent and the caller of this method will
* need to reset the timer.
* @param session the default session
* @param now the time at which to check for expiry
*/
void sessionInactivityTimerExpired(DefaultSession session, long now);
/**
* Called periodically by the HouseKeeper to handle the list of
* sessions that have expired since the last call to scavenge.
*/
void scavenge();
/**
* Adds an event listener for session-related events.
* @param listener the session listener
* @see #removeSessionListener(SessionListener)
*/
void addSessionListener(SessionListener listener);
/**
* Removes an event listener for session-related events.
* @param listener the session listener to remove
* @see #addSessionListener(SessionListener)
*/
void removeSessionListener(SessionListener listener);
/**
* Removes all event listeners for session-related events.
*
* @see #removeSessionListener(SessionListener)
*/
void clearSessionListeners();
/**
* Call binding and attribute listeners based on the new and old values of
* the attribute.
* @param name name of the attribute
* @param newValue new value of the attribute
* @param oldValue previous value of the attribute
* @throws IllegalStateException if no session manager can be find
*/
void fireSessionAttributeListeners(Session session, String name, Object oldValue, Object newValue);
/**
* Call the session lifecycle listeners.
* @param session the session on which to call the lifecycle listeners
*/
void fireSessionDestroyedListeners(Session session);
/**
* Record length of time session has been active. Called when the
* session is about to be invalidated.
* @param session the session whose time to record
*/
void recordSessionTime(DefaultSession session);
/**
* @return the maximum amount of time session remained valid
*/
long getSessionTimeMax();
/**
* @return the total amount of time all sessions remained valid
*/
long getSessionTimeTotal();
/**
* @return the mean amount of time session remained valid
*/
long getSessionTimeMean();
/**
* @return the standard deviation of amount of time session remained valid
*/
double getSessionTimeStdDev();
/**
* Resets the session usage statistics.
*/
void statsReset();
}