org.jboss.security.acl
Class ACLContext

java.lang.Object
  org.jboss.security.acl.ACLContext

public abstract class ACLContext
extends java.lang.Object

Represents a set of ACLProviders

Since:

Jan 30, 2008

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

Field Summary

protected java.util.List<ControlFlag>	controlFlags Control Flags for the individual modules
protected java.util.List<ACLProvider>	modules
protected java.lang.String	securityDomainName
protected java.util.Map<java.lang.String,java.lang.Object>	sharedState

Constructor Summary

ACLContext()

Method Summary

abstract int	authorize(Resource resource, Identity identity, Permission permission) Authorize access to the resource if the specified identity has the proper permissions.
abstract <T> EntitlementHolder<T>	getEntitlements(java.lang.Class<T> clazz, Resource resource, Identity identity) Instance Based Security Get all the entitlements assigned to the components of a Resource
java.lang.String	getSecurityDomain() Return the Security Domain Name

Methods inherited from class java.lang.Object

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

Field Detail

securityDomainName

protected java.lang.String securityDomainName

sharedState

protected java.util.Map<java.lang.String,java.lang.Object> sharedState

modules

protected java.util.List<ACLProvider> modules

controlFlags

protected java.util.List<ControlFlag> controlFlags

Control Flags for the individual modules

Constructor Detail

ACLContext

public ACLContext()

Method Detail

getEntitlements

public abstract <T> EntitlementHolder<T> getEntitlements(java.lang.Class<T> clazz,
                                                         Resource resource,
                                                         Identity identity)
                                              throws AuthorizationException

Instance Based Security Get all the entitlements assigned to the components of a Resource

Parameters:

clazz - class type of the entitlements

resource - A Resource (Can be a Portal Resource, a Rules Resource)

identity - The Identity against whom the entitlements need to be generated

Returns:

a Entitlements Wrapper

Throws:

AuthorizationException

authorize

public abstract int authorize(Resource resource,
                              Identity identity,
                              Permission permission)
                       throws AuthorizationException

Authorize access to the resource if the specified identity has the proper permissions.

Parameters:

resource - the Resource being accessed.

identity - the Identity trying to access the resource.

permission - the permissions required for access to be granted.

Returns:

AuthorizationContext#PERMIT if access has been granted; AuthorizationContext#DENY otherwise.

Throws:

AuthorizationException - if an error occurs while authorizing access to the resource.

getSecurityDomain

public java.lang.String getSecurityDomain()

Return the Security Domain Name

Returns:

security domain