org.opends.server.protocols.ldap
Class ModifyRequestProtocolOp

java.lang.Object
  extended by org.opends.server.protocols.ldap.ProtocolOp
      extended by org.opends.server.protocols.ldap.ModifyRequestProtocolOp

public class ModifyRequestProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP modify request protocol op, which is used to alter the contents of an entry in the Directory Server.


Constructor Summary
ModifyRequestProtocolOp(ASN1OctetString dn)
          Creates a new LDAP modify request protocol op with the specified DN and no modifications.
ModifyRequestProtocolOp(ASN1OctetString dn, java.util.ArrayList<RawModification> modifications)
          Creates a new LDAP modify request protocol op with the specified DN and set of modifications.
 
Method Summary
static ModifyRequestProtocolOp decodeModifyRequest(ASN1Element element)
          Decodes the provided ASN.1 element as an LDAP modify request protocol op.
 ASN1Element encode()
          Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.
 ASN1OctetString getDN()
          Retrieves the DN for this modify request.
 java.util.ArrayList<RawModification> getModifications()
          Retrieves the set of modifications for this modify request.
 java.lang.String getProtocolOpName()
          Retrieves the name for this protocol op type.
 byte getType()
          Retrieves the BER type for this protocol op.
 void setDN(ASN1OctetString dn)
          Specifies the DN for this modify request.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP protocol op to the provided buffer.
 void toString(java.lang.StringBuilder buffer, int indent)
          Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
 
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp
decode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModifyRequestProtocolOp

public ModifyRequestProtocolOp(ASN1OctetString dn)
Creates a new LDAP modify request protocol op with the specified DN and no modifications.

Parameters:
dn - The DN for this modify request.

ModifyRequestProtocolOp

public ModifyRequestProtocolOp(ASN1OctetString dn,
                               java.util.ArrayList<RawModification> modifications)
Creates a new LDAP modify request protocol op with the specified DN and set of modifications.

Parameters:
dn - The DN for this modify request.
modifications - The set of modifications for this modify request.
Method Detail

getDN

public ASN1OctetString getDN()
Retrieves the DN for this modify request.

Returns:
The DN for this modify request.

setDN

public void setDN(ASN1OctetString dn)
Specifies the DN for this modify request.

Parameters:
dn - The DN for this modify request.

getModifications

public java.util.ArrayList<RawModification> getModifications()
Retrieves the set of modifications for this modify request. The returned list may be altered by the caller.

Returns:
The set of modifications for this modify request.

getType

public byte getType()
Retrieves the BER type for this protocol op.

Specified by:
getType in class ProtocolOp
Returns:
The BER type for this protocol op.

getProtocolOpName

public java.lang.String getProtocolOpName()
Retrieves the name for this protocol op type.

Specified by:
getProtocolOpName in class ProtocolOp
Returns:
The name for this protocol op type.

encode

public ASN1Element encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.

Specified by:
encode in class ProtocolOp
Returns:
The ASN.1 element containing the encoded protocol op.

decodeModifyRequest

public static ModifyRequestProtocolOp decodeModifyRequest(ASN1Element element)
                                                   throws LDAPException
Decodes the provided ASN.1 element as an LDAP modify request protocol op.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded modify request protocol op.
Throws:
LDAPException - If a problem occurs while decoding the provided ASN.1 element as an LDAP modify request protocol op.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the string should be appended.

toString

public void toString(java.lang.StringBuilder buffer,
                     int indent)
Appends a multi-line string representation of this LDAP protocol op to the provided buffer.

Specified by:
toString in class ProtocolOp
Parameters:
buffer - The buffer to which the information should be appended.
indent - The number of spaces from the margin that the lines should be indented.