org.jenkinsci.plugins.docker.commons

Class DockerServerCredentials

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

org.jenkinsci.plugins.docker.commons.DockerServerCredentials

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.CertificateCredentials, com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.PasswordCredentials, com.cloudbees.plugins.credentials.common.StandardCertificateCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.Credentials, hudson.ExtensionPoint, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

public abstract class DockerServerCredentials
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
implements com.cloudbees.plugins.credentials.common.StandardCertificateCredentials

Represents the connection details to talk to a docker host, which involves endpoint URI, optional client secret key & certificate, and optional CA certificate to verify the server.

Author:

Kohsuke Kawaguchi

See Also:

DockerServerEndpoint, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCertificateCredentials

com.cloudbees.plugins.credentials.common.StandardCertificateCredentials.NameProvider

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description)

Method Summary

Methods

Modifier and Type	Method and Description
X509Certificate	getClientCertificate()
abstract String	getClientCertificateInPEM() Gets the PEM formatted client certificate that matches with getClientSecretKey().
RSAPublicKey	getClientSecretKey()
abstract String	getClientSecretKeyInPEM() Gets the PEM formatted secret key to identify the client.
KeyStore	getKeyStore()
hudson.util.Secret	getPassword()
X509Certificate	getServerCaCertificate()
abstract String	getServerCaCertificateInPEM() Gets the PEM formatted server certificate that matches with getClientSecretKey().

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getDescriptor, getScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Constructor Detail

DockerServerCredentials

protected DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope,
                       String id,
                       String description)

Method Detail

getClientSecretKeyInPEM

@Nullable
public abstract String getClientSecretKeyInPEM()

Gets the PEM formatted secret key to identify the client. The --tlskey option in docker(1)

Returns:

null if there's no authentication

getClientSecretKey

public RSAPublicKey getClientSecretKey()
                                throws IOException

Throws:

IOException

getClientCertificateInPEM

@Nullable
public abstract String getClientCertificateInPEM()

Gets the PEM formatted client certificate that matches with getClientSecretKey(). The --tlscert option in docker(1).

Returns:

null if there's no authentication

getClientCertificate

public X509Certificate getClientCertificate()
                                     throws IOException

Throws:

IOException

getServerCaCertificateInPEM

@Nullable
public abstract String getServerCaCertificateInPEM()

Gets the PEM formatted server certificate that matches with getClientSecretKey(). The --tlscacert option in docker(1).

Returns:

null if there's no authentication

getServerCaCertificate

public X509Certificate getServerCaCertificate()
                                       throws IOException

Throws:

IOException

getKeyStore

@NonNull
public KeyStore getKeyStore()

Specified by:

getKeyStore in interface com.cloudbees.plugins.credentials.common.CertificateCredentials

getPassword

@NonNull
public hudson.util.Secret getPassword()

Specified by:

getPassword in interface com.cloudbees.plugins.credentials.common.PasswordCredentials