javax.enterprise.deploy API 1.7 · javax.enterprise.deploy.spi.factories.DeploymentFactory

The DeploymentFactory interface is a deployment driver for a Java EE plaform product. It returns a DeploymentManager object which represents a connection to a specific Java EE platform product.

Each application server vendor must provide an implementation of this class in order for the Java EE 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 Java EE resources. A DeploymentManager that runs disconnected only provides module deployment configuration support.

Method Summary

Modifier and Type	Method and Description
public DeploymentManager	Returns: A ready DeploymentManager instance. getDeploymentManager(String The URI that specifies the connection parameters uri, String An optional username (may be `null` if no authentication is required for this platform). username, String An optional password (may be `null if no authentication is required for this platform).` `password)` `Return a connected DeploymentManager instance.`
public DeploymentManager	Returns: A DeploymentManager `disconnected` instance. getDisconnectedDeploymentManager(String the uri of the DeploymentManager to return. uri) Return a `disconnected` DeploymentManager instance.
public String	Returns: the name of the vendor's DeploymentManager. getDisplayName() Provide a string with the name of this vendor's DeploymentManager.
public String	Returns: the name of the vendor's DeploymentManager. getProductVersion() Provide a string identifying version of this vendor's DeploymentManager.
public boolean	Returns: `true` if the factory can handle the uri. handlesURI(String The uri to check uri) Tests whether this factory can create a DeploymentManager object based on the specificed URI.

Method Detail

getDeploymentManager back to summary

getDeploymentManager	back to summary
public DeploymentManager getDeploymentManager(String uri, String username, String password) throws DeploymentManagerCreationException Return a `connected` DeploymentManager instance. Parameters uri:String The URI that specifies the connection parameters username:String An optional username (may be `null` if no authentication is required for this platform). password:String An optional password (may be `null if no authentication is required for this platform).` `Returns:DeploymentManager` `A ready DeploymentManager instance.` `Exceptions` `DeploymentManagerCreationException: occurs when a DeploymentManager could not be returned (server down, unable to authenticate, etc).`

public DeploymentManager getDeploymentManager(String uri, String username, String password) throws DeploymentManagerCreationException

Return a connected DeploymentManager instance.

Parameters

uri:String: The URI that specifies the connection parameters
username:String: An optional username (may be null if no authentication is required for this platform).
password:String: An optional password (may be null if no authentication is required for this platform).

Returns:DeploymentManager

A ready DeploymentManager instance.

Exceptions

DeploymentManagerCreationException:: occurs when a DeploymentManager could not be returned (server down, unable to authenticate, etc).

getDisconnectedDeploymentManager back to summary

getDisconnectedDeploymentManager	back to summary
public DeploymentManager getDisconnectedDeploymentManager(String uri) throws DeploymentManagerCreationException Return a `disconnected` DeploymentManager instance. Parameters uri:String the uri of the DeploymentManager to return. Returns:DeploymentManager A DeploymentManager `disconnected` instance. Exceptions DeploymentManagerCreationException: occurs if the DeploymentManager could not be created.

public DeploymentManager getDisconnectedDeploymentManager(String uri) throws DeploymentManagerCreationException

Return a disconnected DeploymentManager instance.

Parameters

uri:String: the uri of the DeploymentManager to return.

Returns:DeploymentManager

A DeploymentManager disconnected instance.

Exceptions

DeploymentManagerCreationException:: occurs if the DeploymentManager could not be created.

getDisplayName	back to summary
public String getDisplayName() Provide a string with the name of this vendor's DeploymentManager. Returns:String the name of the vendor's DeploymentManager.

getDisplayName

back to summary

public String getDisplayName()

Provide a string with the name of this vendor's DeploymentManager.

Returns:String: the name of the vendor's DeploymentManager.

getProductVersion	back to summary
public String getProductVersion() Provide a string identifying version of this vendor's DeploymentManager. Returns:String the name of the vendor's DeploymentManager.

getProductVersion

back to summary

public String getProductVersion()

Provide a string identifying version of this vendor's DeploymentManager.

Returns:String: the name of the vendor's DeploymentManager.

handlesURI back to summary

handlesURI	back to summary
public boolean handlesURI(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. Parameters uri:String The uri to check Returns:boolean `true` if the factory can handle the uri.

public boolean handlesURI(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.

Parameters

uri:String: The uri to check

Returns:boolean

true if the factory can handle the uri.

public Interface DeploymentFactory

Method Summary

Method Detail