com.unboundid.directory.sdk.ds.types
Class PreOperationPluginResult

java.lang.Object
  com.unboundid.directory.sdk.ds.types.PreOperationPluginResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PreOperationPluginResult
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 pre-operation plugin.

See Also:

Serialized Form

Field Summary

static PreOperationPluginResult

SUCCESS A predefined result instance that indicates all processing completed successfully.

Constructor Summary

PreOperationPluginResult(boolean connectionTerminated, boolean continuePluginProcessing, boolean sendResponseImmediately, boolean skipCoreProcessing)
Creates a new pre-operation plugin result with the provided information.

Method Summary

boolean	connectionTerminated() Indicates whether the client connection was terminated by the plugin.
boolean	continuePluginProcessing() Indicates whether to continue processing other pre-operation plugins for the connection.
boolean	sendResponseImmediately() Indicates whether the server should send a response to the client immediately without performing any core processing.
boolean	skipCoreProcessing() Indicates whether the server should skip the core processing for the operation.
java.lang.String	toString() Retrieves a string representation of this pre-operation 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 PreOperationPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

PreOperationPluginResult

public PreOperationPluginResult(boolean connectionTerminated,
                                boolean continuePluginProcessing,
                                boolean sendResponseImmediately,
                                boolean skipCoreProcessing)

Creates a new pre-operation 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 pre-operation plugins for the operation.

sendResponseImmediately - Indicates whether to send the response to the client immediately without performing any of the core processing.

skipCoreProcessing - Indicates whether the server should skip the core processing for the operation. If this is true but sendResponseImmediately is false, then any post-operation plugins will still be invoked.

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 pre-operation plugins for the connection.

Returns:

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

sendResponseImmediately

public boolean sendResponseImmediately()

Indicates whether the server should send a response to the client immediately without performing any core processing.

Returns:

true if the server should send a response to the client immediately without

skipCoreProcessing

public boolean skipCoreProcessing()

Indicates whether the server should skip the core processing for the operation.

Returns:

true if the server should skip the core processing for the operation, or false if not.

toString

public java.lang.String toString()

Retrieves a string representation of this pre-operation plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this pre-operation plugin result.