Package se.conciliate.extensions.publish.custom

Interface CustomPublishConfig

public interface CustomPublishConfig
A configuration for a custom publish.

  • Method Details

    • getTitle

      String getTitle()
      Returns a title for the publish. This could be used when representing the publish in the UI.
      Returns:
      A title for the publish.

    • setTitle

      void setTitle(String title)
      Sets the title of the publish.
      Parameters:
      title - The new title.

    • getDescription

      String getDescription()
      Returns a description for the publish. This could be used when representing the publish in the UI.
      Returns:
      A description for the publish.

    • setDescription

      void setDescription(String description)
      Sets the description of the publish.
      Parameters:
      description - The new description.

    • setZipFileContent

      void setZipFileContent(byte[] contents)
      Sets any content needed when running the publish. This content should be in ZIP format and will be unpacked to the output directory when running the publish.
      Parameters:
      contents - Any content needed in the output directory when publishing, in ZIP format.

    • unpack

      void unpack(File dir) throws IOException
      Unpacks the content of the configuration to a directory. If no content has been set with setZipFileContent then nothing will happen.
      Parameters:
      dir - The file dir.
      Throws:
      IOException - If an error occurs.

    • setSettings

      void setSettings(ConfigSettings settings)
      Sets the settings used for the publish. Use CustomPublishConfigFactory to create the settings.
      Parameters:
      settings - The new settings.

    • getSettings

      ConfigSettings getSettings()
      Returns the settings for the publish.
      Returns:
      The publish settings.

    • addStep

      void addStep(ConfigStep step)
      Adds a step to the publish configuration. Use CustomPublishConfigFactory to create any of the available steps.
      Parameters:
      step - The step to add.

    • getSteps

      List<ConfigStep> getSteps()
      Returns the current steps added to the configuration.
      Returns:
      The current publish steps in the configuration.