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

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.controls.ManageDsaITControlCodec
All Implemented Interfaces:
Asn1Object

public class ManageDsaITControlCodec
extends AbstractAsn1Object

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: 602753 $
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
ManageDsaITControlCodec()
          Default constructor
 
Method Summary
 int computeLength()
          Returns 0 everytime.
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encodes the control: does nothing but returns an empty buffer.
 
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, toString, wait, wait, wait
 

Constructor Detail

ManageDsaITControlCodec

public ManageDsaITControlCodec()
Default constructor

Method Detail

computeLength

public int computeLength()
Returns 0 everytime.

Specified by:
computeLength in interface Asn1Object
Specified by:
computeLength in class AbstractAsn1Object
Returns:
The object's computed length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException
Encodes the control: does nothing but returns an empty buffer.

Specified by:
encode in interface Asn1Object
Overrides:
encode in class AbstractAsn1Object
Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
EncoderException - if the buffer can't be encoded


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.