Class DockerImageExtractor
- java.lang.Object
-
- org.jenkinsci.plugins.docker.commons.DockerImageExtractor
-
- All Implemented Interfaces:
ExtensionPoint
public abstract class DockerImageExtractor extends Object implements 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
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description DockerImageExtractor()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract Collection<String>
getDockerImagesUsedByJob(Job<?,?> job)
Provides a collection of repository namesnamespace/name
that the job uses as seen by the implementing class.static Set<String>
getDockerImagesUsedByJobFromAll(Job<?,?> job)
Provides a set of repository namesnamespace/name
that the job uses as seen by all the declaredDockerImageExtractor
s.
-
-
-
Method Detail
-
getDockerImagesUsedByJob
@NonNull public abstract Collection<String> getDockerImagesUsedByJob(@NonNull Job<?,?> job)
Provides a collection of repository namesnamespace/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 Job<?,?> job)
Provides a set of repository namesnamespace/name
that the job uses as seen by all the declaredDockerImageExtractor
s. Returns an empty set if none is found.- Parameters:
job
- the job being queried.- Returns:
- a set of names, or an empty set.
-
-