| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
| Method Summary | |
|  DeploymentConfiguration | createConfiguration(DeployableObject dObj)Retrieve the object that provides server-specific deployment configuration information for the J2EE 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)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. | 
|  java.util.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. | 
|  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 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. | 
|  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 J2EE 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 J2EE applications. | 
|  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. | 
|  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 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 | 
public Target[] getTargets()
                    throws java.lang.IllegalStateException
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
public TargetModuleID[] getRunningModules(ModuleType moduleType,
                                          Target[] targetList)
                                   throws TargetException,
                                          java.lang.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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
TargetException - An invalid Target designator
                   encountered.
public TargetModuleID[] getNonRunningModules(ModuleType moduleType,
                                             Target[] targetList)
                                      throws TargetException,
                                             java.lang.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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
TargetException - An invalid Target designator
                   encountered.
public TargetModuleID[] getAvailableModules(ModuleType moduleType,
                                            Target[] targetList)
                                     throws TargetException,
                                            java.lang.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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
TargetException - An invalid Target designator
                   encountered.
public DeploymentConfiguration createConfiguration(DeployableObject dObj)
                                            throws InvalidModuleException
dObj - An object representing a J2EE deployable component.
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)
                          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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
public ProgressObject distribute(Target[] targetList,
                                 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.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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
public 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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
public 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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.
public 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.
java.lang.IllegalStateException - is thrown when the method is
                    called when running in disconnected mode.public boolean isRedeploySupported()
public 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.
java.lang.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.
public 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.
java.lang.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.public void release()
public java.util.Locale getDefaultLocale()
public java.util.Locale getCurrentLocale()
public void setLocale(java.util.Locale locale)
               throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException - the provide locale is
      not supported.public java.util.Locale[] getSupportedLocales()
public boolean isLocaleSupported(java.util.Locale locale)
public DConfigBeanVersionType getDConfigBeanVersion()
public boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)
version - a DConfigBeanVersionType object representing the 
	J2EE platform version for which support is requested.
public 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.| 
 | J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.