Package com.unboundid.ldap.sdk.unboundidds.controls

Class GetEffectiveRightsRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GetEffectiveRightsRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetEffectiveRightsRequestControl extends Control
This class provides an implementation of the get effective rights request control, which may be included in a search request to indicate that matching entries should include information about the rights a given user may have when interacting with that 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.

When the get effective rights control is included in a search request, then each entry returned may include information about the rights that the specified user has for that entry in the aclRights operational attribute. Note that because this is an operational attribute, it must be explicitly included in the set of attributes to return.

If the aclRights attribute is included in the entry, then it will be present with multiple sets of options. In one case, it will have an option of "entryLevel", which provides information about the rights that the user has for the entry in general (see the EntryRight enum for a list of the entry-level rights that can be held). In all other cases, it will have one option of "attributeLevel" and another option that is the name of the attribute for which the set of rights is granted (see the AttributeRight enum for a list of the attribute-level rights that can be held). In either case, the value will be a comma-delimited list of right strings, where each right string is the name of the right followed by a colon and a one to indicate that the right is granted or zero to indicate that it is not granted. The EffectiveRightsEntry class provides a simple means of accessing the information encoded in the values of the aclRights attribute.

This control was designed by Sun Microsystems, and it is not the same as the get effective rights control referenced in the draft-ietf-ldapext-acl-model Internet draft. The value for this control should be encoded as follows: 

 GET_EFFECTIVE_RIGHTS := SEQUENCE {
   authzID     authzID,
   attributes  SEQUENCE OF AttributeType OPTIONAL }

Example

The following example demonstrates the use of the get effective rights control to determine whether user "uid=admin,dc=example,dc=com" has the ability to change the password for the user with uid "john.doe": 
 SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
      SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe"),
      "userPassword", "aclRights");
 searchRequest.addControl(new GetEffectiveRightsRequestControl(
      "dn:uid=admin,dc=example,dc=com"));
 SearchResult searchResult = connection.search(searchRequest);

 for (SearchResultEntry entry : searchResult.getSearchEntries())
 {
   EffectiveRightsEntry effectiveRightsEntry =
        new EffectiveRightsEntry(entry);
   if (effectiveRightsEntry.rightsInformationAvailable())
   {
     if (effectiveRightsEntry.hasAttributeRight(AttributeRight.WRITE,
          "userPassword"))
     {
       // The admin user has permission to change the target user's password.
     }
     else
     {
       // The admin user does not have permission to change the target user's
       // password.
     }
   }
   else
   {
     // No effective rights information was returned.
   }
 }
See Also:

  • Field Details

  • Constructor Details

    • GetEffectiveRightsRequestControl

      public GetEffectiveRightsRequestControl(@NotNull String authzID, @NotNull String... attributes)
      Creates a new get effective rights request control with the provided information. It will not be marked critical.
      Parameters:
      authzID - The authorization ID of the user for whom the effective rights should be calculated. It must not be null.
      attributes - The set of attributes for which to calculate the effective rights.

    • GetEffectiveRightsRequestControl

      public GetEffectiveRightsRequestControl(boolean isCritical, @NotNull String authzID, @NotNull String... attributes)
      Creates a new get effective rights request control with the provided information. It will not be marked critical.
      Parameters:
      isCritical - Indicates whether this control should be marked critical.
      authzID - The authorization ID of the user for whom the effective rights should be calculated. It must not be null.
      attributes - The set of attributes for which to calculate the effective rights.

    • GetEffectiveRightsRequestControl

      public GetEffectiveRightsRequestControl(@NotNull Control control) throws LDAPException
      Creates a new get effective rights request control which is decoded from the provided generic control.
      Parameters:
      control - The generic control to be decoded as a get effective rights request control.
      Throws:
      LDAPException - If the provided control cannot be decoded as a get effective rights request control.

  • Method Details

    • getAuthzID

      @NotNull public String getAuthzID()
      Retrieves the authorization ID of the user for whom to calculate the effective rights.
      Returns:
      The authorization ID of the user for whom to calculate the effective rights.

    • getAttributes

      @NotNull public String[] getAttributes()
      Retrieves the names of the attributes for which to calculate the effective rights information.
      Returns:
      The names of the attributes for which to calculate the effective rights information, or an empty array if no attribute names were specified.

    • getControlName

      @NotNull public String getControlName()
      Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
      Overrides:
      getControlName in class Control
      Returns:
      The user-friendly name for this control, or the OID if no user-friendly name is available.

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this get effective rights request control as a JSON object. The JSON object uses the following fields:
      • oid -- A mandatory string field whose value is the object identifier for this control. For the get effective rights request control, the OID is "1.3.6.1.4.1.42.2.27.9.5.2".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this get effective rights request control. Exactly one of the value-base64 and value-json fields must be present.
      • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this get effective rights request control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
        • authorization-id -- A mandatory string field whose value is the authorization identity of the user for whom to retrieve the effective rights.
        • attributes -- An optional array field whose values are strings that represent the names of the attributes for which to make the effective rights determination.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static GetEffectiveRightsRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a get effective rights request control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The get effective rights request control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid get effective rights request control.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP control to the provided buffer.
      Overrides:
      toString in class Control
      Parameters:
      buffer - The buffer to which to append the string representation of this buffer.