DeploymentFactory

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> enterprise >> deploy >> spi >> [ factories overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of javax.enterprise.deploy.spi.factories.DeploymentFactory

SOURCE |

Download javax.enterprise.deploy.spi.factories.DeploymentFactory

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi.factories
Interface DeploymentFactory

All Known Implementing Classes:: MockDeploymentFactory

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:: $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $

Method Summary

javax.enterprise.deploy.spi.DeploymentManager getDeploymentManager(java.lang.String uri, java.lang.String username, java.lang.String password)
          Returns a connected DeploymentManager instance.

javax.enterprise.deploy.spi.DeploymentManager getDisconnectedDeploymentManager(java.lang.String uri)
          Returns a disconnected DeploymentManager instance.

java.lang.String getDisplayName()
          Provide a string with the name of this vendor's DeploymentManager.

java.lang.String getProductVersion()
          Provides a string identifying the version of this vendor's DeploymentManager.

boolean handlesURI(java.lang.String uri)
          Tests whether this factory can create a DeploymentManager object based on the specified URI.

Method Detail

handlesURI

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

getDeploymentManager

public javax.enterprise.deploy.spi.DeploymentManager getDeploymentManager(java.lang.String uri,
                                                                          java.lang.String username,
                                                                          java.lang.String password)
                                                                   throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException

Returns a connected DeploymentManager instance.

getDisconnectedDeploymentManager

public javax.enterprise.deploy.spi.DeploymentManager getDisconnectedDeploymentManager(java.lang.String uri)
                                                                               throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException

Returns a disconnected DeploymentManager instance.

getDisplayName

public java.lang.String getDisplayName()

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

getProductVersion

public java.lang.String getProductVersion()

Provides a string identifying the version of this vendor's DeploymentManager.