Enum SubtreeAccessibilityState
- java.lang.Object
-
- java.lang.Enum<SubtreeAccessibilityState>
-
- 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>
This enum defines the set of allowed accessibility states that may be used with theSetSubtreeAccessibilityExtendedRequest
.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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 it 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).TO_BE_DELETED
Indicates that the subtree is intended to be deleted.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
isMoreRestrictiveThan(SubtreeAccessibilityState state)
Indicates whether this subtree accessibility state is considered more restrictive than the provided state.boolean
isReadOnly()
Indicates whether this state object represents one of the read-only states.boolean
isToBeDeleted()
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.
-
-
-
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 it 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.
-
TO_BE_DELETED
public static final SubtreeAccessibilityState TO_BE_DELETED
Indicates that the subtree is intended to be deleted. It will behave in the same way as theHIDDEN
state, with the exception that the server will not allow any further changes to the subtree accessibility state. That accessibility state will persist until the entry at the base of the subtree has been removed.
-
-
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 namejava.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
@NotNull 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, orfalse
if not.
-
isHidden
public boolean isHidden()
Indicates whether this state object represents the HIDDEN state. For the purpose of this method, TO_BE_DELETED will also be considered to be HIDDEN, since the server will treat the two states as equivalent with the exception that the accessibility state of TO_BE_DELETED subtrees cannot be changed.- Returns:
true
if this state object represents the HIDDEN or TO_BE_DELETED state, orfalse
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, orfalse
if not.
-
isToBeDeleted
public boolean isToBeDeleted()
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, orfalse
if not.
-
isMoreRestrictiveThan
public boolean isMoreRestrictiveThan(@NotNull SubtreeAccessibilityState state)
Indicates whether this subtree accessibility state is considered more restrictive than the provided state. States will be considered in the following descending order of restrictiveness:TO_BE_DELETED
HIDDEN
READ_ONLY_BIND_DENIED
READ_ONLY_BIND_ALLOWED
ACCESSIBLE
- Parameters:
state
- The accessibility state to compare against this one. It must not benull
.- Returns:
true
if this state is more restrictive than the provided state, orfalse
if this state is the same as or less restrictive than the provided state.
-
valueOf
@Nullable 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
@Nullable public static SubtreeAccessibilityState forName(@NotNull java.lang.String name)
Retrieves the subtree accessibility state with the provided name.- Parameters:
name
- The name for the subtree accessibility state to retrieve. It must not benull
.- Returns:
- The subtree accessibility state with the specified name, or
null
if no state has the provided name.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this subtree accessibility state.- Overrides:
toString
in classjava.lang.Enum<SubtreeAccessibilityState>
- Returns:
- A string representation of this subtree accessibility state.
-
-