com.novell.admin.ns.nds

Class ObjectACLFacade

java.lang.Object

com.novell.admin.ns.ValueListFacade

com.novell.admin.ns.nds.ObjectACLFacade

public final class ObjectACLFacade
extends ValueListFacade

Facade for ACL syntax.

This facade implements 2 different models for manipulating ACL's.

• Traditional
• NVDS

The Traditional model specifies an ACL with 3 fields:
- Protected Attribute Name
- SubjectName
- Privileges (bitmask)

The NVDS model specifies an ACL with 7 fields:
- NVDS Privileges (a different bitmask)
- Modifier (bitmask)
- Trustee DN
- Filter DN
- Scope
- ClassName
- Attribute Name

Three different ACL syntaxes are supported.

• eDirectory/NDAP (or just NDS)
• eDirectory/LDAP (or just eDIR)
• NVDS

The APIs for the Traditional model (3 parameters) can be used with any of the 3 syntaxes. It is thus possible to write generic code that will run correctly in all 3 environments. However, one is limited to the traditional functionality of eDirectory ACLs.

The APIs for the NVDS model (7 parameters) may only be used on an NVDS directory, but one may take full advantage of the new ACL capability provided by NVDS.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	E_ALL_ATTRIBUTES
static int	E_BROWSE_ENTRY
static int	E_COMPARE_ATTR
static int	E_CREATE_ENTRY
static java.lang.String	E_CREATOR
static int	E_DELETE_ENTRY
static int	E_DYNAMIC_GRP_BIT
static java.lang.String	E_ENTRY_RIGHTS
static int	E_INHERIT_CTL_BIT
static int	E_NESTED_GRP_BIT
static java.lang.String	E_PUBLIC
static int	E_READ_ATTR
static int	E_RENAME_ENTRY
static java.lang.String	E_ROOT
static java.lang.String	E_SELF
static int	E_SELF_ATTR
static int	E_SUPER_ATTR
static int	E_SUPER_ENTRY
static int	E_WRITE_ATTR
static int	MODIFIER_ATTRIBUTE
static int	MODIFIER_DYNGRP
static int	MODIFIER_ENTRY
static java.lang.String	SCOPE_BASE_OBJECT
static java.lang.String	SCOPE_DENY_INHERITANCE
static java.lang.String	SCOPE_DENY_INHERITANCE_SUPERIOR
static java.lang.String	SCOPE_SINGLE_LEVEL
static java.lang.String	SCOPE_SUBORDINATES
static java.lang.String	SCOPE_WHOLE_SUBTREE
static java.lang.String	TRUSTEE_AUTHENTICATED
static java.lang.String	TRUSTEE_CREATOR
static java.lang.String	TRUSTEE_SELF
static java.lang.String	TRUSTEE_UNAUTHENTICATED
static int	V_BROWSE_ENTRY
static int	V_COMPARE_ATTR
static int	V_CREATE_ENTRY
static int	V_DELETE_ATTR
static int	V_DELETE_ENTRY
static int	V_READ_ATTR
static int	V_RENAME_ENTRY
static int	V_SELF_ATTR
static int	V_SUPER_ATTR
static int	V_SUPER_ENTRY
static int	V_WRITE_ATTR

Fields inherited from class com.novell.admin.ns.ValueListFacade

valueList

Constructor Summary

Constructors

Constructor and Description
ObjectACLFacade(ValueList comp) Facade constructor.

Method Summary

