oracle.jdeveloper.deploy.common

Class AbstractDeployer

java.lang.Object

oracle.jdeveloper.deploy.common.AbstractDeployer

All Implemented Interfaces:

Deployer, ProgressListener

Direct Known Subclasses:

AbstractStatefulDeployer

public abstract class AbstractDeployer
extends java.lang.Object
implements Deployer, ProgressListener

Base class for constructing new Deployers. Sub-class from this to ensure deployment listeners that are registered to listen on events coming from this Deployer are fired appropriately.

Constructor Summary

Constructors

Constructor and Description
AbstractDeployer(int deploymentSequenceId)

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.
protected void	cancelImpl(int deploySequenceId, DeployShell shell)
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.
protected abstract void	deployImpl(int deploySequenceId, DeployShell shell)
void	finish(int deploySequenceId, DeployShell shell) Called after the entire Deployment process has completed, perform any cleanup operations here.
protected void	finishImpl(int deploySequenceId, DeployShell shell)
java.lang.String	getName() Return a (translatable) name for this Deployer, the default returns the class name.
int	getSequenceId()
void	handleEvent(ProgressEvent dpe)
protected boolean	isDeploymentCancelled()
void	prepare(int deploySequenceId, DeployShell shell) Called to do any preparatory work before the actual deployment takes place.
protected void	prepareImpl(int deploySequenceId, DeployShell shell)
void	throwExceptionIfCancelEventReceived() Deployers can use this method at anytime (specifically during a prepare or a deploy) to verify if a CancelEvent was received (Note that AbstractDeployer instances are listening for cancel events during their prepare and deploy methods).
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractDeployer

public AbstractDeployer(int deploymentSequenceId)

Method Detail

getSequenceId

public int getSequenceId()

Returns:

canDeploy

public boolean canDeploy(int deploySequenceId)

Description copied from interface: Deployer

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.

Specified by:

canDeploy in interface Deployer

Returns:

true if the deployer can deploy the sequence.

getName

public java.lang.String getName()

Return a (translatable) name for this Deployer, the default returns the class name.

Returns:

String name of deployer for display in error messages.

prepare

public void prepare(int deploySequenceId,
                    DeployShell shell)
             throws DeployException

Description copied from interface: Deployer

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

Specified by:

prepare in interface Deployer

Throws:

DeployException

deploy

public void deploy(int deploySequenceId,
                   DeployShell shell)
            throws DeployException

Description copied from interface: Deployer

Do the actual deployment task.

Specified by:

deploy in interface Deployer

Throws:

DeployException

isDeploymentCancelled

protected boolean isDeploymentCancelled()

handleEvent

public void handleEvent(ProgressEvent dpe)

Specified by:

handleEvent in interface ProgressListener

throwExceptionIfCancelEventReceived

public void throwExceptionIfCancelEventReceived()
                                         throws DeployException

Deployers can use this method at anytime (specifically during a prepare or a deploy) to verify if a CancelEvent was received (Note that AbstractDeployer instances are listening for cancel events during their prepare and deploy methods). If a CancelEvent was received, this method will throw a DeployException so that the deployment process can be interrupted.

Throws:

DeployException

finish

public void finish(int deploySequenceId,
                   DeployShell shell)

Description copied from interface: Deployer

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

Specified by:

finish in interface Deployer

cancel

public void cancel(int deploySequenceId,
                   DeployShell shell)

Description copied from interface: Deployer

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.

Specified by:

cancel in interface Deployer

prepareImpl

protected void prepareImpl(int deploySequenceId,
                           DeployShell shell)
                    throws DeployException

Throws:

DeployException

deployImpl

protected abstract void deployImpl(int deploySequenceId,
                                   DeployShell shell)
                            throws DeployException

Throws:

DeployException

finishImpl

protected void finishImpl(int deploySequenceId,
                          DeployShell shell)

cancelImpl

protected void cancelImpl(int deploySequenceId,
                          DeployShell shell)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object