com.goldencode.p2j.security

Class AbstractResource

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.security.AbstractResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

AdminResource, BitFlagsResource, DirectoryResource, NetResource, StringConditionResource, SystemResource

public abstract class AbstractResource
extends Scope
implements Resource

This abstract class partially implements the Resource interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.ThreadLocal<java.lang.Object>	objectPointer per thread reference to the Rights context
protected int	resourceIndex resource index assigned during resource registration
protected SecurityManager	sm reference to the attached instance of SecurityManager

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Modifier and Type	Method and Description
void	associate(java.lang.Object link) Stores the reference to the passed Rights object into a thread local storage temporarily for the use in the library methods during the expression evaluation.
void	attach(SecurityManager sm) Notifies the plugin about the instance of the Security Manager to communicate with.
void	disassociate() Nullifies the reference to the Rights object in the thread local storage.
java.util.function.BiPredicate<AccessControlList,java.lang.String>	getACLMatcher() Returns a bi-predicate allowing to match ACLs based on a supplied resource instance name.
Scope	getEnclosingScope() Gets the parent scope for this scope.
java.lang.Object	getLibrary() Returns the plugin's exported variables and functions.
protected java.lang.Object	getLink() Returns the reference to the currently associated link object.
Rights	getPermissions(java.lang.String subject, java.lang.String instanceName) The method is responsible for computing the permissions for the given instance name; the permissions are the ones valid for the specified subject ID.
void	init() Gives chance to the plugin to initialize when all accounts are created.
void	refresh(AdminAccountExtension ext) Refresh request to plugin.
void	registeredAs(int resourceIndex) Notifies the plugin that the resource type has been assigned a numeric value.
java.lang.String	toString() Returns the string representation of this plugin.

Methods inherited from class com.goldencode.expr.Scope

getLibraries, getLibraryClasses, getLibsByClass, getVariableList, getVariables

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.security.Resource

describeRights, getRightsInstance, getTypeName, isInstanceNameValid, isRightsSetValid

Field Detail

objectPointer

protected static java.lang.ThreadLocal<java.lang.Object> objectPointer

per thread reference to the Rights context

sm

protected SecurityManager sm

reference to the attached instance of SecurityManager

resourceIndex

protected int resourceIndex

resource index assigned during resource registration

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

attach

public final void attach(SecurityManager sm)

Notifies the plugin about the instance of the Security Manager to communicate with.

Specified by:

attach in interface Resource

Parameters:

sm - specifies an instance of SecurityManager this plugin should communicate with

init

public void init()

Gives chance to the plugin to initialize when all accounts are created. This method should be overridden by resource plugin, if init is required.

Specified by:

init in interface Resource

registeredAs

public final void registeredAs(int resourceIndex)

Notifies the plugin that the resource type has been assigned a numeric value.

Specified by:

registeredAs in interface Resource

Parameters:

resourceIndex - specifies the registration number for the resource

getACLMatcher

public java.util.function.BiPredicate<AccessControlList,java.lang.String> getACLMatcher()

Returns a bi-predicate allowing to match ACLs based on a supplied resource instance name. The plugin may choose not to provide its own matcher, in which case the method should return null.

Returns:

A bi-predicate or null.

toString

public java.lang.String toString()

Returns the string representation of this plugin.

Overrides:

toString in class java.lang.Object

Returns:

string describing this plugin

getEnclosingScope

public final Scope getEnclosingScope()

Gets the parent scope for this scope. Plugins always have SecurityManager as the parent scope.

Specified by:

getEnclosingScope in class Scope

Returns:

parent Scope object, which is SecurityManager

getLibrary

public java.lang.Object getLibrary()

Returns the plugin's exported variables and functions.

This implementation exports no library. Plugins that require exported variables should override this method.

Specified by:

getLibrary in interface Resource

Returns:

plugin's instance of a library class for symbol resolution or null if there is nothing to export

associate

public final void associate(java.lang.Object link)

Stores the reference to the passed Rights object into a thread local storage temporarily for the use in the library methods during the expression evaluation.

Parameters:

link - reference to an arbitrary Object that serves as a data sharing link for the expression evaluation.

disassociate

public final void disassociate()

Nullifies the reference to the Rights object in the thread local storage.

getLink

protected final java.lang.Object getLink()

Returns the reference to the currently associated link object.

Returns:

See above.

getPermissions

public Rights getPermissions(java.lang.String subject,
                             java.lang.String instanceName)

The method is responsible for computing the permissions for the given instance name; the permissions are the ones valid for the specified subject ID.

Parameters:

subject - The subject ID for which the permissions needs to be computed.

instanceName - The instance name for which the permissions are checked.

Returns:

The permissions for the given instance name, valid for the specified subject ID.

refresh

public void refresh(AdminAccountExtension ext)

Refresh request to plugin.

Parameters:

ext - A valid instance of the admin plugin.