oracle.ifs.server
Class S_AccessControlList

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryObject
        |
        +--oracle.ifs.server.S_TieLibraryObject
              |
              +--oracle.ifs.server.S_PublicObject
                    |
                    +--oracle.ifs.server.S_TiePublicObject
                          |
                          +--oracle.ifs.server.S_AccessControlList

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:

S_TieAccessControlList

public class S_AccessControlList

extends S_TiePublicObject

Server side representation of the AccessControlList class.

See Also:

S_LibraryService, S_LibrarySession

Method Summary

protected void	deriveDefinition(S_LibraryObjectDefinition def) Add to the S_LibraryObjectDefinition for this class.
protected void	extendedPostUpdate(OperationState opState, S_LibraryObjectDefinition def) extended operations to be performed after updating an object.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition def) Updates any system attributes appropriate for creating this object; in this case, set the is_shared attribute to true if it is not set explicitly.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition def) Update any system attributes appropriate for updating this ACL
S_AccessControlEntry[]	getAccessControlEntrys() Returns the set of S_AccessControlEntry objects associated with this ACL.
S_AccessControlList[]	getComponentAcls() Returns all AccessControlLists that are components of the target ACL.
S_AccessControlList[]	getCompositeAcls() Gets the set of composite ACLs which reference the target ACL as a "component".
AccessLevel	getGrantedAccessLevel() Returns the access level for the current user.
AccessLevel	getGrantedAccessLevel(S_DirectoryUser user) Returns the access level for the specified user.
boolean	isAccessLevelEnabled(AccessLevel level) Checks if a specified set of permissions is enabled for the current user.
boolean	isComposite() Returns indication as to whether the target ACL is considered a "composite ACL", that is if it has one of more component ACLs.
void	verifyAccessLevelEnabled(AccessLevel level) Verifies if a specified set of permissions is enabled for the current user.

Methods inherited from class oracle.ifs.server.S_PublicObject

addRelationship, checkAccess, extendedPreFree, getCategories, getCategories, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getReferencingFolders, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getVersionDescriptions, hasNameAttribute, isLocked, isVersionable, removeRelationship, verifyCanUseContentQuota

Methods inherited from class oracle.ifs.server.S_LibraryObject

equals, free, getAttribute, getAttributeByUpperCaseName, getClassId, getClassObject, getId, getSession, handleEvent, isTraced, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Method Detail

getComponentAcls

public S_AccessControlList[] getComponentAcls()
                                       throws IfsException

Returns all AccessControlLists that are components of the target ACL. If there are one or more component ACLs, the target ACL is considered a "composite ACL". If the target ACL is not a composite ACL, this method returns null.

Returns:

the set of component AccessControlLists

Throws:

IfsException - if operation fails.

isComposite

public boolean isComposite()
                    throws IfsException

Returns indication as to whether the target ACL is considered a "composite ACL", that is if it has one of more component ACLs.

Returns:

true if the target ACL is a composite ACL

Throws:

IfsException - if operation fails.

getCompositeAcls

public S_AccessControlList[] getCompositeAcls()
                                       throws IfsException

Gets the set of composite ACLs which reference the target ACL as a "component".

Returns:

the set of composite ACLs that include the target ACL as a component

Throws:

IfsException - if operation fails.

deriveDefinition

protected void deriveDefinition(S_LibraryObjectDefinition def)
                         throws IfsException

Add to the S_LibraryObjectDefinition for this class. This this called by getDefinition() on S_LibraryObject. This must call super.deriveDefinition() before applying any class-specific changes to the S_LibraryObjectDefinition object.

Overrides:

deriveDefinition in class S_PublicObject

Parameters:

def - the definition of the target object.

Throws:

IfsException - if operation fails.

extendedPreInsert

protected void extendedPreInsert(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Updates any system attributes appropriate for creating this object; in this case, set the is_shared attribute to true if it is not set explicitly.

Overrides:

extendedPreInsert in class S_PublicObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPreUpdate

protected void extendedPreUpdate(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Update any system attributes appropriate for updating this ACL

Overrides:

extendedPreUpdate in class S_PublicObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPostUpdate

protected void extendedPostUpdate(OperationState opState,
                                  S_LibraryObjectDefinition def)
                           throws IfsException

extended operations to be performed after updating an object. This is overridden by classes that need to perform operations after updating this object in the database, but before commit.

Overrides:

extendedPostUpdate in class S_PublicObject

Parameters:

opState - the Operation state

def - the S_LibraryObjectDefinition that contains the updates.

Throws:

IfsException - if operation fails.

getAccessControlEntrys

public S_AccessControlEntry[] getAccessControlEntrys()
                                              throws IfsException

Returns the set of S_AccessControlEntry objects associated with this ACL.

Returns:

array of AccessControlEntry objects associated with this ACL

Throws:

IfsException - if operation fails.

getGrantedAccessLevel

public AccessLevel getGrantedAccessLevel()
                                  throws IfsException

Returns the access level for the current user.

Returns:

AccessLevel corresponding to the current user

Throws:

IfsException - if the operation fails

getGrantedAccessLevel

public AccessLevel getGrantedAccessLevel(S_DirectoryUser user)
                                  throws IfsException

Returns the access level for the specified user.

Parameters:

user - user whose access level is to be determined

Returns:

AccessLevel corresponding to the specified user

Throws:

IfsException - if the operation fails

isAccessLevelEnabled

public boolean isAccessLevelEnabled(AccessLevel level)
                             throws IfsException

Checks if a specified set of permissions is enabled for the current user.

Parameters:

level - the set of permissions to check

Returns:

true if the current user has this permission granted in this ACL

Throws:

IfsException - if the operation fails

verifyAccessLevelEnabled

public void verifyAccessLevelEnabled(AccessLevel level)
                              throws IfsException

Verifies if a specified set of permissions is enabled for the current user.

Parameters:

level - the set of permissions to check

Throws:

IfsException - (IFS-30030) if the operation fails