oracle.rc.asadapter.deploy

Interface Jsr88DeploymentManager

All Known Implementing Classes:

DefaultJsr88DeploymentManager

public interface Jsr88DeploymentManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Jsr88DeploymentManager.TargetType

Method Summary

Modifier and Type	Method and Description
javax.enterprise.deploy.spi.DeploymentConfiguration	createDeploymentConfiguration(javax.enterprise.deploy.model.DeployableObject deployableObject) Creates a DeployementConfiguration object from a DeployableObject.
java.lang.String	getArchiveVersion(javax.enterprise.deploy.spi.TargetModuleID targetModuleID) Returns the Archive version associated witht the given TargetModuleID.
javax.enterprise.deploy.spi.TargetModuleID[]	getInstalledApplications(javax.enterprise.deploy.spi.Target[] targets, javax.enterprise.deploy.shared.ModuleType moduleType, java.lang.String applicationName) Returns a TargetModuleID array representing applications found on the server that match the given application by name and JEE ModuleType.
java.util.Iterator	getRootException(javax.enterprise.deploy.spi.status.DeploymentStatus deploymentStatus) Returns the RootException of a DeploymentStatus as an iterator of Throwable instances.
javax.enterprise.deploy.spi.TargetModuleID[]	getTargetModuleIDs(java.util.List<java.lang.String> applicationIDs, java.util.logging.Logger logger) Returns a list of TargetModuleIDs corresponding to the given application IDs.
javax.enterprise.deploy.spi.Target[]	getTargets(Jsr88DeploymentManager.TargetType targetType) Returns the Targets given a specify targetType.
javax.enterprise.deploy.spi.status.ProgressObject	invokeDeployApplicationMethod(javax.enterprise.deploy.spi.Target[] targets, java.io.File applicationFile, java.io.File deploymentPlan, java.lang.String applicationName, boolean isApplicationLibrary) Invokes Deployment of an Application file and DeploymentPlan given on the given targets.
javax.enterprise.deploy.spi.status.ProgressObject	invokeRedeployApplicationMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps, java.io.File applicationFile, java.io.File deploymentPlan, java.lang.String applicationName) Invokes ReDeployment of an Application file and DeploymentPlan given on the given targets.
javax.enterprise.deploy.spi.status.ProgressObject	invokeStartMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps) Invokes a start of an Application.
javax.enterprise.deploy.spi.status.ProgressObject	invokeStopMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps) Invokes a stop of an Application.
javax.enterprise.deploy.spi.status.ProgressObject	invokeUndeployApplicationsMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps) Invokes UnDeployment of an Application.

Method Detail

getTargets

javax.enterprise.deploy.spi.Target[] getTargets(Jsr88DeploymentManager.TargetType targetType)
                                         throws java.lang.Exception

Returns the Targets given a specify targetType.

Parameters:

targetType - The TargetType (SERVERS, CLUSTERS or ALL).

Returns:

Target Array.

Throws:

java.lang.Exception

getInstalledApplications

javax.enterprise.deploy.spi.TargetModuleID[] getInstalledApplications(javax.enterprise.deploy.spi.Target[] targets,
                                                                      javax.enterprise.deploy.shared.ModuleType moduleType,
                                                                      java.lang.String applicationName)
                                                               throws java.lang.Exception

Returns a TargetModuleID array representing applications found on the server that match the given application by name and JEE ModuleType.

Parameters:

targets - the server Targets to search on.

moduleType - the JEE ModuleType (EAR/WAR/RAR etc) to search for.

applicationName - the name of the application to search for.

Returns:

TargetModuleID[] array of applications matching the application name and type on the supplied Targets.

Throws:

java.lang.Exception

getTargetModuleIDs

javax.enterprise.deploy.spi.TargetModuleID[] getTargetModuleIDs(java.util.List<java.lang.String> applicationIDs,
                                                                java.util.logging.Logger logger)
                                                         throws java.lang.Exception

Returns a list of TargetModuleIDs corresponding to the given application IDs.

