oracle.jdeveloper.deploy

Interface Deployer

All Known Subinterfaces:

StatefulDeployer

All Known Implementing Classes:

AbstractDeployer, AbstractStatefulDeployer, ArchiveDeployer, ArchivePreviewer, BatchDeployer, BuildDeployer, DynamicDeployer, ModulePackager, NullDeployer, oracle.jdevimpl.deploy.common.ProfileDeployer

public interface Deployer

A Deployer is responsible for performing a single unit of work in the Deployment process. Strategy + Template Method pattern.

 The calling sequence is roughly like this:
 
 try {
   prepare();
   deploy();
  }
  catch (DeployException e) {
   cancel();
  }
  finally {
   finish();
  }
}
 

Method Summary

Modifier and Type	Method and Description
void	cancel(int deploySequenceId, DeployShell shell) Called if deployment has been cancelled, either because of user intervention or because of another deployment task failing.
boolean	canDeploy(int deploySequenceId) Indicate whether the deployer (or if its a composite deployer then any of its contained deployers) is capable of deploying the task indicated by the DeploymentSequenceId.
void	deploy(int deploySequenceId, DeployShell shell) Do the actual deployment task.
void	finish(int deploySequenceId, DeployShell shell) Called after the entire Deployment process has completed, perform any cleanup operations here.
void	prepare(int deploySequenceId, DeployShell shell) Called to do any preparatory work before the actual deployment takes place.

Method Detail

canDeploy

boolean canDeploy(int deploySequenceId)

Indicate whether the deployer (or if its a composite deployer then any of its contained deployers) is capable of deploying the task indicated by the DeploymentSequenceId. This method is called by the framework to co-ordinate and resolve deployment events.

Parameters:

deploySequenceId -

Returns:

true if the deployer can deploy the sequence.

prepare

void prepare(int deploySequenceId,
             DeployShell shell)
      throws DeployException

Called to do any preparatory work before the actual deployment takes place. No irreversible changes should be made in this method.

Parameters:

deploySequenceId -

shell -

Throws:

DeployException

deploy

void deploy(int deploySequenceId,
            DeployShell shell)
     throws DeployException

Do the actual deployment task.

Parameters:

deploySequenceId -

shell -

Throws:

DeployException

finish

void finish(int deploySequenceId,
            DeployShell shell)

Called after the entire Deployment process has completed, perform any cleanup operations here. This method should not throw a DeployException.

Parameters:

deploySequenceId -

shell -

cancel

void cancel(int deploySequenceId,
            DeployShell shell)

Called if deployment has been cancelled, either because of user intervention or because of another deployment task failing. This method should not throw a DeployException. This will only be invoked if prepare() has already been called on this Deployer.

Parameters:

deploySequenceId -

shell -