org.apache.directory.shared.ldap.codec.controls

Class ManageDsaITControl

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.controls.AbstractControl

org.apache.directory.shared.ldap.codec.controls.ManageDsaITControl

All Implemented Interfaces:

Asn1Object, CodecControl, Control

public class ManageDsaITControl
extends AbstractControl

Control which allows for the management of referrals and other DSA specific entities without processing them: meaning the referrals are treated as regular entries using this control. More information is available in RFC 3296. Below we have included section 3 of the RFC describing this control:

  3.  The ManageDsaIT Control
 
   The client may provide the ManageDsaIT control with an operation to
   indicate that the operation is intended to manage objects within the
   DSA (server) Information Tree.  The control causes Directory-specific
   entries (DSEs), regardless of type, to be treated as normal entries
   allowing clients to interrogate and update these entries using LDAP
   operations.
 
   A client MAY specify the following control when issuing an add,
   compare, delete, modify, modifyDN, search request or an extended
   operation for which the control is defined.
 
   The control type is 2.16.840.1.113730.3.4.2.  The control criticality
   may be TRUE or, if FALSE, absent.  The control value is absent.
 
   When the control is present in the request, the server SHALL NOT
   generate a referral or continuation reference based upon information
   held in referral objects and instead SHALL treat the referral object
   as a normal entry.  The server, however, is still free to return
   referrals for other reasons.  When not present, referral objects
   SHALL be handled as described above.
 
   The control MAY cause other objects to be treated as normal entries
   as defined by subsequent documents.
 

Version:

$Rev: 905338 $

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROL_OID This control OID

Fields inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

decoder, value, valueLength

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
ManageDsaITControl() Default constructor

Method Summary

Modifier and Type	Method and Description
int	computeLength() Returns 0 every time.
String	toString() Return a String representing this ManageDsaIt Control.

Methods inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl

computeLength, encode, getDecoder, getOid, getValue, hasValue, isCritical, setCritical, setValue

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_OID

public static final String CONTROL_OID

This control OID

See Also:

Constant Field Values

Constructor Detail

ManageDsaITControl

public ManageDsaITControl()

Default constructor

Method Detail

computeLength

public int computeLength()

Returns 0 every time.

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in interface CodecControl

Overrides:

computeLength in class AbstractControl

Returns:

The object's computed length

toString

public String toString()

Return a String representing this ManageDsaIt Control.

Overrides:

toString in class AbstractControl