org.opends.server.controls

Class GetEffectiveRightsRequestControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.GetEffectiveRightsRequestControl

public class GetEffectiveRightsRequestControl
extends Control

This class partially implements the geteffectiverights control as defined in draft-ietf-ldapext-acl-model-08.txt. The main differences are: - The response control is not supported. Instead the dseecompat geteffectiverights control implementation creates attributes containing right information strings and adds those attributes to the entry being returned. The attribute type names are dynamically created; see the dseecompat's AciGetEffectiveRights class for details. - The dseecompat implementation allows additional attribute types in the request control for which rights information can be returned. These are known as the specified attribute types. The dseecompat request control value is the following:

  GetRightsControl ::= SEQUENCE {
    authzId    authzId
    attributes  SEQUENCE OF AttributeType
  }

   -- Only the "dn:DN form is supported.

 

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<GetEffectiveRightsRequestControl>	DECODER The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor and Description
GetEffectiveRightsRequestControl(boolean isCritical, org.forgerock.opendj.ldap.DN authzDN, List<org.forgerock.opendj.ldap.schema.AttributeType> attrs) Create a new geteffectiverights control with the specified authzDN and an attribute list.
GetEffectiveRightsRequestControl(boolean isCritical, String authzDN, List<String> attrs) Create a new geteffectiverights control with the specified raw authzDN and an attribute list.
GetEffectiveRightsRequestControl(org.forgerock.opendj.ldap.DN authzDN, List<org.forgerock.opendj.ldap.schema.AttributeType> attrs) Create a new geteffectiverights control with the specified authzDN and an attribute list.

Method Summary

Methods

Modifier and Type	Method and Description
List<org.forgerock.opendj.ldap.schema.AttributeType>	getAttributes() Return the requested additional attributes parsed from the control.
org.forgerock.opendj.ldap.DN	getAuthzDN() Return the authzDN parsed from the control.
void	writeValue(org.forgerock.opendj.io.ASN1Writer writer) Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

DECODER

public static final ControlDecoder<GetEffectiveRightsRequestControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

GetEffectiveRightsRequestControl

public GetEffectiveRightsRequestControl(org.forgerock.opendj.ldap.DN authzDN,
                                List<org.forgerock.opendj.ldap.schema.AttributeType> attrs)

Create a new geteffectiverights control with the specified authzDN and an attribute list.

Parameters:

authzDN - The authzDN.

attrs - The list of additional attributes to be returned.

GetEffectiveRightsRequestControl

public GetEffectiveRightsRequestControl(boolean isCritical,
                                org.forgerock.opendj.ldap.DN authzDN,
                                List<org.forgerock.opendj.ldap.schema.AttributeType> attrs)

Create a new geteffectiverights control with the specified authzDN and an attribute list.

Parameters:

isCritical - Indicates whether this control should be considered critical in processing the request.

authzDN - The authzDN.

attrs - The list of additional attributes to be returned.

GetEffectiveRightsRequestControl

public GetEffectiveRightsRequestControl(boolean isCritical,
                                String authzDN,
                                List<String> attrs)

Create a new geteffectiverights control with the specified raw authzDN and an attribute list.

Parameters:

isCritical - Indicates whether this control should be considered critical in processing the request.

authzDN - The authzDN.

attrs - The list of additional attributes to be returned.

Method Detail

writeValue

public void writeValue(org.forgerock.opendj.io.ASN1Writer writer)
                throws IOException

Description copied from class: Control

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 writer to use.

Throws:

IOException - If a problem occurs while writing to the stream.

getAuthzDN

public org.forgerock.opendj.ldap.DN getAuthzDN()

Return the authzDN parsed from the control.

Returns:

The DN representing the authzId.

getAttributes

public List<org.forgerock.opendj.ldap.schema.AttributeType> getAttributes()

Return the requested additional attributes parsed from the control. Known as the specified attributes.

Returns:

The list containing any additional attributes to return rights about.