001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/main/I_CmsSessionStorageProvider.java,v $
003: * Date : $Date: 2008-02-27 12:05:39 $
004: * Version: $Revision: 1.4 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.main;
033:
034: import org.opencms.util.CmsUUID;
035:
036: import java.util.List;
037:
038: /**
039: * This interface is used to define the session storage implementation provider.<p>
040: *
041: * @author Michael Moossen
042: *
043: * @version $Revision: 1.4 $
044: *
045: * @since 6.5.5
046: */
047: public interface I_CmsSessionStorageProvider {
048:
049: /**
050: * Validates all session info objects removing any session that have became invalidated.<p>
051: */
052: void validate();
053:
054: /**
055: * Returns the stored session info object with the given id.<p>
056: *
057: * @param sessionId the id to lookup
058: *
059: * @return the stored session info object, or <code>null</code> if not found
060: */
061: CmsSessionInfo get(CmsUUID sessionId);
062:
063: /**
064: * Returns all current stored session info objects.<p>
065: *
066: * @return all current stored session info objects
067: */
068: List getAll();
069:
070: /**
071: * Returns all current stored session info objects for the given user.<p>
072: *
073: * @param userId the id of the user to retrieve the session info objects for
074: *
075: * @return all current stored session info objects for the given user
076: */
077: List getAllOfUser(CmsUUID userId);
078:
079: /**
080: * Returns the current number of stored session info objects.<p>
081: *
082: * @return the current number of stored session info objects, or zero if empty
083: */
084: int getSize();
085:
086: /**
087: * Initializes the storage.<p>
088: *
089: * @throws CmsInitException if initialization fails
090: */
091: void initialize() throws CmsInitException;
092:
093: /**
094: * Stores the given session info object.<p>
095: *
096: * @param sessionInfo the session info object to be stored
097: *
098: * @return the session info object previously stored with the same session id, or <code>null</code> if none
099: */
100: CmsSessionInfo put(CmsSessionInfo sessionInfo);
101:
102: /**
103: * Removes the stored session info object identified by the given session id.<p>
104: *
105: * @param sessionId the id that identifies the stored session info object to remove
106: *
107: * @return the removed cached entry or <code>null</code> if none
108: */
109: CmsSessionInfo remove(CmsUUID sessionId);
110:
111: /**
112: * Last cleanup possibility.<p>
113: *
114: * @throws Exception if something goes wrong
115: */
116: void shutdown() throws Exception;
117: }
|