/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api.plugin;
|
import org.opends.messages.Message;
|
import org.opends.messages.MessageDescriptor;
|
|
|
/**
|
* This class defines a data structure that holds information about
|
* the result of processing by a plugin invoked during the Directory
|
* Server startup process.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
|
mayInstantiate=true,
|
mayExtend=false,
|
mayInvoke=true)
|
public class StartupPluginResult
|
{
|
/**
|
* A startup plugin result instance that indicates all processing
|
* was successful.
|
*/
|
public static final StartupPluginResult SUCCESS =
|
new StartupPluginResult();
|
|
|
|
// Indicates whether the startup plugin completed successfully.
|
private final boolean completedSuccessfully;
|
|
// Indicates whether the server should continue with the startup
|
// process.
|
private final boolean continueStartup;
|
|
// A message that explains any error that might have
|
// occurred.
|
private final Message errorMessage;
|
|
|
|
/**
|
* Creates a new startup plugin result with the default settings.
|
* In this case, it will indicate that the plugin completed
|
* successfully, that the startup process should continue, and that
|
* there is no error message.
|
*/
|
private StartupPluginResult()
|
{
|
this(true, true, null);
|
}
|
|
|
|
/**
|
* Creates a new startup plugin result with the provided
|
* information.
|
*
|
* @param completedSuccessfully Indicates whether the startup
|
* plugin completed its processing
|
* successfully.
|
* @param continueStartup Indicates whether the Directory
|
* Server should continue with its
|
* startup process.
|
* @param errorMessage An error message that explains any
|
* error that might have occurred.
|
*/
|
public StartupPluginResult(boolean completedSuccessfully,
|
boolean continueStartup,
|
Message errorMessage)
|
{
|
this.completedSuccessfully = completedSuccessfully;
|
this.continueStartup = continueStartup;
|
this.errorMessage = errorMessage;
|
}
|
|
|
|
/**
|
* Indicates whether the startup plugin completed its processing
|
* successfully.
|
*
|
* @return {@code true} if the startup plugin completed its
|
* processing successfully, or {@code false} if not.
|
*/
|
public boolean completedSuccessfully()
|
{
|
return completedSuccessfully;
|
}
|
|
|
|
/**
|
* Indicates whether the Directory Server should continue with its
|
* startup process.
|
*
|
* @return {@code true} if the Directory Server should continue
|
* with its startup process, or {@code false} if not.
|
*/
|
public boolean continueStartup()
|
{
|
return continueStartup;
|
}
|
|
|
|
/**
|
* Retrieves the human-readable error message generated by the
|
* startup plugin.
|
*
|
* @return The human-readable error message generated by the
|
* startup plugin, or {@code null} if there is no error
|
* message.
|
*/
|
public Message getErrorMessage()
|
{
|
return errorMessage;
|
}
|
|
|
|
/**
|
* Retrieves a string representation of this startup plugin result.
|
*
|
* @return A string representation of this startup plugin result.
|
*/
|
public String toString()
|
{
|
StringBuilder buffer = new StringBuilder();
|
toString(buffer);
|
return buffer.toString();
|
}
|
|
|
|
/**
|
* Appends a string representation of this startup plugin result to
|
* the provided buffer.
|
*
|
* @param buffer The buffer to which the information should be
|
* appended.
|
*/
|
public void toString(StringBuilder buffer)
|
{
|
buffer.append("StartupPluginResult(completedSuccessfully=");
|
buffer.append(completedSuccessfully);
|
buffer.append(", continueStartup=");
|
buffer.append(continueStartup);
|
buffer.append(", errorID=");
|
if (errorMessage != null) {
|
buffer.append(errorMessage.getDescriptor().getId());
|
} else {
|
buffer.append(MessageDescriptor.NULL_ID);
|
}
|
buffer.append(", errorMessage=\"");
|
buffer.append(errorMessage);
|
buffer.append("\")");
|
}
|
}
|
