org.opends.server.protocols.ldap
Class AddRequestProtocolOp

java.lang.Object
  org.opends.server.protocols.ldap.ProtocolOp
      org.opends.server.protocols.ldap.AddRequestProtocolOp

public class AddRequestProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP add request protocol op, which is used to add a new entry to the Directory Server.

Constructor Summary

AddRequestProtocolOp(ASN1OctetString dn)
Creates a new LDAP add request protocol op with the specified DN and no attributes.

AddRequestProtocolOp(ASN1OctetString dn, java.util.ArrayList<RawAttribute> attributes)
Creates a new LDAP add request protocol op with the specified DN and set of attributes.

Method Summary

static AddRequestProtocolOp	decodeAddRequest(ASN1Element element) Decodes the provided ASN.1 element as an LDAP add request protocol op.
ASN1Element	encode() Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.
java.util.List<RawAttribute>	getAttributes() Retrieves the set of attributes for this add request.
ASN1OctetString	getDN() Retrieves the DN for this add 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 add request.
void	toLDIF(java.lang.StringBuilder buffer, int wrapColumn) Appends an LDIF representation of the entry to the provided buffer.
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

AddRequestProtocolOp

public AddRequestProtocolOp(ASN1OctetString dn)

Creates a new LDAP add request protocol op with the specified DN and no attributes.

Parameters:

dn - The DN for this add request.

AddRequestProtocolOp

public AddRequestProtocolOp(ASN1OctetString dn,
                            java.util.ArrayList<RawAttribute> attributes)

Creates a new LDAP add request protocol op with the specified DN and set of attributes.

Parameters:

dn - The DN for this add request.

attributes - The set of attributes for this add request.

Method Detail

getDN

public ASN1OctetString getDN()

Retrieves the DN for this add request.

Returns:

The DN for this add request.

setDN

public void setDN(ASN1OctetString dn)

Specifies the DN for this add request.

Parameters:

dn - The DN for this add request.

getAttributes

public java.util.List<RawAttribute> getAttributes()

Retrieves the set of attributes for this add request. The returned list may be altered by the caller.

Returns:

The set of attributes for this add 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.

decodeAddRequest

public static AddRequestProtocolOp decodeAddRequest(ASN1Element element)
                                             throws LDAPException

Decodes the provided ASN.1 element as an LDAP add request protocol op.

Parameters:

element - The ASN.1 element to be decoded.

Returns:

The decoded add request protocol op.

Throws:

LDAPException - If a problem occurs while decoding the provided ASN.1 element as an LDAP add 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.

toLDIF

public void toLDIF(java.lang.StringBuilder buffer,
                   int wrapColumn)

Appends an LDIF representation of the entry to the provided buffer.

Parameters:

buffer - The buffer to which the entry should be appended.

wrapColumn - The column at which long lines should be wrapped.