/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  All rights reserved.
  
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR 
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.server;

import java.util.Vector;
import java.util.Properties;
import java.security.cert.X509Certificate;
import org.bodington.database.PrimaryKey;
import org.bodington.server.realm.User;
import org.bodington.server.resources.Resource;
import org.bodington.server.resources.ResourceSummary;

/**
 * Represents a Users session with the site. For each user using the site there
 * is one instance of NavigationSession and it may be used by multiple clients at the same time.
 * For this reason it shouldn't store data that changes with every request such as the current resource.
 * And it probably shouldn't deal with anything that relates to the current resource.
 * @author Jon Maber
 * @author buckett
 */
public interface NavigationSession 
{
	public String currentUserName()
		throws BuildingServerException;
		
	public ResourceSummary getRootSummary()
		throws BuildingServerException;
		
	public Vector childSummaries( PrimaryKey resource_id )
		throws BuildingServerException;
		
	public PrimaryKey findResourceId( String[] names )
		throws BuildingServerException;

	public Resource findResource( PrimaryKey resource_id )
		throws BuildingServerException;
	
    /**
     * Gets a property for the current user.
     * @param name The name of the property to get.
     * @return The value of the property.
     */
	public String getUserProperty( String name )
		throws BuildingServerException;
	
    /**
     * Sets a property for the current user.
     * @param name The name of the property. This can't be null.
     * @param value The value to set the property to, if it is null then the
     * property is deleted.
     */
	public void setUserProperty( String name, String value )
		throws BuildingServerException;
	
	public String getUserPreferredStyleSheet()
		throws BuildingServerException;
	
	public void clearAuthenticationCredentials()
		throws BuildingServerException;
	
	public void setAuthenticationCredentials( Properties credentials, String authenticator_alias )
		throws BuildingServerException;
	
	public void setClientX509( X509Certificate cert )
		throws BuildingServerException;
	
	public boolean isAuthenticated()
		throws BuildingServerException;

	public boolean isAnonymous()
		throws BuildingServerException;

	public String getAuthenticationError()
		throws BuildingServerException;
	
	public PrimaryKey getAuthenticatedUserId()
		throws BuildingServerException;
	
	public User getAuthenticatedUser()
		throws BuildingServerException;
	
	public String getAuthenticatorAlias()
		throws BuildingServerException;
    
    /**
     * Get the container for home resources.
     * @return The container for home resources.
     */
    public HomeContainerSession getHomeContainerSession()
        throws BuildingServerException;
    
	}