org.apache.directory.shared.dsmlv2.request
Class AddRequestDsml

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec
          org.apache.directory.shared.dsmlv2.LdapMessageDecorator
              org.apache.directory.shared.dsmlv2.request.LdapRequestDecorator
                  org.apache.directory.shared.dsmlv2.request.AbstractRequestDsml
                      org.apache.directory.shared.dsmlv2.request.AddRequestDsml

All Implemented Interfaces:

Asn1Object, DsmlDecorator

public class AddRequestDsml
extends AbstractRequestDsml

DSML Decorator for AddRequest

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator

instance

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

ldapMessageLength

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

parent

Constructor Summary

AddRequestDsml()
Creates a new instance of AddRequestDsml.

AddRequestDsml(AddRequestCodec ldapMessage)
Creates a new instance of AddRequestDsml.

Method Summary

void	addAttributeType(java.lang.String type) Create a new attributeValue
void	addAttributeValue(java.lang.Object value) Add a new value to the current attribute
java.lang.String	getCurrentAttributeType()
Entry	getEntry() Get the entry with its attributes.
DN	getEntryDn() Get the added DN
MessageTypeEnum	getMessageType()
void	initEntry() Initialize the Entry.
void	setEntry(Entry entry) Sets the entry.
void	setEntryDn(DN entryDn) Set the added DN.
org.dom4j.Element	toDsml(org.dom4j.Element root) Creates the Request Element and adds RequestID and Controls.

Methods inherited from class org.apache.directory.shared.dsmlv2.LdapMessageDecorator

addControl, addLength, computeLength, computeLengthProtocolOp, encode, encodeProtocolOp, getAbandonRequest, getAddRequest, getAddResponse, getBindRequest, getBindResponse, getCompareRequest, getCompareResponse, getControls, getControls, getCurrentControl, getCurrentLength, getDelRequest, getDelResponse, getExpectedLength, getExtendedRequest, getExtendedResponse, getLdapResponse, getMessageId, getMessageTypeName, getModifyDNRequest, getModifyDNResponse, getModifyRequest, getModifyResponse, getParent, getSearchRequest, getSearchResultDone, getSearchResultEntry, getSearchResultReference, getUnBindRequest, setCurrentLength, setExpectedLength, setMessageId, setParent, toString

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

addControls, encode, getCodecControl, initControls, toString

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

getTlvId

Methods inherited from class java.lang.Object

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

Constructor Detail

AddRequestDsml

public AddRequestDsml()

Creates a new instance of AddRequestDsml.

AddRequestDsml

public AddRequestDsml(AddRequestCodec ldapMessage)

Creates a new instance of AddRequestDsml.

Parameters:

ldapMessage - the message to decorate

Method Detail

getMessageType

public MessageTypeEnum getMessageType()

Overrides:

getMessageType in class LdapMessageDecorator

toDsml

public org.dom4j.Element toDsml(org.dom4j.Element root)

Creates the Request Element and adds RequestID and Controls.

Specified by:

toDsml in interface DsmlDecorator

Overrides:

toDsml in class AbstractRequestDsml

Parameters:

root - the root element

Returns:

the Request Element of the given name containing

initEntry

public void initEntry()

Initialize the Entry.

getEntry

public Entry getEntry()

Get the entry with its attributes.

Returns:

Returns the entry.

addAttributeType

public void addAttributeType(java.lang.String type)
                      throws LdapException

Create a new attributeValue

Parameters:

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

Throws:

LdapException

addAttributeValue

public void addAttributeValue(java.lang.Object value)

Add a new value to the current attribute

Parameters:

value - The value to be added

getEntryDn

public DN getEntryDn()

Get the added DN

Returns:

Returns the entry DN.

setEntryDn

public void setEntryDn(DN entryDn)

Set the added DN.

Parameters:

entry - The entry DN to set.

setEntry

public void setEntry(Entry entry)

Sets the entry.

Parameters:

entry - the entry

getCurrentAttributeType

public java.lang.String getCurrentAttributeType()

Returns:

Returns the currentAttribute type.