/*
|
* 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-2009 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api.plugin;
|
import org.opends.messages.Message;
|
|
|
|
import java.util.List;
|
import java.util.Set;
|
|
import org.opends.server.admin.std.server.PluginCfg;
|
import org.opends.server.api.ClientConnection;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.types.*;
|
import org.opends.server.types.operation.*;
|
|
import static org.opends.messages.PluginMessages.*;
|
|
|
/**
|
* This class defines the set of methods and structures that are
|
* available for use in Directory Server plugins. This is a single
|
* class that may be used for all types of plugins, and an individual
|
* plugin only needs to implement the specific methods that are
|
* applicable to that particular plugin type.
|
*
|
* @param <T> The type of configuration handled by this plugin.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
|
mayInstantiate=false,
|
mayExtend=true,
|
mayInvoke=false)
|
public abstract class DirectoryServerPlugin
|
<T extends PluginCfg>
|
{
|
// Indicates whether this plugin should be invoked for internal
|
// operations.
|
private boolean invokeForInternalOps;
|
|
// The DN of the configuration entry for this plugin.
|
private DN pluginDN;
|
|
// The plugin types for which this plugin is registered.
|
private Set<PluginType> pluginTypes;
|
|
|
|
/**
|
* Creates a new instance of this Directory Server plugin. Every
|
* plugin must implement a default constructor (it is the only one
|
* that will be used to create plugins defined in the
|
* configuration), and every plugin constructor must call
|
* {@code super()} as its first action.
|
*/
|
protected DirectoryServerPlugin()
|
{
|
}
|
|
|
|
/**
|
* Indicates whether the provided configuration is acceptable for
|
* this plugin. It should be possible to call this method on an
|
* uninitialized plugin instance in order to determine whether the
|
* plugin would be able to use the provided configuration.
|
*
|
* @param configuration The plugin configuration for which
|
* to make the determination.
|
* @param unacceptableReasons A list that may be used to hold the
|
* reasons that the provided
|
* configuration is not acceptable.
|
*
|
* @return {@code true} if the provided configuration is acceptable
|
* for this plugin, or {@code false} if not.
|
*/
|
public boolean isConfigurationAcceptable(PluginCfg configuration,
|
List<Message> unacceptableReasons)
|
{
|
// This default implementation does not perform any special
|
// validation. It should be overridden by plugin implementations
|
// that wish to perform more detailed validation.
|
return true;
|
}
|
|
|
|
/**
|
* Performs any initialization that should be done for all types of
|
* plugins regardless of type. This should only be called by the
|
* core Directory Server code during the course of loading a plugin.
|
*
|
* @param configuration The configuration for this plugin.
|
* @param pluginTypes The set of plugin types for which this
|
* plugin is registered.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.PRIVATE,
|
mayInstantiate=false,
|
mayExtend=false,
|
mayInvoke=false)
|
public final void initializeInternal(PluginCfg configuration,
|
Set<PluginType> pluginTypes)
|
{
|
this.pluginTypes = pluginTypes;
|
|
pluginDN = configuration.dn();
|
invokeForInternalOps =
|
configuration.isInvokeForInternalOperations();
|
}
|
|
|
|
/**
|
* Performs any initialization necessary for this plugin. This will
|
* be called as soon as the plugin has been loaded and before it is
|
* registered with the server.
|
*
|
* @param pluginTypes The set of plugin types that indicate the
|
* ways in which this plugin will be invoked.
|
* @param configuration The configuration for this plugin.
|
*
|
* @throws ConfigException If the provided entry does not contain
|
* a valid configuration for this plugin.
|
*
|
* @throws InitializationException If a problem occurs while
|
* initializing the plugin that is
|
* not related to the server
|
* configuration.
|
*/
|
public abstract void initializePlugin(Set<PluginType> pluginTypes,
|
T configuration)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* Performs any necessary finalization for this plugin. This will
|
* be called just after the plugin has been deregistered with the
|
* server but before it has been unloaded.
|
*/
|
public void finalizePlugin()
|
{
|
// No implementation is required by default.
|
}
|
|
|
|
/**
|
* Retrieves the DN of the configuration entry for this plugin.
|
*
|
* @return The DN of the configuration entry for this plugin.
|
*/
|
public final DN getPluginEntryDN()
|
{
|
return pluginDN;
|
}
|
|
|
|
/**
|
* Retrieves the plugin types for which this plugin is registered.
|
* This set must not be modified.
|
*
|
* @return The plugin types for which this plugin is registered.
|
*/
|
public final Set<PluginType> getPluginTypes()
|
{
|
return pluginTypes;
|
}
|
|
|
|
/**
|
* Indicates whether this plugin should be invoked for internal
|
* operations.
|
*
|
* @return {@code true} if this plugin should be invoked for
|
* internal operations, or {@code false} if not.
|
*/
|
public final boolean invokeForInternalOperations()
|
{
|
return invokeForInternalOps;
|
}
|
|
|
|
/**
|
* Specifies whether this plugin should be invoked for internal
|
* operations.
|
*
|
* @param invokeForInternalOps Indicates whether this plugin
|
* should be invoked for internal
|
* operations.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.PRIVATE,
|
mayInstantiate=false,
|
mayExtend=false,
|
mayInvoke=false)
|
public final void setInvokeForInternalOperations(
|
boolean invokeForInternalOps)
|
{
|
this.invokeForInternalOps = invokeForInternalOps;
|
}
|
|
|
|
/**
|
* Performs any processing that should be done when the Directory
|
* Server is in the process of starting. This method will be called
|
* after virtually all other initialization has been performed but
|
* before the connection handlers are started.
|
*
|
* @return The result of the startup plugin processing.
|
*/
|
public PluginResult.Startup doStartup()
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.STARTUP.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any processing that should be done when the Directory
|
* Server is in the process of performing a graceful shutdown. This
|
* method will be called early in the shutdown process after the
|
* connection handlers are stopped but before other finalization is
|
* performed.
|
*
|
* @param reason The human-readable reason for the shutdown.
|
*/
|
public void doShutdown(Message reason)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.SHUTDOWN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any processing that should be done when the Directory
|
* Server accepts a new connection from a client. This method will
|
* be called after additional verification is performed to ensure
|
* that the connection should be accepted.
|
*
|
* @param clientConnection The client connection that has been
|
* accepted.
|
*
|
* @return The result of the plugin processing.
|
*/
|
public PluginResult.PostConnect doPostConnect(ClientConnection
|
clientConnection)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.POST_CONNECT.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any processing that should be done whenever a client
|
* connection is closed (regardless of whether the closure is
|
* initiated by the client or the server).
|
*
|
* @param clientConnection The client connection that has been
|
* closed.
|
* @param disconnectReason The disconnect reason for the closure.
|
* @param message A message providing additional
|
* information about the closure, or
|
* {@code null} if there is none.
|
*
|
* @return The result of the plugin processing.
|
*/
|
public PluginResult.PostDisconnect
|
doPostDisconnect(ClientConnection clientConnection,
|
DisconnectReason disconnectReason,
|
Message message)
|
{
|
Message msg = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_DISCONNECT.getName());
|
throw new UnsupportedOperationException(msg.toString());
|
}
|
|
|
/**
|
* Performs any necessary processing that should be done during an
|
* LDIF import operation immediately after reading an entry and
|
* confirming that it should be imported based on the provided
|
* configuration.
|
*
|
* @param importConfig The configuration used for the LDIF import.
|
* @param entry The entry that has been read to the LDIF
|
* file.
|
*
|
* @return The result of the plugin processing.
|
*/
|
public PluginResult.ImportLDIF
|
doLDIFImport(LDIFImportConfig importConfig, Entry entry)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.LDIF_IMPORT.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
/**
|
* Terminates an import session.
|
* Performs any necessary processing that should be done at the end
|
* of an LDIF import session based on the provided configuration.
|
*
|
* @param importConfig The configuration used for the LDIF import.
|
*/
|
public void doLDIFImportEnd(LDIFImportConfig importConfig)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN),
|
PluginType.LDIF_IMPORT_END.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
/**
|
* Performs any necessary processing that should be done during an
|
* LDIF export operation immediately after determining that the
|
* provided entry should be included in the export.
|
*
|
* @param exportConfig The configuration used for the LDIF export.
|
* @param entry The entry to be written to the LDIF file.
|
*
|
* @return The result of the plugin processing.
|
*/
|
public PluginResult.ImportLDIF
|
doLDIFExport(LDIFExportConfig exportConfig, Entry entry)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.LDIF_EXPORT.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of an abandon request.
|
*
|
* @param abandonOperation The abandon operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseAbandonOperation abandonOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_ABANDON.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for an abandon
|
* operation.
|
*
|
* @param abandonOperation The abandon operation for which
|
* processing has completed.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationAbandonOperation abandonOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_ABANDON.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of an add request.
|
*
|
* @param addOperation The add operation that has been requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseAddOperation addOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN), PluginType.PRE_PARSE_ADD.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for an add
|
* operation.
|
* This method is not called when processing synchronization
|
* operations.
|
*
|
* @param addOperation The add operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationAddOperation addOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_ADD.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for an add
|
* operation but before the response has been sent to the client.
|
*
|
* @param addOperation The add operation for which processing has
|
* completed but no response has yet been
|
* sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationAddOperation addOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_ADD.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for an add
|
* operation and has sent the response to the client.
|
*
|
* @param addOperation The add operation for which processing has
|
* completed and the response has been sent to
|
* the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseAddOperation addOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_ADD.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for an add operation
|
* performed via synchronization.
|
*
|
* @param addOperation The synchronized add operation for which
|
* processing has been completed.
|
*/
|
public void doPostSynchronization(
|
PostSynchronizationAddOperation addOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_SYNCHRONIZATION_ADD.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a bind request.
|
*
|
* @param bindOperation The bind operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseBindOperation bindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_BIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a bind
|
* operation.
|
*
|
* @param bindOperation The bind operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationBindOperation bindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_BIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a bind
|
* operation but before the response has been sent to the client.
|
*
|
* @param bindOperation The bind operation for which processing
|
* has completed but no response has yet been
|
* sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationBindOperation bindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_BIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a bind
|
* operation and has sent the response to the client.
|
*
|
* @param bindOperation The bind operation for which processing
|
* has completed and the response has been
|
* sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseBindOperation bindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_BIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a compare request.
|
*
|
* @param compareOperation The compare operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseCompareOperation compareOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_COMPARE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a compare
|
* operation.
|
*
|
* @param compareOperation The compare operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationCompareOperation compareOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_COMPARE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a compare
|
* operation but before the response has been sent to the client.
|
*
|
* @param compareOperation The compare operation for which
|
* processing has completed but no
|
* response has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationCompareOperation compareOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_COMPARE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a compare
|
* operation and has sent the response to the client.
|
*
|
* @param compareOperation The compare operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseCompareOperation compareOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_COMPARE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a delete request.
|
*
|
* @param deleteOperation The delete operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseDeleteOperation deleteOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_DELETE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a delete
|
* operation.
|
* This method is not called when processing synchronization
|
* operations.
|
*
|
* @param deleteOperation The delete operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationDeleteOperation deleteOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_DELETE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a delete
|
* operation but before the response has been sent to the client.
|
*
|
* @param deleteOperation The delete operation for which
|
* processing has completed but no
|
* response has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationDeleteOperation deleteOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_DELETE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a delete
|
* operation and has sent the response to the client.
|
*
|
* @param deleteOperation The delete operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseDeleteOperation deleteOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_DELETE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for a delete operation
|
* performed via synchronization.
|
*
|
* @param deleteOperation The synchronized delete operation for
|
* which processing has been completed.
|
*/
|
public void doPostSynchronization(
|
PostSynchronizationDeleteOperation deleteOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_SYNCHRONIZATION_DELETE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of an extended request.
|
*
|
* @param extendedOperation The extended operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseExtendedOperation extendedOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_EXTENDED.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for an extended
|
* operation.
|
*
|
* @param extendedOperation The extended operation to be
|
* processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationExtendedOperation extendedOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_EXTENDED.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for an
|
* extended operation but before the response has been sent to the
|
* client.
|
*
|
* @param extendedOperation The extended operation for which
|
* processing has completed but no
|
* response has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationExtendedOperation
|
extendedOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_EXTENDED.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for an extended
|
* operation and has sent the response to the client.
|
*
|
* @param extendedOperation The extended operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseExtendedOperation extendedOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_EXTENDED.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a modify request.
|
*
|
* @param modifyOperation The modify operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseModifyOperation modifyOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_MODIFY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a modify
|
* operation.
|
*
|
* This method is not called when processing synchronization
|
* operations.
|
* @param modifyOperation The modify operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationModifyOperation modifyOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_MODIFY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a modify
|
* operation but before the response has been sent to the client.
|
*
|
* @param modifyOperation The modify operation for which
|
* processing has completed but no response
|
* has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationModifyOperation modifyOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_MODIFY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a modify
|
* operation and has sent the response to the client.
|
*
|
* @param modifyOperation The modify operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseModifyOperation modifyOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_MODIFY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for a modify operation
|
* performed via synchronization.
|
*
|
* @param modifyOperation The synchronized modify operation for
|
* which processing has been completed.
|
*/
|
public void doPostSynchronization(
|
PostSynchronizationModifyOperation modifyOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_SYNCHRONIZATION_MODIFY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a modify DN request.
|
*
|
* @param modifyDNOperation The modify DN operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseModifyDNOperation modifyDNOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a modify DN
|
* operation.
|
* This method is not called when processing synchronization
|
* operations.
|
*
|
* @param modifyDNOperation The modify DN operation to be
|
* processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done whenever a
|
* subordinate entry is moved or renamed as part of a modify DN
|
* operation. Note that if the entry is to be changed in any way,
|
* the new entry should be directly modified, and the changes made
|
* should also be added to the provided list of modifications.
|
* <BR><BR>
|
* NOTE: At the present time, OpenDS does not provide support for
|
* altering entries subordinate to the target of a modify DN
|
* operation. While this may be available in the future, current
|
* plugins should not attempt to alter the new or old entries in any
|
* way, nor should they attempt to add any modifications to the
|
* provided list.
|
*
|
* @param modifyDNOperation The modify DN operation with which the
|
* subordinate entry is associated.
|
* @param oldEntry The subordinate entry prior to the
|
* move/rename operation.
|
* @param newEntry The subordinate enry after the
|
* move/rename operation.
|
* @param modifications A list into which any modifications
|
* made to the target entry should be
|
* placed.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.SubordinateModifyDN
|
processSubordinateModifyDN(SubordinateModifyDNOperation
|
modifyDNOperation,
|
Entry oldEntry, Entry newEntry,
|
List<Modification> modifications)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.get(
|
String.valueOf(pluginDN),
|
PluginType.SUBORDINATE_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a modify
|
* DN operation but before the response has been sent to the client.
|
*
|
* @param modifyDNOperation The modify DN operation for which
|
* processing has completed but no
|
* response has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationModifyDNOperation
|
modifyDNOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a modify DN
|
* operation and has sent the response to the client.
|
*
|
* @param modifyDNOperation The modifyDN operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseModifyDNOperation modifyDNOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for a modify DN
|
* operation performed via synchronization.
|
*
|
* @param modifyDNOperation The synchronized modify DN operation
|
* for which processing has been
|
* completed.
|
*/
|
public void doPostSynchronization(
|
PostSynchronizationModifyDNOperation modifyDNOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_SYNCHRONIZATION_MODIFY_DN.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of a search request.
|
*
|
* @param searchOperation The search operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseSearchOperation searchOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_SEARCH.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done just before
|
* the Directory Server performs the core processing for a search
|
* operation.
|
*
|
* @param searchOperation The search operation to be processed.
|
*
|
* @return Information about the result of the plugin processing.
|
*
|
* @throws CanceledOperationException if this operation should
|
* be cancelled.
|
*/
|
public PluginResult.PreOperation
|
doPreOperation(PreOperationSearchOperation searchOperation)
|
throws CanceledOperationException {
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_OPERATION_SEARCH.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before a
|
* search result entry is sent to a client. This will be called
|
* after it has been verified that the entry does actually match the
|
* search criteria and after access control has been enforced to
|
* ensure that the entry should be sent and/or to strip out
|
* attributes/values that the user should not see.
|
*
|
* @param searchOperation The search operation with which the
|
* search entry is associated.
|
* @param searchEntry The search result entry that is to be
|
* sent to the client. Its contents may be
|
* altered by the plugin if necessary.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.IntermediateResponse
|
processSearchEntry(SearchEntrySearchOperation searchOperation,
|
SearchResultEntry searchEntry)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.SEARCH_RESULT_ENTRY.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before a
|
* search result reference is sent to a client.
|
*
|
* @param searchOperation The search operation with which the
|
* search result reference is associated.
|
* @param searchReference The search result reference that is to
|
* be sent to the client. Its contents may
|
* be altered by the plugin if necessary.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.IntermediateResponse
|
processSearchReference(SearchReferenceSearchOperation
|
searchOperation,
|
SearchResultReference searchReference)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.SEARCH_RESULT_REFERENCE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed the core processing for a search
|
* operation but before the response has been sent to the client.
|
*
|
* @param searchOperation The search operation for which
|
* processing has completed but no response
|
* has yet been sent.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationSearchOperation searchOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_SEARCH.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed all processing for a search
|
* operation and has sent the response to the client.
|
*
|
* @param searchOperation The search operation for which
|
* processing has completed and the
|
* response has been sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostResponse
|
doPostResponse(PostResponseSearchOperation searchOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_RESPONSE_SEARCH.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before the
|
* Directory Server parses the elements of an unbind request.
|
*
|
* @param unbindOperation The unbind operation that has been
|
* requested.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PreParse
|
doPreParse(PreParseUnbindOperation unbindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.PRE_PARSE_UNBIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done after the
|
* Directory Server has completed processing for an unbind
|
* operation.
|
*
|
* @param unbindOperation The unbind operation for which
|
* processing has completed.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.PostOperation
|
doPostOperation(PostOperationUnbindOperation unbindOperation)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.POST_OPERATION_UNBIND.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
|
|
|
/**
|
* Performs any necessary processing that should be done before an
|
* intermediate response message is sent to a client.
|
*
|
* @param intermediateResponse The intermediate response to be
|
* sent to the client.
|
*
|
* @return Information about the result of the plugin processing.
|
*/
|
public PluginResult.IntermediateResponse
|
processIntermediateResponse(
|
IntermediateResponse intermediateResponse)
|
{
|
Message message = ERR_PLUGIN_TYPE_NOT_SUPPORTED.
|
get(String.valueOf(pluginDN),
|
PluginType.INTERMEDIATE_RESPONSE.getName());
|
throw new UnsupportedOperationException(message.toString());
|
}
|
}
|
