Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements session utility methods

 *  Copyright: 2008 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.service;

import java.util.Hashtable;

import javax.servlet.http.Cookie;

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;

import edu.ucsb.nceas.metacat.util.SessionData;

public class SessionService implements ServiceInterface {

	private static SessionService sessionService = null;

	private static Logger logMetacat = Logger.getLogger(SessionService.class);

	private static Hashtable<String, SessionData> sessionHash = null;

	/**

	 * private constructor since this is a singleton

	 */

	private SessionService() {

		sessionHash = new Hashtable<String, SessionData>();

		registerSession(PUBLIC_SESSION_ID, "public", null, null);

	}

	/**

	 * Get the single instance of AuthAdmin.

	 *

	 * @return the single instance of AuthAdmin

	 */

	public static SessionService getInstance() {

		if (sessionService == null) {

			sessionService = new SessionService();

		}

		return sessionService;

	}

	/**

	 * Register a session in the session hash table.  This uses

	 * the parameters passed in to create a SessionData object.

	 *

	 * @param sessionId

	 *            the ID of the session to register

	 * @param userName

	 *            the user name of the session

	 * @param groupNames

	 *            the group names for the session

	 * @param password

	 *            the password for the session

	 */

			String[] groupNames, String password) {

		SessionData sessionData = new SessionData(sessionId, userName, groupNames,

				password);

		sessionHash.put(sessionId, sessionData);

	}

	 * Register a session in the session hash table.

	 *

	 * @param sessionData

	 *            the session data object to add to the session hash

	 */

		sessionHash.put(sessionData.getId(), sessionData);

	}

	 * Unregister a session from the session hash table.

	 *

	 * @param sessionId

	 *            the id of the session to remove.

	 */

		sessionHash.remove(sessionId);

	}

	 * Check if a session is registered in the session hash table.

	 * TODO MCD need to time sessions out

	 *

	 * @param sessionId

	 *            the id of the session to look for.

	 */

		return sessionHash.containsKey(sessionId);

	}

	 * Get a registered session from the session hash table.

	 * TODO MCD need to time sessions out

	 *

	 * @param sessionId

	 *            the id of the session to retrieve.

	 */

		return sessionHash.get(sessionId);

	}

	 * Get the public session from the session hash table.

	 */

	public static SessionData getPublicSession() {

		return sessionHash.get(PUBLIC_SESSION_ID);

	 * Keep a session active by updating its last accessed time.

	 *

	 * @param sessionId

	 *            the id of the session to update.

	 */

		if (isSessionRegistered(sessionId)) {

			SessionData sessionData = getRegisteredSession(sessionId);

			sessionData.setLastAccessedTime();

		}

	}

}