com.unboundid.directory.sdk.ds.types

Class PostResponsePluginResult

java.lang.Object

com.unboundid.directory.sdk.ds.types.PostResponsePluginResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PostResponsePluginResult
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 a post-response plugin.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PostResponsePluginResult	SUCCESS A predefined result instance that indicates all processing completed successfully.

Constructor Summary

Constructors

Constructor and Description
PostResponsePluginResult(boolean connectionTerminated, boolean continuePluginProcessing) Creates a new post-response plugin result with the provided information.

Method Summary

Modifier and Type	Method and Description
boolean	connectionTerminated() Indicates whether the client connection was terminated by the plugin.
boolean	continuePluginProcessing() Indicates whether to continue processing other post-response plugins for the operation.
java.lang.String	toString() Retrieves a string representation of this post-response plugin result.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final PostResponsePluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

PostResponsePluginResult

public PostResponsePluginResult(boolean connectionTerminated,
                                boolean continuePluginProcessing)

Creates a new post-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 post-response plugins for the 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, or false if not.

continuePluginProcessing

public boolean continuePluginProcessing()

Indicates whether to continue processing other post-response plugins for the operation.

Returns:

true if the server should continue processing other post-operation plugins for the operation, or false if not.

toString

public java.lang.String toString()

Retrieves a string representation of this post-response plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this post-response plugin result.