Modifier and Type	Method and Description
static ValueList	createValueList(long privileges, long modifier, java.lang.String trusteeDN, java.lang.String filterDN, java.lang.String scope, java.lang.String className, java.lang.String attrName, Syntax syntax) Creates an NVDS ACL ValueList - NVDS model only. Empty strings should be specified for unused optional parameters.
static ValueList	createValueList(java.lang.String protectedAttrName, java.lang.String subjectName, long privileges) Creates an ACL ValueList - Traditional model
static ValueList	createValueList(java.lang.String protectedAttrName, java.lang.String subjectName, long privileges, Syntax syntax) Creates an Object ACL ValueList - Traditional model. This facade supports all 3 ACL syntaxes.
java.lang.String	getNVDSAttributeName() Retrieves the attribute name - NVDS model only.
java.lang.String	getNVDSClassName() Retrieves the class name filter - NVDS model only.
java.lang.String	getNVDSFilter() Retrieves the filter - NVDS model only.
long	getNVDSModifier() Retrieves the ACL modifier field - NVDS model only.
long	getNVDSPrivileges() Retrieves the access control privileges - NVDS model only.
java.lang.String	getNVDSScope() Retrieves the scope - NVDS model only.
java.lang.String	getNVDSTrustee() Retrieves the trustee DN or keyword - NVDS model only.
long	getPrivileges() Retrieves the access control privileges - Traditional model.
java.lang.String	getProtectedAttrName() Retrieves the protected attribute name - Traditional model.
java.lang.String	getSubjectName() Retrieves the subject name - Traditional model.
void	setNVDSAttributeName(java.lang.String attrName) Sets an attribute name for the ACL - NVDS model only.
void	setNVDSClassName(java.lang.String className) Sets a class name filter for the ACL - NVDS model only.
void	setNVDSFilter(java.lang.String filterDN) Sets a filter for the ACL - NVDS model only.
void	setNVDSModifier(long modifier) Sets the ACL modifier field - NVDS model only.
void	setNVDSPrivileges(long privileges) Sets the access control privileges - NVDS model only.
void	setNVDSScope(java.lang.String scope) Sets a scope for the ACL - NVDS model only.
void	setNVDSTrustee(java.lang.String trusteeDN) Sets the trustee DN - NVDS model only.
void	setPrivileges(long privileges) Sets the access control privileges - Traditional model.
void	setProtectedAttrName(java.lang.String name) Sets the protected attribute name - Traditional model.
void	setSubjectName(java.lang.String name) Sets the subject name - Traditional model.

Methods inherited from class com.novell.admin.ns.ValueListFacade

getValueList, replaceBooleanValue, replaceHexValue, replaceLongValue, replaceStringValue, replaceValueList

Methods inherited from class java.lang.Object

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

Field Detail

E_BROWSE_ENTRY

public static final int E_BROWSE_ENTRY

See Also:

Constant Field Values

E_CREATE_ENTRY

public static final int E_CREATE_ENTRY

See Also:

Constant Field Values

E_DELETE_ENTRY

public static final int E_DELETE_ENTRY

See Also:

Constant Field Values

E_RENAME_ENTRY

public static final int E_RENAME_ENTRY

See Also:

Constant Field Values

E_SUPER_ENTRY

public static final int E_SUPER_ENTRY

See Also:

Constant Field Values

E_COMPARE_ATTR

public static final int E_COMPARE_ATTR

See Also:

Constant Field Values

E_READ_ATTR

public static final int E_READ_ATTR

See Also:

Constant Field Values

E_WRITE_ATTR

public static final int E_WRITE_ATTR

See Also:

Constant Field Values

E_SELF_ATTR

public static final int E_SELF_ATTR

See Also:

Constant Field Values

E_SUPER_ATTR

public static final int E_SUPER_ATTR

See Also:

Constant Field Values

E_INHERIT_CTL_BIT

public static final int E_INHERIT_CTL_BIT

See Also:

Constant Field Values

E_DYNAMIC_GRP_BIT

public static final int E_DYNAMIC_GRP_BIT

See Also:

Constant Field Values

E_NESTED_GRP_BIT

public static final int E_NESTED_GRP_BIT

See Also:

Constant Field Values

E_ENTRY_RIGHTS

public static final java.lang.String E_ENTRY_RIGHTS

See Also:

Constant Field Values

E_ALL_ATTRIBUTES

public static final java.lang.String E_ALL_ATTRIBUTES

See Also:

Constant Field Values

E_PUBLIC

public static final java.lang.String E_PUBLIC

See Also:

Constant Field Values

E_ROOT

public static final java.lang.String E_ROOT

See Also:

Constant Field Values

E_CREATOR

public static final java.lang.String E_CREATOR

See Also:

Constant Field Values

E_SELF

public static final java.lang.String E_SELF

See Also:

Constant Field Values

V_BROWSE_ENTRY

public static final int V_BROWSE_ENTRY

See Also:

Constant Field Values

V_CREATE_ENTRY

public static final int V_CREATE_ENTRY

See Also:

Constant Field Values

V_DELETE_ENTRY

public static final int V_DELETE_ENTRY

See Also:

Constant Field Values

V_RENAME_ENTRY

public static final int V_RENAME_ENTRY

See Also:

Constant Field Values

V_SUPER_ENTRY

public static final int V_SUPER_ENTRY

See Also:

Constant Field Values

V_COMPARE_ATTR

public static final int V_COMPARE_ATTR

See Also:

Constant Field Values

V_READ_ATTR

public static final int V_READ_ATTR

See Also:

Constant Field Values

