com.dtolabs.rundeck.plugins.scm

Interface ScmImportPlugin

public interface ScmImportPlugin

Plugin for importing job definitions from a Source control repository

Method Summary

Modifier and Type	Method and Description
java.util.List<Action>	actionsAvailableForContext(ScmOperationContext context)
void	cleanup() perform any cleanup/teardown needed after disabling
ScmImportDiffResult	getFileDiff(JobScmReference job) Get diff for the given job
ScmImportDiffResult	getFileDiff(JobScmReference job, java.lang.String originalPath) Get diff for the given job against another path, e.g.
BasicInputView	getInputViewForAction(ScmOperationContext context, java.lang.String actionId) Provide the input view for an action.
JobImportState	getJobStatus(JobScmReference job) Return the state of the given job
JobImportState	getJobStatus(JobScmReference 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
Action	getSetupAction(ScmOperationContext context) Return any action that is needed for post-create setup.
ScmImportSynchState	getStatus(ScmOperationContext context)
java.util.List<ScmImportTrackedItem>	getTrackedItemsForAction(java.lang.String actionId) list any known items that can be tracked, such as: all files found in the selected source repository branch, can be an empty list (no items found to track) or null (item tracking is not used)
JobImportState	jobChanged(JobChangeEvent event, JobScmReference reference) Return the state of the given job
ScmExportResult	scmImport(ScmOperationContext context, java.lang.String actionId, JobImporter importer, java.util.List<java.lang.String> selectedPaths, java.util.Map<java.lang.String,java.lang.String> input) Perform import with the input

Method Detail

scmImport

ScmExportResult scmImport(ScmOperationContext context,
                          java.lang.String actionId,
                          JobImporter importer,
                          java.util.List<java.lang.String> selectedPaths,
                          java.util.Map<java.lang.String,java.lang.String> input)
                   throws ScmPluginException

Perform import with the input

Parameters:

input - result of GUI input

importer - can import files as jobs

Throws:

ScmPluginException

getStatus

ScmImportSynchState getStatus(ScmOperationContext context)
                       throws ScmPluginException

Returns:

overall status

Throws:

ScmPluginException

getJobStatus

JobImportState getJobStatus(JobScmReference job)

Return the state of the given job

Parameters:

job - job

Returns:

state

getJobStatus

JobImportState getJobStatus(JobScmReference 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

jobChanged

JobImportState jobChanged(JobChangeEvent event,
                          JobScmReference reference)

Return the state of the given job

Parameters:

event - change event

reference - job

Returns:

state

cleanup

void cleanup()

perform any cleanup/teardown needed after disabling

getInputViewForAction

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

Provide the input view for an action.

Parameters:

actionId - action ID

Returns:

input view for the specified action

getSetupAction

Action getSetupAction(ScmOperationContext context)

Return any action that is needed for post-create setup. If not null, then the user will be forwarded to this action after plugin is configured, this should always return the setup action even if setup has already been performed, as the user may disable/reconfigure the plugin.

Parameters:

context - context map

Returns:

action used for post-create setup, if necessary

actionsAvailableForContext

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

Parameters:

context - context map

Returns:

list of actions available for the context

getTrackedItemsForAction

java.util.List<ScmImportTrackedItem> getTrackedItemsForAction(java.lang.String actionId)

list any known items that can be tracked, such as: all files found in the selected source repository branch, can be an empty list (no items found to track) or null (item tracking is not used)

getRelativePathForJob

java.lang.String getRelativePathForJob(JobReference job)

Return the relative path for the job in the repo

Parameters:

job - job

Returns:

state

getFileDiff

ScmImportDiffResult getFileDiff(JobScmReference job)

Get diff for the given job

Parameters:

job - job

getFileDiff

ScmImportDiffResult getFileDiff(JobScmReference 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