com.orchestranetworks.service
Interface AccessRule

public interface AccessRule

Specifies a programmatic access rule.

Access rules are set by methods setAccessRule... on class SchemaExtensionsContext.

See Also:

SchemaExtensionsContext.setAccessRuleOnNode(Path, AccessRule)

Field Summary

static AccessRule	ALWAYS_HIDDEN This rule always returns hidden access permission.
static AccessRule	ALWAYS_READ_ONLY This rule always returns read-only access permission.
static AccessRule	ALWAYS_READ_WRITE This rule always returns read-write access permission.

Method Summary

AccessPermission

getPermission(Adaptation anAdaptation, Session aSession, SchemaNode aNode) Returns a permission for the specified arguments.

Field Detail

ALWAYS_READ_WRITE

public static final AccessRule ALWAYS_READ_WRITE

This rule always returns read-write access permission.

ALWAYS_READ_ONLY

public static final AccessRule ALWAYS_READ_ONLY

This rule always returns read-only access permission.

ALWAYS_HIDDEN

public static final AccessRule ALWAYS_HIDDEN

This rule always returns hidden access permission.

Method Detail

getPermission

public AccessPermission getPermission(Adaptation anAdaptation,
                                      Session aSession,
                                      SchemaNode aNode)

Returns a permission for the specified arguments.

Warning: if this AccessRule is assigned to a table occurrence node, this method is called in three contexts:

• For evaluating table "column" permission; in this case, anAdaptation is the current instance.
• For evaluating the node permission of a specific existing record; in this case, anAdaptation is the current record.
• For evaluating the node permission in a record creation context (meaning that the record does not yet exist); in this case, anAdaptation is the current instance.

Parameters:

anAdaptation - current adaptation (either an instance or an occurrence, see warning above)

aSession - current user session

aNode - current schema node whose access must be computed; when the requested permission is about the global adaptation, this is the root node

Returns:

a permission, never null.

See Also:

SchemaExtensionsContext.setAccessRuleOnInstance(AccessRule), SchemaExtensionsContext.setAccessRuleOnNode(Path, AccessRule), SchemaExtensionsContext.setAccessRuleOnNodeAndAllDescendants(Path, boolean, AccessRule), SchemaExtensionsContext.setAccessRuleOnOccurrence(Path, AccessRule)