//
// ========================================================================
// 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.session;

import java.util.Set;

SessionDataStore
A store for the data contained in a Session object. The store
would usually be persistent.
/**
 * SessionDataStore
 *
 * A store for the data contained in a Session object. The store
 * would usually be persistent.
 */
public interface SessionDataStore extends SessionDataMap
{

    
Create a new SessionData
Params:
id – the id
created – the timestamp when created
accessed – the timestamp when accessed
lastAccessed – the timestamp when last accessed
maxInactiveMs – the max inactive time in milliseconds
Returns:
a new SessionData object/**
     * Create a new SessionData
     *
     * @param id the id
     * @param created the timestamp when created
     * @param accessed the timestamp when accessed
     * @param lastAccessed the timestamp when last accessed
     * @param maxInactiveMs the max inactive time in milliseconds
     * @return a new SessionData object
     */
    public SessionData newSessionData(String id, long created, long accessed, long lastAccessed, long maxInactiveMs);

    
Called periodically, this method should search the data store
for sessions that have been expired for a 'reasonable' amount
of time.
Params:
candidates – if provided, these are keys of sessions that
the SessionDataStore thinks has expired and should be verified by the
SessionDataStore
Returns:
set of session ids/**
     * Called periodically, this method should search the data store
     * for sessions that have been expired for a 'reasonable' amount
     * of time.
     *
     * @param candidates if provided, these are keys of sessions that
     * the SessionDataStore thinks has expired and should be verified by the
     * SessionDataStore
     * @return set of session ids
     */
    public Set<String> getExpired(Set<String> candidates);

    
True if this type of datastore will passivate session objects
Returns:
true if this store can passivate sessions, false otherwise/**
     * True if this type of datastore will passivate session objects
     *
     * @return true if this store can passivate sessions, false otherwise
     */
    public boolean isPassivating();

    
Test if data exists for a given session id.
Params:
id – Identity of session whose existence should be checked
Throws:
Exception – if problem checking existence with persistence layer
Returns:
true if valid, non-expired session exists/**
     * Test if data exists for a given session id.
     *
     * @param id Identity of session whose existence should be checked
     * @return true if valid, non-expired session exists
     * @throws Exception if problem checking existence with persistence layer
     */
    public boolean exists(String id) throws Exception;
}