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

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

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

static StartupPluginResult

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

Constructor Summary

StartupPluginResult(boolean completedSuccessfully, boolean continueStartup, java.lang.CharSequence message)
Creates a new startup plugin result with the provided information.

Method Summary

boolean	completedSuccessfully() Indicates whether the plugin successfully completed its processing.
boolean	continueStartup() Indicates whether the server startup process should continue.
java.lang.String	getMessage() Retrieves a message with additional information about the processing performed by this plugin, if available.
java.lang.String	toString() Retrieves a string representation of this startup 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 StartupPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

StartupPluginResult

public StartupPluginResult(boolean completedSuccessfully,
                           boolean continueStartup,
                           java.lang.CharSequence message)

Creates a new startup plugin result with the provided information.

Parameters:

completedSuccessfully - Indicates whether the plugin successfully completed its processing.

continueStartup - Indicates whether server startup processing should continue.

message - An optional message providing additional information about the result of the plugin processing.

Method Detail

completedSuccessfully

public boolean completedSuccessfully()

Indicates whether the plugin successfully completed its processing.

Returns:

true if the plugin successfully completed its processing, or false if not.

continueStartup

public boolean continueStartup()

Indicates whether the server startup process should continue.

Returns:

true if the server startup process should continue, or false if not.

getMessage

public java.lang.String getMessage()

Retrieves a message with additional information about the processing performed by this plugin, if available.

Returns:

A message with additional information about the processing performed by this plugin, or null if none is available.

toString

public java.lang.String toString()

Retrieves a string representation of this startup plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this startup plugin result.