com.goldencode.p2j.security

Class BitFlagsResource

java.lang.Object

com.goldencode.expr.Scope

com.goldencode.p2j.security.AbstractResource

com.goldencode.p2j.security.BitFlagsResource

All Implemented Interfaces:

BitFlagsConstants, Resource

Direct Known Subclasses:

ConcurrentResource, FileSystemResource

public abstract class BitFlagsResource
extends AbstractResource
implements BitFlagsConstants

Implements the "bitFlags" resource. This can be used to protect any resource whose rights 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
• 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 3 reserved bits. The last bit is for explicit denial of access. When printed, they are shown as CDRW...N.

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
private java.lang.String[]	extBits Extended bits, if any
private static CentralLogger	LOG Logger.

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
BitFlagsResource() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	accessWorker(java.lang.String name, int bit) Implements generalized access rights check worker.
boolean	canCreate(java.lang.String name) Reports if CREATE is allowed for the given resource name.
boolean	canDelete(java.lang.String name) Reports if DELETE is allowed for the given resource name.
boolean	canRead(java.lang.String name) Reports if READ is allowed for the given resource name.
boolean	canWrite(java.lang.String name) Reports if WRITE is allowed for the given resource name.
Description[]	describeRights() Returns an array of descriptions, one object per the plugin's access rights item.
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) Converts from the persistent form of the plugin's rights to the specific in-memory type.
abstract java.lang.String	getTypeName() Returns the plugin's resource type name as a string.
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

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

isInstanceNameValid

Field Detail

extBits

private java.lang.String[] extBits

Extended bits, if any

LOG

private static final CentralLogger LOG

Logger.

Constructor Detail

BitFlagsResource

public BitFlagsResource()

Constructor.

Method Detail

getTypeName

public abstract java.lang.String getTypeName()

Returns the plugin's resource type name as a string.

Specified by:

getTypeName in interface Resource

Returns:

The plugin's 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.

Returns:

See above.

describeRights

public final Description[] describeRights()

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

This plugin uses one field of type BitField with three bits: read, write end execute.

Specified by:

describeRights in interface Resource

Returns:

The descriptions, one per access rights item.

getRightsInstance

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

Converts from the persistent form of the plugin's rights to the specific in-memory type.

Specified by:

getRightsInstance in interface Resource

Parameters:

rights - An array of objects of proper types representing items in a set of access rights.

Returns:

The reference to the interface.

isRightsSetValid

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

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

This method returns true only if:

• DENIED bit is not set, or
• DENIED bit is set and no other bit is set.

Specified by:

isRightsSetValid in interface Resource

Parameters:

rights - An array of objects of proper types representing items in a set of access rights.

Returns:

true if the array is acceptable for an instance of access rights.

canCreate

public boolean canCreate(java.lang.String name)

Reports if CREATE is allowed for the given resource name.

Parameters:

name - Resource instance name.

Returns:

true if access is allowed.

canDelete

public boolean canDelete(java.lang.String name)

Reports if DELETE is allowed for the given resource name.

Parameters:

name - Resource instance name.

Returns:

true if access is allowed.

canRead

public boolean canRead(java.lang.String name)

Reports if READ is allowed for the given resource name.

Parameters:

name - Resource instance name.

Returns:

true if access is allowed.

canWrite

public boolean canWrite(java.lang.String name)

Reports if WRITE is allowed for the given resource name.

Parameters:

name - Resource instance name.

Returns:

true if access is allowed.

accessWorker

public boolean accessWorker(java.lang.String name,
                            int bit)

Implements generalized access rights check worker.

Parameters:

name - Resource instance name.

bit - The bit to check.

Returns:

true if access is allowed.