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.
getDeploymentManager
public DeploymentManager getDeploymentManager(String uri,
String username,
String password)
throws DeploymentManagerCreationException
Returns a connected DeploymentManager instance.
uri
- The URI that specifies the connection parametersusername
- An optional username (may be null if no
authentication is required for this platform).password
- An optional password (may be null if no
authentication is required for this platform).
- A ready DeploymentManager instance.
getDisconnectedDeploymentManager
public DeploymentManager getDisconnectedDeploymentManager(String uri)
throws DeploymentManagerCreationException
Returns a disconnected DeploymentManager instance.
uri
- the uri of the DeploymentManager to return.
- A DeploymentManager disconnected instance.
getDisplayName
public String getDisplayName()
Provide a string with the name of this vendor's DeploymentManager.
- the name of the vendor's DeploymentManager.
getProductVersion
public String getProductVersion()
Provides a string identifying the version of this vendor's
DeploymentManager.
- the name of the vendor's DeploymentManager.
handlesURI
public boolean handlesURI(String uri)
Tests whether this factory can create a DeploymentManager object based
on the specified URI. This does not indicate whether such an attempt
will be successful, only whether the factory can handle the uri.
- true if the factory can handle the uri.