Package com.unboundid.directory.sdk.ds.types

Class PostConnectPluginResult

java.lang.Object

com.unboundid.directory.sdk.ds.types.PostConnectPluginResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	connectionTerminated()	Indicates whether the connection has been terminated.
boolean	continuePluginProcessing()	Indicates whether to continue processing other post-connect plugins for the connection.
java.lang.String	toString()	Retrieves a string representation of this post-connect 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 PostConnectPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

PostConnectPluginResult

public PostConnectPluginResult(boolean connectionTerminated,
                               boolean continuePluginProcessing)

Creates a new post-connect plugin result with the provided information.

Parameters:

connectionTerminated - Indicates whether the connection has been terminated.

continuePluginProcessing - Indicates whether to continue processing other post-connect plugins for the connection.

Method Detail

connectionTerminated

public boolean connectionTerminated()

Indicates whether the connection has been terminated.

Returns:

true if the connection has been terminated, or false if not.

continuePluginProcessing

public boolean continuePluginProcessing()

Indicates whether to continue processing other post-connect plugins for the connection.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this post-connect plugin result.