Oracle Content Management SDK: Class AccessControlListDefinition

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Content Management SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ifs.beans
Class AccessControlListDefinition

java.lang.Object
  |
  +--oracle.ifs.beans.LibraryObjectDefinition
        |
        +--oracle.ifs.beans.PublicObjectDefinition
              |
              +--oracle.ifs.beans.AccessControlListDefinition

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.

See Also:: AccessControlList

Constructor Summary

AccessControlListDefinition(LibrarySession session)
          Constructs a AccessControlListDefinition explicitly capturing the session.

Method Summary

void addAceDefinition(AccessControlEntryDefinition definition)
          Adds an AccessControlEntryDefinition to this object.

void addCategoryDefinition(CategoryDefinition def)
          Set the Category definition for the new PublicObject.

java.lang.Boolean isShared()
          Get the indication as to whether this ACL is a shared ACL.

void setShared(boolean isShared)
          Set the indication as to whether this ACL is shared.

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

getAddToFolderOption, getCategoryDefinitions, getContentQuotaCopyOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockForSessionOption, getSecuringPublicObject, getUnlockForSessionOption, setAddToFolderOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockForSessionOption, setSecuringPublicObject, setUnlockForSessionOption

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

clone, getAttribute, getAttributes, getClassObject, getOption, getOptionKeys, removeAttribute, removeOption, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributes, setClassObject, setOption

Constructor Detail

AccessControlListDefinition

public AccessControlListDefinition(LibrarySession session)
                            throws IfsException

Constructs a AccessControlListDefinition explicitly capturing the session. The class name is initialized to ACCESSCONTROLLIST.

Parameters:: session - the session
Throws:: IfsException - if the operation fails

Method Detail

addCategoryDefinition

public void addCategoryDefinition(CategoryDefinition def)
                           throws IfsException

Set the Category definition for the new PublicObject. This is overriden to force throwing IfsException 10203, as ACL objects do not themselves have categories.

Overrides:: addCategoryDefinition in class PublicObjectDefinition

Parameters:: def - the Category definition for the new Category.
Throws:: IfsException - if operation fails.

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 .

isShared

public java.lang.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.

addAceDefinition

public final void addAceDefinition(AccessControlEntryDefinition definition)
                            throws IfsException

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

Parameters:: definition - the AccessControlEntryDefinition of the new ACE
Throws:: IfsException - if the operation fails
See Also:: AccessControlEntryDefinition