javax.enterprise.deploy API 1.7.2 · javax.enterprise.deploy.spi.DeploymentManager

Method Summary

Modifier and Type	Method and Description
public DeploymentConfiguration	createConfiguration(DeployableObject An object representing a Jakarta EE deployable component. dObj) Retrieve the object that provides server-specific deployment configuration information for the Jakarta EE deployable component.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the distribution process. distribute(Target[] A list of server targets the user is specifying this application be deployed to. targetList, File The file name of the application archive to be disrtibuted. moduleArchive, File The XML file containing the runtime configuration information associated with this application archive. 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.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the distribution process. distribute(Target[] A list of server targets the user is specifying this application be deployed to. targetList, InputStream The input stream containing the application archive to be disrtibuted. moduleArchive, InputStream The input stream containing the deployment configuration information associated with this application archive. deploymentPlan) Deprecated as of Java EE 5, replaced with `distribute(Target[], ModuleType, InputStream, InputStream)` 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.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the distribution process. distribute(Target[] A list of server targets the user is specifying this application be deployed to. targetList, ModuleType The module type of this application archive. type, InputStream The input stream containing the application archive to be disrtibuted. moduleArchive, InputStream The input stream containing the deployment configuration information associated with this application archive. 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.
public TargetModuleID[]	Returns: An array of TargetModuleID objects representing all deployed modules running or not or 'null' if there are no deployed modules. getAvailableModules(ModuleType A predefined designator for a Jakarta EE module type. moduleType, Target[] A list of deployment Target designators the user wants checked for module not running status. targetList) Retrieve the list of all Jakarta EE application modules running or not running on the identified targets.
public Locale	Returns: Locale the active locale of this implementation. getCurrentLocale() Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running.
public DConfigBeanVersionType	Returns: a DConfigBeanVersionType object representing the platform version number for which these beans are provided. getDConfigBeanVersion() Returns the Jakarta EE platform version number for which the configuration beans are provided.
public Locale	Returns: Locale the default locale for this implementation. getDefaultLocale() Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages.
public TargetModuleID[]	Returns: An array of TargetModuleID objects representing the non-running modules or 'null' if there are none. getNonRunningModules(ModuleType A predefined designator for a Jakarta EE module type. moduleType, Target[] A list of deployment Target designators the user wants checked for module not running status. targetList) Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently not running on the associated server or servers.
public TargetModuleID[]	Returns: An array of TargetModuleID objects representing the running modules or 'null' if there are none. getRunningModules(ModuleType A predefined designator for a Jakarta EE module type. moduleType, Target[] A list of deployment Target designators the user wants checked for module run status. targetList) Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently running on the associated server or servers.
public Locale[]	Returns: Locale[] the list of supported locales. getSupportedLocales() Returns an array of supported locales for this implementation.
public Target[]	Returns: A list of deployment Target designators the user may select for application deployment or 'null' if there are none. getTargets() Retrieve the list of deployment targets supported by this DeploymentManager.
public boolean	Returns: 'true' if the version is supported and 'false if not. isDConfigBeanVersionSupported(DConfigBeanVersionType a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested. version) Returns 'true' if the configuration beans support the Jakarta EE platform version specified.
public boolean	Returns: A value of 'true' means it is support and 'false' it is not. isLocaleSupported(Locale locale) Reports if this implementation supports the designated locale.
public boolean	Returns: A value of true means redeployment is supported by this vendor's DeploymentManager. False means it is not. isRedeploySupported() This method designates whether this platform vendor provides application redeployment functionality.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the redeploy operation. redeploy(TargetModuleID[] An array of designators of the applications to be updated. moduleIDList, File The file name of the application archive to be disrtibuted. moduleArchive, File The deployment configuration information associated with this application archive. deploymentPlan) (optional) The redeploy method provides a means for updating currently deployed Jakarta EE applications.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the redeploy operation. redeploy(TargetModuleID[] An array of designators of the applications to be updated. moduleIDList, InputStream The input stream containing the application archive to be disrtibuted. moduleArchive, InputStream The input stream containing the runtime configuration information associated with this application archive. deploymentPlan) (optional) The redeploy method provides a means for updating currently deployed Jakarta EE applications.
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.
public void	setDConfigBeanVersion(DConfigBeanVersionType a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested. version) Set the configuration beans to be used to the Jakarta EE platform version specificed.
public void	setLocale(Locale locale) Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the start operation. start(TargetModuleID[] A array of TargetModuleID objects representing the modules to be started. moduleIDList) Start the application running.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the stop operation. stop(TargetModuleID[] A array of TargetModuleID objects representing the modules to be stopped. moduleIDList) Stop the application running.
public ProgressObject	Returns: ProgressObject an object that tracks and reports the status of the stop operation. undeploy(TargetModuleID[] An array of TargetModuleID objects representing the root modules to be stopped. moduleIDList) Remove the application from the target server.

Method Detail

createConfiguration	back to summary
public DeploymentConfiguration createConfiguration(DeployableObject dObj) throws InvalidModuleException Retrieve the object that provides server-specific deployment configuration information for the Jakarta EE deployable component. Parameters dObj:DeployableObject An object representing a Jakarta EE deployable component. Exceptions InvalidModuleException: The DeployableObject is an unknown or unsupport component for this configuration tool.

createConfiguration

back to summary

public DeploymentConfiguration createConfiguration(DeployableObject dObj) throws InvalidModuleException

Retrieve the object that provides server-specific deployment configuration information for the Jakarta EE deployable component.

Parameters

dObj:DeployableObject: An object representing a Jakarta EE deployable component.

Exceptions

InvalidModuleException:: The DeployableObject is an unknown or unsupport component for this configuration tool.

distribute	back to summary
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. Parameters targetList:Target[] A list of server targets the user is specifying this application be deployed to. moduleArchive:File The file name of the application archive to be disrtibuted. deploymentPlan:File The XML file containing the runtime configuration information associated with this application archive. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the distribution process. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

distribute

back to summary

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.

Parameters

targetList:Target[]: A list of server targets the user is specifying this application be deployed to.
moduleArchive:File: The file name of the application archive to be disrtibuted.
deploymentPlan:File: The XML file containing the runtime configuration information associated with this application archive.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the distribution process.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

distribute back to summary

distribute	back to summary
public ProgressObject distribute(Target[] targetList, InputStream moduleArchive, InputStream deploymentPlan) throws IllegalStateException Deprecated as of Java EE 5, replaced with `distribute(Target[], ModuleType, InputStream, InputStream)` 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. Parameters targetList:Target[] A list of server targets the user is specifying this application be deployed to. moduleArchive:InputStream The input stream containing the application archive to be disrtibuted. deploymentPlan:InputStream The input stream containing the deployment configuration information associated with this application archive. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the distribution process. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

public ProgressObject distribute(Target[] targetList, InputStream moduleArchive, InputStream deploymentPlan) throws IllegalStateException

Deprecated

as of Java EE 5, replaced with distribute(Target[], ModuleType, InputStream, InputStream)

Parameters

targetList:Target[]: A list of server targets the user is specifying this application be deployed to.
moduleArchive:InputStream: The input stream containing the application archive to be disrtibuted.
deploymentPlan:InputStream: The input stream containing the deployment configuration information associated with this application archive.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the distribution process.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

distribute	back to summary
public ProgressObject distribute(Target[] targetList, ModuleType type, 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. Parameters targetList:Target[] A list of server targets the user is specifying this application be deployed to. type:ModuleType The module type of this application archive. moduleArchive:InputStream The input stream containing the application archive to be disrtibuted. deploymentPlan:InputStream The input stream containing the deployment configuration information associated with this application archive. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the distribution process. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

distribute

back to summary

public ProgressObject distribute(Target[] targetList, ModuleType type, InputStream moduleArchive, InputStream deploymentPlan) throws IllegalStateException

Parameters

targetList:Target[]: A list of server targets the user is specifying this application be deployed to.
type:ModuleType: The module type of this application archive.
moduleArchive:InputStream: The input stream containing the application archive to be disrtibuted.
deploymentPlan:InputStream: The input stream containing the deployment configuration information associated with this application archive.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the distribution process.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

getAvailableModules	back to summary
public TargetModuleID[] getAvailableModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException Retrieve the list of all Jakarta EE application modules running or not running on the identified targets. Parameters moduleType:ModuleType A predefined designator for a Jakarta EE module type. targetList:Target[] A list of deployment Target designators the user wants checked for module not running status. Returns:TargetModuleID[] An array of TargetModuleID objects representing all deployed modules running or not or 'null' if there are no deployed modules. Exceptions TargetException: An invalid Target designator encountered. IllegalStateException: is thrown when the method is called when running in disconnected mode.

getAvailableModules

back to summary

public TargetModuleID[] getAvailableModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException

Retrieve the list of all Jakarta EE application modules running or not running on the identified targets.

Parameters

moduleType:ModuleType: A predefined designator for a Jakarta EE module type.
targetList:Target[]: A list of deployment Target designators the user wants checked for module not running status.

Returns:TargetModuleID[]

An array of TargetModuleID objects representing all deployed modules running or not or 'null' if there are no deployed modules.

Exceptions

TargetException:: An invalid Target designator encountered.
IllegalStateException:: is thrown when the method is called when running in disconnected mode.

getCurrentLocale	back to summary
public Locale getCurrentLocale() Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running. Returns:Locale Locale the active locale of this implementation.

getCurrentLocale

back to summary

public Locale getCurrentLocale()

Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running.

Returns:Locale: Locale the active locale of this implementation.

getDConfigBeanVersion	back to summary
public DConfigBeanVersionType getDConfigBeanVersion() Returns the Jakarta EE platform version number for which the configuration beans are provided. The beans must have been compiled with the J2SE version required by the Jakarta EE platform. Returns:DConfigBeanVersionType a DConfigBeanVersionType object representing the platform version number for which these beans are provided.

getDConfigBeanVersion

back to summary

public DConfigBeanVersionType getDConfigBeanVersion()

Returns the Jakarta EE platform version number for which the configuration beans are provided. The beans must have been compiled with the J2SE version required by the Jakarta EE platform.

Returns:DConfigBeanVersionType: a DConfigBeanVersionType object representing the platform version number for which these beans are provided.

getDefaultLocale	back to summary
public Locale getDefaultLocale() Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages. Returns:Locale Locale the default locale for this implementation.

getDefaultLocale

back to summary

public Locale getDefaultLocale()

Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages.

Returns:Locale: Locale the default locale for this implementation.

getNonRunningModules	back to summary
public TargetModuleID[] getNonRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently not running on the associated server or servers. Parameters moduleType:ModuleType A predefined designator for a Jakarta EE module type. targetList:Target[] A list of deployment Target designators the user wants checked for module not running status. Returns:TargetModuleID[] An array of TargetModuleID objects representing the non-running modules or 'null' if there are none. Exceptions TargetException: An invalid Target designator encountered. IllegalStateException: is thrown when the method is called when running in disconnected mode.

getNonRunningModules

back to summary

public TargetModuleID[] getNonRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException

Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently not running on the associated server or servers.

Parameters

moduleType:ModuleType: A predefined designator for a Jakarta EE module type.
targetList:Target[]: A list of deployment Target designators the user wants checked for module not running status.

Returns:TargetModuleID[]

An array of TargetModuleID objects representing the non-running modules or 'null' if there are none.

Exceptions

TargetException:: An invalid Target designator encountered.
IllegalStateException:: is thrown when the method is called when running in disconnected mode.

getRunningModules	back to summary
public TargetModuleID[] getRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently running on the associated server or servers. Parameters moduleType:ModuleType A predefined designator for a Jakarta EE module type. targetList:Target[] A list of deployment Target designators the user wants checked for module run status. Returns:TargetModuleID[] An array of TargetModuleID objects representing the running modules or 'null' if there are none. Exceptions TargetException: An invalid Target designator encountered. IllegalStateException: is thrown when the method is called when running in disconnected mode.

getRunningModules

back to summary

public TargetModuleID[] getRunningModules(ModuleType moduleType, Target[] targetList) throws TargetException, IllegalStateException

Retrieve the list of Jakarta EE application modules distributed to the identified targets and that are currently running on the associated server or servers.

Parameters

moduleType:ModuleType: A predefined designator for a Jakarta EE module type.
targetList:Target[]: A list of deployment Target designators the user wants checked for module run status.

Returns:TargetModuleID[]

An array of TargetModuleID objects representing the running modules or 'null' if there are none.

Exceptions

TargetException:: An invalid Target designator encountered.
IllegalStateException:: is thrown when the method is called when running in disconnected mode.

getSupportedLocales	back to summary
public Locale[] getSupportedLocales() Returns an array of supported locales for this implementation. Returns:Locale[] Locale[] the list of supported locales.

getSupportedLocales

back to summary

public Locale[] getSupportedLocales()

Returns an array of supported locales for this implementation.

Returns:Locale[]: Locale[] the list of supported locales.

getTargets	back to summary
public Target[] getTargets() throws IllegalStateException Retrieve the list of deployment targets supported by this DeploymentManager. Returns:Target[] A list of deployment Target designators the user may select for application deployment or 'null' if there are none. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

getTargets

back to summary

public Target[] getTargets() throws IllegalStateException

Retrieve the list of deployment targets supported by this DeploymentManager.

Returns:Target[]

A list of deployment Target designators the user may select for application deployment or 'null' if there are none.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

isDConfigBeanVersionSupported	back to summary
public boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version) Returns 'true' if the configuration beans support the Jakarta EE platform version specified. It returns 'false' if the version is not supported. Parameters version:DConfigBeanVersionType a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested. Returns:boolean 'true' if the version is supported and 'false if not.

isDConfigBeanVersionSupported

back to summary

public boolean isDConfigBeanVersionSupported(DConfigBeanVersionType version)

Returns 'true' if the configuration beans support the Jakarta EE platform version specified. It returns 'false' if the version is not supported.

Parameters

version:DConfigBeanVersionType: a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested.

Returns:boolean

'true' if the version is supported and 'false if not.

isLocaleSupported	back to summary
public boolean isLocaleSupported(Locale locale) Reports if this implementation supports the designated locale. Returns:boolean A value of 'true' means it is support and 'false' it is not.

isLocaleSupported

back to summary

public boolean isLocaleSupported(Locale locale)

Reports if this implementation supports the designated locale.

Returns:boolean: A value of 'true' means it is support and 'false' it is not.

isRedeploySupported	back to summary
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. Returns:boolean A value of true means redeployment is supported by this vendor's DeploymentManager. False means it is not.

isRedeploySupported

back to summary

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.

Returns:boolean: A value of true means redeployment is supported by this vendor's DeploymentManager. False means it is not.

redeploy	back to summary
public ProgressObject redeploy(TargetModuleID[] moduleIDList, File moduleArchive, File deploymentPlan) throws UnsupportedOperationException, IllegalStateException (optional) The redeploy method provides a means for updating currently deployed Jakarta EE 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. Parameters moduleIDList:TargetModuleID[] An array of designators of the applications to be updated. moduleArchive:File The file name of the application archive to be disrtibuted. deploymentPlan:File The deployment configuration information associated with this application archive. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the redeploy operation. Exceptions UnsupportedOperationException: this optional command is not supported by this implementation. IllegalStateException: is thrown when the method is called when running in disconnected mode.

redeploy

back to summary

public ProgressObject redeploy(TargetModuleID[] moduleIDList, File moduleArchive, File deploymentPlan) throws UnsupportedOperationException, IllegalStateException

(optional) The redeploy method provides a means for updating currently deployed Jakarta EE 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.

Parameters

moduleIDList:TargetModuleID[]: An array of designators of the applications to be updated.
moduleArchive:File: The file name of the application archive to be disrtibuted.
deploymentPlan:File: The deployment configuration information associated with this application archive.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the redeploy operation.

Exceptions

UnsupportedOperationException:: this optional command is not supported by this implementation.
IllegalStateException:: is thrown when the method is called when running in disconnected mode.

redeploy	back to summary
public ProgressObject redeploy(TargetModuleID[] moduleIDList, InputStream moduleArchive, InputStream deploymentPlan) throws UnsupportedOperationException, IllegalStateException (optional) The redeploy method provides a means for updating currently deployed Jakarta EE 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. Parameters moduleIDList:TargetModuleID[] An array of designators of the applications to be updated. moduleArchive:InputStream The input stream containing the application archive to be disrtibuted. deploymentPlan:InputStream The input stream containing the runtime configuration information associated with this application archive. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the redeploy operation. Exceptions UnsupportedOperationException: this optional command is not supported by this implementation. IllegalStateException: is thrown when the method is called when running in disconnected mode.

redeploy

back to summary

public ProgressObject redeploy(TargetModuleID[] moduleIDList, InputStream moduleArchive, InputStream deploymentPlan) throws UnsupportedOperationException, IllegalStateException

Parameters

moduleIDList:TargetModuleID[]: An array of designators of the applications to be updated.
moduleArchive:InputStream: The input stream containing the application archive to be disrtibuted.
deploymentPlan:InputStream: The input stream containing the runtime configuration information associated with this application archive.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the redeploy operation.

Exceptions

UnsupportedOperationException:: this optional command is not supported by this implementation.
IllegalStateException:: is thrown when the method is called when running in disconnected mode.

release	back to summary
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 Jakarta EE 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).

release

back to summary

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 Jakarta EE 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	back to summary
public void setDConfigBeanVersion(DConfigBeanVersionType version) throws DConfigBeanVersionUnsupportedException Set the configuration beans to be used to the Jakarta EE platform version specificed. Parameters version:DConfigBeanVersionType a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested. Exceptions DConfigBeanVersionUnsupportedException: when the requested bean version is not supported.

setDConfigBeanVersion

back to summary

public void setDConfigBeanVersion(DConfigBeanVersionType version) throws DConfigBeanVersionUnsupportedException

Set the configuration beans to be used to the Jakarta EE platform version specificed.

Parameters

version:DConfigBeanVersionType: a DConfigBeanVersionType object representing the Jakarta EE platform version for which support is requested.

Exceptions

DConfigBeanVersionUnsupportedException:: when the requested bean version is not supported.

setLocale	back to summary
public void setLocale(Locale locale) throws UnsupportedOperationException Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run. Exceptions UnsupportedOperationException: the provide locale is not supported.

setLocale

back to summary

public void setLocale(Locale locale) throws UnsupportedOperationException

Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run.

Exceptions

UnsupportedOperationException:: the provide locale is not supported.

start	back to summary
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. Parameters moduleIDList:TargetModuleID[] A array of TargetModuleID objects representing the modules to be started. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the start operation. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

start

back to summary

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.

Parameters

moduleIDList:TargetModuleID[]: A array of TargetModuleID objects representing the modules to be started.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the start operation.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

stop	back to summary
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. Parameters moduleIDList:TargetModuleID[] A array of TargetModuleID objects representing the modules to be stopped. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the stop operation. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

stop

back to summary

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.

Parameters

moduleIDList:TargetModuleID[]: A array of TargetModuleID objects representing the modules to be stopped.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the stop operation.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

undeploy	back to summary
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. Parameters moduleIDList:TargetModuleID[] An array of TargetModuleID objects representing the root modules to be stopped. Returns:ProgressObject ProgressObject an object that tracks and reports the status of the stop operation. Exceptions IllegalStateException: is thrown when the method is called when running in disconnected mode.

undeploy

back to summary

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.

Parameters

moduleIDList:TargetModuleID[]: An array of TargetModuleID objects representing the root modules to be stopped.

Returns:ProgressObject

ProgressObject an object that tracks and reports the status of the stop operation.

Exceptions

IllegalStateException:: is thrown when the method is called when running in disconnected mode.

public Interface DeploymentManager

Method Summary

Method Detail