javax.enterprise.deploy.spi.factories

Interface DeploymentFactory

public interface DeploymentFactory

The DeploymentFactory interface is a deployment driver for a J2EE plaform product. It returns a DeploymentManager object which represents a connection to a specific J2EE platform product. Each application server vendor must provide an implementation of this class in order for the J2EE Deployment API to work with their product. The class implementing this interface should have a public no-argument constructor, and it should be stateless (two instances of the class should always behave the same). It is suggested but not required that the class have a static initializer that registers an instance of the class with the DeploymentFactoryManager class. A connected or disconnected DeploymentManager can be requested. A DeploymentManager that runs connected to the platform can provide access to J2EE resources. A DeploymentManager that runs disconnected only provides module deployment configuration support.

Version:

$Revision$

Author:

Adrian Brock

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentManager	getDeploymentManager(String uri, String userName, String password) Get a connected deployment manager
DeploymentManager	getDisconnectedDeploymentManager(String uri) Get a disconnected version of the deployment manager
String	getDisplayName() The vendor of the deployment manager
String	getProductVersion() The version of the deployment manager
boolean	handlesURI(String uri) Tests whether the factory can create a manager for the URI

Method Detail

handlesURI

boolean handlesURI(String uri)

Tests whether the factory can create a manager for the URI

Parameters:

uri - the uri

Returns:

true when it can, false otherwise

getDeploymentManager

DeploymentManager getDeploymentManager(String uri,
                                     String userName,
                                     String password)
                                       throws DeploymentManagerCreationException

Get a connected deployment manager

Parameters:

uri - the uri of the deployment manager

userName - the user name

password - the password

Returns:

the deployment manager

Throws:

DeploymentManagerCreationException

getDisconnectedDeploymentManager

DeploymentManager getDisconnectedDeploymentManager(String uri)
                                                   throws DeploymentManagerCreationException

Get a disconnected version of the deployment manager

Parameters:

uri - the uri to connect to

Returns:

the disconnected deployment manager

Throws:

DeploymentManagerCreationException

getDisplayName

String getDisplayName()

The vendor of the deployment manager

Returns:

the vendor name

getProductVersion

String getProductVersion()

The version of the deployment manager

Returns:

the version