|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeploymentManager
The DeploymentManager object provides the core set of functions a Java EE platform must provide for Java EE application deployment. It provides server related information, such as, a list of deployment targets, and vendor unique runtime configuration information.
Method Summary | |
---|---|
DeploymentConfiguration |
createConfiguration(DeployableObject dObj)
Retrieve the object that provides server-specific deployment configuration information for the Java EE deployable component. |
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. |
ProgressObject |
distribute(Target[] targetList,
java.io.InputStream moduleArchive,
java.io.InputStream deploymentPlan)
Deprecated. as of Java EE 5, replaced with distribute(Target[], ModuleType, InputStream, InputStream) |
ProgressObject |
distribute(Target[] targetList,
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. |
TargetModuleID[] |
getAvailableModules(ModuleType moduleType,
Target[] targetList)
Retrieve the list of all Java EE application modules running or not running on the identified targets. |
java.util.Locale |
getCurrentLocale()
Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running. |
DConfigBeanVersionType |
getDConfigBeanVersion()
Returns the Java EE platform version number for which the configuration beans are provided. |
java.util.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 Java EE 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 Java EE application modules distributed to the identified targets and that are currently running on the associated server or servers. |
java.util.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 Java EE platform version specified. |
boolean |
isLocaleSupported(java.util.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,
java.io.File moduleArchive,
java.io.File deploymentPlan)
(optional) The redeploy method provides a means for updating currently deployed Java EE applications. |
ProgressObject |
redeploy(TargetModuleID[] moduleIDList,
java.io.InputStream moduleArchive,
java.io.InputStream deploymentPlan)
(optional) The redeploy method provides a means for updating currently deployed Java EE 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 Java EE platform version specificed. |
void |
setLocale(java.util.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. |
Method Detail |
---|
Target[] getTargets() throws java.lang.IllegalStateException
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.TargetModuleID[] getRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, java.lang.IllegalStateException
moduleType
- A predefined designator for a Java EE
module type.targetList
- A list of deployment Target designators
the user wants checked for module run
status.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.
TargetException
- An invalid Target designator
encountered.TargetModuleID[] getNonRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, java.lang.IllegalStateException
moduleType
- A predefined designator for a Java EE
module type.targetList
- A list of deployment Target designators
the user wants checked for module not
running status.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.
TargetException
- An invalid Target designator
encountered.TargetModuleID[] getAvailableModules(ModuleType moduleType, Target[] targetList) throws TargetException, java.lang.IllegalStateException
moduleType
- A predefined designator for a Java EE
module type.targetList
- A list of deployment Target designators
the user wants checked for module not
running status.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.
TargetException
- An invalid Target designator
encountered.DeploymentConfiguration createConfiguration(DeployableObject dObj) throws InvalidModuleException
dObj
- An object representing a Java EE deployable component.
InvalidModuleException
- The DeployableObject is an
unknown or unsupport component for this
configuration tool.ProgressObject distribute(Target[] targetList, java.io.File moduleArchive, java.io.File deploymentPlan) throws java.lang.IllegalStateException
targetList
- A list of server targets the user is specifying
this application be deployed to.moduleArchive
- The file name of the application archive
to be disrtibuted.deploymentPlan
- The XML 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, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) throws java.lang.IllegalStateException
distribute(Target[], ModuleType, InputStream, InputStream)
targetList
- A list of server targets the user is specifying
this application be deployed to.moduleArchive
- The input stream containing the application
archive to be disrtibuted.deploymentPlan
- The input stream containing the deployment
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 type, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) throws java.lang.IllegalStateException
targetList
- A list of server targets the user is specifying
this application be deployed to.moduleType
- The module type of this application archive.moduleArchive
- The input stream containing the application
archive to be disrtibuted.deploymentPlan
- The input stream containing the deployment
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 java.lang.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
- A 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 java.lang.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
- A 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 java.lang.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 stopped.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.boolean isRedeploySupported()
ProgressObject redeploy(TargetModuleID[] moduleIDList, java.io.File moduleArchive, java.io.File deploymentPlan) throws java.lang.UnsupportedOperationException, java.lang.IllegalStateException
moduleIDList
- An array of designators of the applications
to be updated.moduleArchive
- The file name of the application archive
to be disrtibuted.deploymentPlan
- The deployment configuration information
associated with this application archive.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.
java.lang.UnsupportedOperationException
- this optional command
is not supported by this implementation.ProgressObject redeploy(TargetModuleID[] moduleIDList, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan) throws java.lang.UnsupportedOperationException, java.lang.IllegalStateException
moduleIDList
- An array of designators of the applications
to be updated.moduleArchive
- The input stream containing the application
archive to be disrtibuted.deploymentPlan
- The input stream containing the runtime
configuration information associated with
this application archive.
IllegalStateException
- is thrown when the method is
called when running in disconnected mode.
java.lang.UnsupportedOperationException
- this optional command
is not supported by this implementation.void release()
java.util.Locale getDefaultLocale()
java.util.Locale getCurrentLocale()
void setLocale(java.util.Locale locale) throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
- the provide locale is
not supported.java.util.Locale[] getSupportedLocales()
boolean isLocaleSupported(java.util.Locale locale)
DConfigBeanVersionType getDConfigBeanVersion()
boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)
version
- a DConfigBeanVersionType object representing the
Java EE platform version for which support is requested.
void setDConfigBeanVersion(DConfigBeanVersionType version) throws DConfigBeanVersionUnsupportedException
version
- a DConfigBeanVersionType object representing the
Java EE platform version for which support is requested.
DConfigBeanVersionUnsupportedException
- when the
requested bean version is not supported.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.
Generated on 10-February-2011 12:41