Class AbandonRequestImpl
- 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.AbandonRequestImpl
-
- All Implemented Interfaces:
AbandonRequest
,Message
,Request
public class AbandonRequestImpl extends AbstractRequest implements AbandonRequest
Implementation of an AbandonRequest message.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description AbandonRequestImpl()
Creates an AbandonRequest implementation for an outstanding request.AbandonRequestImpl(int abdandonnedId)
Creates an AbandonRequest implementation for an outstanding request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
abandon()
RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.AbandonRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.AbandonRequest
addControl(Control control)
Adds a control to this Message.boolean
equals(Object obj)
Checks for equality first by asking the super method which should compare all but the Abandoned request's Id.int
getAbandoned()
Gets the id of the request operation to terminate.int
hashCode()
AbandonRequest
removeControl(Control control)
Deletes a control removing it from this Message.AbandonRequest
setAbandoned(int abandonId)
Sets the id of the request operation to terminate.AbandonRequest
setMessageId(int messageId)
Sets the Message ID for this requestString
toString()
Return a String representing an AbandonRequest-
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.Message
get, getControl, getControls, getMessageId, getType, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
-
-
-
Constructor Detail
-
AbandonRequestImpl
public AbandonRequestImpl()
Creates an AbandonRequest implementation for an outstanding request.
-
AbandonRequestImpl
public AbandonRequestImpl(int abdandonnedId)
Creates an AbandonRequest implementation for an outstanding request.- Parameters:
abdandonnedId
- the sequence identifier of the AbandonRequest message.
-
-
Method Detail
-
getAbandoned
public int getAbandoned()
Gets the id of the request operation to terminate.- Specified by:
getAbandoned
in interfaceAbandonRequest
- Returns:
- the id of the request message to abandon
-
setAbandoned
public AbandonRequest setAbandoned(int abandonId)
Sets the id of the request operation to terminate.- Specified by:
setAbandoned
in interfaceAbandonRequest
- Parameters:
abandonId
- the sequence id of the request message to abandon- Returns:
- The AbandonRequest instance
-
abandon
public void abandon()
RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.
-
setMessageId
public AbandonRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public AbandonRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public AbandonRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public AbandonRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
equals
public boolean equals(Object obj)
Checks for equality first by asking the super method which should compare all but the Abandoned request's Id. It then compares this to determine equality.- Overrides:
equals
in classAbstractRequest
- Parameters:
obj
- the object to test for equality to this AbandonRequest- Returns:
- true if the obj equals this request, false otherwise
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractRequest
- Returns:
- the instance's hash code
- See Also:
Object.hashCode()
-
-