Class DockerServerEndpoint
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<DockerServerEndpoint>
-
- org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint
-
- All Implemented Interfaces:
Describable<DockerServerEndpoint>
public class DockerServerEndpoint extends AbstractDescribableImpl<DockerServerEndpoint>
Encapsulates the endpoint of Docker daemon and how to interact with it.As
Describable
it comes with pre-baked configuration form that you can use in your builders/publishers/etc that interact with Docker daemon.- Author:
- Kohsuke Kawaguchi
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DockerServerEndpoint.DescriptorImpl
-
Constructor Summary
Constructors Constructor Description DockerServerEndpoint(String uri, String credentialsId)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object obj)
String
getCredentialsId()
ID of the credentials used to talk to this endpoint.String
getUri()
Gets the endpoint in URI, such as "unix:///var/run/docker.sock".int
hashCode()
KeyMaterialFactory
newKeyMaterialFactory(FilePath dir, DockerServerCredentials credentials)
Create aKeyMaterialFactory
for connecting to the docker server/host.KeyMaterialFactory
newKeyMaterialFactory(AbstractBuild build)
Deprecated.KeyMaterialFactory
newKeyMaterialFactory(Item context, hudson.remoting.VirtualChannel target)
Deprecated.KeyMaterialFactory
newKeyMaterialFactory(Run context, hudson.remoting.VirtualChannel target)
Makes the key materials available locally and returnsKeyMaterialFactory
that gives you the parameters needed to access it.String
toString()
-
Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor
-
-
-
-
Method Detail
-
getUri
@Nullable public String getUri()
Gets the endpoint in URI, such as "unix:///var/run/docker.sock".Null to indicate whatever Docker picks by default.
-
getCredentialsId
@Nullable public String getCredentialsId()
ID of the credentials used to talk to this endpoint.
-
newKeyMaterialFactory
@Deprecated public KeyMaterialFactory newKeyMaterialFactory(@NonNull AbstractBuild build) throws IOException, InterruptedException
Deprecated.Makes the key materials available locally for the on-going build and returnsKeyMaterialFactory
that gives you the parameters needed to access it.- Throws:
IOException
InterruptedException
-
newKeyMaterialFactory
@Deprecated public KeyMaterialFactory newKeyMaterialFactory(@NonNull Item context, @NonNull hudson.remoting.VirtualChannel target) throws IOException, InterruptedException
Deprecated.Makes the key materials available locally and returnsKeyMaterialFactory
that gives you the parameters needed to access it.- Throws:
IOException
InterruptedException
-
newKeyMaterialFactory
public KeyMaterialFactory newKeyMaterialFactory(@NonNull Run context, @NonNull hudson.remoting.VirtualChannel target) throws IOException, InterruptedException
Makes the key materials available locally and returnsKeyMaterialFactory
that gives you the parameters needed to access it.- Throws:
IOException
InterruptedException
-
newKeyMaterialFactory
public KeyMaterialFactory newKeyMaterialFactory(FilePath dir, @Nullable DockerServerCredentials credentials) throws IOException, InterruptedException
Create aKeyMaterialFactory
for connecting to the docker server/host.- Throws:
IOException
InterruptedException
-
-