Package org.forgerock.opendj.ldap.messages

Class GenericExtendedRequest

java.lang.Object

org.forgerock.opendj.ldap.messages.AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

org.forgerock.opendj.ldap.messages.GenericExtendedRequest

All Implemented Interfaces:

ExtendedRequest<GenericExtendedResult>, ProtocolOp, Request

public final class GenericExtendedRequest
extends AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>
implements ExtendedRequest<GenericExtendedResult>

A generic Extended request which should be used for unsupported extended operations. Servers list the names of Extended requests they recognize in the supportedExtension attribute in the root DSE. Where the name is not recognized, the server returns ResultCode.PROTOCOL_ERROR (the server may return this error in other cases).

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.opendj.ldap.messages.Request

Request.RequestType

Field Summary

Fields

Modifier and Type	Field	Description
static final ExtendedRequestDecoder<GenericExtendedRequest,GenericExtendedResult>	DECODER	A decoder which can be used to decode generic extended operation requests.

Method Summary

Modifier and Type	Method	Description
final GenericExtendedRequest	addControl(Control control)	Adds the provided control to this protocol-op.
final GenericExtendedRequest	addControls(Iterable<? extends Control> controls)	Adds the provided controls to this protocol-op.
final boolean	containsControl(String oid)	Returns true if this protocol-op contains the specified control.
final <C extends Control> C	getControl(ControlDecoder<C> decoder, DecodeOptions options)	Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
final List<Control>	getControls()	Returns a List containing the controls included with this protocol-op.
String	getOid()	Returns the numeric OID associated with this extended request.
ExtendedResultDecoder<GenericExtendedResult>	getResultDecoder()	Returns a decoder which can be used to decoded responses to this extended request.
ByteString	getValue()	Returns the value, if any, associated with this extended request.
boolean	hasValue()	Returns true if this extended request has a value.
final GenericExtendedRequest	removeControls(String oid)	Removes all the controls having the specified OID.
GenericExtendedRequest	setOid(String oid)	Sets the numeric OID associated with this extended request.
GenericExtendedRequest	setValue(Object value)	Sets the value, if any, associated with this extended request.
String	toString()

Methods inherited from class org.forgerock.opendj.ldap.messages.AbstractExtendedRequest

accept, getType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.opendj.ldap.messages.ExtendedRequest

addControl, addControls, getControl, getControls, removeControls

Methods inherited from interface org.forgerock.opendj.ldap.messages.ProtocolOp

containsControl, getControl

Methods inherited from interface org.forgerock.opendj.ldap.messages.Request

accept, getType

Field Details

DECODER

public static final ExtendedRequestDecoder<GenericExtendedRequest,GenericExtendedResult> DECODER

A decoder which can be used to decode generic extended operation requests.

Method Details

getOid

public String getOid()

Description copied from interface: ExtendedRequest

Returns the numeric OID associated with this extended request.

Specified by:

getOid in interface ExtendedRequest<GenericExtendedResult>

Specified by:

getOid in class AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

Returns:

The numeric OID associated with this extended request.

getResultDecoder

public ExtendedResultDecoder<GenericExtendedResult> getResultDecoder()

Description copied from interface: ExtendedRequest

Returns a decoder which can be used to decoded responses to this extended request.

Specified by:

getResultDecoder in interface ExtendedRequest<GenericExtendedResult>

Specified by:

getResultDecoder in class AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

Returns:

A decoder which can be used to decoded responses to this extended request.

getValue

public ByteString getValue()

Description copied from interface: ExtendedRequest

Returns the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.

Specified by:

getValue in interface ExtendedRequest<GenericExtendedResult>

Specified by:

getValue in class AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

Returns:

The value associated with this extended request, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: ExtendedRequest

Returns true if this extended request has a value. In some circumstances it may be useful to determine if a extended request has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface ExtendedRequest<GenericExtendedResult>

Specified by:

hasValue in class AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

Returns:

true if this extended request has a value, or false if there is no value.

setOid

public GenericExtendedRequest setOid(String oid)

Sets the numeric OID associated with this extended request.

Parameters:

oid - The numeric OID associated with this extended request.

Returns:

This generic extended request.

Throws:

UnsupportedOperationException - If this generic extended request does not permit the request name to be set.

NullPointerException - If oid was null.

setValue

public GenericExtendedRequest setValue(Object value)

Sets the value, if any, associated with this extended request. Its format is defined by the specification of this extended request.

If value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

Parameters:

value - TThe value associated with this extended request, or null if there is no value. Its format is defined by the specification of this control.

Returns:

This generic extended request.

Throws:

UnsupportedOperationException - If this generic extended request does not permit the request value to be set.

toString

public String toString()

Overrides:

toString in class AbstractExtendedRequest<GenericExtendedRequest,GenericExtendedResult>

addControl

public final GenericExtendedRequest addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface ProtocolOp

Parameters:

control - The control to be added to this protocol-op.

Returns:

This protocol-op.

addControls

public final GenericExtendedRequest addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Parameters:

controls - The controls to be added to this protocol-op.

Returns:

This protocol-op.

removeControls

public final GenericExtendedRequest removeControls(String oid)

Description copied from interface: ProtocolOp

Removes all the controls having the specified OID.

Specified by:

removeControls in interface ProtocolOp

Parameters:

oid - The numeric OID of the protocol-op control to remove.

Returns:

This protocol-op.

containsControl

public final boolean containsControl(String oid)

Description copied from interface: ProtocolOp

Returns true if this protocol-op contains the specified control.

Specified by:

containsControl in interface ProtocolOp

Parameters:

oid - The numeric OID of the protocol-op control.

Returns:

true if this protocol-op contains the specified control.

getControl

public final <C extends Control> C getControl(ControlDecoder<C> decoder,
 DecodeOptions options)
                                       throws DecodeException

Description copied from interface: ProtocolOp

Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.

Specified by:

getControl in interface ProtocolOp

Type Parameters:

C - The type of control to be decoded and returned.

Parameters:

decoder - The control decoder.

options - The set of decode options which should be used when decoding the control.

Returns:

The decoded control, or null if the control is not included with this protocol-op.

Throws:

DecodeException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

getControls

public final List<Control> getControls()

Description copied from interface: ProtocolOp

Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.