public abstract class AbstractDeployer extends java.lang.Object implements Deployer, ProgressListener
Constructor and Description |
---|
AbstractDeployer(int deploymentSequenceId) |
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() |
public int getSequenceId()
public boolean canDeploy(int deploySequenceId)
Deployer
public java.lang.String getName()
public void prepare(int deploySequenceId, DeployShell shell) throws DeployException
Deployer
prepare
in interface Deployer
DeployException
public void deploy(int deploySequenceId, DeployShell shell) throws DeployException
Deployer
deploy
in interface Deployer
DeployException
protected boolean isDeploymentCancelled()
public void handleEvent(ProgressEvent dpe)
handleEvent
in interface ProgressListener
public void throwExceptionIfCancelEventReceived() throws DeployException
DeployException
public void finish(int deploySequenceId, DeployShell shell)
Deployer
public void cancel(int deploySequenceId, DeployShell shell)
Deployer
protected void prepareImpl(int deploySequenceId, DeployShell shell) throws DeployException
DeployException
protected abstract void deployImpl(int deploySequenceId, DeployShell shell) throws DeployException
DeployException
protected void finishImpl(int deploySequenceId, DeployShell shell)
protected void cancelImpl(int deploySequenceId, DeployShell shell)
public java.lang.String toString()
toString
in class java.lang.Object