com.goldencode.p2j.security

Class StringConditionResource

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.security.AbstractResource

com.goldencode.p2j.security.StringConditionResource

All Implemented Interfaces:

Resource

Direct Known Subclasses:

EntryPointResource, RemoteEntryPointResource, RemoteLaunchOptionResource, TrustedSpawnerResource, WebServiceResource

public class StringConditionResource
extends AbstractResource

Implements a resource that is protected by a single string that describes the condition for which to allow access. That condition is a matching expression (exact match or regex). This is meant to be a parent class where there is almost no code in the child.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger.

Fields inherited from class com.goldencode.p2j.security.AbstractResource

objectPointer, resourceIndex, sm

Constructor Summary

Constructors

Constructor and Description
StringConditionResource() Default constructor.

Method Summary

Modifier and Type	Method and Description
private boolean	checkSingle(StringConditionRights rights) Implements a worker that performs access rights check on a single instance of the StringConditionRights object.
Description[]	describeRights() Returns an array of descriptions, one object per the plugin's access rights item.
Rights	getRightsInstance(java.lang.Object[] rights) Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.
java.lang.String	getTypeName() Returns the plugin resource type name as a string.
boolean	isAllowed(java.lang.String instance) Implements generalized access rights check worker.
boolean	isInstanceNameValid(java.lang.String resource) Checks whether a given string is a valid resource name for this resource type.
boolean	isRightsSetValid(java.lang.Object[] rights) Checks whether a given array of objects representing a set of access rights fields is acceptable.

Methods inherited from class com.goldencode.p2j.security.AbstractResource

associate, attach, disassociate, getACLMatcher, getEnclosingScope, getLibrary, getLink, getPermissions, init, refresh, registeredAs, toString

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

Field Detail

LOG

private static final CentralLogger LOG

Logger.

Constructor Detail

StringConditionResource

public StringConditionResource()

Default constructor.

Method Detail

getTypeName

public java.lang.String getTypeName()

Returns the plugin resource type name as a string.

Returns:

The plugin resource type name.

describeRights

public Description[] describeRights()

Returns an array of descriptions, one object per the plugin's access rights item.

Returns:

An array of Description elements, one for each access rights item.

getRightsInstance

public Rights getRightsInstance(java.lang.Object[] rights)

Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.

Parameters:

rights - The objects needed to create an access rights instance.

Returns:

The newly created rights instance.

isInstanceNameValid

public boolean isInstanceNameValid(java.lang.String resource)

Checks whether a given string is a valid resource name for this resource type. This method only checks to ensure the resource is not null and it is a non- empty string. Override this to add conditions.

Parameters:

resource - A string naming a resource.

Returns:

true if the name is syntactically correct.

isRightsSetValid

public boolean isRightsSetValid(java.lang.Object[] rights)

Checks whether a given array of objects representing a set of access rights fields is acceptable.

Parameters:

rights - An array of objects of types representing items in a rights instance.

Returns:

true if the array is acceptable to create a rights instance.

isAllowed

public boolean isAllowed(java.lang.String instance)

Implements generalized access rights check worker.

Parameters:

instance - name of the particular instance of the abstract resource about to be accessed

Returns:

true if access is allowed.

checkSingle

private boolean checkSingle(StringConditionRights rights)

Implements a worker that performs access rights check on a single instance of the StringConditionRights object.

Parameters:

rights - The instance of StringConditionRights to check, must not be null.

Returns:

true if access is allowed.