org.apache.directory.api.ldap.model.message

Class AbstractExtendedRequest

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.AbstractExtendedRequest

All Implemented Interfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

Direct Known Subclasses:

CancelRequestImpl, CertGenerationRequestImpl, GracefulShutdownRequestImpl, PasswordModifyRequestImpl, StartTlsRequestImpl, StoredProcedureRequestImpl, WhoAmIRequestImpl

public abstract class AbstractExtendedRequest
extends AbstractRequest
implements ExtendedRequest

ExtendedRequest implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	oid Extended request's Object Identifier or requestName
private ExtendedResponse	response The associated response
(package private) static long	serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Constructor and Description
AbstractExtendedRequest() Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.
AbstractExtendedRequest(int id) Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.

Method Summary

Modifier and Type	Method and Description
ExtendedRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
ExtendedRequest	addControl(Control control) Adds a control to this Message.
boolean	equals(java.lang.Object obj) Checks to see if an object equals this ExtendedRequest.
java.lang.String	getRequestName() Gets the Object Identifier corresponding to the extended request type.
ExtendedResponse	getResponse()
MessageTypeEnum	getResponseType() Gets the protocol response message type for this request which produces at least one response.
abstract ExtendedResponse	getResultResponse() The result containing response for this request.
int	hashCode()
ExtendedRequest	removeControl(Control control) Deletes a control removing it from this Message.
ExtendedRequest	setMessageId(int messageId) Sets the Message ID for this request
ExtendedRequest	setRequestName(java.lang.String newOid) Sets the Object Identifier corresponding to the extended request type.
void	setResponse(ExtendedResponse response)
java.lang.String	toString() Get a String representation of an Extended Request

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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request

hasResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

get, getControl, getControls, getMessageId, getType, hasControl, put

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

oid

private java.lang.String oid

Extended request's Object Identifier or requestName

response

private ExtendedResponse response

The associated response

Constructor Detail

AbstractExtendedRequest

public AbstractExtendedRequest()

Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.

AbstractExtendedRequest

public AbstractExtendedRequest(int id)

Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.

Parameters:

id - the sequential message identifier

Method Detail

getRequestName

public java.lang.String getRequestName()

Gets the Object Identifier corresponding to the extended request type. This is the requestName portion of the ext. req. PDU.

Specified by:

getRequestName in interface ExtendedRequest

Returns:

the dotted-decimal representation as a String of the OID

setRequestName

public ExtendedRequest setRequestName(java.lang.String newOid)

Sets the Object Identifier corresponding to the extended request type.

Specified by:

setRequestName in interface ExtendedRequest

Parameters:

newOid - the dotted-decimal representation as a String of the OID

Returns:

The ExtendedRequest instance

setMessageId

public ExtendedRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface ExtendedRequest

Specified by:

setMessageId in interface Message

Overrides:

setMessageId in class AbstractMessage

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

public ExtendedRequest addControl(Control control)

Adds a control to this Message.

Specified by:

addControl in interface ExtendedRequest

Specified by:

addControl in interface Message

Overrides:

addControl in class AbstractMessage

Parameters:

control - the control to add.

Returns:

A Message reference

addAllControls

public ExtendedRequest addAllControls(Control[] controls)

Adds an array of controls to this Message.

Specified by:

addAllControls in interface ExtendedRequest

Specified by:

addAllControls in interface Message

Overrides:

addAllControls in class AbstractMessage

Parameters:

controls - the controls to add.

Returns:

A Message reference

removeControl

public ExtendedRequest removeControl(Control control)

Deletes a control removing it from this Message.

Specified by:

removeControl in interface ExtendedRequest

Specified by:

removeControl in interface Message

Overrides:

removeControl in class AbstractMessage

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 interface SingleReplyRequest

Returns:

the message type of the response.

getResultResponse

public abstract ExtendedResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest

Returns:

the result containing response for this request

getResponse

public ExtendedResponse getResponse()

Returns:

the response

setResponse

public void setResponse(ExtendedResponse response)

Parameters:

response - the response to set

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequest

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class AbstractRequest

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise

toString

public java.lang.String toString()

Get a String representation of an Extended Request

Overrides:

toString in class java.lang.Object

Returns:

an Extended Request String