V_WRITE_ATTR

public static final int V_WRITE_ATTR

See Also:

Constant Field Values

V_DELETE_ATTR

public static final int V_DELETE_ATTR

See Also:

Constant Field Values

V_SUPER_ATTR

public static final int V_SUPER_ATTR

See Also:

Constant Field Values

V_SELF_ATTR

public static final int V_SELF_ATTR

See Also:

Constant Field Values

MODIFIER_ATTRIBUTE

public static final int MODIFIER_ATTRIBUTE

See Also:

Constant Field Values

MODIFIER_ENTRY

public static final int MODIFIER_ENTRY

See Also:

Constant Field Values

MODIFIER_DYNGRP

public static final int MODIFIER_DYNGRP

See Also:

Constant Field Values

TRUSTEE_AUTHENTICATED

public static final java.lang.String TRUSTEE_AUTHENTICATED

See Also:

Constant Field Values

TRUSTEE_UNAUTHENTICATED

public static final java.lang.String TRUSTEE_UNAUTHENTICATED

See Also:

Constant Field Values

TRUSTEE_CREATOR

public static final java.lang.String TRUSTEE_CREATOR

See Also:

Constant Field Values

TRUSTEE_SELF

public static final java.lang.String TRUSTEE_SELF

See Also:

Constant Field Values

SCOPE_BASE_OBJECT

public static final java.lang.String SCOPE_BASE_OBJECT

See Also:

Constant Field Values

SCOPE_SINGLE_LEVEL

public static final java.lang.String SCOPE_SINGLE_LEVEL

See Also:

Constant Field Values

SCOPE_SUBORDINATES

public static final java.lang.String SCOPE_SUBORDINATES

See Also:

Constant Field Values

SCOPE_WHOLE_SUBTREE

public static final java.lang.String SCOPE_WHOLE_SUBTREE

See Also:

Constant Field Values

SCOPE_DENY_INHERITANCE

public static final java.lang.String SCOPE_DENY_INHERITANCE

See Also:

Constant Field Values

SCOPE_DENY_INHERITANCE_SUPERIOR

public static final java.lang.String SCOPE_DENY_INHERITANCE_SUPERIOR

See Also:

Constant Field Values

Constructor Detail

ObjectACLFacade

public ObjectACLFacade(ValueList comp)
                throws IncompatibleComponentException

Facade constructor.

Parameters:

comp - The ValueList that represents the ACL data.

Throws:

IncompatibleComponentException - Not used.

Method Detail

createValueList

public static ValueList createValueList(java.lang.String protectedAttrName,
                                        java.lang.String subjectName,
                                        long privileges)

Creates an ACL ValueList - Traditional model

This is a legacy method that assumes NDSSyntax.SYN_OBJECT_ACL. New code should use the method that includes a syntax argument.

Parameters:

protectedAttrName - Refer to NDS Schema Reference.

subjectName - Refer to NDS Schema Reference.

privileges - Refer to NDS Schema Reference.

Returns:

A new Object ACL ValueList.

createValueList

public static ValueList createValueList(java.lang.String protectedAttrName,
                                        java.lang.String subjectName,
                                        long privileges,
                                        Syntax syntax)

Creates an Object ACL ValueList - Traditional model.
This facade supports all 3 ACL syntaxes.

Parameters:

protectedAttrName - Refer to NDS Schema Reference.

subjectName - Refer to NDS Schema Reference.

privileges - Refer to NDS Schema Reference.

syntax - The syntax for this value. May be NDSSyntax.SYN_OBJECT_ACL, LDAPSyntax.SYN_NDS_ACL, or LDAPSyntax.SYN_NVDS_ACL.

Returns:

A new Object ACL ValueList.

getProtectedAttrName

public java.lang.String getProtectedAttrName()

Retrieves the protected attribute name - Traditional model.

Returns:

The name of the protected attribute.

Throws:

FacadeParameterException - Cannot convert between old and new ACL syntaxes.

getSubjectName

public java.lang.String getSubjectName()

Retrieves the subject name - Traditional model.

Returns:

The name of the subject.

Throws:

FacadeParameterException - Cannot convert between old and new ACL syntaxes.

getPrivileges

public long getPrivileges()

Retrieves the access control privileges - Traditional model.

Returns:

The privileges.

Throws:

FacadeParameterException - Cannot convert between old and new ACL syntaxes.

setProtectedAttrName

public void setProtectedAttrName(java.lang.String name)

Sets the protected attribute name - Traditional model.

Parameters:

