/* ======================================================================
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.resources;

import java.rmi.*;
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.BuildingSession;
import org.bodington.server.BuildingServerException;

public interface NavigationSession extends BuildingSession
	{
        public BuildingSession getResourceSession( PrimaryKey resource_id )
		throws RemoteException, BuildingServerException;
        
	public String currentUserName()
		throws RemoteException, BuildingServerException;
		
	public String resourceTitle()
		throws RemoteException, BuildingServerException;
		
	public Vector childNames()
		throws RemoteException, BuildingServerException;

	public ResourceSummary getSummary()
		throws RemoteException, BuildingServerException;
		
	public ResourceSummary getRootSummary()
		throws RemoteException, BuildingServerException;
		
	public Vector childSummaries()
		throws RemoteException, BuildingServerException;

	public Vector childSummaries( PrimaryKey resource_id )
		throws RemoteException, BuildingServerException;
		
	public BuildingSession getSession()
		throws RemoteException, BuildingServerException;
	
	public PrimaryKey findResourceId( String[] names )
		throws RemoteException, BuildingServerException;

	public Resource findResource( PrimaryKey resource_id )
		throws RemoteException, BuildingServerException;
	
	public String getUserProperty( String name )
		throws RemoteException, BuildingServerException;
	
	public void setUserProperty( String name, String value )
		throws RemoteException, BuildingServerException;
	
	public String getUserPreferredStyleSheet()
		throws RemoteException, BuildingServerException;
	
	public void clearAuthenticationCredentials()
		throws RemoteException, BuildingServerException;
	
	public void setAuthenticationCredentials( Properties credentials, String authenticator_alias )
		throws RemoteException, BuildingServerException;
	
	public void setClientX509( X509Certificate cert )
		throws RemoteException, BuildingServerException;
	
	public boolean isAuthenticated()
		throws RemoteException, BuildingServerException;

	public boolean isAnonymous()
		throws RemoteException, BuildingServerException;

	public String getAuthenticationError()
		throws RemoteException, BuildingServerException;
	
	public PrimaryKey getAuthenticatedUserId()
		throws RemoteException, BuildingServerException;
	
	public User getAuthenticatedUser()
		throws RemoteException, BuildingServerException;
	
	public String getAuthenticatorAlias()
		throws RemoteException, BuildingServerException;
	}