- java.lang.Object
-
- javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
-
public final class DeploymentFactoryManager extends Object
The DeploymentFactoryManager class is a central registry for Java EE DeploymentFactory objects. The DeploymentFactoryManager retains references to DeploymentFactory objects loaded by a tool. A DeploymentFactory object provides a reference to a DeploymentManager. The DeploymentFactoryManager has been implemented as a singleton. A tool gets a reference to the DeploymentFactoryManager via the getInstance method. The DeploymentFactoryManager can return two types of DeploymentManagers, a connected DeploymentManager and a disconnected DeploymentManager. The connected DeploymentManager provides access to any product resources that may be required for configurations and deployment. The method to retrieve a connected DeploymentManager is getDeploymentManager. This method provides parameters for user name and password that the product may require for user authentication. A disconnected DeploymentManager does not provide access to a running Java EE product. The method to retrieve a disconnected DeploymentManager is getDisconnectedDeploymentManager. A disconnected DeploymentManager does not need user authentication information.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description DeploymentFactory[]
getDeploymentFactories()
Retrieve the lists of currently registered DeploymentFactories.DeploymentManager
getDeploymentManager(String uri, String username, String password)
Retrieves a DeploymentManager instance to use for deployment.DeploymentManager
getDisconnectedDeploymentManager(String uri)
Return a disconnected DeploymentManager instance.static DeploymentFactoryManager
getInstance()
Retrieve the Singleton DeploymentFactoryManagervoid
registerDeploymentFactory(DeploymentFactory factory)
Registers a DeploymentFactory so it will be able to handle requests.
-
-
-
Method Detail
-
getInstance
public static DeploymentFactoryManager getInstance()
Retrieve the Singleton DeploymentFactoryManager- Returns:
- DeploymentFactoryManager instance
-
getDeploymentFactories
public DeploymentFactory[] getDeploymentFactories()
Retrieve the lists of currently registered DeploymentFactories.- Returns:
- the list of DeploymentFactory objects or an empty array if there are none.
-
getDeploymentManager
public DeploymentManager getDeploymentManager(String uri, String username, String password) throws DeploymentManagerCreationException
Retrieves a DeploymentManager instance to use for deployment. The caller provides a URI and optional username and password, and all registered DeploymentFactories will be checked. The first one to understand the URI provided will attempt to initiate a server connection and return a ready DeploymentManager instance.- Parameters:
uri
- The uri to checkusername
- 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).- Returns:
- A ready DeploymentManager instance.
- Throws:
DeploymentManagerCreationException
- Occurs when the factory appropriate to the specified URI was unable to initialize a DeploymentManager instance (server down, unable to authenticate, etc.).
-
registerDeploymentFactory
public void registerDeploymentFactory(DeploymentFactory factory)
Registers a DeploymentFactory so it will be able to handle requests.
-
getDisconnectedDeploymentManager
public DeploymentManager getDisconnectedDeploymentManager(String uri) throws DeploymentManagerCreationException
Return a disconnected DeploymentManager instance.- Parameters:
uri
- identifier of the disconnected DeploymentManager to return.- Returns:
- A DeploymentManager instance.
- Throws:
DeploymentDriverException
- occurs if the DeploymentManager could not be created.DeploymentManagerCreationException
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/enterprise/deploy/shared/factories/deploymentfactorymanager.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.