AMSessionRepository.java revision aee26cce86cd7acccbcd94284b027d11cb9ac327
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: AMSessionRepository.java,v 1.4 2008/06/25 05:41:30 qcheng Exp $
*
*/
/**
* Portions Copyrighted 2012 ForgeRock AS
*/
/**
* The <code>AMSessionRepository</code> interface provides methods to
* <code>retrive</code> , <code>save</code> , <code>delete</code> the session
* from the session repository.Any </code>Session<code> repository mechanisms
* such as <code>JDBCSessionRepository</code>,
* <code> JMQSessionRepository</code> implements this interface.
*
* @see <code>JMQSessionRepository</code>
* @see <code></code>
*/
public interface AMSessionRepository {
public static final String REPOSITORY_CLASS_PROPERTY =
"com.sun.am.session.SessionRepositoryImpl";
/**
* Retrieves session state from the repository.
*
* @param sid session ID
* @return <code>InternalSession</code> object retrieved from the repository
* @throws Exception if anything goes wrong
*/
/**
* Saves session state to the repository If it is a new session (version ==
* 0) it inserts new record(s) to the repository. For an existing session it
* updates repository record instead while checking that versions in the
* InternalSession and in the record match In case of version mismatch or
* missing record IllegalArgumentException will be thrown
*
* @param is reference to <code>InternalSession</code> object being saved.
* @throws Exception if anything goes wrong.
*/
/**
* Deletes session record from the repository.
*
* @param sid session ID.
* @throws Exception if anything goes wrong.
*/
/**
* Deletes the expired session records , this is mainly used by the
* background clean up thread to cleanup the expired session records from
* the <code>Sessionrepository</code>
*
* @throws Exception when unable to deleted the session record from the
* repository
*/
public void deleteExpired() throws Exception;
/**
* Deletes a record from the store.
*
* @param id The id of the record to delete from the store
* @throws StoreException
* @throws NotFoundException
*/
/**
* Delete all records in the store
* that have an expiry date older than the one specified.
*
* @param expDate The expDate in seconds
* @throws StoreException
*/
/**
* Returns the expiration information of all sessions belonging to a user.
* The returned value will be a Map (sid->expiration_time).
*
* @param uuid User's universal unique ID.
* @throws Exception if there is any problem with accessing the session
* repository.
*/
/**
* Merge of additional methods from PersistentStore Class for new session-ha.
*/
/**
* Takes an AMRecord and writes this to the store
*
* @param amRootEntity The record object to store
* @throws StoreException
*/
/**
* Reads a record from the store with the specified id
*
* @param id The primary key of the record to find
* @return AMRootEntity The AMRecord if found
* @throws StoreException
* @throws NotFoundException
*/
/**
* Reads a record with the secondary key from the underlying store. The
* return value is a <code><Set>String</code>. Each string represents the
* token id of the matching session found.
*
* @param id The secondary key on which to search the store
* @return A Set of Strings of the matching records, if any.
* @throws StoreException
* @throws NotFoundException
*/
/**
* Shut down the store
*/
public void shutdown();
/**
* Returns the count of the records found in the store with a given matching
* id.
* <p/>
* The return value is <code>Map<String, Long></code> where the key is the
* token.id of the users session and the long is the expiry time of the session.
*
* @param id
* @return
* @throws StoreException
*/
/**
* Returns the current set of store statistics.
*
* @return DBStatistics
*/
public DBStatistics getDBStatistics();
}