Class IntermediateResponsePluginResult
- java.lang.Object
-
- com.unboundid.directory.sdk.ds.types.IntermediateResponsePluginResult
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IntermediateResponsePluginResult extends java.lang.Object implements java.io.Serializable
This class defines a structure which may be used to provide information about the result of the processing performed by an intermediate response plugin.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static IntermediateResponsePluginResult
SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
Constructor Summary
Constructors Constructor Description IntermediateResponsePluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendIntermediateResponse, boolean continueOperationProcessing)
Creates a new intermediate response plugin result with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
connectionTerminated()
Indicates whether the client connection was terminated by the plugin.boolean
continueOperationProcessing()
Indicates whether to continue processing for the associated operation.boolean
continuePluginProcessing()
Indicates whether to continue processing other intermediate response plugins for the associated response.boolean
sendIntermediateResponse()
Indicates whether the associated intermediate response should be returned to the client.java.lang.String
toString()
Retrieves a string representation of this intermediate response plugin result.
-
-
-
Field Detail
-
SUCCESS
public static final IntermediateResponsePluginResult SUCCESS
A predefined result instance that indicates all processing completed successfully.
-
-
Constructor Detail
-
IntermediateResponsePluginResult
public IntermediateResponsePluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendIntermediateResponse, boolean continueOperationProcessing)
Creates a new intermediate response plugin result with the provided information.- Parameters:
connectionTerminated
- Indicates whether the client connection was terminated by the plugin.continuePluginProcessing
- Indicates whether to continue processing other intermediate response plugins for the associated response.sendIntermediateResponse
- Indicates whether to send the intermediate response to the client.continueOperationProcessing
- Indicates whether to continue processing the associated operation.
-
-
Method Detail
-
connectionTerminated
public boolean connectionTerminated()
Indicates whether the client connection was terminated by the plugin.- Returns:
true
if the client connection was terminated by the plugin, orfalse
if not.
-
continuePluginProcessing
public boolean continuePluginProcessing()
Indicates whether to continue processing other intermediate response plugins for the associated response.- Returns:
true
if the server should continue processing other intermediate response plugins for the associated response, orfalse
if not.
-
sendIntermediateResponse
public boolean sendIntermediateResponse()
Indicates whether the associated intermediate response should be returned to the client.- Returns:
true
if the intermediate response should be returned to the client, orfalse
if the server should not return the intermediate response to the client.
-
continueOperationProcessing
public boolean continueOperationProcessing()
Indicates whether to continue processing for the associated operation.- Returns:
true
if the server should continue processing for the associated operation, orfalse
if not and the operation response should be sent to the client.
-
toString
public java.lang.String toString()
Retrieves a string representation of this intermediate response plugin result.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this intermediate response plugin result.
-
-