net.nemerosa.ontrack.jenkins.dsl.v3

Class OntrackDSLV3Facade

java.lang.Object

net.nemerosa.ontrack.jenkins.dsl.v3.OntrackDSLV3Facade

All Implemented Interfaces:

OntrackDSLFacade

public class OntrackDSLV3Facade
extends Object
implements OntrackDSLFacade

Constructor Summary

Constructors

Constructor and Description
OntrackDSLV3Facade(OntrackConfiguration config, OntrackDSLLogger logger)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OntrackDSLV3Facade

public OntrackDSLV3Facade(OntrackConfiguration config,
                          OntrackDSLLogger logger)

Method Detail

getVersion

public String getVersion()

Description copied from interface: OntrackDSLFacade

Version of this facade

Specified by:

getVersion in interface OntrackDSLFacade

Returns:

Version being supported by this facade

See Also:

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

getAppVersion

public String getAppVersion()

Description copied from interface: OntrackDSLFacade

Gets the version of the remote app version

Specified by:

getAppVersion in interface OntrackDSLFacade

Returns:

Version

getDSLRoot

public Object getDSLRoot()

Description copied from interface: OntrackDSLFacade

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

Specified by:

getDSLRoot in interface OntrackDSLFacade

Returns:

Object to inject in the Ontrack DSL scripts

onClientException

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

Description copied from interface: OntrackDSLFacade

Catching client exceptions

Specified by:

onClientException in interface OntrackDSLFacade

Parameters:

exception - Exception to manage

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

onNotFoundException

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

Description copied from interface: OntrackDSLFacade

Catching not found exceptions

Specified by:

onNotFoundException in interface OntrackDSLFacade

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

graphQLQuery

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

Description copied from interface: OntrackDSLFacade

Runs an arbitrary GraphQL query

Specified by:

graphQLQuery in interface OntrackDSLFacade

Parameters:

query - GraphQL query

vars - Variables for the query

Returns:

GraphQL JSON response

project

public ProjectFacade project(String project)

Description copied from interface: OntrackDSLFacade

Gets a project

Specified by:

project in interface OntrackDSLFacade

Parameters:

project - Name of the project

Returns:

Existing project

branch

public BranchFacade branch(String project,
                           String branch)

Description copied from interface: OntrackDSLFacade

Gets a branch

Specified by:

branch in interface OntrackDSLFacade

Parameters:

project - Name of the project

branch - Name of the branch

Returns:

Existing branch

build

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

Description copied from interface: OntrackDSLFacade

Gets a build

Specified by:

build in interface OntrackDSLFacade

Parameters:

projectName - Name of the project

branchName - Name of the branch

buildName - Name of the build

Returns:

Existing build