//
// ========================================================================
// Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under
// the terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0
//
// This Source Code may also be made available under the following
// Secondary Licenses when the conditions for such availability set
// forth in the Eclipse Public License, v. 2.0 are satisfied:
// the Apache License v2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.server;

import java.util.Set;

import jakarta.servlet.http.HttpServletRequest;
import org.eclipse.jetty.server.session.HouseKeeper;
import org.eclipse.jetty.server.session.SessionHandler;
import org.eclipse.jetty.util.component.LifeCycle;

Session ID Manager.
Manages session IDs across multiple contexts.
/**
 * Session ID Manager.
 *
 * Manages session IDs across multiple contexts.
 */
public interface SessionIdManager extends LifeCycle
{

    
Params:
id – The plain session ID (ie no workername extension)
Returns:
True if the session ID is in use by at least one context./**
     * @param id The plain session ID (ie no workername extension)
     * @return True if the session ID is in use by at least one context.
     */
    public boolean isIdInUse(String id);

    
Expire all sessions on all contexts that share the same id.
Params:
id – The session ID without any cluster node extension/**
     * Expire all sessions on all contexts that share the same id.
     *
     * @param id The session ID without any cluster node extension
     */
    public void expireAll(String id);

    
Invalidate all sessions on all contexts that share the same id.
Params:
id – the session id/**
     * Invalidate all sessions on all contexts that share the same id.
     *
     * @param id the session id
     */
    public void invalidateAll(String id);

    
Create a new Session ID.
Params:
request – the request with the sesion
created – the timestamp for when the session was created
Returns:
the new session id/**
     * Create a new Session ID.
     *
     * @param request the request with the sesion
     * @param created the timestamp for when the session was created
     * @return the new session id
     */
    public String newSessionId(HttpServletRequest request, long created);

    
Returns:
the unique name of this server instance/**
     * @return the unique name of this server instance
     */
    public String getWorkerName();

    
Get just the session id from an id that includes the worker name
as a suffix.
Strip node identifier from a located session ID.
Params:
qualifiedId – the session id including the worker name
Returns:
the cluster id/**
     * Get just the session id from an id that includes the worker name
     * as a suffix.
     *
     * Strip node identifier from a located session ID.
     *
     * @param qualifiedId the session id including the worker name
     * @return the cluster id
     */
    public String getId(String qualifiedId);

    
Get an extended id for a session. An extended id contains
the workername as a suffix.
Params:
id – The id of the session
request – The request that for the session (or null)
Returns:
The session id qualified with the worker name/**
     * Get an extended id for a session. An extended id contains
     * the workername as a suffix.
     *
     * @param id The id of the session
     * @param request The request that for the session (or null)
     * @return The session id qualified with the worker name
     */
    public String getExtendedId(String id, HttpServletRequest request);

    
Change the existing session id.
Params:
oldId – the old plain session id
oldExtendedId – the old fully qualified id
request – the request containing the session
Returns:
the new session id/**
     * Change the existing session id.
     *
     * @param oldId the old plain session id
     * @param oldExtendedId the old fully qualified id
     * @param request the request containing the session
     * @return the new session id
     */
    public String renewSessionId(String oldId, String oldExtendedId, HttpServletRequest request);

    
Get the set of all session handlers for this node
Returns:
the set of session handlers/**
     * Get the set of all session handlers for this node
     *
     * @return the set of session handlers
     */
    public Set<SessionHandler> getSessionHandlers();

    
Params:
houseKeeper – the housekeeper for doing scavenging/**
     * @param houseKeeper the housekeeper for doing scavenging
     */
    public void setSessionHouseKeeper(HouseKeeper houseKeeper);

    
Returns:
the housekeeper for doing scavenging/**
     * @return the housekeeper for doing scavenging
     */
    public HouseKeeper getSessionHouseKeeper();
}