Package org.forgerock.opendj.ldap.messages

Interface GenericIntermediateResponse

All Superinterfaces:

IntermediateResponse, ProtocolOp, Response

public interface GenericIntermediateResponse
extends IntermediateResponse

A Generic Intermediate response provides a mechanism for communicating unrecognized or unsupported Intermediate responses to the client.

Method Summary

Modifier and Type	Method	Description
GenericIntermediateResponse	addControl(Control control)	Adds the provided control to this protocol-op.
GenericIntermediateResponse	addControls(Iterable<? extends Control> controls)	Adds the provided controls to this protocol-op.
<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.
List<Control>	getControls()	Returns a List containing the controls included with this protocol-op.
String	getOid()	Returns the numeric OID, if any, associated with this intermediate response.
ByteString	getValue()	Returns the value, if any, associated with this intermediate response.
boolean	hasValue()	Returns true if this intermediate response has a value.
GenericIntermediateResponse	setOid(String oid)	Sets the numeric OID, if any, associated with this intermediate response.
GenericIntermediateResponse	setValue(Object value)	Sets the value, if any, associated with this intermediate response.

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

containsControl, getControl

Method Detail

addControl

GenericIntermediateResponse addControl(Control control)

Description copied from interface: ProtocolOp

Adds the provided control to this protocol-op.

Specified by:

addControl in interface IntermediateResponse

Specified by:

addControl in interface ProtocolOp

Specified by:

addControl in interface Response

Parameters:

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

Returns:

This protocol-op.

addControls

GenericIntermediateResponse addControls(Iterable<? extends Control> controls)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface IntermediateResponse

Specified by:

addControls in interface ProtocolOp

Specified by:

addControls in interface Response

Parameters:

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

Returns:

This protocol-op.

getControl

<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 IntermediateResponse

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

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 IntermediateResponse

Specified by:

getControls in interface ProtocolOp

Returns:

A List containing the controls.

getOid

String getOid()

Description copied from interface: IntermediateResponse

Returns the numeric OID, if any, associated with this intermediate response.

Specified by:

getOid in interface IntermediateResponse

Returns:

The numeric OID associated with this intermediate response, or null if there is no OID.

getValue

ByteString getValue()

Description copied from interface: IntermediateResponse

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

Specified by:

getValue in interface IntermediateResponse

Returns:

The value associated with this intermediate response, or null if there is no value.

hasValue

boolean hasValue()

Description copied from interface: IntermediateResponse

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

Specified by:

hasValue in interface IntermediateResponse

Returns:

true if this intermediate response has a value, or false if there is no value.

setOid

GenericIntermediateResponse setOid(String oid)

Sets the numeric OID, if any, associated with this intermediate response.

Parameters:

oid - The numeric OID associated with this intermediate response, or null if there is no value.

Returns:

This generic intermediate response.

Throws:

UnsupportedOperationException - If this intermediate response does not permit the response name to be set.

setValue

GenericIntermediateResponse setValue(Object value)

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

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

Parameters:

value - The value associated with this intermediate response, or null if there is no value.

Returns:

This generic intermediate response.

Throws:

UnsupportedOperationException - If this intermediate response does not permit the response value to be set.