Class SubtreeAccessibilityRestriction
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.extensions.SubtreeAccessibilityRestriction
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SubtreeAccessibilityRestriction extends java.lang.Object implements java.io.Serializable
This class defines a data structure with information about a subtree with restricted access, as may be included in aGetSubtreeAccessibilityExtendedResult
.
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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SubtreeAccessibilityRestriction(java.lang.String subtreeBaseDN, SubtreeAccessibilityState accessibilityState, java.lang.String bypassUserDN, java.util.Date effectiveTime)
Creates a new subtree accessibility restriction object with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubtreeAccessibilityState
getAccessibilityState()
Retrieves the accessibility state for the affected subtree.java.lang.String
getBypassUserDN()
Retrieves the DN of a user that will be allowed to bypass any restrictions on the affected subtree.java.util.Date
getEffectiveTime()
Retrieves the time the accessibility restriction was put into place.java.lang.String
getSubtreeBaseDN()
Retrieves the base DN for the affected subtree.java.lang.String
toString()
Retrieves a string representation of this accessibility restriction.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this accessibility restriction to the provided buffer.
-
-
-
Constructor Detail
-
SubtreeAccessibilityRestriction
public SubtreeAccessibilityRestriction(@NotNull java.lang.String subtreeBaseDN, @NotNull SubtreeAccessibilityState accessibilityState, @Nullable java.lang.String bypassUserDN, @NotNull java.util.Date effectiveTime)
Creates a new subtree accessibility restriction object with the provided information.- Parameters:
subtreeBaseDN
- The base DN of the affected subtree.accessibilityState
- The accessibility state of the affected subtree.bypassUserDN
- The DN of a user allowed to bypass any associated restrictions, if defined.effectiveTime
- The time this restriction was put into place.
-
-
Method Detail
-
getSubtreeBaseDN
@NotNull public java.lang.String getSubtreeBaseDN()
Retrieves the base DN for the affected subtree.- Returns:
- The base DN for the affected subtree.
-
getAccessibilityState
@NotNull public SubtreeAccessibilityState getAccessibilityState()
Retrieves the accessibility state for the affected subtree.- Returns:
- The accessibility state for the affected subtree.
-
getBypassUserDN
@Nullable public java.lang.String getBypassUserDN()
Retrieves the DN of a user that will be allowed to bypass any restrictions on the affected subtree.- Returns:
- The DN of a user that will be allowed to bypass any restrictions
on the affected subtree, or
null
if no bypass user is defined.
-
getEffectiveTime
@NotNull public java.util.Date getEffectiveTime()
Retrieves the time the accessibility restriction was put into place.- Returns:
- The time the accessibility restriction was put into place.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of this accessibility restriction.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this accessibility restriction.
-
-