com.dtolabs.rundeck.plugins.scm

Interface ScmExportPlugin

public interface ScmExportPlugin

Export plugin

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Action>	actionsAvailableForContext(ScmOperationContext context)
void	cleanup() perform any cleanup/teardown needed after disabling
ScmExportResult	export(ScmOperationContext context, java.lang.String actionId, java.util.Set<JobExportReference> jobs, java.util.Set<java.lang.String> pathsToDelete, java.util.Map<java.lang.String,java.lang.String> input) Perform export of the jobs
java.util.List<java.lang.String>	getDeletedFiles() Return a list of tracked files that have been deleted.
ScmDiffResult	getFileDiff(JobExportReference job) Get diff for the given job
ScmDiffResult	getFileDiff(JobExportReference job, java.lang.String originalPath) Get diff for the given job against another path, e.g.
BasicInputView	getInputViewForAction(ScmOperationContext context, java.lang.String actionId)
JobState	getJobStatus(JobExportReference job) Return the state of the given job
JobState	getJobStatus(JobExportReference job, java.lang.String originalPath) Return the state of the given job, with optional original repo path
java.lang.String	getRelativePathForJob(JobReference job) Return the relative path for the job in the repo
ScmExportSynchState	getStatus(ScmOperationContext context)
JobState	jobChanged(JobChangeEvent event, JobExportReference exportReference) Return the state of the given job

Method Detail

cleanup

void cleanup()

perform any cleanup/teardown needed after disabling

getInputViewForAction

BasicInputView getInputViewForAction(ScmOperationContext context,
                                   java.lang.String actionId)

Parameters:

actionId - action ID

Returns:

input view for the specified action

actionsAvailableForContext

java.util.List<Action> actionsAvailableForContext(ScmOperationContext context)

Parameters:

context - context map

Returns:

list of actions available for the context

export

ScmExportResult export(ScmOperationContext context,
                     java.lang.String actionId,
                     java.util.Set<JobExportReference> jobs,
                     java.util.Set<java.lang.String> pathsToDelete,
                     java.util.Map<java.lang.String,java.lang.String> input)
                       throws ScmPluginException

Perform export of the jobs

Parameters:

jobs - jobs to be exported

input - input for the action properties

Returns:

result of export

Throws:

ScmPluginException

getStatus

ScmExportSynchState getStatus(ScmOperationContext context)
                              throws ScmPluginException

Returns:

overall status

Throws:

ScmPluginException

getJobStatus

JobState getJobStatus(JobExportReference job)

Return the state of the given job

Parameters:

job - job

Returns:

state

getJobStatus

JobState getJobStatus(JobExportReference job,
                    java.lang.String originalPath)

Return the state of the given job, with optional original repo path

Parameters:

job - job

originalPath - path of original job, e.g. if the file was renamed

Returns:

state

getDeletedFiles

java.util.List<java.lang.String> getDeletedFiles()

Return a list of tracked files that have been deleted.

jobChanged

JobState jobChanged(JobChangeEvent event,
                  JobExportReference exportReference)

Return the state of the given job

Parameters:

event - change event

exportReference - serialize the job

Returns:

state

getRelativePathForJob

java.lang.String getRelativePathForJob(JobReference job)

Return the relative path for the job in the repo

Parameters:

job - job

Returns:

state

getFileDiff

ScmDiffResult getFileDiff(JobExportReference job)

Get diff for the given job

Parameters:

job - job

getFileDiff

ScmDiffResult getFileDiff(JobExportReference job,
                        java.lang.String originalPath)

Get diff for the given job against another path, e.g. the original path before a rename

Parameters:

job - job

originalPath - original path