Package org.forgerock.opendj.ldap.messages

Interface Response

All Superinterfaces:

ProtocolOp

All Known Subinterfaces:

BindResult, CompareResult, ExtendedResult, GenericExtendedResult, GenericIntermediateResponse, IntermediateResponse, PasswordModifyExtendedResult, Result, SearchResultEntry, SearchResultReference, StartTlsExtendedResult, WhoAmIExtendedResult

All Known Implementing Classes:

AbstractExtendedResult, AbstractIntermediateResponse

public interface Response
extends ProtocolOp

The base class of all Responses provides methods for querying and manipulating the set of Controls included with a Response.

Method Summary

Modifier and Type	Method	Description
Response	addControl(Control control)	Adds the provided control to this protocol-op.
Response	addControls(Iterable<? extends Control> control)	Adds the provided controls to this protocol-op.
Response	removeControls(String oid)	Removes all the controls having the specified OID.

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

containsControl, getControl, getControl, getControls

Method Details

addControl

Response 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

Response addControls(Iterable<? extends Control> control)

Description copied from interface: ProtocolOp

Adds the provided controls to this protocol-op.

Specified by:

addControls in interface ProtocolOp

Parameters:

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

Returns:

This protocol-op.

removeControls

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