org.apache.directory.shared.ldap.message.control
Class ManageDsaITControl

java.lang.Object
  org.apache.directory.shared.ldap.message.control.InternalAbstractControl
      org.apache.directory.shared.ldap.message.control.ManageDsaITControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control, InternalControl

public class ManageDsaITControl
extends InternalAbstractControl

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: 764131 $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

static java.lang.String

CONTROL_OID

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

ManageDsaITControl()

Method Summary

byte[]	getEncodedValue() Returns an empty byte[] every time.
java.lang.String	getID() Returns "2.16.840.1.113730.3.4.2" every time.
java.lang.String	getType() Returns "2.16.840.1.113730.3.4.2" every time.
byte[]	getValue() Returns an empty byte[] every time.

Methods inherited from class org.apache.directory.shared.ldap.message.control.InternalAbstractControl

isCritical, setCritical, setID

Methods inherited from class java.lang.Object

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

Field Detail

CONTROL_OID

public static final java.lang.String CONTROL_OID

See Also:

Constant Field Values

Constructor Detail

ManageDsaITControl

public ManageDsaITControl()

Method Detail

getEncodedValue

public byte[] getEncodedValue()

Returns an empty byte[] every time.

getValue

public byte[] getValue()

Returns an empty byte[] every time.

getType

public java.lang.String getType()

Returns "2.16.840.1.113730.3.4.2" every time.

getID

public java.lang.String getID()

Returns "2.16.840.1.113730.3.4.2" every time.

Specified by:

getID in interface javax.naming.ldap.Control

Overrides:

getID in class InternalAbstractControl

Returns:

The non-null object identifier string.