oracle.ifs.beans

Class AccessControlListDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.AccessControlListDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ClassAccessControlListDefinition, SystemAccessControlListDefinition

public class AccessControlListDefinition
extends PublicObjectDefinition

The AccessControlListDefinition class is used to create or update an AccessControlList object. Most of the specifications can be set using the setAttribute() method inherited from LibraryObjectDefinition. The specifications that must be set with explicit methods on this class are:

• setShared - indication whether the new ACL can be shared between multiple PublicObjects. The default is set to true.
• addAceDefinition - adds an AccessControlEntryDefinition. The newly created/modified ACL will have the privilege granted/revoked as specified in the definition.

Associating a Category with an ACL is not supported so the setCategoryDefinition() method is overridden.

Version:

1.0

Author:

Dave Long

See Also:

AccessControlList, Serialized Form

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
AccessControlListDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
AccessControlListDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
void	addAceDefinition(AccessControlEntryDefinition def) Adds an AccessControlEntryDefinition to this object.
void	addAceDefinition(AttributeValueTable aceTable) Adds a new AccessControlEntryDefinition for an element specified in a table.
void	addAceDefinitions(AccessControlEntryDefinition[] defs) Adds a set of new AccessControlEntry definitions.
void	addAceDefinitions(List<AttributeValueTable> aceList) Adds a set of new AccessControlEntryDefinitions via a table list.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
AccessControlEntryDefinition[]	getAceDefinitions() returns all the ACE Definitions for this instance.
Boolean	isShared() Get the indication as to whether this ACL is a shared ACL.
void	removeAceDefinitions() Removes all ACE definition specifications from this instance.
void	setAceDefinitions(AccessControlEntryDefinition[] defs) Defines a set of new ACE Definitions.
void	setShared(boolean isShared) Set the indication as to whether this ACL is shared.

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessControlListDefinition

public AccessControlListDefinition(LibrarySessionInterface session)
                            throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be AccessControlList.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

AccessControlListDefinition

public AccessControlListDefinition(LibrarySessionInterface session,
                                   String className)
                            throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class PublicObjectDefinition

Parameters:

avt - the table having the definition settings

Throws:

IfsException - if the operation fails

(Published)

setShared

public void setShared(boolean isShared)
               throws IfsException

Set the indication as to whether this ACL is shared.

Parameters:

isShared - the indication as to whether this ACL is shared.

Throws:

IfsException - if operation fails .

(Published)

isShared

public Boolean isShared()
                 throws IfsException

Get the indication as to whether this ACL is a shared ACL. Return null if no indication was specified.

Returns:

isShared the indication as to whether this ACL is a shared ACL.

Throws:

IfsException - if operation fails.

(Published)

addAceDefinition

public void addAceDefinition(AttributeValueTable aceTable)
                      throws IfsException

Adds a new AccessControlEntryDefinition for an element specified in a table.

Parameters:

aceTable - the AccessControlEntry table

Throws:

IfsException - if the operation fails

(Published)

addAceDefinitions

public void addAceDefinitions(List<AttributeValueTable> aceList)
                       throws IfsException

Adds a set of new AccessControlEntryDefinitions via a table list.

Parameters:

aceList - the AccessControlEntry table list

Throws:

IfsException - if the operation fails

(Published)

addAceDefinition

public final void addAceDefinition(AccessControlEntryDefinition def)
                            throws IfsException

Adds an AccessControlEntryDefinition to this object. The AccessControlEntryDefinition can represent either a grant or revoke operation.

Parameters:

def - the AccessControlEntryDefinition of the new ACE

Throws:

IfsException - if the operation fails

See Also:

AccessControlEntryDefinition

(Published)

addAceDefinitions

public void addAceDefinitions(AccessControlEntryDefinition[] defs)
                       throws IfsException

Adds a set of new AccessControlEntry definitions. All specified AccessControlEntryDefinitions will be added to the current set of definitions held by this instance.

Parameters:

defs - the ACE definitions to be added for this instance

Throws:

IfsException

(Unpublished)

setAceDefinitions

public void setAceDefinitions(AccessControlEntryDefinition[] defs)
                       throws IfsException

Defines a set of new ACE Definitions. All previously specified AccessControlEntryDefinitions will be removed, prior to adding this set to the instance.

Parameters:

defs - the ACE definitions

Throws:

IfsException

(Unpublished)

removeAceDefinitions

public void removeAceDefinitions()
                          throws IfsException

Removes all ACE definition specifications from this instance.

Throws:

IfsException

(Unpublished)

getAceDefinitions

public AccessControlEntryDefinition[] getAceDefinitions()
                                                 throws IfsException

returns all the ACE Definitions for this instance. Return null if no ACE definitions have been specified.

Returns:

ACE Definitions for this instance.

Throws:

IfsException - if the operation fails

(Published)