Parameters:

applicationIDs - Application Names.

logger - Logger to be used for warning messages

Returns:

List of TargetModuleID instances.

Throws:

java.lang.Exception

createDeploymentConfiguration

javax.enterprise.deploy.spi.DeploymentConfiguration createDeploymentConfiguration(javax.enterprise.deploy.model.DeployableObject deployableObject)
                                                                           throws java.lang.Exception

Creates a DeployementConfiguration object from a DeployableObject.

Parameters:

deployableObject - The deployableObject representing the JEE module to be deployed.

Returns:

the DeploymentConfiguration object created.

Throws:

java.lang.Exception

invokeDeployApplicationMethod

javax.enterprise.deploy.spi.status.ProgressObject invokeDeployApplicationMethod(javax.enterprise.deploy.spi.Target[] targets,
                                                                                java.io.File applicationFile,
                                                                                java.io.File deploymentPlan,
                                                                                java.lang.String applicationName,
                                                                                boolean isApplicationLibrary)
                                                                         throws java.lang.Exception

Invokes Deployment of an Application file and DeploymentPlan given on the given targets.

Parameters:

targets - The targets where the application will be deployed.

applicationFile - The archive being deployed (archive or exploded directory)

deploymentPlan - The deploymentPlan for this application.

applicationName - The name of the applicatioin being deployed.

isApplicationLibrary - indicates if the application is a Shared Library or not.

Returns:

ProgressObject that can be used to monitor the deployment progress.

Throws:

java.lang.Exception

invokeRedeployApplicationMethod

javax.enterprise.deploy.spi.status.ProgressObject invokeRedeployApplicationMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps,
                                                                                  java.io.File applicationFile,
                                                                                  java.io.File deploymentPlan,
                                                                                  java.lang.String applicationName)
                                                                           throws java.lang.Exception

Invokes ReDeployment of an Application file and DeploymentPlan given on the given targets.

Parameters:

apps - The TargetModuleID array representing the existing applications to be replaced.

applicationFile - The archive being deployed (archive or exploded directory)

deploymentPlan - The deploymentPlan for this application.

applicationName - The name of the application being redeployed.

Returns:

ProgressObject that can be used to monitor the deployment progress.

Throws:

java.lang.Exception

invokeUndeployApplicationsMethod

javax.enterprise.deploy.spi.status.ProgressObject invokeUndeployApplicationsMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps)
                                                                            throws java.lang.Exception

Invokes UnDeployment of an Application.

Parameters:

apps - The TargetModuleID array representing the existing applications to be removed.

Returns:

ProgressObject that can be used to monitor the deployment progress.

Throws:

java.lang.Exception

invokeStartMethod

javax.enterprise.deploy.spi.status.ProgressObject invokeStartMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps)
                                                             throws java.lang.Exception

Invokes a start of an Application.

Parameters:

apps - The TargetModuleID array representing the existing applications to be started.

Returns:

ProgressObject that can be used to monitor the progress.

Throws:

java.lang.Exception

invokeStopMethod

javax.enterprise.deploy.spi.status.ProgressObject invokeStopMethod(javax.enterprise.deploy.spi.TargetModuleID[] apps)
                                                            throws java.lang.Exception

Invokes a stop of an Application.

Parameters:

apps - The TargetModuleID array representing the existing applications to be stoped.

Returns:

ProgressObject that can be used to monitor the progress.

Throws:

java.lang.Exception

getArchiveVersion

java.lang.String getArchiveVersion(javax.enterprise.deploy.spi.TargetModuleID targetModuleID)

Returns the Archive version associated witht the given TargetModuleID.

Parameters:

targetModuleID -

Returns:

archive version

getRootException

java.util.Iterator getRootException(javax.enterprise.deploy.spi.status.DeploymentStatus deploymentStatus)

Returns the RootException of a DeploymentStatus as an iterator of Throwable instances.

Parameters:

deploymentStatus -

Returns:

Iterator of Throwable instances.