//
//  ========================================================================
//  Copyright (c) 1995-2019 Mort Bay Consulting Pty. Ltd.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.server.session;

import org.eclipse.jetty.util.component.LifeCycle;

SessionDataMap
A map style access to SessionData keyed by the session id.
/**
 * SessionDataMap
 *
 * A map style access to SessionData keyed by the session id.
 */
public interface SessionDataMap extends LifeCycle
{
    
Initialize this data map for the
given context. A SessionDataMap can only
be used by one context(/session manager).
Params:
context – context associated
Throws:
Exception – if unable to initialize the/**
     * Initialize this data map for the
     * given context. A SessionDataMap can only
     * be used by one context(/session manager).
     *
     * @param context context associated
     * @throws Exception if unable to initialize the
     */
    void initialize(SessionContext context) throws Exception;

    
Read in session data.
Params:
id – identity of session to load
Throws:
Exception – if unable to load session data
Returns:
the SessionData matching the id/**
     * Read in session data.
     *
     * @param id identity of session to load
     * @return the SessionData matching the id
     * @throws Exception if unable to load session data
     */
    public SessionData load(String id) throws Exception;

    
Store the session data.
Params:
id – identity of session to store
data – info of session to store
Throws:
Exception – if unable to write session data/**
     * Store the session data.
     *
     * @param id identity of session to store
     * @param data info of session to store
     * @throws Exception if unable to write session data
     */
    public void store(String id, SessionData data) throws Exception;

    
Delete session data
Params:
id – identity of session to delete
Throws:
Exception – if unable to delete session data
Returns:
true if the session was deleted/**
     * Delete session data
     *
     * @param id identity of session to delete
     * @return true if the session was deleted
     * @throws Exception if unable to delete session data
     */
    public boolean delete(String id) throws Exception;
}