Package io.jenkins.plugins.harbor.client

Class HarborClientImpl

java.lang.Object

io.jenkins.plugins.harbor.client.HarborClientImpl

All Implemented Interfaces:

HarborClient

public class HarborClientImpl
extends Object
implements HarborClient

Constructor Summary

Constructors

Constructor	Description
HarborClientImpl(String baseUrl, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials, boolean isSkipTlsVerify, boolean debugLogging)

Method Summary

Modifier and Type	Method	Description
Artifact	getArtifact(String projectName, String repositoryName, String reference, Map<String,String> extraParams)	Get the specific artifact
String	getPing()	Ping Harbor to check if it's alive.
NativeReportSummary	getVulnerabilitiesAddition(String projectName, String repositoryName, String reference)	Get the vulnerabilities addition of the specific artifact
Repository[]	listAllRepositories()	List all authorized repositories
Artifact[]	listArtifacts(String projectName, String repositoryName, Map<String,String> extraParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

HarborClientImpl

public HarborClientImpl(String baseUrl,
                        com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials credentials,
                        boolean isSkipTlsVerify,
                        boolean debugLogging)
                 throws NoSuchAlgorithmException,
                        KeyManagementException

Throws:

NoSuchAlgorithmException

KeyManagementException

Method Detail

getVulnerabilitiesAddition

public NativeReportSummary getVulnerabilitiesAddition(String projectName,
                                                      String repositoryName,
                                                      String reference)

Description copied from interface: HarborClient

Get the vulnerabilities addition of the specific artifact

Get the vulnerabilities addition of the artifact specified by the reference under the project and repository.

Specified by:

getVulnerabilitiesAddition in interface HarborClient

Parameters:

projectName - The project name of Harbor

repositoryName - The name of

reference - The reference can be digest or tag.

getPing

public String getPing()
               throws IOException

Description copied from interface: HarborClient

Ping Harbor to check if it's alive.

This API simply replies a pong to indicate the process to handle API is up, disregarding the health status of dependent components.

Specified by:

getPing in interface HarborClient

Returns:

If the request succeeds, the 'Pong' string is returned

Throws:

IOException - The HTTP request failed

listAllRepositories

public Repository[] listAllRepositories()
                                 throws IOException

Description copied from interface: HarborClient

List all authorized repositories

Specified by:

listAllRepositories in interface HarborClient

Returns:

Return to the list of repositories

Throws:

IOException

listArtifacts

public Artifact[] listArtifacts(String projectName,
                                String repositoryName,
                                @Nullable
                                Map<String,String> extraParams)
                         throws HarborException,
                                IOException

Specified by:

listArtifacts in interface HarborClient

Throws:

HarborException

IOException

getArtifact

public Artifact getArtifact(String projectName,
                            String repositoryName,
                            String reference,
                            @Nullable
                            Map<String,String> extraParams)
                     throws IOException

Description copied from interface: HarborClient

Get the specific artifact

Get the artifact specified by the reference under the project and repository. The reference can be digest or tag.

Specified by:

getArtifact in interface HarborClient

Returns:

Artifact Return artifact information

Throws:

IOException - The HTTP request failed