Package org.rundeck.app.components.jobs
Interface JobDefinitionManager<J>
-
public interface JobDefinitionManager<J>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<ImportedJob<J>>
decodeFormat(java.lang.String format, java.io.File file)
Decode job defintion from a filejava.util.List<ImportedJob<J>>
decodeFormat(java.lang.String format, java.io.InputStream inputStream)
Decode job defintion from a streamjava.util.List<ImportedJob<J>>
decodeFormat(java.lang.String format, java.io.Reader reader)
Decode Job format into a list of Jobsjava.util.List<ImportedJob<J>>
decodeFormat(java.lang.String format, java.lang.String content)
Decode job defintion from a stringjava.util.List<ImportedJob<J>>
decodeXml(java.io.File file)
Decode Job XML from a file into a list of Jobsjava.util.List<ImportedJob<J>>
decodeXml(java.io.Reader reader)
Decode Job XML into a list of Jobsjava.util.List<ImportedJob<J>>
decodeYaml(java.io.File file)
Decode YAML job defintion from a filejava.util.List<ImportedJob<J>>
decodeYaml(java.io.Reader reader)
Decode YAML from a readerjava.lang.String
exportAs(java.lang.String format, java.util.List<J> list)
Serialize job list as yamlvoid
exportAs(java.lang.String format, java.util.List<J> list, java.io.Writer writer)
Serialize job list as formatvoid
exportAs(java.lang.String format, java.util.List<J> list, JobFormat.Options options, java.io.Writer writer)
Serialize job list as formatjava.lang.String
exportAsXml(java.util.List<J> list)
Serialize job list as xmljava.lang.String
exportAsYaml(java.util.List<J> list)
Serialize job list as yamljava.lang.String
exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list)
Serialize imported list as formatvoid
exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list, java.io.Writer writer)
Serialize imported list as formatvoid
exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list, JobFormat.Options options, java.io.Writer writer)
Serialize imported list as formatjava.util.Map
jobMapToXMap(java.util.Map map, boolean preserveUuid, java.lang.String replaceId, java.lang.String stripJobRef)
Validator.ReportSet
validateImportedJob(ImportedJob<J> importedJob)
Validate imported component associations
-
-
-
Method Detail
-
decodeFormat
java.util.List<ImportedJob<J>> decodeFormat(java.lang.String format, java.io.Reader reader) throws JobDefinitionException
Decode Job format into a list of Jobs- Parameters:
reader
- input XML- Returns:
- List of jobs
- Throws:
JobDefinitionException
- if a decode error occurs
-
decodeFormat
java.util.List<ImportedJob<J>> decodeFormat(java.lang.String format, java.lang.String content) throws JobDefinitionException
Decode job defintion from a string- Parameters:
format
- job formatcontent
- formatted content- Returns:
- list of jobs
- Throws:
JobDefinitionException
-
decodeFormat
java.util.List<ImportedJob<J>> decodeFormat(java.lang.String format, java.io.InputStream inputStream) throws JobDefinitionException
Decode job defintion from a stream- Parameters:
format
- job formatinputStream
- input- Returns:
- list of jobs
- Throws:
JobDefinitionException
-
decodeFormat
java.util.List<ImportedJob<J>> decodeFormat(java.lang.String format, java.io.File file) throws JobDefinitionException
Decode job defintion from a file- Parameters:
format
- job formatfile
- yaml content file- Returns:
- list of jobs
- Throws:
JobDefinitionException
-
decodeYaml
java.util.List<ImportedJob<J>> decodeYaml(java.io.Reader reader) throws JobDefinitionException
Decode YAML from a reader- Parameters:
reader
-- Returns:
- list of jobs
- Throws:
JobDefinitionException
-
decodeYaml
java.util.List<ImportedJob<J>> decodeYaml(java.io.File file) throws JobDefinitionException
Decode YAML job defintion from a file- Parameters:
file
- yaml content file- Returns:
- list of jobs
- Throws:
JobDefinitionException
-
decodeXml
java.util.List<ImportedJob<J>> decodeXml(java.io.Reader reader) throws JobDefinitionException
Decode Job XML into a list of Jobs- Parameters:
reader
- input XML- Returns:
- List of jobs
- Throws:
JobDefinitionException
- if a decode error occurs
-
decodeXml
java.util.List<ImportedJob<J>> decodeXml(java.io.File file) throws JobDefinitionException
Decode Job XML from a file into a list of Jobs- Parameters:
file
- file containing XML- Returns:
- List of jobs
- Throws:
JobDefinitionException
- if a decode error occurs
-
exportImportedAs
void exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list, JobFormat.Options options, java.io.Writer writer)
Serialize imported list as format- Parameters:
format
- formatoptions
- optionslist
- job list
-
exportImportedAs
void exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list, java.io.Writer writer)
Serialize imported list as format- Parameters:
format
- formatlist
- job list
-
exportAs
void exportAs(java.lang.String format, java.util.List<J> list, JobFormat.Options options, java.io.Writer writer)
Serialize job list as format- Parameters:
format
- formatlist
- job list
-
exportImportedAs
java.lang.String exportImportedAs(java.lang.String format, java.util.List<ImportedJob<J>> list)
Serialize imported list as format- Parameters:
format
- formatlist
- job list
-
exportAs
void exportAs(java.lang.String format, java.util.List<J> list, java.io.Writer writer)
Serialize job list as format- Parameters:
format
- formatlist
- job list
-
exportAs
java.lang.String exportAs(java.lang.String format, java.util.List<J> list)
Serialize job list as yaml- Parameters:
format
- formatlist
- job list
-
exportAsYaml
java.lang.String exportAsYaml(java.util.List<J> list)
Serialize job list as yaml- Parameters:
list
- job list
-
exportAsXml
java.lang.String exportAsXml(java.util.List<J> list)
Serialize job list as xml- Parameters:
list
- job list
-
jobMapToXMap
java.util.Map jobMapToXMap(java.util.Map map, boolean preserveUuid, java.lang.String replaceId, java.lang.String stripJobRef)
-
validateImportedJob
Validator.ReportSet validateImportedJob(ImportedJob<J> importedJob)
Validate imported component associations- Parameters:
importedJob
- imported job wrapper- Returns:
- validation report
-
-