oracle.ifs.beans

Class AccessControlEntry

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.AccessControlEntry

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieAccessControlEntry

public class AccessControlEntry
extends TieSystemObject

The AccessControlEntry (ACE) class represents an atomic unit of access control.

The basic parts of an ACE are:

• AccessControlList - the ACL that the ACE is part of
• Grantee - a grantee is the DirectoryObject (user or group) to which the privilege is to be granted or revoked.
• AccessLevel/PermissionBundle - represents the privilege being granted/revoked
• Granted - a boolean indicating if the privilege is being granted (true) or revoked (false)
• SortSequence - the order in which the access control will be resolved. Access is resolved in ascending order. For example, if the first ACE grants a group complete access to a PublicObject. Then the second ACE revokes specific privileges to distinct members of the group. The result would be some members having full privileges and others having restricted privileges. Had the order of the ACEs been reversed, the result would be the whole group having full privileges.

An ACE may be constructed either by using AccessLevel or PermissionBundles and can only exist in the context of referring to an AccessControlList.

Version:

1.0

Author:

Dave Long

See Also:

AccessControlList, AccessLevel, DirectoryObject

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESSLEVEL_ATTRIBUTE The level of the permission associated with this AccessControlEntry, e.g., Discover, Delete.
static String	ACL_ATTRIBUTE The AccessControlList to which this AccessControlEntry belongs.
static String	CLASS_NAME This class name for this class.
static String	EXTENDEDPERMISSIONS_ATTRIBUTE The extended permission levels created by a custom application which are associated with this AccessControlEntry.
static String	GRANTED_ATTRIBUTE An indicator of whether the AccessLevel is being granted or revoked by the AccessControlEntry.
static String	GRANTEE_ATTRIBUTE The DirectoryObject to which this AccessControlEntry is applied.
static String	PERMISSIONBUNDLES_ATTRIBUTE The PermissionBundles optionally used to set the permissions for this AccessControlEntry.
static String	SORTSEQUENCE_ATTRIBUTE The sort sequence of this AccessControlEntry in the AccessControlList.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AccessControlEntry(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a AccessControlEntry object.

Method Summary

Modifier and Type	Method and Description
protected static AccessControlEntry	constructAccessControlEntry(LibrarySession sess, S_LibraryObjectData data) Construct AccessControlEntry from a S_LibraryObjectData
protected static AccessControlEntry[]	constructAccessControlEntryArray(LibrarySession sess, Long[] ids) Construct a AccessControlEntry array from an array of object IDs.
protected static Vector	constructAccessControlEntryVector(LibrarySession sess, Vector vector) Construct a Vector of ACE from a Vector of S_LibraryObjectData.
AccessControlList	getAcl() Return the ACL object that contains this ACE.
AccessLevel	getDistinctAccessLevel() Returns the access level represented by this ACE without considering permission bundles.
ExtendedPermission[]	getExtendedPermissions() Returns extended permissions of this ACE.
DirectoryObject	getGrantee() Returns the directory object (grantee) that is associated with this ACE.
AccessLevel	getMergedAccessLevel() Returns the access level represented by this ACE including permission bundles.
PermissionBundle[]	getPermissionBundles() Returns all PermissionBundles that were used to define the set of permissions for this ACE.
long	getSortSequence() Returns the Sort Sequence represented by this ACE.
boolean	isGrant() Return indication as to whether this is a grant or a revoke ACE.
protected static AccessControlEntry	vectorAccessControlEntryElement(Vector vector, int index) Return a AccessControlEntry from a specified Vector of AccessControlEntrys and an index.
protected static AccessControlEntry[]	vectorToAccessControlEntryArray(Vector vector) Convert a Vector of AccessControlEntrys to an array of AccessControlEntrys.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, preFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

ACL_ATTRIBUTE

public static final String ACL_ATTRIBUTE

The AccessControlList to which this AccessControlEntry belongs.

See Also:

Constant Field Values

(Published)

GRANTEE_ATTRIBUTE

public static final String GRANTEE_ATTRIBUTE

The DirectoryObject to which this AccessControlEntry is applied.

See Also:

Constant Field Values

(Published)

ACCESSLEVEL_ATTRIBUTE

public static final String ACCESSLEVEL_ATTRIBUTE

The level of the permission associated with this AccessControlEntry, e.g., Discover, Delete.

See Also:

Constant Field Values

(Published)

EXTENDEDPERMISSIONS_ATTRIBUTE

public static final String EXTENDEDPERMISSIONS_ATTRIBUTE

The extended permission levels created by a custom application which are associated with this AccessControlEntry.

See Also:

Constant Field Values

(Published)

GRANTED_ATTRIBUTE

public static final String GRANTED_ATTRIBUTE

An indicator of whether the AccessLevel is being granted or revoked by the AccessControlEntry.

See Also:

Constant Field Values

(Published)

SORTSEQUENCE_ATTRIBUTE

public static final String SORTSEQUENCE_ATTRIBUTE

The sort sequence of this AccessControlEntry in the AccessControlList.

See Also:

Constant Field Values

(Published)

PERMISSIONBUNDLES_ATTRIBUTE

public static final String PERMISSIONBUNDLES_ATTRIBUTE

The PermissionBundles optionally used to set the permissions for this AccessControlEntry.

See Also:

Constant Field Values

(Published)

Constructor Detail

AccessControlEntry

protected AccessControlEntry(LibrarySession session,
                             Long id,
                             Long classId,
                             S_LibraryObjectData data)
                      throws IfsException

Construct a AccessControlEntry object.

Parameters:

session - current Session

id - object ID

classId - the class ID

data - Data associated with the object.

Throws:

IfsException - if operation fails.

(Unpublished)

Method Detail

getAcl

public AccessControlList getAcl()
                         throws IfsException

Return the ACL object that contains this ACE.

Returns:

the ACL object that contains this ACE

Throws:

IfsException - if operation fails.

(Published)

getGrantee

public DirectoryObject getGrantee()
                           throws IfsException

Returns the directory object (grantee) that is associated with this ACE.

Returns:

the grantee for this ACE

Throws:

IfsException - if operation fails.

(Published)

getDistinctAccessLevel

public AccessLevel getDistinctAccessLevel()
                                   throws IfsException

Returns the access level represented by this ACE without considering permission bundles.

Returns:

the access level represented by this ACE.

Throws:

IfsException - if operation fails.

(Published)

getMergedAccessLevel

public AccessLevel getMergedAccessLevel()
                                 throws IfsException

Returns the access level represented by this ACE including permission bundles.

Returns:

the access level represented by this ACE including permission bundles

Throws:

IfsException - if operation fails.

(Published)

getExtendedPermissions

public ExtendedPermission[] getExtendedPermissions()
                                            throws IfsException

Returns extended permissions of this ACE.

Returns:

an array of extended permissions.

Throws:

IfsException - if operation fails.

(Published)

getPermissionBundles

public PermissionBundle[] getPermissionBundles()
                                        throws IfsException

Returns all PermissionBundles that were used to define the set of permissions for this ACE. If the permissions were set explicitly using access levels, returns null.

Returns:

array of permission bundles.

Throws:

IfsException - if operation fails.

(Published)

getSortSequence

public long getSortSequence()
                     throws IfsException

Returns the Sort Sequence represented by this ACE. Sort sequnce determines the position of ACE within an ACL and used in determining the order of ACEs to evaluate effective permissions defined by an ACL.

Returns:

the sort sequence represented by this ACE.

Throws:

IfsException - if operation fails.

(Published)

isGrant

public boolean isGrant()
                throws IfsException

Return indication as to whether this is a grant or a revoke ACE.

Returns:

true if this ACE represents a grant operation, or false otherwise

Throws:

IfsException - if operation fails.

(Unpublished)

constructAccessControlEntryVector

protected static Vector constructAccessControlEntryVector(LibrarySession sess,
                                                          Vector vector)
                                                   throws IfsException

Construct a Vector of ACE from a Vector of S_LibraryObjectData.

Parameters:

sess - the Session

vector - a Vector of S_LibraryObjectData

Returns:

the Vector of AccessControlEntry objects.

Throws:

IfsException - if operation fails.

(Unpublished)

constructAccessControlEntry

protected static AccessControlEntry constructAccessControlEntry(LibrarySession sess,
                                                                S_LibraryObjectData data)
                                                         throws IfsException

Construct AccessControlEntry from a S_LibraryObjectData

Parameters:

sess - the Session

data - the S_LibraryObejctData

Returns:

the ACE object

Throws:

IfsException - if operation fails.

(Unpublished)

constructAccessControlEntryArray

protected static AccessControlEntry[] constructAccessControlEntryArray(LibrarySession sess,
                                                                       Long[] ids)
                                                                throws IfsException

Construct a AccessControlEntry array from an array of object IDs. This will throw an exception if any of the IDs cannot be converted into a AccessControlentry object.

Parameters:

sess - the requesting session

ids - the array of object IDs

Returns:

the array of ace's

Throws:

IfsException - if operation fails.

(Unpublished)

vectorToAccessControlEntryArray

protected static AccessControlEntry[] vectorToAccessControlEntryArray(Vector vector)

Convert a Vector of AccessControlEntrys to an array of AccessControlEntrys.

Parameters:

vector - A Vector containing AccessControlEntrys.

Returns:

an array of AccessControlEntrys.

(Unpublished)

vectorAccessControlEntryElement

protected static AccessControlEntry vectorAccessControlEntryElement(Vector vector,
                                                                    int index)
                                                             throws IndexOutOfBoundsException

Return a AccessControlEntry from a specified Vector of AccessControlEntrys and an index.

Parameters:

vector - a Vector containing AccessControlEntrys.

index - an index into the Vector of AccessControlEntrys.

Returns:

the requested AccessControlEntry.

Throws:

IndexOutOfBoundsException - if index is invalid.

(Unpublished)