name - The name of the protected attribute.

Throws:

FacadeParameterException - Cannot set the requested value.

setSubjectName

public void setSubjectName(java.lang.String name)

Sets the subject name - Traditional model.

Parameters:

name - The name of the subject.

Throws:

FacadeParameterException - Cannot set the requested value.

setPrivileges

public void setPrivileges(long privileges)

Sets the access control privileges - Traditional model.

Parameters:

privileges - The privileges.

Throws:

FacadeParameterException - Cannot set the requested value.

createValueList

public static ValueList createValueList(long privileges,
                                        long modifier,
                                        java.lang.String trusteeDN,
                                        java.lang.String filterDN,
                                        java.lang.String scope,
                                        java.lang.String className,
                                        java.lang.String attrName,
                                        Syntax syntax)

Creates an NVDS ACL ValueList - NVDS model only.
Empty strings should be specified for unused optional parameters.

Parameters:

privileges - A bitmask containing the privileges.

modifier - A bitmask indicating if this is an Entry or Attribute ACL, and if it's a normal or dynamic group ACL.

trusteeDN - A DN or simple keyword containing the object to which this ACL grants rights. Valid keywords are: authenticated, unauthenticated, creator, and self.

filterDN - The DN of a dynamic group containing a filter to be used for this ACL.

scope - Indicates the scope for this ACL Valid scopes are: baseObject, singleLevel, subordinates, wholeSubtree, inheritedRightsFilterWholeSubtree, and inheritedRightsFilterSubordinateSubtree.

className - Specifies a class name limiting which objects this ACL affects.

attrName - Specifies an attribute name or "any" for all attribute rights. This parameter should be null for an Entry ACL.

Returns:

A new NVDS ACL ValueList.

getNVDSPrivileges

public long getNVDSPrivileges()

Retrieves the access control privileges - NVDS model only.

Returns:

The privileges.

setNVDSPrivileges

public void setNVDSPrivileges(long privileges)

Sets the access control privileges - NVDS model only.

Parameters:

privileges - The privileges.

getNVDSModifier

public long getNVDSModifier()

Retrieves the ACL modifier field - NVDS model only.

Returns:

The modifier.

setNVDSModifier

public void setNVDSModifier(long modifier)

Sets the ACL modifier field - NVDS model only.

Parameters:

modifier - The modifier.

getNVDSTrustee

public java.lang.String getNVDSTrustee()

Retrieves the trustee DN or keyword - NVDS model only.

Returns:

The name of the trustee.

setNVDSTrustee

public void setNVDSTrustee(java.lang.String trusteeDN)

Sets the trustee DN - NVDS model only.

Parameters:

name - The name of the trustee or a simple keyword: "authenticated", "unauthenticated", "creator", or "self".

getNVDSFilter

public java.lang.String getNVDSFilter()

Retrieves the filter - NVDS model only.

Returns:

The DN of a dynamic group containing a filter to be used for this ACL. If no filter has been set, an empty string is returned.

setNVDSFilter

public void setNVDSFilter(java.lang.String filterDN)

Sets a filter for the ACL - NVDS model only.

Parameters:

filterDN - A DN of a dynamic group containing a filter to be used for this ACL. An empty string or null may be passed for this parameter to indicate no filter.

getNVDSScope

public java.lang.String getNVDSScope()

Retrieves the scope - NVDS model only.

Returns:

The scope identifier for the ACL.

setNVDSScope

public void setNVDSScope(java.lang.String scope)

Sets a scope for the ACL - NVDS model only.

Parameters:

scope - A keyword indicating the scope to be used for this ACL.

getNVDSClassName

public java.lang.String getNVDSClassName()

Retrieves the class name filter - NVDS model only.

Returns:

The class name to be used as a filter for the ACL. If no class name has been set, an empty string is returned.

setNVDSClassName

public void setNVDSClassName(java.lang.String className)

Sets a class name filter for the ACL - NVDS model only.

Parameters:

className - The class name to be used as a filter for the ACL. An empty string or null may be passed for this parameter to indicate no class filter.

getNVDSAttributeName

public java.lang.String getNVDSAttributeName()

Retrieves the attribute name - NVDS model only.

Returns:

The attribute name for the ACL. For an entry ACL, an empty string is returned.

setNVDSAttributeName

public void setNVDSAttributeName(java.lang.String attrName)

Sets an attribute name for the ACL - NVDS model only.

Parameters:

attrName - The attribute name for the ACL. For all attribute rights, use "any". A null or empty string must be set for an entry ACL.