public interface DeploymentManager
Modifier and Type | Method and Description |
---|---|
DeploymentConfiguration |
createConfiguration(DeployableObject dObj)
Retrieve the object that provides server-specific deployment configuration
information for the J2EE deployable component.
|
ProgressObject |
distribute(Target[] targetList,
File moduleArchive,
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.
|
ProgressObject |
distribute(Target[] targetList,
InputStream moduleArchive,
InputStream deploymentPlan)
Deprecated.
use the following method including the moduletype instead
|
ProgressObject |
distribute(Target[] targetList,
ModuleType moduleType,
InputStream moduleArchive,
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.
|
TargetModuleID[] |
getAvailableModules(ModuleType moduleType,
Target[] targetList)
Retrieve the list of all J2EE application modules running or not running on the
identified targets.
|
Locale |
getCurrentLocale()
Returns the active locale this implementation of
javax.enterprise.deploy.spi subpackages is running.
|
DConfigBeanVersionType |
getDConfigBeanVersion()
Returns the J2EE platform version number for which the configuration
beans are provided.
|
Locale |
getDefaultLocale()
Returns the default locale supported by this implementation of
javax.enterprise.deploy.spi subpackages.
|
TargetModuleID[] |
getNonRunningModules(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.
|
TargetModuleID[] |
getRunningModules(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.
|
Locale[] |
getSupportedLocales()
Returns an array of supported locales for this implementation.
|
Target[] |
getTargets()
Retrieve the list of deployment targets supported by this DeploymentManager.
|
boolean |
isDConfigBeanVersionSupported(DConfigBeanVersionType version)
Returns
true if the configuration beans support the J2EE platform
version specified. |
boolean |
isLocaleSupported(Locale locale)
Reports if this implementation supports the designated locale.
|
boolean |
isRedeploySupported()
This method designates whether this platform vendor provides application
redeployment functionality.
|
ProgressObject |
redeploy(TargetModuleID[] moduleIDList,
File moduleArchive,
File deploymentPlan)
(optional) The redeploy method provides a means for updating currently
deployed J2EE applications.
|
ProgressObject |
redeploy(TargetModuleID[] moduleIDList,
InputStream moduleArchive,
InputStream deploymentPlan)
(optional) The redeploy method provides a means for updating currently
deployed J2EE applications.
|
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.
|
void |
setDConfigBeanVersion(DConfigBeanVersionType version)
Set the configuration beans to be used to the J2EE platform version specified.
|
void |
setLocale(Locale locale)
Set the active locale for this implementation of
javax.enterprise.deploy.spi subpackages to run.
|
ProgressObject |
start(TargetModuleID[] moduleIDList)
Start the application running.
|
ProgressObject |
stop(TargetModuleID[] moduleIDList)
Stop the application running.
|
ProgressObject |
undeploy(TargetModuleID[] moduleIDList)
Remove the application from the target server.
|
Target[] getTargets() throws IllegalStateException
null
if there are none.IllegalStateException
- is thrown when the method is called when
running in disconnected mode.TargetModuleID[] getRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException
moduleType
- A predefined designator for a J2EE module type.targetList
- A list of deployment Target designators the user wants
checked for module run status.null
if there are none.TargetException
- occurs when an invalid Target was provided.IllegalStateException
- is thrown when the method is called when running
in disconnected mode.TargetModuleID[] getNonRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException
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.null
if there are none.TargetException
- occurs when an invalid Target was provided.IllegalStateException
- is thrown when the method is called when running
in disconnected mode.TargetModuleID[] getAvailableModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException
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.null
if there are no deployed modules.TargetException
- occurs when an invalid Target was provided.IllegalStateException
- is thrown when the method is called when running
in disconnected mode.DeploymentConfiguration createConfiguration(DeployableObject dObj) throws InvalidModuleException
dObj
- An object representing a J2EE deployable component.InvalidModuleException
- The DeployableObject is an unknown or unsupported
component for this configuration tool.ProgressObject distribute(Target[] targetList, File moduleArchive, File deploymentPlan) throws IllegalStateException
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.IllegalStateException
- is thrown when the method is called when running in disconnected mode.ProgressObject distribute(Target[] targetList, InputStream moduleArchive, InputStream deploymentPlan) throws IllegalStateException
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.IllegalStateException
- is thrown when the method is called when running in disconnected mode.ProgressObject distribute(Target[] targetList, ModuleType moduleType, InputStream moduleArchive, InputStream deploymentPlan) throws IllegalStateException
targetList
- A list of server targets the user is specifying this application
should be deployed to.moduleType
- The module type of the application archive to be distributed.moduleArchive
- The stream containing the application archive to be distributed.deploymentPlan
- The stream containing the runtime configuration information
associated with this application archive.IllegalStateException
- is thrown when the method is called when running in disconnected mode.ProgressObject start(TargetModuleID[] moduleIDList) throws IllegalStateException
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.IllegalStateException
- is thrown when the method is called when running in disconnected mode.ProgressObject stop(TargetModuleID[] moduleIDList) throws IllegalStateException
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.IllegalStateException
- is thrown when the method is called when running in disconnected mode.ProgressObject undeploy(TargetModuleID[] moduleIDList) throws IllegalStateException
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.IllegalStateException
- is thrown when the method is called when running in disconnected mode.boolean isRedeploySupported()
ProgressObject redeploy(TargetModuleID[] moduleIDList, File moduleArchive, File deploymentPlan) throws UnsupportedOperationException, IllegalStateException
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.UnsupportedOperationException
- this optional command is not supported by
this implementation.IllegalStateException
- is thrown when the method is called when running
in disconnected mode.ProgressObject redeploy(TargetModuleID[] moduleIDList, InputStream moduleArchive, InputStream deploymentPlan) throws UnsupportedOperationException, IllegalStateException
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.UnsupportedOperationException
- this optional command is not supported by
this implementation.IllegalStateException
- is thrown when the method is called when running
in disconnected mode.void release()
Locale getDefaultLocale()
Locale getCurrentLocale()
void setLocale(Locale locale) throws UnsupportedOperationException
locale
- the locale to setUnsupportedOperationException
- the provide locale is not supported.Locale[] getSupportedLocales()
boolean isLocaleSupported(Locale locale)
locale
- the locale to checktrue
means it is supported and false
it is not.DConfigBeanVersionType getDConfigBeanVersion()
boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)
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.void setDConfigBeanVersion(DConfigBeanVersionType version) throws DConfigBeanVersionUnsupportedException
version
- a DConfigBeanVersionType object representing the J2EE
platform version for which support is requested.DConfigBeanVersionUnsupportedException
- when the requested bean
version is not supported.Copyright © 2013. All Rights Reserved.