File Doc Category Size Date Package
DeploymentFactory.java API Doc Glassfish v2 API 5337 Fri May 04 22:35:50 BST 2007 javax.enterprise.deploy.spi.factories

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.

see: javax.enterprise.deploy.shared.factories.DeploymentFactoryManager

Fields Summary
Constructors Summary
Methods Summary
public javax.enterprise.deploy.spi.DeploymentManager getDeploymentManager(java.lang.String uri, java.lang.String username, java.lang.String password)
Return a connected DeploymentManager instance.
param
uri The URI that specifies the connection parameters
param
username An optional username (may be null if no authentication is required for this platform).
param
password An optional password (may be null if no authentication is required for this platform).
return
A ready DeploymentManager instance.
throws
DeploymentManagerCreationException occurs when a DeploymentManager could not be returned (server down, unable to authenticate, etc).
public javax.enterprise.deploy.spi.DeploymentManager getDisconnectedDeploymentManager(java.lang.String uri)
Return a disconnected DeploymentManager instance.
param
uri the uri of the DeploymentManager to return.
return
A DeploymentManager disconnected instance.
throws
DeploymentManagerCreationException occurs if the DeploymentManager could not be created.
public java.lang.String getDisplayName()
Provide a string with the name of this vendor's DeploymentManager.
return
the name of the vendor's DeploymentManager.
public java.lang.String getProductVersion()
Provide a string identifying version of this vendor's DeploymentManager.
return
the name of the vendor's DeploymentManager.
public boolean handlesURI(java.lang.String uri)
Tests whether this factory can create a DeploymentManager object based on the specificed URI. This does not indicate whether such an attempt will be successful, only whether the factory can handle the uri.
param
uri The uri to check
return
true if the factory can handle the uri.