Package org.apache.sling.resourceaccesssecurity

Class AllowingResourceAccessGate

java.lang.Object

org.apache.sling.resourceaccesssecurity.AllowingResourceAccessGate

All Implemented Interfaces:

ResourceAccessGate

public abstract class AllowingResourceAccessGate
extends java.lang.Object
implements ResourceAccessGate

This abstract implementation of the ResourceAccessGate can be used to implement own resource access gates. This implementation simply allows operations, restricting implementations just need to overwrite the operations they want to restrict.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sling.resourceaccesssecurity.ResourceAccessGate

ResourceAccessGate.GateResult, ResourceAccessGate.Operation

Field Summary

Fields inherited from interface org.apache.sling.resourceaccesssecurity.ResourceAccessGate

APPLICATION_CONTEXT, CONTEXT, FINALOPERATIONS, OPERATIONS, PATH, PROVIDER_CONTEXT, SERVICE_NAME

Constructor Summary

Constructors

Constructor	Description
AllowingResourceAccessGate()

Method Summary

Modifier and Type	Method	Description
ResourceAccessGate.GateResult	canCreate(java.lang.String absPathName, ResourceResolver resourceResolver)
boolean	canCreateAllValues(Resource resource)
ResourceAccessGate.GateResult	canCreateValue(Resource resource, java.lang.String valueName)
ResourceAccessGate.GateResult	canDelete(Resource resource)
boolean	canDeleteAllValues(Resource resource)
ResourceAccessGate.GateResult	canDeleteValue(Resource resource, java.lang.String valueName)
ResourceAccessGate.GateResult	canExecute(Resource resource)
ResourceAccessGate.GateResult	canOrderChildren(Resource resource)
ResourceAccessGate.GateResult	canRead(Resource resource)
boolean	canReadAllValues(Resource resource)
ResourceAccessGate.GateResult	canReadValue(Resource resource, java.lang.String valueName)
ResourceAccessGate.GateResult	canUpdate(Resource resource)
boolean	canUpdateAllValues(Resource resource)
ResourceAccessGate.GateResult	canUpdateValue(Resource resource, java.lang.String valueName)
boolean	hasCreateRestrictions(ResourceResolver resourceResolver)
boolean	hasDeleteRestrictions(ResourceResolver resourceResolver)
boolean	hasExecuteRestrictions(ResourceResolver resourceResolver)
boolean	hasOrderChildrenRestrictions(ResourceResolver resourceResolver)
boolean	hasReadRestrictions(ResourceResolver resourceResolver)
boolean	hasUpdateRestrictions(ResourceResolver resourceResolver)
java.lang.String	transformQuery(java.lang.String query, java.lang.String language, ResourceResolver resourceResolver)	Allows to transform the query based on the current user's credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllowingResourceAccessGate

public AllowingResourceAccessGate()

Method Detail

canRead

public ResourceAccessGate.GateResult canRead(Resource resource)

Specified by:

canRead in interface ResourceAccessGate

canCreate

public ResourceAccessGate.GateResult canCreate(java.lang.String absPathName,
                                               ResourceResolver resourceResolver)

Specified by:

canCreate in interface ResourceAccessGate

canOrderChildren

public ResourceAccessGate.GateResult canOrderChildren(Resource resource)

Specified by:

canOrderChildren in interface ResourceAccessGate

canUpdate

public ResourceAccessGate.GateResult canUpdate(Resource resource)

Specified by:

canUpdate in interface ResourceAccessGate

canDelete

public ResourceAccessGate.GateResult canDelete(Resource resource)

Specified by:

canDelete in interface ResourceAccessGate

canExecute

public ResourceAccessGate.GateResult canExecute(Resource resource)

Specified by:

canExecute in interface ResourceAccessGate

canReadValue

public ResourceAccessGate.GateResult canReadValue(Resource resource,
                                                  java.lang.String valueName)

Specified by:

canReadValue in interface ResourceAccessGate

canCreateValue

public ResourceAccessGate.GateResult canCreateValue(Resource resource,
                                                    java.lang.String valueName)

Specified by:

canCreateValue in interface ResourceAccessGate

canUpdateValue

public ResourceAccessGate.GateResult canUpdateValue(Resource resource,
                                                    java.lang.String valueName)

Specified by:

canUpdateValue in interface ResourceAccessGate

canDeleteValue

public ResourceAccessGate.GateResult canDeleteValue(Resource resource,
                                                    java.lang.String valueName)

Specified by:

canDeleteValue in interface ResourceAccessGate

transformQuery

public java.lang.String transformQuery(java.lang.String query,
                                       java.lang.String language,
                                       ResourceResolver resourceResolver)
                                throws AccessSecurityException

Description copied from interface: ResourceAccessGate

Allows to transform the query based on the current user's credentials. Can be used to narrow down queries to omit results that the current user is not allowed to see anyway, speeding up downstream access control. Query transformations are not critical with respect to access control as results are checked using the canRead.. methods anyway.

Specified by:

transformQuery in interface ResourceAccessGate

Parameters:

query - the query

language - the language in which the query is expressed

resourceResolver - the resource resolver which resolves the query

Returns:

the transformed query or the original query if no tranformation took place. This method should never return null

Throws:

AccessSecurityException

hasReadRestrictions

public boolean hasReadRestrictions(ResourceResolver resourceResolver)

Specified by:

hasReadRestrictions in interface ResourceAccessGate

hasCreateRestrictions

public boolean hasCreateRestrictions(ResourceResolver resourceResolver)

Specified by:

hasCreateRestrictions in interface ResourceAccessGate

hasOrderChildrenRestrictions

public boolean hasOrderChildrenRestrictions(ResourceResolver resourceResolver)

Specified by:

hasOrderChildrenRestrictions in interface ResourceAccessGate

hasUpdateRestrictions

public boolean hasUpdateRestrictions(ResourceResolver resourceResolver)

Specified by:

hasUpdateRestrictions in interface ResourceAccessGate

hasDeleteRestrictions

public boolean hasDeleteRestrictions(ResourceResolver resourceResolver)

Specified by:

hasDeleteRestrictions in interface ResourceAccessGate

hasExecuteRestrictions

public boolean hasExecuteRestrictions(ResourceResolver resourceResolver)

Specified by:

hasExecuteRestrictions in interface ResourceAccessGate

canReadAllValues

public boolean canReadAllValues(Resource resource)

Specified by:

canReadAllValues in interface ResourceAccessGate

canCreateAllValues

public boolean canCreateAllValues(Resource resource)

Specified by:

canCreateAllValues in interface ResourceAccessGate

canUpdateAllValues

public boolean canUpdateAllValues(Resource resource)

Specified by:

canUpdateAllValues in interface ResourceAccessGate

canDeleteAllValues

public boolean canDeleteAllValues(Resource resource)

Specified by:

canDeleteAllValues in interface ResourceAccessGate