se.diabol.jenkins.core

Interface PipelineView

All Known Implementing Classes:

DeliveryPipelineView, ReadOnlyDeliveryPipelineView, WorkflowPipelineView

public interface PipelineView

Interface defining common methods for delivery pipeline views. Note that Jenkins does NOT support the following:

• Java 8 interface default methods
• @Exported annotations on interface methods - these needs to be set on the method in the implementing class

Method Summary

Modifier and Type	Method and Description
void	abortBuild(String projectName, String buildId)
String	getError() Exposes any error that is currently associated with the pipeline view.
String	getLastUpdated() A date time string representing when the pipeline view was last updated.
List<? extends GenericComponent>	getPipelines() Resolve the pipelines associated with this view.
boolean	isAllowAbort() Whether to allow running pipelines to be aborted from the pipeline view.
boolean	isAllowPipelineStart() Whether to allow a new pipeline to be started from the pipeline view.
void	triggerManual(String projectName, String upstreamName, String buildId)
void	triggerRebuild(String projectName, String buildId)

Method Detail

triggerManual

void triggerManual(String projectName,
                   String upstreamName,
                   String buildId)
            throws TriggerException,
                   org.acegisecurity.AuthenticationException

Throws:

TriggerException

org.acegisecurity.AuthenticationException

triggerRebuild

void triggerRebuild(String projectName,
                    String buildId)

abortBuild

void abortBuild(String projectName,
                String buildId)
         throws TriggerException,
                org.acegisecurity.AuthenticationException

Throws:

TriggerException

org.acegisecurity.AuthenticationException

isAllowPipelineStart

boolean isAllowPipelineStart()

Whether to allow a new pipeline to be started from the pipeline view. Expected to be annotated with @Exported for consumption from the view page.

Returns:

whether to allow a new pipeline to be started from the pipeline view.

isAllowAbort

boolean isAllowAbort()

Whether to allow running pipelines to be aborted from the pipeline view. Expected to be annotated with @Exported for consumption from the view page.

Returns:

whether to allow pipelines to be aborted from the pipeline view.

getLastUpdated

String getLastUpdated()

A date time string representing when the pipeline view was last updated. Expected to be annotated with @Exported for consumption from the view page.

Returns:

a string representation on when the pipeline view was last updated.

getError

String getError()

Exposes any error that is currently associated with the pipeline view.

Returns:

the error currently associated with this pipeline view.

getPipelines

List<? extends GenericComponent> getPipelines()

Resolve the pipelines associated with this view. Expected to be annotated with @Exported for consumption from the view page.

Returns:

a list of components associated with this pipeline view.