Class AddRequestImpl
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.AbstractMessage
-
- org.apache.directory.api.ldap.model.message.AbstractRequest
-
- org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
-
- org.apache.directory.api.ldap.model.message.AddRequestImpl
-
- All Implemented Interfaces:
AbandonableRequest
,AddRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
public class AddRequestImpl extends AbstractAbandonableRequest implements AddRequest
Lockable add request implementation.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description AddRequestImpl()
Creates an AddRequest implementation to create a new entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.void
addAttributeType(String type)
Create a new attributeValuevoid
addAttributeValue(byte[] value)
Add a new value to the current attributevoid
addAttributeValue(String value)
Add a new value to the current attributevoid
addAttributeValue(Value value)
Add a new value to the current attributeAddRequest
addControl(Control control)
Adds a control to this Message.boolean
equals(Object obj)
Checks to see if an object is equivalent to this AddRequest.String
getCurrentAttributeType()
Entry
getEntry()
Gets the entry to add.Dn
getEntryDn()
Gets the distinguished name of the entry to add.MessageTypeEnum
getResponseType()
Gets the protocol response message type for this request which produces at least one response.AddResponse
getResultResponse()
The result containing response for this request.int
hashCode()
AddRequest
removeControl(Control control)
Deletes a control removing it from this Message.AddRequest
setEntry(Entry entry)
Sets the Entry to add.AddRequest
setEntryDn(Dn dn)
Sets the distinguished name of the entry to add.AddRequest
setMessageId(int messageId)
Sets the Message ID for this requestString
toString()
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest
hasResponse
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage
get, getControl, getControls, getMessageId, getType, hasControl, put, toString
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, getType, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
-
-
-
Constructor Detail
-
AddRequestImpl
public AddRequestImpl()
Creates an AddRequest implementation to create a new entry.
-
-
Method Detail
-
addAttributeType
public void addAttributeType(String type) throws LdapException
Create a new attributeValue- Parameters:
type
- The attribute's name (called 'type' in the grammar)- Throws:
LdapException
- If the type can't be added
-
getCurrentAttributeType
public String getCurrentAttributeType()
- Returns:
- Returns the currentAttribute type.
-
addAttributeValue
public void addAttributeValue(String value) throws LdapException
Add a new value to the current attribute- Parameters:
value
- The value to add- Throws:
LdapException
- If the value can't be added
-
addAttributeValue
public void addAttributeValue(Value value) throws LdapException
Add a new value to the current attribute- Parameters:
value
- The value to add- Throws:
LdapException
- If the value can't be added
-
addAttributeValue
public void addAttributeValue(byte[] value) throws LdapException
Add a new value to the current attribute- Parameters:
value
- The value to add- Throws:
LdapException
- If the value can't be added
-
getEntryDn
public Dn getEntryDn()
Gets the distinguished name of the entry to add.- Specified by:
getEntryDn
in interfaceAddRequest
- Returns:
- the Dn of the added entry.
-
setEntryDn
public AddRequest setEntryDn(Dn dn)
Sets the distinguished name of the entry to add.- Specified by:
setEntryDn
in interfaceAddRequest
- Parameters:
dn
- the Dn of the added entry.- Returns:
- The AddRequest instance
-
getEntry
public Entry getEntry()
Gets the entry to add.- Specified by:
getEntry
in interfaceAddRequest
- Returns:
- the added Entry
-
setEntry
public AddRequest setEntry(Entry entry)
Sets the Entry to add.- Specified by:
setEntry
in interfaceAddRequest
- Parameters:
entry
- the added Entry- Returns:
- The AddRequest instance
-
setMessageId
public AddRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceAddRequest
- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public AddRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceAddRequest
- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public AddRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceAddRequest
- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public AddRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceAddRequest
- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
getResponseType
public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.- Specified by:
getResponseType
in interfaceSingleReplyRequest
- Returns:
- the message type of the response.
-
getResultResponse
public AddResponse getResultResponse()
The result containing response for this request.- Specified by:
getResultResponse
in interfaceResultResponseRequest
- Returns:
- the result containing response for this request
-
equals
public boolean equals(Object obj)
Checks to see if an object is equivalent to this AddRequest. First there's a quick test to see if the obj is the same object as this one - if so true is returned. Next if the super method fails false is returned. Then the name of the entry is compared - if not the same false is returned. Lastly the attributes of the entry are compared. If they are not the same false is returned otherwise the method exists returning true.- Overrides:
equals
in classAbstractRequest
- Parameters:
obj
- the object to test for equality to this- Returns:
- true if the obj is equal to this AddRequest, false otherwise
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractRequest
- Returns:
- the instance's hash code
- See Also:
Object.hashCode()
-
toString
public String toString()
- Overrides:
toString
in classObject
- See Also:
Object.toString()
-
-