org.jenkinsci.plugins.docker.commons

Class DockerImageExtractor

java.lang.Object

org.jenkinsci.plugins.docker.commons.DockerImageExtractor

All Implemented Interfaces:

hudson.ExtensionPoint

public abstract class DockerImageExtractor
extends Object
implements hudson.ExtensionPoint

Identifies the Docker images used by a Jenkins job. Docker-related plugins can use this extension point to integrate with for example Docker HUB web hook support.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DockerImageExtractor()

Method Summary

Modifier and Type	Method and Description
abstract Collection<String>	getDockerImagesUsedByJob(hudson.model.Job<?,?> job) Provides a collection of repository names namespace/name that the job uses as seen by the implementing class.
static Set<String>	getDockerImagesUsedByJobFromAll(hudson.model.Job<?,?> job) Provides a set of repository names namespace/name that the job uses as seen by all the declared DockerImageExtractors.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerImageExtractor

public DockerImageExtractor()

Method Detail

getDockerImagesUsedByJob

@Nonnull
public abstract Collection<String> getDockerImagesUsedByJob(@Nonnull
                                                                      hudson.model.Job<?,?> job)

Provides a collection of repository names namespace/name that the job uses as seen by the implementing class. Return an empty collection if none is found.

Parameters:

job - the job being queried.

Returns:

a collection of names, or an empty collection.

getDockerImagesUsedByJobFromAll

@Nonnull
public static Set<String> getDockerImagesUsedByJobFromAll(@Nonnull
                                                                    hudson.model.Job<?,?> job)

Provides a set of repository names namespace/name that the job uses as seen by all the declared DockerImageExtractors. Returns an empty set if none is found.

Parameters:

job - the job being queried.

Returns:

a set of names, or an empty set.