Package org.jenkinsci.plugins.docker.commons.credentials

Class DockerServerCredentials

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

org.jenkinsci.plugins.docker.commons.credentials.DockerServerCredentials

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.Credentials, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

public class DockerServerCredentials
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

Represents the connection details to talk to a TLS server, 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

Modifier and Type	Class	Description
static class	DockerServerCredentials.DescriptorImpl

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 hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

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

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

com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

Constructor Summary

Constructors

Constructor	Description
DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, Secret clientKeySecret, String clientCertificate, String serverCaCertificate)
DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String clientKey, String clientCertificate, String serverCaCertificate)	Deprecated. use DockerServerCredentials(CredentialsScope, String, String, Secret, String, String)

Method Summary

Modifier and Type	Method	Description
String	getClientCertificate()	Gets the PEM formatted client certificate.
String	getClientKey()	Deprecated. use getClientKeySecret()
Secret	getClientKeySecret()	Gets the PEM formatted secret key to identify the client.
String	getServerCaCertificate()	Gets the PEM formatted server certificate.

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.Credentials

forRun, getDescriptor, getScope

Constructor Details

DockerServerCredentials

@Deprecated
public DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope,
 String id,
 String description,
 @CheckForNull
 String clientKey,
 @CheckForNull
 String clientCertificate,
 @CheckForNull
 String serverCaCertificate)

Deprecated.

use DockerServerCredentials(CredentialsScope, String, String, Secret, String, String)

DockerServerCredentials

@DataBoundConstructor
public DockerServerCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope,
 String id,
 String description,
 @CheckForNull
 Secret clientKeySecret,
 @CheckForNull
 String clientCertificate,
 @CheckForNull
 String serverCaCertificate)

Method Details

getClientKey

@CheckForNull
@Deprecated
public String getClientKey()

Deprecated.

use getClientKeySecret()

getClientKeySecret

@CheckForNull
public Secret getClientKeySecret()

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

Returns:

null if there's no authentication

getClientCertificate

@CheckForNull
public String getClientCertificate()

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

Returns:

null if there's no authentication

getServerCaCertificate

@CheckForNull
public String getServerCaCertificate()

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

Returns:

null if there's no authentication