The DeploymentManager object provides the core set of functions a J2EE platform
must provide for J2EE application deployment. It provides server related
information, such as, a list of deployment targets, and vendor unique runtime
configuration information.
createConfiguration
public DeploymentConfiguration createConfiguration(DeployableObject dObj)
throws InvalidModuleException
Retrieve the object that provides server-specific deployment configuration
information for the J2EE deployable component.
dObj
- An object representing a J2EE deployable component.
- An object used to configure server-specific deployment information
InvalidModuleException
- The DeployableObject is an unknown or unsupported
component for this configuration tool.
distribute
public ProgressObject distribute(Target[] targetList,
File moduleArchive,
File deploymentPlan)
throws IllegalStateException
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.
targetList
- A list of server targets the user is specifying this application
should be deployed to.moduleArchive
- The file name of the application archive to be distributed.deploymentPlan
- The file containing the runtime configuration information
associated with this application archive.
- an object that tracks and reports the status of the distribution process.
distribute
public ProgressObject distribute(Target[] targetList,
InputStream moduleArchive,
InputStream deploymentPlan)
throws IllegalStateException
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.
targetList
- A list of server targets the user is specifying this application
should be deployed to.moduleArchive
- The stream containing the application archive to be distributed.deploymentPlan
- The stream containing the runtime configuration information
associated with this application archive.
- an object that tracks and reports the status of the distribution process.
getAvailableModules
public TargetModuleID[] getAvailableModules(ModuleType moduleType,
Target[] targetList)
throws TargetException,
IllegalStateException
Retrieve the list of all J2EE application modules running or not running on the
identified targets.
moduleType
- A predefined designator for a J2EE module type.targetList
- A list of deployment Target designators the user wants checked
for module not running status.
- An array of TargetModuleID objects representing all deployed modules
running or not or
null
if there are no deployed modules.
getCurrentLocale
public Locale getCurrentLocale()
Returns the active locale this implementation of
javax.enterprise.deploy.spi subpackages is running.
- the active locale of this implementation.
getDConfigBeanVersion
public 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.
- a DConfigBeanVersionType object representing the platform
version number for which these beans are provided.
getDefaultLocale
public Locale getDefaultLocale()
Returns the default locale supported by this implementation of
javax.enterprise.deploy.spi subpackages.
- the default locale for this implementation.
getNonRunningModules
public TargetModuleID[] getNonRunningModules(ModuleType moduleType,
Target[] targetList)
throws TargetException,
IllegalStateException
Retrieve the list of J2EE application modules distributed to the identified
targets and that are currently not running on the associated server or servers.
moduleType
- A predefined designator for a J2EE module type.targetList
- A list of deployment Target designators the user wants checked
for module not running status.
- An array of TargetModuleID objects representing the non-running modules
or
null
if there are none.
getRunningModules
public TargetModuleID[] getRunningModules(ModuleType moduleType,
Target[] targetList)
throws TargetException,
IllegalStateException
Retrieve the list of J2EE application modules distributed to the identified
targets and that are currently running on the associated server or servers.
moduleType
- A predefined designator for a J2EE module type.targetList
- A list of deployment Target designators the user wants
checked for module run status.
- An array of TargetModuleID objects representing the running modules
or
null
if there are none.
getSupportedLocales
public Locale[] getSupportedLocales()
Returns an array of supported locales for this implementation.
- the list of supported locales.
getTargets
public Target[] getTargets()
throws IllegalStateException
Retrieve the list of deployment targets supported by this DeploymentManager.
- A list of deployment Target designators the user may select for
application deployment or
null
if there are none.
isDConfigBeanVersionSupported
public boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)
Returns true
if the configuration beans support the J2EE platform
version specified. It returns false
if the version is not supported.
version
- a DConfigBeanVersionType object representing the J2EE
platform version for which support is requested.
true
if the version is supported and 'false if not.
isLocaleSupported
public boolean isLocaleSupported(Locale locale)
Reports if this implementation supports the designated locale.
locale
- the locale to check
- A value of
true
means it is supported and false
it is not.
isRedeploySupported
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.
- A value of true means redeployment is supported by this vendor's
DeploymentManager. False means it is not.
redeploy
public ProgressObject redeploy(TargetModuleID[] moduleIDList,
File moduleArchive,
File deploymentPlan)
throws UnsupportedOperationException,
IllegalStateException
(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.
moduleIDList
- An array of designators of the applications to be updated.moduleArchive
- The file name of the application archive to be redeployed.deploymentPlan
- The deployment configuration information associated with
this application archive.
- An object that tracks and reports the status of the redeploy operation.
redeploy
public ProgressObject redeploy(TargetModuleID[] moduleIDList,
InputStream moduleArchive,
InputStream deploymentPlan)
throws UnsupportedOperationException,
IllegalStateException
(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.
moduleIDList
- An array of designators of the applications to be updated.moduleArchive
- The stream containing the application archive to be redeployed.deploymentPlan
- The streeam containing the deployment configuration information
associated with this application archive.
- An object that tracks and reports the status of the redeploy operation.
release
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).
setDConfigBeanVersion
public void setDConfigBeanVersion(DConfigBeanVersionType version)
throws DConfigBeanVersionUnsupportedException
Set the configuration beans to be used to the J2EE platform version specified.
version
- a DConfigBeanVersionType object representing the J2EE
platform version for which support is requested.
setLocale
public void setLocale(Locale locale)
throws UnsupportedOperationException
Set the active locale for this implementation of
javax.enterprise.deploy.spi subpackages to run.
locale
- the locale to set
start
public ProgressObject start(TargetModuleID[] moduleIDList)
throws IllegalStateException
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.
moduleIDList
- An array of TargetModuleID objects representing the modules to be started.
- An object that tracks and reports the status of the start operation.
stop
public ProgressObject stop(TargetModuleID[] moduleIDList)
throws IllegalStateException
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.
moduleIDList
- An array of TargetModuleID objects representing the modules to be stopped.
- An object that tracks and reports the status of the stop operation.
undeploy
public ProgressObject undeploy(TargetModuleID[] moduleIDList)
throws IllegalStateException
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.
moduleIDList
- An array of TargetModuleID objects representing the root
modules to be undeployed.
- An object that tracks and reports the status of the stop operation.