org.apache.jetspeed.services.security.turbine
Class TurbineAccessController

java.lang.Object
  org.apache.turbine.services.BaseInitable
      org.apache.turbine.services.BaseService
          org.apache.turbine.services.TurbineBaseService
              org.apache.jetspeed.services.security.turbine.TurbineAccessController

All Implemented Interfaces:

org.apache.turbine.services.Initable, PortalAccessController, org.apache.turbine.services.Service

public class TurbineAccessController

extends org.apache.turbine.services.TurbineBaseService

implements PortalAccessController

TurbineAccessController

Version:

$Id: TurbineAccessController.java,v 1.8 2004/02/23 03:54:49 jford Exp $

Author:

Paul Spencer

Field Summary

Fields inherited from class org.apache.turbine.services.BaseService

configuration, name, properties, serviceBroker

Fields inherited from class org.apache.turbine.services.BaseInitable

initableBroker, isInitialized

Fields inherited from interface org.apache.jetspeed.services.security.PortalAccessController

SERVICE_NAME

Constructor Summary

TurbineAccessController()

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.
void	init(javax.servlet.ServletConfig conf) This is the early initialization method called by the Turbine Service framework

Methods inherited from class org.apache.turbine.services.TurbineBaseService

init, init, init, shutdown

Methods inherited from class org.apache.turbine.services.BaseService

getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker

Methods inherited from class org.apache.turbine.services.BaseInitable

getInit, getInitableBroker, setInit, setInitableBroker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

TurbineAccessController

public TurbineAccessController()

Method Detail

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.

Specified by:

checkPermission in interface PortalAccessController

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.

Specified by:

checkPermission in interface PortalAccessController

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 entry, i.e. the username

Returns:

boolean true if the user has sufficient privilege.

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.

Specified by:

checkPermission in interface PortalAccessController

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.

Specified by:

checkPermission in interface PortalAccessController

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,
                               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.

Specified by:

checkPermission in interface PortalAccessController

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.

init

public void init(javax.servlet.ServletConfig conf)
          throws org.apache.turbine.services.InitializationException

This is the early initialization method called by the Turbine Service framework

Parameters:

conf - The ServletConfig

Throws:

throws - a InitializationException if the service fails to initialize

org.apache.turbine.services.InitializationException