Package com.unboundid.directory.sdk.common.types

Class PostManageExtensionPluginResult

java.lang.Object

com.unboundid.directory.sdk.common.types.PostManageExtensionPluginResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
PostManageExtensionPluginResult(boolean restartServer, java.util.List<java.lang.String> messages)	Creates a new post manage extension plugin result with the provided information.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getMessages()	Retrieves the list of messages to print to the console.
boolean	restartServer()	Indicates whether the manage-extension tool should restart the server after the installation if it was previous started.
java.lang.String	toString()	Retrieves a string representation of this post manage extension 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 PostManageExtensionPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

PostManageExtensionPluginResult

public PostManageExtensionPluginResult(boolean restartServer,
                                       java.util.List<java.lang.String> messages)

Creates a new post manage extension plugin result with the provided information.

Parameters:

restartServer - Indicates whether the manage-extension tool should restart the server after the installation if it was previous started.

messages - Messages to print to the console or null.

Method Detail

restartServer

public boolean restartServer()

Indicates whether the manage-extension tool should restart the server after the installation if it was previous started.

Returns:

true the manage-extension tool should restart the server, or false if not.

getMessages

public java.util.List<java.lang.String> getMessages()

Retrieves the list of messages to print to the console.

Returns:

The list of messages to print to the console or null if no messages are to be printed.

toString

public java.lang.String toString()

Retrieves a string representation of this post manage extension plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this post manage extension plugin result.