Package org.craftercms.deployer.api

Interface Target

All Known Implementing Classes:
TargetImpl
public interface Target
Represents a deployment target.
Author:
avasquez

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Target.Status
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUTHORING_ENV
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanRepo()
    Performs a cleanup of the local repository.
    void
    close()
    Closes the target, releases any open resources and stops any running threads associated to the target.
    void
    delete()
    Deletes the target, executing any delete hooks.
    Deployment
    deploy(boolean waitTillDone, Map<String,Object> params)
    Starts a new deployment for the target (asynchronous operation if waitTillDone is false).
    Collection<Deployment>
    getAllDeployments()
    Returns all deployments (pending and current).
    org.springframework.context.ConfigurableApplicationContext
    getApplicationContext()
    Returns this target's Spring application context
    org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode>
    getConfiguration()
    Returns the configuration of the target.
    File
    getConfigurationFile()
    Returns the YAML configuration file of the target.
    Deployment
    getCurrentDeployment()
    Returns the current deployment.
    String
    getEnv()
    Returns the environment of the target.
    String
    getId()
    Returns the ID of the target.
    ZonedDateTime
    getLoadDate()
    Returns the load date of the target.
    Collection<Deployment>
    getPendingDeployments()
    Returns the pending deployments.
    String
    getSiteName()
    Returns the site name of the target.
    Target.Status
    getStatus()
    Returns the status of the target
    void
    init()
    Starts the initialization of the target (asynchronous operation).
    void
    unlock()
    Deletes the git lock file is present in the local repository.

  • Field Details

  • Method Details

    • getId

      String getId()
      Returns the ID of the target.

    • getEnv

      String getEnv()
      Returns the environment of the target.

    • getSiteName

      String getSiteName()
      Returns the site name of the target.

    • getLoadDate

      ZonedDateTime getLoadDate()
      Returns the load date of the target.

    • getStatus

      Target.Status getStatus()
      Returns the status of the target

    • getConfigurationFile

      File getConfigurationFile()
      Returns the YAML configuration file of the target.

    • getConfiguration

      org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> getConfiguration()
      Returns the configuration of the target.

    • getApplicationContext

      org.springframework.context.ConfigurableApplicationContext getApplicationContext()
      Returns this target's Spring application context

    • init

      void init()
      Starts the initialization of the target (asynchronous operation). Called when the create target API is called or the target config is loaded.

    • deploy

      Deployment deploy(boolean waitTillDone, Map<String,Object> params) throws TargetNotReadyException
      Starts a new deployment for the target (asynchronous operation if waitTillDone is false).
      Parameters:
      waitTillDone - if the method should wait till the deployment is done or return immediately
      params - miscellaneous parameters that can be used by the processors.
      Returns:
      the deployment info
      Throws:
      TargetNotReadyException - if the target is not in Target.Status.INIT_COMPLETED

    • getPendingDeployments

      Collection<Deployment> getPendingDeployments()
      Returns the pending deployments.

    • getCurrentDeployment

      Deployment getCurrentDeployment()
      Returns the current deployment.

    • getAllDeployments

      Collection<Deployment> getAllDeployments()
      Returns all deployments (pending and current).

    • cleanRepo

      void cleanRepo()
      Performs a cleanup of the local repository.

    • close

      void close()
      Closes the target, releases any open resources and stops any running threads associated to the target.

    • delete

      void delete()
      Deletes the target, executing any delete hooks. Calls close() too.

    • unlock

      void unlock()
      Deletes the git lock file is present in the local repository.