Package se.conciliate.extensions.publish.custom.step

Interface ConfigStepIndex

All Superinterfaces:
ConfigStep
public interface ConfigStepIndex extends ConfigStep
Creates an XML file containing an index of all files in a directory. The paths will be relative to the location of the target XML file if possible, otherwise absolute paths will be stored. type: post-step Example XML: 

  <index>
      <source-dir>copied-documents</source-dir>
      <target-file>pdf-documents.xml</target-file>
      <file-ending>pdf</file-ending>
  </index>

  • Method Details

    • getSourceDir

      String getSourceDir()
      The source directory to scan for files. Can be absolute or relative to the output directory. XML tag: "source-dir"
      Returns:
      The source directory to scan for files.

    • setSourceDir

      void setSourceDir(String dir)

    • getTargetFile

      String getTargetFile()
      The target file to store the index in. Can be absolute or relative to the output directory. XML tag: "target-file"
      Returns:
      The target file to store the index in.

    • setTargetFile

      void setTargetFile(String file)

    • getFileEnding

      String getFileEnding()
      The file ending of the files from the source directory to add to the index. Defaults to ".xml" if no value is provided. XML tag: "file-ending"
      Returns:
      The file ending of the files from the source directory to add to the index.

    • setFileEnding

      void setFileEnding(String fileEnding)