Mercurial > hg > digilib-old
view servlet/src/digilib/auth/AuthOps.java @ 72:300d5ba8b33b
New servlet version 1.5b.
Mostly cleanup. Global parameters for digilib now in DigilibConfiguration,
per request parameters are now all in DigilibRequest. The DocuImage implementation
can be selected by the configuration docuimage-class.
Pixel-by-pixel view implemented with "mo=clip".
author | robcast |
---|---|
date | Fri, 24 Jan 2003 21:40:59 +0100 |
parents | 0ff3ede32060 |
children | e758a49258e8 |
line wrap: on
line source
/* AuthOps -- Authentication interface class Digital Image Library servlet components Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de) 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. Please read license.txt for the full details. A copy of the GPL may be found at http://www.gnu.org/copyleft/lgpl.html 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 digilib.auth; import java.util.List; import javax.servlet.http.HttpServletRequest; import digilib.servlet.DigilibRequest; /** Class of operations requiring authentication. */ public interface AuthOps { /** Test if the request must be authorized to access the filepath. * * Information about the user is taken from the ServletRequest. * @param filepath filepath to be accessed. * @param request ServletRequest with user information. * @throws AuthOpException Exception thrown on error. * @return true if the user request must be authorized. */ public boolean isAuthRequired(String filepath, HttpServletRequest request) throws AuthOpException; /** Test if the request must be authorized to access the filepath. * * Information about the user is taken from the DigilibRequest. * @param request DigilibRequest with user information. * @throws AuthOpException Exception thrown on error. * @return true if the user request must be authorized. */ public boolean isAuthRequired(DigilibRequest request) throws AuthOpException; /** Test if the request is allowed to access filepath. * * @param filepath filepath to be acessed. * @param request Request with user information. * @throws AuthOpException Exception thrown on error. * @return true if the request is allowed. */ public boolean isAuthorized(String filepath, HttpServletRequest request) throws AuthOpException; /** Test if the request is allowed to access filepath. * * @param request Request with user information. * @throws AuthOpException Exception thrown on error. * @return true if the request is allowed. */ public boolean isAuthorized(DigilibRequest request) throws AuthOpException; /** Authorization roles needed for request. * * Returns the list of authorization roles that are needed to access the * specified path. No list means the path is free. * * The location information of the request is also considered. * * @param filepath filepath to be accessed. * @param request ServletRequest with address information. * @throws AuthOpException Exception thrown on error. * @return List of Strings with role names. */ public List rolesForPath(String filepath, HttpServletRequest request) throws AuthOpException; /** Authorization roles needed for request. * * Returns the list of authorization roles that are needed to access the * specified path. No list means the path is free. * * The location information of the request is also considered. * * @param request DigilibRequest with address information. * @throws AuthOpException Exception thrown on error. * @return List of Strings with role names. */ public List rolesForPath(DigilibRequest request) throws AuthOpException; /** Test request authorization against a list of roles. * @param roles List of Strings with role names. * @param request ServletRequest with address information. * @return true if the user information in the request authorizes one of the roles. */ public boolean isRoleAuthorized(List roles, HttpServletRequest request); /** Test request authorization against a list of roles. * @param roles List of Strings with role names. * @param request ServletRequest with address information. * @return true if the user information in the request authorizes one of the roles. */ public boolean isRoleAuthorized(List roles, DigilibRequest request); }