org.apache.jetspeed.services.security
Interface PortalAccessController

All Superinterfaces:
org.apache.turbine.services.Initable, org.apache.turbine.services.Service
All Known Implementing Classes:
NoSecurityAccessController, RegistryAccessController, TurbineAccessController

public interface PortalAccessController
extends org.apache.turbine.services.Service

The PortalAccessController interface defines a contract between the portal and security provider required for authorization to portal-secure areas. This interface enables an application to be independent of the underlying authorization technology.

Version:
$Id: PortalAccessController.java,v 1.4 2004/02/23 03:58:11 jford Exp $
Author:
David Sean Taylor

Field Summary
static java.lang.String SERVICE_NAME
           
 
Method Summary
 boolean checkPermission(JetspeedUser user, Entry entry, java.lang.String action)
          Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet Instance (Entry) resource.
 boolean checkPermission(JetspeedUser user, Entry entry, java.lang.String action, java.lang.String owner)
          Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet Instance (Entry) resource.
 boolean checkPermission(JetspeedUser user, PortalResource resource, java.lang.String action)
          Given a JetspeedUser, authorize that user to perform the secured action on the given resource.
 boolean checkPermission(JetspeedUser user, Portlet portlet, java.lang.String action)
          Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet resource.
 boolean checkPermission(JetspeedUser user, Portlet portlet, java.lang.String action, java.lang.String owner)
          Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet resource.
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
See Also:
Constant Field Values
Method Detail

checkPermission

public boolean checkPermission(JetspeedUser user,
                               Entry entry,
                               java.lang.String action)
Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet Instance (Entry) resource. If the user does not have sufficient privilege to perform the action on the resource, the check returns false, otherwise when sufficient privilege is present, checkPermission returns true.

Parameters:
user - the user to be checked.
entry - the portlet instance resource.
action - the secured action to be performed on the resource by the user.
Returns:
boolean true if the user has sufficient privilege.

checkPermission

public boolean checkPermission(JetspeedUser user,
                               Entry entry,
                               java.lang.String action,
                               java.lang.String owner)
Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet Instance (Entry) resource. If the user does not have sufficient privilege to perform the action on the resource, the check returns false, otherwise when sufficient privilege is present, checkPermission returns true.

Parameters:
user - the user to be checked.
entry - the portlet instance resource.
action - the secured action to be performed on the resource by the user.
owner - of the entry, i.e. the username
Returns:
boolean true if the user has sufficient privilege.

checkPermission

public boolean checkPermission(JetspeedUser user,
                               Portlet portlet,
                               java.lang.String action)
Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet resource. If the user does not have sufficient privilege to perform the action on the resource, the check returns false, otherwise when sufficient privilege is present, checkPermission returns true.

Parameters:
user - the user to be checked.
portlet - the portlet resource.
action - the secured action to be performed on the resource by the user.
Returns:
boolean true if the user has sufficient privilege.

checkPermission

public boolean checkPermission(JetspeedUser user,
                               Portlet portlet,
                               java.lang.String action,
                               java.lang.String owner)
Given a JetspeedUser, authorize that user to perform the secured action on the given Portlet resource. If the user does not have sufficient privilege to perform the action on the resource, the check returns false, otherwise when sufficient privilege is present, checkPermission returns true.

Parameters:
user - the user to be checked.
portlet - the portlet resource.
action - the secured action to be performed on the resource by the user.
owner - of the portlet, i.e. the username
Returns:
boolean true if the user has sufficient privilege.

checkPermission

public boolean checkPermission(JetspeedUser user,
                               PortalResource resource,
                               java.lang.String action)
Given a JetspeedUser, authorize that user to perform the secured action on the given resource. If the user does not have sufficient privilege to perform the action on the resource, the check returns false, otherwise when sufficient privilege is present, checkPermission returns true.

Parameters:
user - the user to be checked.
resource - requesting an action
action - the secured action to be performed on the resource by the user.
Returns:
boolean true if the user has sufficient privilege.


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.