Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> javax >> enterprise >> deploy >> [ spi overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of javax.enterprise.deploy.spi.MockDeploymentManager JAVADOC | Sourc code of javax.enterprise.deploy.spi.MockDeploymentManager SOURCE | Download javax.enterprise.deploy.spi.MockDeploymentManager DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.enterprise.deploy.spi
Class MockDeploymentManager  view MockDeploymentManager download MockDeploymentManager.java

java.lang.Object
  extended byjavax.enterprise.deploy.spi.MockDeploymentManager
All Implemented Interfaces:
DeploymentManager
public class MockDeploymentManager
extends java.lang.Object
implements DeploymentManager

Constructor Summary
MockDeploymentManager()
           
 
Method Summary
 DeploymentConfiguration createConfiguration(javax.enterprise.deploy.model.DeployableObject dObj)
          Retrieve the object that provides server-specific deployment configuration information for the J2EE deployable component.
 javax.enterprise.deploy.spi.status.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.
 javax.enterprise.deploy.spi.status.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(javax.enterprise.deploy.shared.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.
 javax.enterprise.deploy.shared.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(javax.enterprise.deploy.shared.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(javax.enterprise.deploy.shared.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(javax.enterprise.deploy.shared.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.
 javax.enterprise.deploy.spi.status.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.
 javax.enterprise.deploy.spi.status.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(javax.enterprise.deploy.shared.DConfigBeanVersionType version)
          Set the configuration beans to be used to the J2EE platform version specified.
 void setLocale(java.util.Locale locale)
          Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run.
 javax.enterprise.deploy.spi.status.ProgressObject start(TargetModuleID[] moduleIDList)
          Start the application running.
 javax.enterprise.deploy.spi.status.ProgressObject stop(TargetModuleID[] moduleIDList)
          Stop the application running.
 javax.enterprise.deploy.spi.status.ProgressObject undeploy(TargetModuleID[] moduleIDList)
          Remove the application from the target server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockDeploymentManager

public MockDeploymentManager()
Method Detail

getTargets

public Target[] getTargets()
                    throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
Retrieve the list of deployment targets supported by this DeploymentManager.

Specified by:
getTargets in interface DeploymentManager

getRunningModules

public TargetModuleID[] getRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType,
                                          Target[] targetList)
                                   throws javax.enterprise.deploy.spi.exceptions.TargetException,
                                          java.lang.IllegalStateException
Description copied from interface: DeploymentManager
Retrieve the list of J2EE application modules distributed to the identified targets and that are currently running on the associated server or servers.

Specified by:
getRunningModules in interface DeploymentManager

getNonRunningModules

public TargetModuleID[] getNonRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType,
                                             Target[] targetList)
                                      throws javax.enterprise.deploy.spi.exceptions.TargetException,
                                             java.lang.IllegalStateException
Description copied from interface: DeploymentManager
Retrieve the list of J2EE application modules distributed to the identified targets and that are currently not running on the associated server or servers.

Specified by:
getNonRunningModules in interface DeploymentManager

getAvailableModules

public TargetModuleID[] getAvailableModules(javax.enterprise.deploy.shared.ModuleType moduleType,
                                            Target[] targetList)
                                     throws javax.enterprise.deploy.spi.exceptions.TargetException,
                                            java.lang.IllegalStateException
Description copied from interface: DeploymentManager
Retrieve the list of all J2EE application modules running or not running on the identified targets.

Specified by:
getAvailableModules in interface DeploymentManager

createConfiguration

public DeploymentConfiguration createConfiguration(javax.enterprise.deploy.model.DeployableObject dObj)
                                            throws javax.enterprise.deploy.spi.exceptions.InvalidModuleException
Description copied from interface: DeploymentManager
Retrieve the object that provides server-specific deployment configuration information for the J2EE deployable component.

Specified by:
createConfiguration in interface DeploymentManager

distribute

public javax.enterprise.deploy.spi.status.ProgressObject distribute(Target[] targetList,
                                                                    java.io.File moduleArchive,
                                                                    java.io.File deploymentPlan)
                                                             throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
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.

Specified by:
distribute in interface DeploymentManager

distribute

public javax.enterprise.deploy.spi.status.ProgressObject distribute(Target[] targetList,
                                                                    java.io.InputStream moduleArchive,
                                                                    java.io.InputStream deploymentPlan)
                                                             throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
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.

Specified by:
distribute in interface DeploymentManager

start

public javax.enterprise.deploy.spi.status.ProgressObject start(TargetModuleID[] moduleIDList)
                                                        throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
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.

Specified by:
start in interface DeploymentManager

stop

public javax.enterprise.deploy.spi.status.ProgressObject stop(TargetModuleID[] moduleIDList)
                                                       throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
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.

Specified by:
stop in interface DeploymentManager

undeploy

public javax.enterprise.deploy.spi.status.ProgressObject undeploy(TargetModuleID[] moduleIDList)
                                                           throws java.lang.IllegalStateException
Description copied from interface: DeploymentManager
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.

Specified by:
undeploy in interface DeploymentManager

isRedeploySupported

public boolean isRedeploySupported()
Description copied from interface: DeploymentManager
This method designates whether this platform vendor provides application redeployment functionality. A value of true means it is supported. False means it is not.

Specified by:
isRedeploySupported in interface DeploymentManager

redeploy

public javax.enterprise.deploy.spi.status.ProgressObject redeploy(TargetModuleID[] moduleIDList,
                                                                  java.io.File moduleArchive,
                                                                  java.io.File deploymentPlan)
                                                           throws java.lang.UnsupportedOperationException,
                                                                  java.lang.IllegalStateException
Description copied from interface: DeploymentManager
(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.

Specified by:
redeploy in interface DeploymentManager

redeploy

public javax.enterprise.deploy.spi.status.ProgressObject redeploy(TargetModuleID[] moduleIDList,
                                                                  java.io.InputStream moduleArchive,
                                                                  java.io.InputStream deploymentPlan)
                                                           throws java.lang.UnsupportedOperationException,
                                                                  java.lang.IllegalStateException
Description copied from interface: DeploymentManager
(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.

Specified by:
redeploy in interface DeploymentManager

release

public void release()
Description copied from interface: DeploymentManager
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).

Specified by:
release in interface DeploymentManager

getDefaultLocale

public java.util.Locale getDefaultLocale()
Description copied from interface: DeploymentManager
Returns the default locale supported by this implementation of javax.enterprise.deploy.spi subpackages.

Specified by:
getDefaultLocale in interface DeploymentManager

getCurrentLocale

public java.util.Locale getCurrentLocale()
Description copied from interface: DeploymentManager
Returns the active locale this implementation of javax.enterprise.deploy.spi subpackages is running.

Specified by:
getCurrentLocale in interface DeploymentManager

setLocale

public void setLocale(java.util.Locale locale)
               throws java.lang.UnsupportedOperationException
Description copied from interface: DeploymentManager
Set the active locale for this implementation of javax.enterprise.deploy.spi subpackages to run.

Specified by:
setLocale in interface DeploymentManager

getSupportedLocales

public java.util.Locale[] getSupportedLocales()
Description copied from interface: DeploymentManager
Returns an array of supported locales for this implementation.

Specified by:
getSupportedLocales in interface DeploymentManager

isLocaleSupported

public boolean isLocaleSupported(java.util.Locale locale)
Description copied from interface: DeploymentManager
Reports if this implementation supports the designated locale.

Specified by:
isLocaleSupported in interface DeploymentManager

getDConfigBeanVersion

public javax.enterprise.deploy.shared.DConfigBeanVersionType getDConfigBeanVersion()
Description copied from interface: DeploymentManager
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.

Specified by:
getDConfigBeanVersion in interface DeploymentManager

isDConfigBeanVersionSupported

public boolean isDConfigBeanVersionSupported(javax.enterprise.deploy.shared.DConfigBeanVersionType version)
Description copied from interface: DeploymentManager
Returns true if the configuration beans support the J2EE platform version specified. It returns false if the version is not supported.

Specified by:
isDConfigBeanVersionSupported in interface DeploymentManager

setDConfigBeanVersion

public void setDConfigBeanVersion(javax.enterprise.deploy.shared.DConfigBeanVersionType version)
                           throws javax.enterprise.deploy.spi.exceptions.DConfigBeanVersionUnsupportedException
Description copied from interface: DeploymentManager
Set the configuration beans to be used to the J2EE platform version specified.

Specified by:
setDConfigBeanVersion in interface DeploymentManager
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> javax >> enterprise >> deploy >> [ spi overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of javax.enterprise.deploy.spi.MockDeploymentManager JAVADOC | Sourc code of javax.enterprise.deploy.spi.MockDeploymentManager SOURCE | Download javax.enterprise.deploy.spi.MockDeploymentManager DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD