net.nemerosa.ontrack.jenkins.dsl

Interface OntrackDSLFacade

All Known Implementing Classes:

OntrackDSLV3Facade, OntrackDSLV4Facade

public interface OntrackDSLFacade

Method Summary

Modifier and Type	Method and Description
BranchFacade	branch(String project, String branch) Gets a branch
BuildFacade	build(String projectName, String branchName, String buildName) Gets a build
String	getAppVersion() Gets the version of the remote app version
Object	getDSLRoot() Gets the root object to inject as ontrack into the DSL scripts.
String	getVersion() Version of this facade
Object	graphQLQuery(String query, Map<String,?> vars) Runs an arbitrary GraphQL query
void	onClientException(Exception exception, Consumer<String> handler) Catching client exceptions
<T> T	onNotFoundException(Exception exception, Supplier<T> handler) Catching not found exceptions
ProjectFacade	project(String project) Gets a project

Method Detail

getVersion

String getVersion()

Version of this facade

Returns:

Version being supported by this facade

See Also:

OntrackConfiguration.getOntrackVersion(), OntrackConfiguration.VERSION_3, OntrackConfiguration.VERSION_4

getDSLRoot

Object getDSLRoot()

Gets the root object to inject as ontrack into the DSL scripts.

Returns:

Object to inject in the Ontrack DSL scripts

onClientException

void onClientException(Exception exception,
                       Consumer<String> handler)

Catching client exceptions

Parameters:

exception - Exception to manage

handler - Handler called with the exception message if the exception is a client exception

onNotFoundException

<T> T onNotFoundException(Exception exception,
                          Supplier<T> handler)

Catching not found exceptions

Type Parameters:

T - Type of object returned by the handler

Parameters:

exception - Exception to manage

handler - Handler called if the exception is a "not found" exception

Returns:

Value returned by the handler in case of "not found" exception

build

BuildFacade build(String projectName,
                  String branchName,
                  String buildName)

Gets a build

Parameters:

projectName - Name of the project

branchName - Name of the branch

buildName - Name of the build

Returns:

Existing build

branch

BranchFacade branch(String project,
                    String branch)

Gets a branch

Parameters:

project - Name of the project

branch - Name of the branch

Returns:

Existing branch

project

ProjectFacade project(String project)

Gets a project

Parameters:

project - Name of the project

Returns:

Existing project

graphQLQuery

Object graphQLQuery(String query,
                    Map<String,?> vars)

Runs an arbitrary GraphQL query

Parameters:

query - GraphQL query

vars - Variables for the query

Returns:

GraphQL JSON response

getAppVersion

String getAppVersion()

Gets the version of the remote app version

Returns:

Version