ArtifactDeploymentTemplate.java

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.module.deployment.internal;

import org.mule.runtime.module.artifact.Artifact;

/**
 * Utility to hook callbacks just before and after an artifact is redeployed in Mule.
 */
public interface ArtifactDeploymentTemplate {

  /**
   * No-op implementation of {@link ArtifactDeploymentTemplate}.
   */
  public final ArtifactDeploymentTemplate NOP_ARTIFACT_DEPLOYMENT_TEMPLATE = new ArtifactDeploymentTemplate() {

    @Override
    public void preRedeploy(Artifact artifact) {
      // Nothing to do
    }

    @Override
    public void postRedeploy(Artifact artifact) {
      // Nothing to do
    }
  };

  /**
   * Callback to be invoked just before redeploying an artifact.
   * 
   * @param artifact the artifact that is about to be redeployed.
   */
  void preRedeploy(Artifact artifact);

  /**
   * Callback to be invoked just after redeploying an artifact.
   * 
   * @param artifact the artifact that was just redeployed.
   */
  void postRedeploy(Artifact artifact);

}