org.jenkinsci.plugins.docker.traceability.core

Class DockerTraceabilityRootAction

java.lang.Object

org.jenkinsci.plugins.docker.traceability.core.DockerTraceabilityRootAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, hudson.model.Saveable, hudson.search.SearchableModelObject, hudson.search.SearchItem

@Extension
@ExportedBean
public class DockerTraceabilityRootAction
extends Object
implements hudson.model.RootAction, hudson.search.SearchableModelObject, hudson.model.Saveable

Provides a button, which allows to trace fingerprints.

Author:

Oleg Nenashev

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DockerTraceabilityRootAction()

Method Summary

Methods

Modifier and Type	Method and Description
void	addContainerID(String containerID) Adds new container ID to the registry.
void	doContainer(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String id) Gets a container Fingerprint page.
org.kohsuke.stapler.HttpResponse	doDeleteContainer(String id) Removes the container reference from the registry.
void	doImage(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, String id) Gets an image Fingerprint page.
org.kohsuke.stapler.HttpResponse	doQueryContainer(String id, String mode, long since, long until) Queries container statuses via API.
org.kohsuke.stapler.HttpResponse	doRawContainerInfo(String id) Retrieves the latest container status via API.
org.kohsuke.stapler.HttpResponse	doRawImageInfo(String id) Retrieves the latest raw status via API.
org.kohsuke.stapler.HttpResponse	doSubmitContainerStatus(String inspectData, String hostId, String hostName, String status, long time, String environment, String imageName) Submits a new event through Jenkins API.
org.kohsuke.stapler.HttpResponse	doSubmitReport(String json) Submits a new DockerTraceabilityReport via API.
hudson.model.Api	getApi()
Set<String>	getContainerIDs() Get a list of all Docker container IDs.
List<DockerContainerRecord>	getContainerRecords() Gets a last container record for every registered container.
DockerDeploymentFacet	getDeploymentFacet(String containerId)
String	getDisplayName()
hudson.model.Fingerprint	getFingerprint(String containerId)
String	getIconFileName()
static DockerTraceabilityRootAction	getInstance() Gets the DockerTraceabilityRootAction of Jenkins instance.
DockerContainerRecord	getLastDeploymentRecord(String containerId)
hudson.security.Permission	getRequiredPermission()
hudson.search.Search	getSearch()
hudson.search.SearchIndex	getSearchIndex()
String	getSearchName()
String	getSearchUrl()
String	getUrlName()
List<DockerAPIReport>	records()
void	removeContainerID(String containerID) Removes the container ID from the registry.
void	save()

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerTraceabilityRootAction

public DockerTraceabilityRootAction()

Method Detail

getApi

public hudson.model.Api getApi()

getContainerIDs

@Nonnull
public Set<String> getContainerIDs()

Get a list of all Docker container IDs.

Returns:

Docker container IDs.

records

@Exported
@Nonnull
public List<DockerAPIReport> records()

addContainerID

@Nonnull
public void addContainerID(@Nonnull
                          String containerID)
                    throws IOException

Adds new container ID to the registry. If the value already exists, it will be ignored.

Parameters:

containerID - Container ID.

Throws:

IOException - Cannot save the list to the disk

removeContainerID

@Nonnull
public void removeContainerID(@Nonnull
                             String containerID)
                       throws IOException

Removes the container ID from the registry.

Parameters:

containerID - Container ID.

Throws:

IOException - Cannot save the list to the disk

getFingerprint

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
@CheckForNull
public hudson.model.Fingerprint getFingerprint(@Nonnull
                                                                                                                 String containerId)

getDeploymentFacet

@CheckForNull
public DockerDeploymentFacet getDeploymentFacet(@Nonnull
                                                    String containerId)

getLastDeploymentRecord

@CheckForNull
public DockerContainerRecord getLastDeploymentRecord(@Nonnull
                                                         String containerId)

getContainerRecords

@Nonnull
public List<DockerContainerRecord> getContainerRecords()

Gets a last container record for every registered container.

Returns:

List of container records for all entries.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

doSubmitContainerStatus

public org.kohsuke.stapler.HttpResponse doSubmitContainerStatus(@QueryParameter(required=true)
                                                       String inspectData,
                                                       @QueryParameter(required=false)
                                                       String hostId,
                                                       @QueryParameter(required=false)
                                                       String hostName,
                                                       @QueryParameter(required=false)
                                                       String status,
                                                       @QueryParameter(required=false)
                                                       long time,
                                                       @QueryParameter(required=false)@CheckForNull
                                                       String environment,
                                                       @QueryParameter(required=false)@CheckForNull
                                                       String imageName)
                                                         throws IOException,
                                                                javax.servlet.ServletException

Submits a new event through Jenkins API.

Parameters:

inspectData - JSON output of docker inspect container (array of container infos)

hostName - Optional name of the host, which submitted the event "unknown" by default

hostId - Optional host ID. "unknown" by default

