File	Doc	Category	Size	Date	Package
DeploymentManager.java	API Doc	Glassfish v2 API	21347	Fri May 04 22:35:48 BST 2007	javax.enterprise.deploy.spi

DeploymentManager

Fields Summary

Constructors Summary

Methods Summary
public DeploymentConfiguration	createConfiguration(javax.enterprise.deploy.model.DeployableObject dObj) Retrieve the object that provides server-specific deployment configuration information for the J2EE deployable component. param dObj An object representing a J2EE deployable component. throws InvalidModuleException The DeployableObject is an unknown or unsupport component for this configuration tool.
public ProgressObject	distribute(Target[] targetList, java.io.File moduleArchive, java.io.File deploymentPlan) The distribute method performs three tasks; it validates the deployment configuration data, generates all container specific classes and interfaces, and moves the fully baked archive to the designated deployment targets. param targetList A list of server targets the user is specifying this application be deployed to. param moduleArchive The file name of the application archive to be disrtibuted. param deploymentPlan The XML file containing the runtime configuration information associated with this application archive. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the distribution process.
public ProgressObject	distribute(Target[] targetList, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) The distribute method performs three tasks; it validates the deployment configuration data, generates all container specific classes and interfaces, and moves the fully baked archive to the designated deployment targets. param targetList A list of server targets the user is specifying this application be deployed to. param moduleArchive The input stream containing the application archive to be disrtibuted. param deploymentPlan The input stream containing the deployment configuration information associated with this application archive. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the distribution process. deprecated as of Java EE 5, replaced with {@link #distribute(Target[], ModuleType, InputStream, InputStream)}
public ProgressObject	distribute(Target[] targetList, javax.enterprise.deploy.shared.ModuleType type, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) The distribute method performs three tasks; it validates the deployment configuration data, generates all container specific classes and interfaces, and moves the fully baked archive to the designated deployment targets. param targetList A list of server targets the user is specifying this application be deployed to. param moduleType The module type of this application archive. param moduleArchive The input stream containing the application archive to be disrtibuted. param deploymentPlan The input stream containing the deployment configuration information associated with this application archive. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the distribution process.
public TargetModuleID[]	getAvailableModules(javax.enterprise.deploy.shared.ModuleType moduleType, Target[] targetList) Retrieve the list of all J2EE application modules running or not running on the identified targets. param moduleType A predefined designator for a J2EE module type. param targetList A list of deployment Target designators the user wants checked for module not running status. return An array of TargetModuleID objects representing all deployed modules running or not or 'null' if there are no deployed modules. throws IllegalStateException is thrown when the method is called when running in disconnected mode. throws TargetException An invalid Target designator encountered.
public java.util.Locale	getCurrentLocale() Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running. return Locale the active locale of this implementation.
public javax.enterprise.deploy.shared.DConfigBeanVersionType	getDConfigBeanVersion() Returns the J2EE platform version number for which the configuration beans are provided. The beans must have been compiled with the J2SE version required by the J2EE platform. return a DConfigBeanVersionType object representing the platform version number for which these beans are provided.
public java.util.Locale	getDefaultLocale() Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages. return Locale the default locale for this implementation.
public TargetModuleID[]	getNonRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType, Target[] targetList) Retrieve the list of J2EE application modules distributed to the identified targets and that are currently not running on the associated server or servers. param moduleType A predefined designator for a J2EE module type. param targetList A list of deployment Target designators the user wants checked for module not running status. return An array of TargetModuleID objects representing the non-running modules or 'null' if there are none. throws IllegalStateException is thrown when the method is called when running in disconnected mode. throws TargetException An invalid Target designator encountered.
public TargetModuleID[]	getRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType, Target[] targetList) Retrieve the list of J2EE application modules distributed to the identified targets and that are currently running on the associated server or servers. param moduleType A predefined designator for a J2EE module type. param targetList A list of deployment Target designators the user wants checked for module run status. return An array of TargetModuleID objects representing the running modules or 'null' if there are none. throws IllegalStateException is thrown when the method is called when running in disconnected mode. throws TargetException An invalid Target designator encountered.
public java.util.Locale[]	getSupportedLocales() Returns an array of supported locales for this implementation. return Locale[] the list of supported locales.
public Target[]	getTargets() Retrieve the list of deployment targets supported by this DeploymentManager. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return A list of deployment Target designators the user may select for application deployment or 'null' if there are none.
public boolean	isDConfigBeanVersionSupported(javax.enterprise.deploy.shared.DConfigBeanVersionType version) Returns 'true' if the configuration beans support the J2EE platform version specified. It returns 'false' if the version is not supported. param version a DConfigBeanVersionType object representing the J2EE platform version for which support is requested. return 'true' if the version is supported and 'false if not.
public boolean	isLocaleSupported(java.util.Locale locale) Reports if this implementation supports the designated locale. return A value of 'true' means it is support and 'false' it is not.
public boolean	isRedeploySupported() This method designates whether this platform vendor provides application redeployment functionality. A value of true means it is supported. False means it is not. return A value of true means redeployment is supported by this vendor's DeploymentManager. False means it is not.
public ProgressObject	redeploy(TargetModuleID[] moduleIDList, java.io.File moduleArchive, java.io.File deploymentPlan) (optional) The redeploy method provides a means for updating currently deployed J2EE applications. This is an optional method for vendor implementation. Redeploy replaces a currently deployed application with an updated version. The runtime configuration information for the updated application must remain identical to the application it is updating. When an application update is redeployed, all existing client connections to the original running application must not be disrupted; new clients will connect to the application update. This operation is valid for TargetModuleIDs that represent a root module. A root TargetModuleID has no parent. A root TargetModuleID module and all its child modules will be redeployed. A child TargetModuleID module cannot be individually redeployed. The redeploy operation is complete only when this action for all the modules has completed. param moduleIDList An array of designators of the applications to be updated. param moduleArchive The file name of the application archive to be disrtibuted. param deploymentPlan The deployment configuration information associated with this application archive. return ProgressObject an object that tracks and reports the status of the redeploy operation. throws IllegalStateException is thrown when the method is called when running in disconnected mode. throws java.lang.UnsupportedOperationException this optional command is not supported by this implementation.
public ProgressObject	redeploy(TargetModuleID[] moduleIDList, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) (optional) The redeploy method provides a means for updating currently deployed J2EE applications. This is an optional method for vendor implementation. Redeploy replaces a currently deployed application with an updated version. The runtime configuration information for the updated application must remain identical to the application it is updating. When an application update is redeployed, all existing client connections to the original running application must not be disrupted; new clients will connect to the application update. This operation is valid for TargetModuleIDs that represent a root module. A root TargetModuleID has no parent. A root TargetModuleID module and all its child modules will be redeployed. A child TargetModuleID module cannot be individually redeployed. The redeploy operation is complete only when this action for all the modules has completed. param moduleIDList An array of designators of the applications to be updated. param moduleArchive The input stream containing the application archive to be disrtibuted. param deploymentPlan The input stream containing the runtime configuration information associated with this application archive. return ProgressObject an object that tracks and reports the status of the redeploy operation. throws IllegalStateException is thrown when the method is called when running in disconnected mode. throws java.lang.UnsupportedOperationException this optional command is not supported by this implementation.
public void	release() The release method is the mechanism by which the tool signals to the DeploymentManager that the tool does not need it to continue running connected to the platform. The tool may be signaling it wants to run in a disconnected mode or it is planning to shutdown. When release is called the DeploymentManager may close any J2EE resource connections it had for deployment configuration and perform other related resource cleanup. It should not accept any new operation requests (i.e., distribute, start stop, undeploy, redeploy. It should finish any operations that are currently in process. Each ProgressObject associated with a running operation should be marked as released (see the ProgressObject).
public void	setDConfigBeanVersion(javax.enterprise.deploy.shared.DConfigBeanVersionType version) Set the configuration beans to be used to the J2EE platform version specificed. param version a DConfigBeanVersionType object representing the J2EE platform version for which support is requested. throws DConfigBeanVersionUnsupportedException when the requested bean version is not supported.
public void	setLocale(java.util.Locale locale) Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run. throws java.lang.UnsupportedOperationException the provide locale is not supported.
public ProgressObject	start(TargetModuleID[] moduleIDList) Start the application running. Only the TargetModuleIDs which represent a root module are valid for being started. A root TargetModuleID has no parent. A TargetModuleID with a parent can not be individually started. A root TargetModuleID module and all its child modules will be started. param moduleIDList A array of TargetModuleID objects representing the modules to be started. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the start operation.
public ProgressObject	stop(TargetModuleID[] moduleIDList) Stop the application running. Only the TargetModuleIDs which represent a root module are valid for being stopped. A root TargetModuleID has no parent. A TargetModuleID with a parent can not be individually stopped. A root TargetModuleID module and all its child modules will be stopped. param moduleIDList A array of TargetModuleID objects representing the modules to be stopped. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the stop operation.
public ProgressObject	undeploy(TargetModuleID[] moduleIDList) Remove the application from the target server. Only the TargetModuleIDs which represent a root module are valid for undeployment. A root TargetModuleID has no parent. A TargetModuleID with a parent can not be undeployed. A root TargetModuleID module and all its child modules will be undeployed. The root TargetModuleID module and all its child modules must stopped before they can be undeployed. param moduleIDList An array of TargetModuleID objects representing the root modules to be stopped. throws IllegalStateException is thrown when the method is called when running in disconnected mode. return ProgressObject an object that tracks and reports the status of the stop operation.