io.jenkins.plugins.util

Class JenkinsFacade

java.lang.Object

io.jenkins.plugins.util.JenkinsFacade

All Implemented Interfaces:

Serializable

public class JenkinsFacade
extends Object
implements Serializable

Facade to Jenkins server. Encapsulates all calls to the running Jenkins server so that tests can replace this facade with a stub.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JenkinsFacade()

Method Summary

Modifier and Type	Method and Description
String	getAbsoluteUrl(String... urlElements) Returns an absolute URL for the specified url elements: e.g., creates the sequence ${rootUrl}/element1/element2.
Set<String>	getAllJobNames() Returns the full names of all available jobs.
List<Job>	getAllJobs() Returns all available jobs.
Optional<Run<?,?>>	getBuild(String id) Gets a build by the full ID.
<T extends Describable<T>,D extends Descriptor<T>> DescriptorExtensionList<T,D>	getDescriptorsFor(Class<T> describableType) Returns the discovered instances for the given descriptor type.
<T> List<T>	getExtensionsFor(Class<T> extensionType) Returns the discovered instances for the given extension type.
String	getFullNameOf(Job<?,?> job) Returns the full name of the specified job.
String	getImagePath(BallColor color) Returns the absolute URL for the specified ball icon.
String	getImagePath(String icon) Returns the absolute URL for the specified icon.
Optional<Job<?,?>>	getJob(String name) Gets a Job by its full name.
boolean	hasPermission(Permission permission) Checks if the current security principal has this permission.
boolean	hasPermission(Permission permission, Job<?,?> project) Checks if the current security principal has this permission for the specified project.
boolean	isPluginInstalled(String pluginId) Returns whether the plugin with the specified ID (short name, artifact ID) is installed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JenkinsFacade

public JenkinsFacade()

Method Detail

getExtensionsFor

public <T> List<T> getExtensionsFor(Class<T> extensionType)

Returns the discovered instances for the given extension type.

Type Parameters:

T - type of the extension

Parameters:

extensionType - The base type that represents the extension point. Normally ExtensionPoint subtype but that's not a hard requirement.

Returns:

the discovered instances, might be an empty list

getDescriptorsFor

public <T extends Describable<T>,D extends Descriptor<T>> DescriptorExtensionList<T,D> getDescriptorsFor(Class<T> describableType)

Returns the discovered instances for the given descriptor type.

Type Parameters:

T - type of the describable

D - type of the descriptor

Parameters:

describableType - the base type that represents the descriptor of the describable

Returns:

the discovered instances, might be an empty list

hasPermission

public boolean hasPermission(Permission permission)

Checks if the current security principal has this permission.

Parameters:

permission - the permission to check for

Returns:

false if the user doesn't have the permission

hasPermission

public boolean hasPermission(Permission permission,
                             Job<?,?> project)

Checks if the current security principal has this permission for the specified project.

Parameters:

permission - the permission to check for

project - the project to check the permissions for

Returns:

false if the user doesn't have the permission

getJob

public Optional<Job<?,?>> getJob(String name)

Gets a Job by its full name. Full names are like path names, where each name of Item is combined by '/'.

Parameters:

name - the full name of the job

Returns:

the selected job, if it exists under the given full name and if it is accessible

getBuild

public Optional<Run<?,?>> getBuild(String id)

Gets a build by the full ID.

Parameters:

id - the ID of the build

Returns:

the selected build, if it exists with the given ID and if it is accessible

getImagePath

public String getImagePath(BallColor color)

Returns the absolute URL for the specified ball icon.

Parameters:

color - the color

Returns:

the absolute URL

getImagePath

public String getImagePath(String icon)

Returns the absolute URL for the specified icon.

Parameters:

icon - the icon URL

Returns:

the absolute URL

getAbsoluteUrl

public String getAbsoluteUrl(String... urlElements)

Returns an absolute URL for the specified url elements: e.g., creates the sequence ${rootUrl}/element1/element2.

Parameters:

urlElements - the url elements

Returns:

the absolute URL

getAllJobNames

public Set<String> getAllJobNames()

Returns the full names of all available jobs. The full name is given by AbstractItem.getFullName().

Returns:

the full names of all jobs

getAllJobs

public List<Job> getAllJobs()

Returns all available jobs.

Returns:

all jobs

getFullNameOf

public String getFullNameOf(Job<?,?> job)

Returns the full name of the specified job.

Parameters:

job - the job to get the name for

Returns:

the full name

isPluginInstalled

public boolean isPluginInstalled(String pluginId)

Returns whether the plugin with the specified ID (short name, artifact ID) is installed.

Parameters:

pluginId - the ID of the plugin

Returns:

true if the plugin is installed, false if not