Package com.unboundid.directory.sdk.common.api

Class ManageExtensionPlugin

java.lang.Object

com.unboundid.directory.sdk.common.api.ManageExtensionPlugin

All Implemented Interfaces:

UnboundIDExtension

@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=true)
@SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
@MetricsEngineExtension
@BrokerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class ManageExtensionPlugin
extends java.lang.Object
implements UnboundIDExtension

This class defines an API that may be implemented by extensions which will be managed by the manage-extension tool. This API allows extensions to perform custom operations during the install/update process.

This plugin will be invoked during the following phases:

• before install -- Invoked when an extension is first installed before any files are copied to the server installation.
• after install -- Invoked when an extension is first installed after all files are copied to the server installation.
• before update -- Invoked when an extension is updated before any files are updated.
• after update -- Invoked when an extension is updated after all files are updated.

Constructor Summary

Constructors

Constructor	Description
ManageExtensionPlugin()

Method Summary

Modifier and Type	Method	Description
PostManageExtensionPluginResult	postInstall(InstallExtensionDetails details)	Invoked when an extension is first installed after all files are copied to the server installation but before restarting the server.
PostManageExtensionPluginResult	postUpdate(UpdateExtensionDetails details)	Invoked when an extension is updated after all files are update to the server installation but before restarting the server.
PreManageExtensionPluginResult	preInstall(InstallExtensionDetails details)	Invoked when an extension is first installed before shutting down the server and any files are copied to the server installation.
PreManageExtensionPluginResult	preUpdate(UpdateExtensionDetails details)	Invoked when an extension is updated before shutting down the server and any files are updated to the server installation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension

getExtensionDescription, getExtensionName

Constructor Detail

ManageExtensionPlugin

public ManageExtensionPlugin()

Method Detail

preInstall

public PreManageExtensionPluginResult preInstall(InstallExtensionDetails details)

Invoked when an extension is first installed before shutting down the server and any files are copied to the server installation.

Parameters:

details - The state of the install before any files are copied.

Returns:

Whether to continue the installation process.

postInstall

public PostManageExtensionPluginResult postInstall(InstallExtensionDetails details)

Invoked when an extension is first installed after all files are copied to the server installation but before restarting the server.

Parameters:

details - The state of the install after all files are copied.

Returns:

Whether the server should be restarted after the install if previous started.

preUpdate

public PreManageExtensionPluginResult preUpdate(UpdateExtensionDetails details)

Invoked when an extension is updated before shutting down the server and any files are updated to the server installation.

Parameters:

details - The state of the update before any files are updated.

Returns:

Whether to continue the update process.

postUpdate

public PostManageExtensionPluginResult postUpdate(UpdateExtensionDetails details)

Invoked when an extension is updated after all files are update to the server installation but before restarting the server.

Parameters:

details - The state of the update after all files are updated.

Returns:

Whether the server should be restarted after the update if previous started.