status - Optional status of the container. By default, an artificial DockerEventType.NONE will be used.

time - Optional time when the event happened. The time is specified in seconds since January 1, 1970, 00:00:00 GMT Default value - current time

environment - Optional field, which describes the environment

imageName - Optional field, which provides the name of the image

Returns:

HttpResponse

Throws:

IOException - Request processing error

javax.servlet.ServletException - Servlet error

doSubmitReport

public org.kohsuke.stapler.HttpResponse doSubmitReport(@QueryParameter(required=true)
                                              String json)
                                                throws IOException,
                                                       javax.servlet.ServletException

Submits a new DockerTraceabilityReport via API.

Parameters:

json - String representation of DockerTraceabilityReport

Returns:

HttpResponse

Throws:

javax.servlet.ServletException - Servlet error

IOException - Processing error

doContainer

public void doContainer(org.kohsuke.stapler.StaplerRequest req,
               org.kohsuke.stapler.StaplerResponse rsp,
               @QueryParameter(required=true)
               String id)
                 throws IOException,
                        javax.servlet.ServletException

Gets a container Fingerprint page.

Parameters:

req - Stapler request

rsp - Stapler response

id - Container ID. Method supports full 64-char IDs only.

Throws:

IOException - Request processing error

javax.servlet.ServletException - Servlet error

doDeleteContainer

public org.kohsuke.stapler.HttpResponse doDeleteContainer(@QueryParameter(required=true)
                                                 String id)
                                                   throws IOException,
                                                          javax.servlet.ServletException

Removes the container reference from the registry.

Parameters:

id - Container ID. Method supports full 64-char IDs only.

Returns:

response

Throws:

IOException - Cannot save the updated DockerTraceabilityRootAction

javax.servlet.ServletException - Servlet exception

doImage

public void doImage(org.kohsuke.stapler.StaplerRequest req,
           org.kohsuke.stapler.StaplerResponse rsp,
           @QueryParameter(required=true)
           String id)
             throws IOException,
                    javax.servlet.ServletException

Gets an image Fingerprint page.

Parameters:

req - Stapler request

rsp - Stapler response

id - Image ID. Method supports full 64-char IDs only.

Throws:

IOException - Request processing error

javax.servlet.ServletException - Servlet error

doRawContainerInfo

public org.kohsuke.stapler.HttpResponse doRawContainerInfo(@QueryParameter(required=true)
                                                  String id)
                                                    throws IOException,
                                                           javax.servlet.ServletException

Retrieves the latest container status via API. The output will be retrieved in JSON. Supports filers. Missing "since" and "until"

Parameters:

id - ID of the container, for which the info should be retrieved. Short container IDs are not supported.

Returns:

Raw JSON output compatible with docker inspect

Throws:

IOException - Processing error

javax.servlet.ServletException - Servlet error

doQueryContainer

public org.kohsuke.stapler.HttpResponse doQueryContainer(@QueryParameter(required=true)
                                                String id,
                                                @QueryParameter(required=false)
                                                String mode,
                                                @QueryParameter(required=false)
                                                long since,
                                                @QueryParameter(required=false)
                                                long until)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Queries container statuses via API. The output will be retrieved in JSON. Supports filters.

Parameters:

id - ID of the container, for which the info should be retrieved. Short container IDs are not supported.

mode - QueryMode. Default value - QueryMode#inspectContainer

since - Optional starting time. If the value equals to 0, the filter will be ignored (default in QueryParameter).

until - End time. If the value equals to 0, the filter will be ignored (default in QueryParameter).

Returns:

Response containing the output JSON. may be an error if something breaks.

Throws:

IOException - Processing error

javax.servlet.ServletException - Servlet error

doRawImageInfo

public org.kohsuke.stapler.HttpResponse doRawImageInfo(@QueryParameter(required=true)
                                              String id)
                                                throws IOException,
                                                       javax.servlet.ServletException

Retrieves the latest raw status via API. The output will be retrieved in JSON.

Parameters:

id - ID of the image, for which the info should be retrieved. Short container IDs are not supported.

Returns:

HttpResponse

Throws:

IOException - Processing error

javax.servlet.ServletException - Servlet error

getRequiredPermission

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public hudson.security.Permission getRequiredPermission()

getSearch

public hudson.search.Search getSearch()

Specified by:

getSearch in interface hudson.search.SearchableModelObject

getSearchName

public String getSearchName()

Specified by:

getSearchName in interface hudson.search.SearchItem

getSearchUrl

public String getSearchUrl()

Specified by:

getSearchUrl in interface hudson.search.SearchItem

getSearchIndex

public hudson.search.SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface hudson.search.SearchItem

save

public void save()
          throws IOException

Specified by:

save in interface hudson.model.Saveable

Throws:

IOException

getInstance

@CheckForNull
public static DockerTraceabilityRootAction getInstance()

Gets the DockerTraceabilityRootAction of Jenkins instance.

Returns:

Instance or null if it is not available