org.jenkinsci.plugins.docker.traceability

Class DockerEventListener

java.lang.Object

org.jenkinsci.plugins.docker.traceability.DockerEventListener

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

DockerEventsListenerImpl, DockerEventsLogger

public class DockerEventListener
extends Object
implements hudson.ExtensionPoint

An extension point, which allows to subscribe to Docker events in Jenkins.

Since:

1.0

Author:

Oleg Nenashev

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DockerEventListener()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DockerEventListener>	all() Retrieves a list of Docker event listeners.
static void	fire(DockerTraceabilityReport event) Fires DockerEvent on all listeners.
static void	fireNewDeployment(String containerId) Notifies all listeners about the container deployment.
void	onEvent(DockerTraceabilityReport event) Notifies external listener that an event in Docker happened.
void	onNewDeployment(String containerId) Being called when a container deployment has been spotted.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerEventListener

public DockerEventListener()

Method Detail

onEvent

public void onEvent(@Nonnull
           DockerTraceabilityReport event)

Notifies external listener that an event in Docker happened. The method does nothing by default

Parameters:

event - Event

onNewDeployment

public void onNewDeployment(@Nonnull
                   String containerId)

Being called when a container deployment has been spotted. Common case: registration of new DockerDeploymentFacet.

Parameters:

containerId - Container ID (full 64-char representation)

fire

public static void fire(@Nonnull
        DockerTraceabilityReport event)

Fires DockerEvent on all listeners.

Parameters:

event - Event to be triggered

fireNewDeployment

public static void fireNewDeployment(@Nonnull
                     String containerId)

Notifies all listeners about the container deployment.

Parameters:

containerId - Container ID (full 64-char representation)

all

@Nonnull
public static hudson.ExtensionList<DockerEventListener> all()

Retrieves a list of Docker event listeners.

Returns:

A list of all DockerEventListener extensions.