/*
 * Copyright (C) 2005-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.repo.security.authentication;

import java.util.Set;


/**
 * Manage authentication tickets
 * 
 * @author andyh
 * 
 */
public interface TicketComponent
{
    /**
     * Register a new ticket. If a session ID is given, an association with that session ID will be recorded for the
     * returned ticket.
     * 
     * @param userName
     * @param sessionId
     *            the app server session ID (e.g. HttpSession ID) or <code>null</code> if not applicable.
     * @return - the ticket
     * @throws AuthenticationException
     */
    public String getNewTicket(String userName, String sessionId) throws AuthenticationException;

    /**
     * Gets the current ticket. If a session ID is given, an association with that session ID will be recorded for the
     * returned ticket.
     * 
     * @param userName
     * @param sessionId
     *            the app server session ID (e.g. HttpSession ID) or <code>null</code> if not applicable.
     * @param autoCreate
     *            should we create one automatically if there isn't one?
     * @return - the ticket
     */    
    public String getCurrentTicket(String userName, String sessionId, boolean autoCreate);
    
    /**
     * Check that a certificate is valid and can be used in place of a login. Optionally records an association between
     * the ticket and a given app server session Id. This is so that we don't expire tickets prematurely referenced by
     * more than one application server session. Tickets may be rejected because:
     * <ol>
     * <li>The certificate does not exists
     * <li>The status of the user has changed
     * <ol>
     * <li>The user is locked
     * <li>The account has expired
     * <li>The credentials have expired
     * <li>The account is disabled
     * </ol>
     * <li>The ticket may have expired
     * <ol>
     * <li>The ticked my be invalid by timed expiry
     * <li>An attemp to reuse a once only ticket
     * </ol>
     * </ol>
     * 
     * @param ticket
     * @param sessionId
     *            the app server session ID (e.g. HttpSession ID) or <code>null</code> if not applicable.
     * @return - the user name
     * @throws AuthenticationException
     */
    public String validateTicket(String ticket, String sessionId) throws AuthenticationException;
    
    /**
     * Invalidates a ticket, or disassociates it from an app server session. Once it has been disassociated from all
     * sessions, the ticket will be invalidated globally.
     * 
     * @param ticket
     * @param sessionId
     *            the app server session ID (e.g. HttpSession ID) or <code>null</code> if the ticket should be
     *            invalidated globally.
     */
    public void invalidateTicketById(String ticket, String sessionId);
    
    /**
     * Invalidate all user tickets
     * 
     * @param userName
     */
    public void invalidateTicketByUser(String userName);
      
	/**
	 * Count tickets
	 * 
	 * This may be higher than the user count, since a user can have more than one ticket/session
	 *
	 * @param nonExpiredOnly  true for non expired tickets, false for all (including expired) tickets
	 * @return int number of tickets
	 */
    public int countTickets(boolean nonExpiredOnly);
    
	/**
	 * Get set of users with tickets
	 * 
	 * This may be lower than the ticket count, since a user can have more than one ticket/session
	 *
	 * @param nonExpiredOnly  true for non expired tickets, false for all (including expired) tickets
	 * @return Set<String>   set of users with (one or more) tickets
	 */
    public Set<String> getUsersWithTickets(boolean nonExpiredOnly);

	/**
	 * Invalidate tickets
	 * 
	 * @param expiredOnly  true for EXPIRED tickets, false for ALL (including non-expired) tickets
	 * @return int  count of invalidated tickets
	 */
    public int invalidateTickets(boolean expiredOnly);
    
    /**
     * Get the authority for the given ticket
     * 
     * @param ticket
     * @return the authority
     */
    public String getAuthorityForTicket(String ticket);
    
    /**
     * Clear the current ticket
     *
     */
    public void clearCurrentTicket();
}