org.opends.server.types
Class IntermediateResponse

java.lang.Object
  org.opends.server.types.IntermediateResponse

@PublicAPI(stability=VOLATILE,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class IntermediateResponse
extends java.lang.Object

This class defines a data structure for holding information that may be sent to the client in the form of an intermediate response. It may contain an OID, value, and/or set of controls.

Constructor Summary

IntermediateResponse(Operation operation, java.lang.String oid, ASN1OctetString value, java.util.List<Control> controls)
Creates a new intermediate response with the provided information.

Method Summary

java.util.List<Control>	getControls() Retrieves the set of controls for this intermediate response.
java.lang.String	getOID() Retrieves the OID for this intermediate response.
Operation	getOperation() Retrieves the operation with which this intermediate response message is associated.
ASN1OctetString	getValue() Retrieves the value for this intermediate response.
void	setOID(java.lang.String oid) Specifies the OID for this intermediate response.
void	setValue(ASN1OctetString value) Specifies the value for this intermediate response.
java.lang.String	toString() Retrieves a string representation of this intermediate response.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this intermediate response to the provided buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntermediateResponse

public IntermediateResponse(Operation operation,
                            java.lang.String oid,
                            ASN1OctetString value,
                            java.util.List<Control> controls)

Creates a new intermediate response with the provided information.

Parameters:

operation - The operation with which this intermediate response is associated.

oid - The OID for this intermediate response.

value - The value for this intermediate response.

controls - The set of controls to for this intermediate response.

Method Detail

getOperation

public Operation getOperation()

Retrieves the operation with which this intermediate response message is associated.

Returns:

The operation with which this intermediate response message is associated.

getOID

public java.lang.String getOID()

Retrieves the OID for this intermediate response.

Returns:

The OID for this intermediate response, or null if there is none.

setOID

public void setOID(java.lang.String oid)

Specifies the OID for this intermediate response.

Parameters:

oid - The OID for this intermediate response.

getValue

public ASN1OctetString getValue()

Retrieves the value for this intermediate response.

Returns:

The value for this intermediate response, or null if there is none.

setValue

public void setValue(ASN1OctetString value)

Specifies the value for this intermediate response.

Parameters:

value - The value for this intermediate response.

getControls

public java.util.List<Control> getControls()

Retrieves the set of controls for this intermediate response. The contents of the list may be altered by intermediate response plugins.

Returns:

The set of controls for this intermediate response.

toString

public java.lang.String toString()

Retrieves a string representation of this intermediate response.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this intermediate response.

toString

public void toString(java.lang.StringBuilder buffer)

Appends a string representation of this intermediate response to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.