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

Class OpaqueExtendedRequest

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

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

All Implemented Interfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class OpaqueExtendedRequest
extends AbstractExtendedRequest

ExtendedRequest basic implementation.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	requestValue Extended request value as an opaque byte array
protected ExtendedResponse	response The associated response
(package private) static long	serialVersionUID

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

oid

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

controls

Constructor Summary

Constructors

Constructor and Description
OpaqueExtendedRequest() Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.
OpaqueExtendedRequest(byte[] requestValue) Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.
OpaqueExtendedRequest(int id) Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.
OpaqueExtendedRequest(String requestName) Creates an ExtendedRequest implementing object used to perform extended protocol operation on the server.
OpaqueExtendedRequest(String requestName, byte[] requestValue) 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(Object obj) Checks to see if an object equals this ExtendedRequest.
ExtendedResponse	getExtendedResponse() The result containing response for this request.
String	getRequestName() Gets the Object Identifier corresponding to the extended request type.
byte[]	getRequestValue()
MessageTypeEnum	getResponseType() Gets the protocol response message type for this request which produces at least one response.
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(String newOid) Sets the Object Identifier corresponding to the extended request type.
void	setRequestValue(byte[] requestValue)
String	toString() Get a String representation of an Extended Request

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

getResponse, setResponse

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

requestValue

private byte[] requestValue

Extended request value as an opaque byte array

response

protected ExtendedResponse response

The associated response

Constructor Detail

OpaqueExtendedRequest

public OpaqueExtendedRequest()

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

OpaqueExtendedRequest

public OpaqueExtendedRequest(int id)

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

Parameters:

id - The message ID

OpaqueExtendedRequest

public OpaqueExtendedRequest(String requestName)

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

Parameters:

requestName - the extended request name

OpaqueExtendedRequest

public OpaqueExtendedRequest(byte[] requestValue)

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

Parameters:

requestValue - the embedded value

OpaqueExtendedRequest

public OpaqueExtendedRequest(String requestName,
                             byte[] requestValue)

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

Parameters:

requestName - The extended request OID

requestValue - the embedded value

Method Detail

getRequestName

public 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

Overrides:

getRequestName in class AbstractExtendedRequest

Returns:

the dotted-decimal representation as a String of the OID

setRequestName

public ExtendedRequest setRequestName(String newOid)

Sets the Object Identifier corresponding to the extended request type.

Specified by:

setRequestName in interface ExtendedRequest

Overrides:

setRequestName in class AbstractExtendedRequest

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 AbstractExtendedRequest

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 AbstractExtendedRequest

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 AbstractExtendedRequest

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 AbstractExtendedRequest

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

Overrides:

getResponseType in class AbstractExtendedRequest

Returns:

the message type of the response.

getExtendedResponse

public ExtendedResponse getExtendedResponse()

The result containing response for this request.

Returns:

the result containing response for this request

getResultResponse

public ExtendedResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest

Specified by:

getResultResponse in class AbstractExtendedRequest

Returns:

the result containing response for this request

getRequestValue

public byte[] getRequestValue()

Returns:

the request value

setRequestValue

public void setRequestValue(byte[] requestValue)

Parameters:

requestValue - the requestValue to set

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractExtendedRequest

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class AbstractExtendedRequest

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise

toString

public String toString()

Get a String representation of an Extended Request

Overrides:

toString in class AbstractExtendedRequest

Returns:

an Extended Request String