com.unboundid.ldap.sdk.unboundidds.extensions
Enum SubtreeAccessibilityState

java.lang.Object
  extended by java.lang.Enum<SubtreeAccessibilityState>
      extended by com.unboundid.ldap.sdk.unboundidds.extensions.SubtreeAccessibilityState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SubtreeAccessibilityState>

public enum SubtreeAccessibilityState
extends java.lang.Enum<SubtreeAccessibilityState>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This enum defines the set of allowed accessibility states that may be used with the SetSubtreeAccessibilityExtendedRequest.


Enum Constant Summary
ACCESSIBLE
          Indicates that the subtree should return to normal accessibility so that all appropriately-authorized users will be able to perform all kinds of operations in the target subtree.
HIDDEN
          Indicates that the subtree should be made hidden so that is is not accessible to most clients for any kinds of operations.
READ_ONLY_BIND_ALLOWED
          Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request).
READ_ONLY_BIND_DENIED
          Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request).
 
Method Summary
static SubtreeAccessibilityState forName(java.lang.String name)
          Retrieves the subtree accessibility state with the provided name.
 java.lang.String getStateName()
          Retrieves the name for this subtree accessibility state.
 int intValue()
          Retrieves the integer value for this subtree accessibility state.
 boolean isAccessible()
          Indicates whether this state object represents the ACCESSIBLE state.
 boolean isHidden()
          Indicates whether this state object represents the HIDDEN state.
 boolean isReadOnly()
          Indicates whether this state object represents one of the read-only states.
 java.lang.String toString()
          Retrieves a string representation of this subtree accessibility state.
static SubtreeAccessibilityState valueOf(int intValue)
          Retrieves the subtree accessibility state with the specified integer value.
static SubtreeAccessibilityState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SubtreeAccessibilityState[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ACCESSIBLE

public static final SubtreeAccessibilityState ACCESSIBLE
Indicates that the subtree should return to normal accessibility so that all appropriately-authorized users will be able to perform all kinds of operations in the target subtree.


READ_ONLY_BIND_ALLOWED

public static final SubtreeAccessibilityState READ_ONLY_BIND_ALLOWED
Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request). Bind operations will be allowed, but any changes intended to update password policy or other account state (e.g., to record failed authentication attempts or update last login time) will not be applied.


READ_ONLY_BIND_DENIED

public static final SubtreeAccessibilityState READ_ONLY_BIND_DENIED
Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request). Bind operations will not be allowed for any user in the specified subtree.


HIDDEN

public static final SubtreeAccessibilityState HIDDEN
Indicates that the subtree should be made hidden so that is is not accessible to most clients for any kinds of operations. The subtree will be available to one specified user (as indicated in the set subtree accessibility request) for add, compare, delete, modify, modify DN, and search operations. Bind operations will not be allowed for any user in a hidden subtree.

Method Detail

values

public static SubtreeAccessibilityState[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SubtreeAccessibilityState c : SubtreeAccessibilityState.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubtreeAccessibilityState valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

intValue

public int intValue()
Retrieves the integer value for this subtree accessibility state.

Returns:
The integer value for this subtree accessibility state.

getStateName

public java.lang.String getStateName()
Retrieves the name for this subtree accessibility state.

Returns:
The name for this subtree accessibility state.

isAccessible

public boolean isAccessible()
Indicates whether this state object represents the ACCESSIBLE state.

Returns:
true if this state object represents the ACCESSIBLE state, or false if not.

isHidden

public boolean isHidden()
Indicates whether this state object represents the HIDDEN state.

Returns:
true if this state object represents the HIDDEN state, or false if not.

isReadOnly

public boolean isReadOnly()
Indicates whether this state object represents one of the read-only states.

Returns:
true if this state object represents one of the read-only states, or false if not.

valueOf

public static SubtreeAccessibilityState valueOf(int intValue)
Retrieves the subtree accessibility state with the specified integer value.

Parameters:
intValue - The integer value for the state to retrieve.
Returns:
The subtree accessibility state with the specified integer value, or null if there is no accessibility state with the specified integer value.

forName

public static SubtreeAccessibilityState forName(java.lang.String name)
Retrieves the subtree accessibility state with the provided name.

Parameters:
name - The name for the subtree accessibility state to retrieve.
Returns:
The subtree accessibility state with the specified name, or null if no state has the provided name.

toString

public java.lang.String toString()
Retrieves a string representation of this subtree accessibility state.

Overrides:
toString in class java.lang.Enum<SubtreeAccessibilityState>
Returns:
A string representation of this subtree accessibility state.