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

java.lang.Object
  extended by 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

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 class defines a data structure with information about a subtree with restricted access, as may be included in a GetSubtreeAccessibilityExtendedResult.

See Also:
Serialized Form

Constructor Summary
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
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubtreeAccessibilityRestriction

public 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.

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

public java.lang.String getSubtreeBaseDN()
Retrieves the base DN for the affected subtree.

Returns:
The base DN for the affected subtree.

getAccessibilityState

public SubtreeAccessibilityState getAccessibilityState()
Retrieves the accessibility state for the affected subtree.

Returns:
The accessibility state for the affected subtree.

getBypassUserDN

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

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

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

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this accessibility restriction.

toString

public void toString(java.lang.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.