atg.deployment.common.event
Interface DeploymentEventListener

All Superinterfaces:
java.util.EventListener
All Known Implementing Classes:
DeploymentEmailer

public interface DeploymentEventListener
extends java.util.EventListener

A simple interface defining a listener of DeploymentEvents. A component wishing to know of deployment state changes should implement this interface and register itself with the local deployment server or deployment agent.

A registered listener will receive all deployment events fired by the event sender. Listeners should look at the deployment event's state to see if they are interested in the specific deployment event.

For example, a listener on the deployment server that only wants to know when deployments complete should have a deploymentEvent() method that looks something like:

   public void deploymentEvent (DeploymentEvent pEvent)
   {
     if (pEvent.getNewState() == pEvent.DEPLOYMENT_COMPLETE)
       {
         Sytem.out.println("Yippee! Deployment "+pEvent.getDeploymentID()+" is over!");
       }
   }
 
Listeners can interrupt the deployment upon receiving an event by calling interrupt() on the event.

See Also:
DeploymentEvent, DeploymentEventSender

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Method Summary
 void deploymentEvent(DeploymentEvent pEvent)
          Method called on a deployment event.
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values
Method Detail

deploymentEvent

void deploymentEvent(DeploymentEvent pEvent)
Method called on a deployment event.