org.rundeck.app.components.jobs

Interface JobFormat

public interface JobFormat

Interface to define a Job definition format

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JobFormat.Options Encode options
static class	JobFormat.StripJobRef Options for stripping Job Reference data

Method Summary

Modifier and Type	Method and Description
java.util.List<java.util.Map>	decode(java.io.Reader reader) Decode input to canonical Job Map data
static JobFormat.Options	defaultOptions()
void	encode(java.util.List<java.util.Map> list, JobFormat.Options options, java.io.Writer writer) Encode list of canonical Job Maps
java.lang.String	getFormat()
static JobFormat.Options	options(boolean preserveUuid, java.util.Map<java.lang.String,java.lang.String> replaceIds, JobFormat.StripJobRef stripJobRef) Create options object
static JobFormat.Options	options(boolean preserveUuid, java.util.Map<java.lang.String,java.lang.String> replaceIds, java.lang.String stripJobRef) Create options object

Method Detail

getFormat

java.lang.String getFormat()

Returns:

format name

decode

java.util.List<java.util.Map> decode(java.io.Reader reader)
                              throws JobDefinitionException

Decode input to canonical Job Map data

Parameters:

reader -

Returns:

List of maps

Throws:

JobDefinitionException

encode

void encode(java.util.List<java.util.Map> list,
            JobFormat.Options options,
            java.io.Writer writer)

Encode list of canonical Job Maps

Parameters:

list - list of maps

options - encode options

writer - writer

options

static JobFormat.Options options(boolean preserveUuid,
                                 java.util.Map<java.lang.String,java.lang.String> replaceIds,
                                 java.lang.String stripJobRef)

Create options object

Parameters:

preserveUuid - true to preserve UUIDs

replaceIds - replacement map for replacing UUIDs

stripJobRef - option for stripping Job Reference data

Returns:

options

options

static JobFormat.Options options(boolean preserveUuid,
                                 java.util.Map<java.lang.String,java.lang.String> replaceIds,
                                 JobFormat.StripJobRef stripJobRef)

Create options object

Parameters:

preserveUuid - true to preserve UUIDs

replaceIds - replacement map for replacing UUIDs

stripJobRef - option for stripping Job Reference data

Returns:

options

defaultOptions

static JobFormat.Options defaultOptions()

Returns:

default options