com.unboundid.ldap.sdk.unboundidds.controls

Class EffectiveRightsEntry

java.lang.Object

com.unboundid.ldap.sdk.Entry

com.unboundid.ldap.sdk.ReadOnlyEntry

com.unboundid.ldap.sdk.unboundidds.controls.EffectiveRightsEntry

All Implemented Interfaces:

LDIFRecord, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class EffectiveRightsEntry
extends ReadOnlyEntry

This class provides a mechanism for extracting the effective rights information from an entry returned for a search request that included the get effective rights request control. In particular, it provides the ability to parse the values of the aclRights attributes in order to determine what rights the specified user may have when interacting with the entry.

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 the GetEffectiveRightsRequestControl for an example that demonstrates the use of the get effective rights request control and this entry.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EffectiveRightsEntry(Entry entry) Creates a new get effective rights entry from the provided entry.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Set<AttributeRight>>	getAttributeRights() Retrieves the set of attribute-level rights parsed from the entry, mapped from attribute name (in all lowercase characters) to the set of attribute-level rights for that attribute.
java.util.Set<AttributeRight>	getAttributeRights(java.lang.String attributeName) Retrieves the set of attribute-level rights parsed from the entry for the specified attribute.
java.util.Set<EntryRight>	getEntryRights() Retrieves the set of entry-level rights parsed from the entry.
boolean	hasAttributeRight(AttributeRight attributeRight, java.lang.String attributeName) Indicates whether the specified attribute right is granted for the specified attribute in this entry.
boolean	hasEntryRight(EntryRight entryRight) Indicates whether the specified entry right is granted for this entry.
boolean	rightsInformationAvailable() Indicates whether any access control rights information was contained in the entry.

Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN

Methods inherited from class com.unboundid.ldap.sdk.Entry

addAttribute, applyModifications, applyModifications, applyModifyDN, applyModifyDN, diff, diff, diff, duplicate, equals, getAttribute, getAttribute, getAttributes, getAttributesWithOptions, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsDate, getAttributeValueAsDN, getAttributeValueAsInteger, getAttributeValueAsLong, getAttributeValueByteArrays, getAttributeValueBytes, getAttributeValues, getDN, getObjectClassAttribute, getObjectClassValues, getParentDN, getParentDNString, getParsedDN, getRDN, getSchema, hasAttribute, hasAttribute, hasAttribute, hasAttributeValue, hasAttributeValue, hasAttributeValue, hasAttributeValue, hashCode, hasObjectClass, intersectEntries, matchesBaseAndScope, matchesBaseAndScope, mergeEntries, removeAttributeValue, removeAttributeValue, setAttribute, toLDIF, toLDIF, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toLDIFString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EffectiveRightsEntry

public EffectiveRightsEntry(@NotNull
                            Entry entry)

Creates a new get effective rights entry from the provided entry.

Parameters:

entry - The entry to use to create this get effective rights entry. It must not be null.

Method Detail

rightsInformationAvailable

public boolean rightsInformationAvailable()

Indicates whether any access control rights information was contained in the entry.

Returns:

true if access control rights information was contained in the entry, or false if not.

getEntryRights

@Nullable
public java.util.Set<EntryRight> getEntryRights()

Retrieves the set of entry-level rights parsed from the entry.

Returns:

The set of entry-level rights parsed from the entry, or null if the entry did not have any entry-level rights information.

hasEntryRight

public boolean hasEntryRight(@NotNull
                             EntryRight entryRight)

Indicates whether the specified entry right is granted for this entry.

Parameters:

entryRight - The entry right for which to make the determination. It must not be null.

Returns:

true if the entry included entry-level rights information and the specified entry right is granted, or false if not.

getAttributeRights

@Nullable
public java.util.Map<java.lang.String,java.util.Set<AttributeRight>> getAttributeRights()

Retrieves the set of attribute-level rights parsed from the entry, mapped from attribute name (in all lowercase characters) to the set of attribute-level rights for that attribute.

Returns:

The set of attribute-level rights parsed from the entry, or null if the entry did not have any attribute-level rights information.

getAttributeRights

@Nullable
public java.util.Set<AttributeRight> getAttributeRights(@NotNull
                                                                  java.lang.String attributeName)

Retrieves the set of attribute-level rights parsed from the entry for the specified attribute.

Parameters:

attributeName - The name of the attribute for which to retrieve the attribute-level rights. It must not be null.

Returns:

The set of attribute-level rights for the specified attribute, or null if the entry did not include any attribute-level rights information for the specified attribute.

hasAttributeRight

public boolean hasAttributeRight(@NotNull
                                 AttributeRight attributeRight,
                                 @NotNull
                                 java.lang.String attributeName)

Indicates whether the specified attribute right is granted for the specified attribute in this entry.

Parameters:

attributeRight - The attribute right for which to make the determination. It must not be null.

attributeName - The name of the attribute for which to make the determination. It must not be null.

Returns:

true if the entry included attribute-level rights information for the specified attribute and the indicated right is granted, or false if not.