com.goldencode.p2j.security

Class FileSystemResource

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.security.AbstractResource

com.goldencode.p2j.security.BitFlagsResource

com.goldencode.p2j.security.FileSystemResource

All Implemented Interfaces:

BitFlagsConstants, Resource

public class FileSystemResource
extends BitFlagsResource

Implements the "FileSystemResource" resource. Access to such resources have rights which can be represented by a small set of flags:

• create - a runtime instance of the resource can be created
• delete - an existing runtime instance can be destroyed
• read - the state or data associated with an existing runtime instance can be accessed
• write - the state or data associated with an existing runtime instance can be modified
• execute - the runtime instance can be executed
• denied - no access is allowed (overrides any other access flags)

Rights objects for this resource are made of one bitfield with 8 bits. The first four bits correspond to the create, delete, read and write respectively. There are 2 reserved bits. The last bit is for explicit denial of access. When printed, they are shown as CDRWE

Resource names will be namespaced using the subclass' resource type name. The naming approach is /resource_type_name/instance_name. Each different instance of a particular resource type will share the same type name but must have a unique, non-empty instance name.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIT_EXECUTE_ACCESS EXECUTE permissions bit for the bitflags resource.
private static CentralLogger	LOG Logger
static java.lang.String	TYPE_NAME Resource type name

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

objectPointer, resourceIndex, sm

Fields inherited from interface com.goldencode.p2j.security.BitFlagsConstants

BIT_CREATE_ACCESS, BIT_DELETE_ACCESS, BIT_DENIED_ACCESS, BIT_READ_ACCESS, BIT_WRITE_ACCESS, BITSET_SIZE

Constructor Summary

Constructors

Constructor and Description
FileSystemResource()

Method Summary

Modifier and Type	Method and Description
boolean	canExecute(java.lang.String name) Reports if EXECUTE is allowed for the given resource name.
java.util.function.BiPredicate<AccessControlList,java.lang.String>	getACLMatcher() Returns a bi-predicate allowing to match ACLs based on a supplied resource instance name.
java.lang.String[]	getExtendedBits() Override the method to provide extended bit names to augment the default set of bits.
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	isInstanceNameValid(java.lang.String resource) Checks whether a given string is a syntactically valid resource name for this resource type.

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

accessWorker, canCreate, canDelete, canRead, canWrite, describeRights, isRightsSetValid

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

associate, attach, disassociate, 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 CentralLogger LOG

Logger

BIT_EXECUTE_ACCESS

public static final int BIT_EXECUTE_ACCESS

EXECUTE permissions bit for the bitflags resource.

See Also:

Constant Field Values

TYPE_NAME

public static final java.lang.String TYPE_NAME

Resource type name

See Also:

Constant Field Values

Constructor Detail

FileSystemResource

public FileSystemResource()

Method Detail

getTypeName

public java.lang.String getTypeName()

Returns the plugin resource type name as a string.

Specified by:

getTypeName in interface Resource

Specified by:

getTypeName in class BitFlagsResource

Returns:

plugin resource type name

getExtendedBits

public java.lang.String[] getExtendedBits()

Override the method to provide extended bit names to augment the default set of bits. The method must return either null for no extended bits or an array of length 1, 2, 3. An array of length 1 will carry name of bit 4, length 2 bits 4 and 5, and length 3 bits 4, 5 and 6.

Overrides:

getExtendedBits in class BitFlagsResource

Returns:

See above.

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.

Specified by:

getRightsInstance in interface Resource

Overrides:

getRightsInstance in class BitFlagsResource

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 syntactically valid resource name for this resource type.

Parameters:

resource - string naming a resource

Returns:

true if the name is syntactically correct

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.

Overrides:

getACLMatcher in class AbstractResource

Returns:

A valid bi-predicate.

canExecute

public boolean canExecute(java.lang.String name)

Reports if EXECUTE is allowed for the given resource name.

Parameters:

name - Resource instance name.

Returns:

true if access is allowed.