Package org.craftercms.deployer.api

Class Deployment

java.lang.Object
org.craftercms.deployer.api.Deployment
public class Deployment extends Object
Represents a deployment. Contains every important status information of a particular deployment execution.
Author:
avasquez

  • Field Details

  • Constructor Details

  • Method Details

    • getTarget

      public Target getTarget()
      Returns the Target being deployed.

    • getStart

      public ZonedDateTime getStart()
      Returns the start date of the deployment.

    • getEnd

      public ZonedDateTime getEnd()
      Returns the end date of the deployment.

    • isRunning

      public boolean isRunning()
      Returns true if the deployment is still running.

    • getDuration

      public Long getDuration()
      Returns the duration of the deployment.

    • getStatus

      public Deployment.Status getStatus()
      Returns the status of the deployment, either success or failure.

    • getMode

      public Deployment.Mode getMode()

    • getChangeSet

      public ChangeSet getChangeSet()
      Returns the change set of the deployment.

    • setChangeSet

      public void setChangeSet(ChangeSet changeSet)
      Sets the change set of the deployment.

    • isChangeSetEmpty

      public boolean isChangeSetEmpty()
      Returns true if the change set is null or empty.

    • start

      public void start()
      Starts the deployment.

    • end

      public void end(Deployment.Status status)
      Ends the deployment with the specified status.

    • getProcessorExecutions

      public List<ProcessorExecution> getProcessorExecutions()
      Returns the list of ProcessorExecutions.

    • addProcessorExecution

      public void addProcessorExecution(ProcessorExecution status)
      Adds a ProcessorExecution to the list.

    • addParam

      public void addParam(String name, Object value)
      Adds a param that can be used by processors during the deployment.
      Parameters:
      name - the name of the param
      value - the value of the param

    • getParam

      public Object getParam(String name)
      Returns a param that can be used by processors during the deployment.
      Parameters:
      name - the name of the param
      Returns:
      the value of the param

    • removeParam

      public void removeParam(String name)
      Removes the specified param
      Parameters:
      name - the name of the param

    • toString

      public String toString()
      Overrides:
      toString in class Object