org.jenkinsci.plugins.docker.traceability.core

Class DockerTraceabilityHelper

java.lang.Object

org.jenkinsci.plugins.docker.traceability.core.DockerTraceabilityHelper

public class DockerTraceabilityHelper
extends Object

Provides extra methods, which simplify common traceability use-cases.

Author:

Oleg Nenashev

Constructor Summary

Constructors

Constructor and Description
DockerTraceabilityHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static String	formatDate(Date date) Formats the time to the Docker-standard format.
static String	formatTime(long time) Formats the time to the Docker-standard format.
static String	getContainerHash(String containerId)
static String	getImageHash(String imageId)
static DockerContainerRecord	getLastContainerRecord(String containerId) Retrieves the last deployment record for the specified container.
static com.github.dockerjava.api.command.InspectImageResponse	getLastInspectImageResponse(String imageId) Retrieves the last InspectImageResponse for the specified image.
static DockerTraceabilityReport	getLastReport(String containerId) Retrieves the last trace report for the specified container.
static DockerEventsAction	getTraceabilityAction() Gets the DockerEventsAction of Jenkins instance.
static hudson.model.Fingerprint	make(String containerId) Get or create a fingerprint by the specified container ID.
static hudson.model.Fingerprint	of(String containerId) Get a fingerprint by the specified container ID.
static hudson.model.Fingerprint	ofValidated(String containerId) Get a fingerprint by the specified container ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerTraceabilityHelper

public DockerTraceabilityHelper()

Method Detail

getImageHash

@Nonnull
public static String getImageHash(@Nonnull
                          String imageId)

getContainerHash

@Nonnull
public static String getContainerHash(@Nonnull
                              String containerId)

ofValidated

@CheckForNull
public static hudson.model.Fingerprint ofValidated(@Nonnull
                                                String containerId)
                                            throws IOException

Get a fingerprint by the specified container ID. This method allows to handle exception in the logic. Use of(java.lang.String) to get a default behavior.

Parameters:

containerId - Full 64-symbol container id. Short forms are not supported.

Returns:

Fingerprint. null if it does not exist (or if Jenkins has not been initialized yet)

Throws:

IOException - Fingerprint loading error

of

@CheckForNull
public static hudson.model.Fingerprint of(@Nonnull
                                       String containerId)

Get a fingerprint by the specified container ID. Logs and ignores IOExceptions on fingerprint loading.

Parameters:

containerId - Full 64-symbol container id. Short forms are not supported.

Returns:

Fingerprint. null if it is not available or if a loading error happens

make

@CheckForNull
public static hudson.model.Fingerprint make(@Nonnull
                                         String containerId)
                                     throws IOException

Get or create a fingerprint by the specified container ID.

Parameters:

containerId - Full 64-symbol container id. Short forms are not supported.

Returns:

Fingerprint. null if Jenkins has not been initialized yet

Throws:

IOException - Fingerprint loading error

getLastContainerRecord

@CheckForNull
public static DockerContainerRecord getLastContainerRecord(@Nonnull
                                                        String containerId)

Retrieves the last deployment record for the specified container.

Parameters:

containerId - Container Id

Returns:

Last registered record. Null if there is no data available (or if an internal exception happens)

getLastReport

@CheckForNull
public static DockerTraceabilityReport getLastReport(@Nonnull
                                                  String containerId)

Retrieves the last trace report for the specified container.

Parameters:

containerId - Container Id

Returns:

Last available report. Null if there is no data available (or if an internal exception happens)

getLastInspectImageResponse

@CheckForNull
public static com.github.dockerjava.api.command.InspectImageResponse getLastInspectImageResponse(@Nonnull
                                                                                              String imageId)

Retrieves the last InspectImageResponse for the specified image.

Parameters:

imageId - Image Id

Returns:

Last available report. Null if there is no data available (or if an internal exception happens)

getTraceabilityAction

@CheckForNull
public static DockerEventsAction getTraceabilityAction()

Gets the DockerEventsAction of Jenkins instance.

Returns:

Instance or null if it is not available

formatTime

@Nonnull
public static String formatTime(long time)

Formats the time to the Docker-standard format.

Parameters:

time - Time to be converted

Returns:

String in the following format: yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS'Z' Up to nanoseconds, but actually the last 6 digits are null in the current implementation.

formatDate

@Nonnull
public static String formatDate(Date date)

Formats the time to the Docker-standard format.

Parameters:

date - Date to be converted

Returns:

String in the following format: yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS'Z' Up to nanoseconds, but actually the last 6 digits are null in the current implementation.