org.jenkinsci.plugins.docker.traceability.model

Class DockerTraceabilityReportListener

java.lang.Object

org.jenkinsci.plugins.docker.traceability.model.DockerTraceabilityReportListener

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

DockerTraceabilityReportListenerImpl, DockerTraceabilityReportLogger

public class DockerTraceabilityReportListener
extends Object
implements hudson.ExtensionPoint

An extension point, which allows to subscribe to DockerTraceabilityReports 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
DockerTraceabilityReportListener()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DockerTraceabilityReportListener>	all() Retrieves a list of Docker event listeners.
static void	fire(DockerTraceabilityReport report) Process DockerTraceabilityReport on all listeners.
static void	fireNewDeployment(String containerId) Notifies all listeners about the container deployment.
void	onNewDeployment(String containerId) Being called when a container deployment has been spotted.
void	onReport(DockerTraceabilityReport report) Notifies external listeners that a new Docker report has been received.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerTraceabilityReportListener

public DockerTraceabilityReportListener()

Method Detail

onReport

public void onReport(@Nonnull
            DockerTraceabilityReport report)

Notifies external listeners that a new Docker report has been received. The method does nothing by default

Parameters:

report - 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 report)

Process DockerTraceabilityReport on all listeners.

Parameters:

report - 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<DockerTraceabilityReportListener> all()

Retrieves a list of Docker event listeners.

Returns:

A list of all DockerTraceabilityReportListener extensions.