Package com.unboundid.ldap.sdk.unboundidds.extensions

Class SubtreeAccessibilityRestriction

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.extensions.SubtreeAccessibilityRestriction

All Implemented Interfaces:

Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SubtreeAccessibilityRestriction
extends Object
implements Serializable

This class defines a data structure with information about a subtree with restricted access, as may be included in a GetSubtreeAccessibilityExtendedResult.

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(String subtreeBaseDN, SubtreeAccessibilityState accessibilityState, String bypassUserDN, Date effectiveTime)	Creates a new subtree accessibility restriction object with the provided information.

Method Summary

Modifier and Type	Method	Description
SubtreeAccessibilityState	getAccessibilityState()	Retrieves the accessibility state for the affected subtree.
String	getBypassUserDN()	Retrieves the DN of a user that will be allowed to bypass any restrictions on the affected subtree.
Date	getEffectiveTime()	Retrieves the time the accessibility restriction was put into place.
String	getSubtreeBaseDN()	Retrieves the base DN for the affected subtree.
String	toString()	Retrieves a string representation of this accessibility restriction.
void	toString(StringBuilder buffer)	Appends a string representation of this accessibility restriction to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Details

SubtreeAccessibilityRestriction

public SubtreeAccessibilityRestriction(@NotNull
 String subtreeBaseDN,
 @NotNull
 SubtreeAccessibilityState accessibilityState,
 @Nullable
 String bypassUserDN,
 @NotNull
 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 Details

getSubtreeBaseDN

@NotNull
public 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 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 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 String toString()

Retrieves a string representation of this accessibility restriction.

Overrides:

toString in class Object

Returns:

A string representation of this accessibility restriction.

toString

public void toString(@NotNull
 StringBuilder buffer)

Appends a string representation of this accessibility restriction to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.