org.jenkinsci.plugins.docker.traceability.fingerprint

Class DockerDeploymentFacet

java.lang.Object

jenkins.model.FingerprintFacet

org.jenkinsci.plugins.docker.commons.fingerprint.DockerFingerprintFacet

org.jenkinsci.plugins.docker.traceability.fingerprint.DockerDeploymentFacet

All Implemented Interfaces:

hudson.ExtensionPoint

public class DockerDeploymentFacet
extends org.jenkinsci.plugins.docker.commons.fingerprint.DockerFingerprintFacet

Implements a facet for DockerContainerRecords. It's supposed to be used within a container fingerprint, which stores the info about events. This facet should be added to container Fingerprints.

Author:

Oleg Nenashev

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DockerDeploymentFacet(hudson.model.Fingerprint fingerprint, long timestamp)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(DockerContainerRecord r)
static DockerDeploymentFacet	addEvent(hudson.model.Fingerprint fingerprint, org.jenkinsci.plugins.docker.traceability.api.DockerTraceabilityReport event)
static DockerDeploymentFacet	getDeploymentFacet(String containerId) Retrieves a deployment facet for the specified container.
SortedSet<DockerContainerRecord>	getDeploymentRecords()
String	getImageId() Get Image ID, for which the container has been created.
String	getLastStatus() Retrieves the last known status.
DockerContainerRecord	getLatest()
static DockerDeploymentFacet	getOrCreate(hudson.model.Fingerprint fingerprint)

Methods inherited from class jenkins.model.FingerprintFacet

_setOwner, createActions, getFingerprint, getTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerDeploymentFacet

public DockerDeploymentFacet(hudson.model.Fingerprint fingerprint,
                     long timestamp)

Method Detail

add

public void add(DockerContainerRecord r)
         throws IOException

Throws:

IOException

getDeploymentRecords

@Nonnull
public SortedSet<DockerContainerRecord> getDeploymentRecords()

getLatest

@CheckForNull
public DockerContainerRecord getLatest()

getImageId

@CheckForNull
public String getImageId()

Get Image ID, for which the container has been created. This method is required, because the imageId may be missing in particular records. A common case - DIE event for a container with the deleted image.

Returns:

Commonly a non-null value, but may be null in corner-cases

getLastStatus

@Nonnull
public String getLastStatus()

Retrieves the last known status.

Returns:

Status string

getDeploymentFacet

@CheckForNull
public static DockerDeploymentFacet getDeploymentFacet(String containerId)

Retrieves a deployment facet for the specified container.

Parameters:

containerId - Container ID (64-char)

Returns:

Facet. Null if it is not available

getOrCreate

@Nonnull
public static DockerDeploymentFacet getOrCreate(@Nonnull
                                        hudson.model.Fingerprint fingerprint)
                                         throws IOException

Throws:

IOException

addEvent

public static DockerDeploymentFacet addEvent(@Nonnull
                             hudson.model.Fingerprint fingerprint,
                             @Nonnull
                             org.jenkinsci.plugins.docker.traceability.api.DockerTraceabilityReport event)
                                      throws IOException

Throws:

IOException