org.netbeans.modules.j2ee.deployment.plugins.spi
Class OptionalDeploymentManagerFactory

java.lang.Object
  org.netbeans.modules.j2ee.deployment.plugins.spi.OptionalDeploymentManagerFactory

public abstract class OptionalDeploymentManagerFactory
extends Object

Factory for optional deployment functionality that a plugin can provide. Plugins need to register an instance of this class in module layer in folder J2EE/DeploymentPlugins/{plugin_name}.

Constructor Summary

OptionalDeploymentManagerFactory()

Method Summary

void	finishServerInitialization() Allows a plugin to perform post initialization action.
WizardDescriptor.InstantiatingIterator	getAddInstanceIterator() Create the wizard iterator to be used in the Add Server Instance wizard
AntDeploymentProvider	getAntDeploymentProvider(javax.enterprise.deploy.spi.DeploymentManager dm) Creates an Ant deployment provider for the specified deployment manager.
DatasourceManager	getDatasourceManager(javax.enterprise.deploy.spi.DeploymentManager dm) Creates a DatasourceManager for the given deployment manager or null if data source management is not supported
abstract FindJSPServlet	getFindJSPServlet(javax.enterprise.deploy.spi.DeploymentManager dm) Create FindJSPServlet for given DeploymentManager.
abstract IncrementalDeployment	getIncrementalDeployment(javax.enterprise.deploy.spi.DeploymentManager dm) Create IncrementalDeployment for given DeploymentManager.
JDBCDriverDeployer	getJDBCDriverDeployer(javax.enterprise.deploy.spi.DeploymentManager dm) Creates a JDBC driver deployer for the specified deployment manager.
MessageDestinationDeployment	getMessageDestinationDeployment(javax.enterprise.deploy.spi.DeploymentManager dm) Creates a MessageDestinationDeployment for the given deployment manager or null if message destination deployment is not supported
ServerInstanceDescriptor	getServerInstanceDescriptor(javax.enterprise.deploy.spi.DeploymentManager dm) Creates a ServerInstanceDescriptor for the given deployment manager or null if descriptor is not supported.
abstract StartServer	getStartServer(javax.enterprise.deploy.spi.DeploymentManager dm) Create StartServer for given DeploymentManager.
TargetModuleIDResolver	getTargetModuleIDResolver(javax.enterprise.deploy.spi.DeploymentManager dm) Create TargetModuleIDResolver for the given DeploymentManager.
boolean	isCommonUIRequired() Returns true if the common UI (like the wizard in common add dialog) should be handled by insfrastructure of the j2eeserver.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalDeploymentManagerFactory

public OptionalDeploymentManagerFactory()

Method Detail

getStartServer

public abstract StartServer getStartServer(javax.enterprise.deploy.spi.DeploymentManager dm)

Create StartServer for given DeploymentManager. The instance returned by this method will be cached by the j2eeserver.

getIncrementalDeployment

public abstract IncrementalDeployment getIncrementalDeployment(javax.enterprise.deploy.spi.DeploymentManager dm)

Create IncrementalDeployment for given DeploymentManager. The instance returned by this method will be cached by the j2eeserver.

getFindJSPServlet

public abstract FindJSPServlet getFindJSPServlet(javax.enterprise.deploy.spi.DeploymentManager dm)

Create FindJSPServlet for given DeploymentManager. The instance returned by this method will be cached by the j2eeserver.

getTargetModuleIDResolver

public TargetModuleIDResolver getTargetModuleIDResolver(javax.enterprise.deploy.spi.DeploymentManager dm)

Create TargetModuleIDResolver for the given DeploymentManager. The instance returned by this method will be cached by the j2eeserver.

getAddInstanceIterator

public WizardDescriptor.InstantiatingIterator getAddInstanceIterator()

Create the wizard iterator to be used in the Add Server Instance wizard

isCommonUIRequired

public boolean isCommonUIRequired()

Returns true if the common UI (like the wizard in common add dialog) should be handled by insfrastructure of the j2eeserver.

Returns:

true if the common UI is required by the plugin

Since:

1.38.0

getAntDeploymentProvider

public AntDeploymentProvider getAntDeploymentProvider(javax.enterprise.deploy.spi.DeploymentManager dm)

Creates an Ant deployment provider for the specified deployment manager.

Parameters:

dm - deployment manager.

Returns:

an instance of the AntDeploymentProvider if Ant deployment is supported for the specified deployment manager, null otherwise.

Since:

1.18

getDatasourceManager

public DatasourceManager getDatasourceManager(javax.enterprise.deploy.spi.DeploymentManager dm)

Creates a DatasourceManager for the given deployment manager or null if data source management is not supported

Parameters:

dm - the deployment manager

Returns:

a data source manager or null if data source management is not supported

Since:

1.15

getJDBCDriverDeployer

public JDBCDriverDeployer getJDBCDriverDeployer(javax.enterprise.deploy.spi.DeploymentManager dm)

Creates a JDBC driver deployer for the specified deployment manager.

Parameters:

dm - deployment manager.

Returns:

JDBC driver deployer for the specified deployment manager or null if JDBC driver deployment is not supported.

Since:

1.24

getMessageDestinationDeployment

public MessageDestinationDeployment getMessageDestinationDeployment(javax.enterprise.deploy.spi.DeploymentManager dm)

Creates a MessageDestinationDeployment for the given deployment manager or null if message destination deployment is not supported

Parameters:

dm - the deployment manager

Returns:

a message destination deployment or null if message destination deployment is not supported

Since:

1.25

getServerInstanceDescriptor

public ServerInstanceDescriptor getServerInstanceDescriptor(javax.enterprise.deploy.spi.DeploymentManager dm)

Creates a ServerInstanceDescriptor for the given deployment manager or null if descriptor is not supported.

Parameters:

dm - the deployment manager

Returns:

instance descriptor or null if descriptor is not supported

Since:

1.46

finishServerInitialization

public void finishServerInitialization()
                                throws ServerInitializationException

Allows a plugin to perform post initialization action. When this method invoked infrastructure is initialized so it can register/query instances.

Throws:

ServerInitializationException

Since:

1.51