org.apache.directory.shared.ldap.codec.add
Class AddRequestCodec

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec
          org.apache.directory.shared.ldap.codec.add.AddRequestCodec

All Implemented Interfaces:

Asn1Object

public class AddRequestCodec
extends LdapMessageCodec

An AddRequest Message. Its syntax is : AddRequest ::= [APPLICATION 8] SEQUENCE { entry LDAPDN, attributes AttributeList } AttributeList ::= SEQUENCE OF SEQUENCE { type AttributeDescription, vals SET OF AttributeValue } AttributeValue ::= OCTET STRING

Version:

$Rev: 798550 $, $Date: 2009-07-28 16:54:01 +0200 (Mar, 28 jul 2009) $,

Author:

Apache Directory Project

Field Summary

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

parent

Constructor Summary

AddRequestCodec()
Creates a new AddRequest object.

Method Summary

void	addAttributeType(java.lang.String type) Create a new attributeValue
void	addAttributeValue(byte[] value) Add a new value to the current attribute
void	addAttributeValue(java.lang.String value) Add a new value to the current attribute
void	addAttributeValue(Value<?> value) Add a new value to the current attribute
int	computeLength() Compute the AddRequest length AddRequest : 0x68 L1 | +--> 0x04 L2 entry +--> 0x30 L3 (attributes) | +--> 0x30 L4-1 (attribute) | | | +--> 0x04 L5-1 type | +--> 0x31 L6-1 (values) | | | +--> 0x04 L7-1-1 value | +--> ...
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Encode the AddRequest message to a PDU.
java.lang.String	getCurrentAttributeType()
Entry	getEntry() Get the entry to be added
LdapDN	getEntryDn() Get the added DN
int	getMessageType() Get the message type
void	initEntry() Initialize the Entry.
void	setEntry(Entry entry) Sets the entry.
void	setEntryDn(LdapDN entryDn) Set the added DN.
java.lang.String	toString() Return a String representing an AddRequest

Methods inherited from class org.apache.directory.shared.ldap.codec.LdapMessageCodec

addControl, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getDelRequest, getDelResponse, getExtendedRequest, getExtendedResponse, getIntermediateResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, initControls, setMessageId, setProtocolOP

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

Constructor Detail

AddRequestCodec

public AddRequestCodec()

Creates a new AddRequest object.

Method Detail

getMessageType

public int getMessageType()

Get the message type

Overrides:

getMessageType in class LdapMessageCodec

Returns:

Returns the type.

initEntry

public void initEntry()

Initialize the Entry.

getEntry

public Entry getEntry()

Get the entry to be added

Returns:

Returns the entry.

setEntry

public void setEntry(Entry entry)

Sets the entry.

Parameters:

entry - the entry

addAttributeType

public void addAttributeType(java.lang.String type)
                      throws javax.naming.NamingException

Create a new attributeValue

Parameters:

type - The attribute's name (called 'type' in the grammar)

Throws:

javax.naming.NamingException

addAttributeValue

public void addAttributeValue(java.lang.String value)

Add a new value to the current attribute

Parameters:

value - The value to add

addAttributeValue

public void addAttributeValue(Value<?> value)

Add a new value to the current attribute

Parameters:

value - The value to add

addAttributeValue

public void addAttributeValue(byte[] value)

Add a new value to the current attribute

Parameters:

value - The value to add

getEntryDn

public LdapDN getEntryDn()

Get the added DN

Returns:

Returns the entry DN.

setEntryDn

public void setEntryDn(LdapDN entryDn)

Set the added DN.

Parameters:

entry - The DN to set.

computeLength

public int computeLength()

Compute the AddRequest length AddRequest : 0x68 L1 | +--> 0x04 L2 entry +--> 0x30 L3 (attributes) | +--> 0x30 L4-1 (attribute) | | | +--> 0x04 L5-1 type | +--> 0x31 L6-1 (values) | | | +--> 0x04 L7-1-1 value | +--> ... | +--> 0x04 L7-1-n value | +--> 0x30 L4-2 (attribute) | | | +--> 0x04 L5-2 type | +--> 0x31 L6-2 (values) | | | +--> 0x04 L7-2-1 value | +--> ... | +--> 0x04 L7-2-n value | +--> ... | +--> 0x30 L4-m (attribute) | +--> 0x04 L5-m type +--> 0x31 L6-m (values) | +--> 0x04 L7-m-1 value +--> ... +--> 0x04 L7-m-n value

Specified by:

computeLength in interface Asn1Object

Overrides:

computeLength in class LdapMessageCodec

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException

Encode the AddRequest message to a PDU. AddRequest : 0x68 LL 0x04 LL entry 0x30 LL attributesList 0x30 LL attributeList 0x04 LL attributeDescription 0x31 LL attributeValues 0x04 LL attributeValue ... 0x04 LL attributeValue ... 0x30 LL attributeList 0x04 LL attributeDescription 0x31 LL attributeValue 0x04 LL attributeValue ... 0x04 LL attributeValue

Specified by:

encode in interface Asn1Object

Overrides:

encode in class LdapMessageCodec

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Return a String representing an AddRequest

Overrides:

toString in class LdapMessageCodec

Returns:

A String representing the AddRequest

getCurrentAttributeType

public java.lang.String getCurrentAttributeType()

Returns:

Returns the currentAttribute type.