/*
|
* 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
|
*
|
*
|
* Portions Copyright 2006 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api.plugin;
|
|
|
|
import static org.opends.server.loggers.Debug.*;
|
|
|
|
/**
|
* This class defines a data structure that holds information about
|
* the result of processing by a post-disconnect plugin.
|
*/
|
public class PostDisconnectPluginResult
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.api.plugin.PostDisconnectPluginResult";
|
|
|
|
/**
|
* A post-disconnect plugin result instance that indicates all
|
* processing was successful.
|
*/
|
public static final PostDisconnectPluginResult SUCCESS =
|
new PostDisconnectPluginResult();
|
|
|
|
// Indicates whether any further post-disconnect plugins should be
|
// invoked for this connection.
|
private final boolean continuePluginProcessing;
|
|
|
|
/**
|
* Creates a new post-connect plugin result with the default
|
* settings. In this case, it will indicate that the further
|
* post-disconnect plugin processing should be allowed.
|
*/
|
private PostDisconnectPluginResult()
|
{
|
this(true);
|
}
|
|
|
|
/**
|
* Creates a new post-disconnect plugin result with the provided
|
* information.
|
*
|
* @param continuePluginProcessing Indicates whether any further
|
* post-disconnect plugins should
|
* be invoked for this connection.
|
*/
|
public PostDisconnectPluginResult(boolean continuePluginProcessing)
|
{
|
assert debugConstructor(CLASS_NAME,
|
String.valueOf(continuePluginProcessing));
|
|
this.continuePluginProcessing = continuePluginProcessing;
|
}
|
|
|
|
/**
|
* Indicates whether any further post-disconnect plugins should be
|
* invoked for this connection.
|
*
|
* @return <CODE>true</CODE> if any further post-disconnect plugins
|
* should be invoked for this connection, or
|
* <CODE>false</CODE> if not.
|
*/
|
public boolean continuePluginProcessing()
|
{
|
assert debugEnter(CLASS_NAME, "continuePluginProcessing");
|
|
return continuePluginProcessing;
|
}
|
|
|
|
/**
|
* Retrieves a string representation of this post-connect plugin
|
* result.
|
*
|
* @return A string representation of this post-connect plugin
|
* result.
|
*/
|
public String toString()
|
{
|
assert debugEnter(CLASS_NAME, "toString");
|
|
StringBuilder buffer = new StringBuilder();
|
toString(buffer);
|
return buffer.toString();
|
}
|
|
|
|
/**
|
* Appends a string representation of this post-connect plugin
|
* result to the provided buffer.
|
*
|
* @param buffer The buffer to which the information should be
|
* appended.
|
*/
|
public void toString(StringBuilder buffer)
|
{
|
assert debugEnter(CLASS_NAME, "toString",
|
"java.lang.StringBuilder");
|
|
buffer.append("PostDisconnectPluginResult(" +
|
"continuePluginProcessing=");
|
buffer.append(continuePluginProcessing);
|
buffer.append(")");
|
}
|
}
|
