public class DelegatingDockerClient extends Object implements com.github.dockerjava.api.DockerClient
DockerClient interface.
This makes it easy for other classes to override specific methods without having to implement all of them. Every method here:
getDelegate(),interceptVoid() and then
returns,interceptAnswer(Object), passing in the
delegate method's answer and returns whatever
interceptAnswer(Object) returned.
If you are writing a Jenkins plugin that needs a class to implement/wrap
DockerClient, you'd be best advised to extend this one, otherwise
your code could fail whenever the version of this plugin changes and the
DockerClient gains additional methods.
| Constructor and Description |
|---|
DelegatingDockerClient(com.github.dockerjava.api.DockerClient delegate)
Constructs a new instance that delegates all API calls to the specified
DockerClient. |
| Modifier and Type | Method and Description |
|---|---|
com.github.dockerjava.api.command.AttachContainerCmd |
attachContainerCmd(String arg0) |
com.github.dockerjava.api.command.AuthCmd |
authCmd() |
com.github.dockerjava.api.model.AuthConfig |
authConfig() |
com.github.dockerjava.api.command.BuildImageCmd |
buildImageCmd() |
com.github.dockerjava.api.command.BuildImageCmd |
buildImageCmd(File arg0) |
com.github.dockerjava.api.command.BuildImageCmd |
buildImageCmd(InputStream arg0) |
void |
close() |
com.github.dockerjava.api.command.CommitCmd |
commitCmd(String arg0) |
com.github.dockerjava.api.command.ConnectToNetworkCmd |
connectToNetworkCmd() |
com.github.dockerjava.api.command.ContainerDiffCmd |
containerDiffCmd(String arg0) |
com.github.dockerjava.api.command.CopyArchiveFromContainerCmd |
copyArchiveFromContainerCmd(String arg0,
String arg1) |
com.github.dockerjava.api.command.CopyArchiveToContainerCmd |
copyArchiveToContainerCmd(String arg0) |
com.github.dockerjava.api.command.CopyFileFromContainerCmd |
copyFileFromContainerCmd(String arg0,
String arg1) |
com.github.dockerjava.api.command.CreateContainerCmd |
createContainerCmd(String arg0) |
com.github.dockerjava.api.command.CreateImageCmd |
createImageCmd(String arg0,
InputStream arg1) |
com.github.dockerjava.api.command.CreateNetworkCmd |
createNetworkCmd() |
com.github.dockerjava.api.command.CreateServiceCmd |
createServiceCmd(com.github.dockerjava.api.model.ServiceSpec serviceSpec) |
com.github.dockerjava.api.command.CreateVolumeCmd |
createVolumeCmd() |
com.github.dockerjava.api.command.DisconnectFromNetworkCmd |
disconnectFromNetworkCmd() |
com.github.dockerjava.api.command.EventsCmd |
eventsCmd() |
com.github.dockerjava.api.command.ExecCreateCmd |
execCreateCmd(String arg0) |
com.github.dockerjava.api.command.ExecStartCmd |
execStartCmd(String arg0) |
protected com.github.dockerjava.api.DockerClient |
getDelegate()
Obtains the underlying
DockerClient interface. |
com.github.dockerjava.api.command.InfoCmd |
infoCmd() |
com.github.dockerjava.api.command.InitializeSwarmCmd |
initializeSwarmCmd(com.github.dockerjava.api.model.SwarmSpec swarmSpec) |
com.github.dockerjava.api.command.InspectContainerCmd |
inspectContainerCmd(String arg0) |
com.github.dockerjava.api.command.InspectExecCmd |
inspectExecCmd(String arg0) |
com.github.dockerjava.api.command.InspectImageCmd |
inspectImageCmd(String arg0) |
com.github.dockerjava.api.command.InspectNetworkCmd |
inspectNetworkCmd() |
com.github.dockerjava.api.command.InspectServiceCmd |
inspectServiceCmd(String serviceId) |
com.github.dockerjava.api.command.InspectSwarmCmd |
inspectSwarmCmd() |
com.github.dockerjava.api.command.InspectVolumeCmd |
inspectVolumeCmd(String arg0) |
protected <T> T |
interceptAnswer(T originalAnswer)
Called just before the result is returned.
|
protected void |
interceptVoid()
Called just before the method returns void.
|
com.github.dockerjava.api.command.JoinSwarmCmd |
joinSwarmCmd() |
com.github.dockerjava.api.command.KillContainerCmd |
killContainerCmd(String arg0) |
com.github.dockerjava.api.command.LeaveSwarmCmd |
leaveSwarmCmd() |
com.github.dockerjava.api.command.ListContainersCmd |
listContainersCmd() |
com.github.dockerjava.api.command.ListImagesCmd |
listImagesCmd() |
com.github.dockerjava.api.command.ListNetworksCmd |
listNetworksCmd() |
com.github.dockerjava.api.command.ListServicesCmd |
listServicesCmd() |
com.github.dockerjava.api.command.ListSwarmNodesCmd |
listSwarmNodesCmd() |
com.github.dockerjava.api.command.ListTasksCmd |
listTasksCmd() |
com.github.dockerjava.api.command.ListVolumesCmd |
listVolumesCmd() |
com.github.dockerjava.api.command.LoadImageCmd |
loadImageCmd(InputStream arg0) |
com.github.dockerjava.api.command.LogContainerCmd |
logContainerCmd(String arg0) |
com.github.dockerjava.api.command.LogSwarmObjectCmd |
logServiceCmd(String serviceId) |
com.github.dockerjava.api.command.LogSwarmObjectCmd |
logTaskCmd(String taskId) |
com.github.dockerjava.api.command.PauseContainerCmd |
pauseContainerCmd(String arg0) |
com.github.dockerjava.api.command.PingCmd |
pingCmd() |
com.github.dockerjava.api.command.PruneCmd |
pruneCmd(com.github.dockerjava.api.model.PruneType pruneType) |
com.github.dockerjava.api.command.PullImageCmd |
pullImageCmd(String arg0) |
com.github.dockerjava.api.command.PushImageCmd |
pushImageCmd(com.github.dockerjava.api.model.Identifier arg0) |
com.github.dockerjava.api.command.PushImageCmd |
pushImageCmd(String arg0) |
com.github.dockerjava.api.command.RemoveContainerCmd |
removeContainerCmd(String arg0) |
com.github.dockerjava.api.command.RemoveImageCmd |
removeImageCmd(String arg0) |
com.github.dockerjava.api.command.RemoveNetworkCmd |
removeNetworkCmd(String arg0) |
com.github.dockerjava.api.command.RemoveServiceCmd |
removeServiceCmd(String serviceId) |
com.github.dockerjava.api.command.RemoveVolumeCmd |
removeVolumeCmd(String arg0) |
com.github.dockerjava.api.command.RenameContainerCmd |
renameContainerCmd(String arg0) |
com.github.dockerjava.api.command.RestartContainerCmd |
restartContainerCmd(String arg0) |
com.github.dockerjava.api.command.SaveImageCmd |
saveImageCmd(String arg0) |
com.github.dockerjava.api.command.SearchImagesCmd |
searchImagesCmd(String arg0) |
com.github.dockerjava.api.command.StartContainerCmd |
startContainerCmd(String arg0) |
com.github.dockerjava.api.command.StatsCmd |
statsCmd(String arg0) |
com.github.dockerjava.api.command.StopContainerCmd |
stopContainerCmd(String arg0) |
com.github.dockerjava.api.command.TagImageCmd |
tagImageCmd(String arg0,
String arg1,
String arg2) |
com.github.dockerjava.api.command.TopContainerCmd |
topContainerCmd(String arg0) |
com.github.dockerjava.api.command.UnpauseContainerCmd |
unpauseContainerCmd(String arg0) |
com.github.dockerjava.api.command.UpdateContainerCmd |
updateContainerCmd(String arg0) |
com.github.dockerjava.api.command.UpdateServiceCmd |
updateServiceCmd(String serviceId,
com.github.dockerjava.api.model.ServiceSpec serviceSpec) |
com.github.dockerjava.api.command.UpdateSwarmCmd |
updateSwarmCmd(com.github.dockerjava.api.model.SwarmSpec swarmSpec) |
com.github.dockerjava.api.command.UpdateSwarmNodeCmd |
updateSwarmNodeCmd() |
com.github.dockerjava.api.command.VersionCmd |
versionCmd() |
com.github.dockerjava.api.command.WaitContainerCmd |
waitContainerCmd(String arg0) |
public DelegatingDockerClient(@Nonnull com.github.dockerjava.api.DockerClient delegate)
DockerClient.delegate - The DockerClient to delegate to.@Nonnull protected com.github.dockerjava.api.DockerClient getDelegate()
DockerClient interface. Subclasses can
override this if they need to hook into every call before anything else
happens.DockerClient to be delegated to.protected <T> T interceptAnswer(T originalAnswer)
Note: If a subclass only wishes to act upon certain specific
DockerClient calls then it may be clearer to override those specific
methods instead. This hook is intended for use by subclasses that need to act
upon "all methods" or need to act on methods that were not part of the
DockerClient API at the time they were implemented.
T - The type of the originalAnswer.originalAnswer - The result from the delegate.protected void interceptVoid()
Note: If a subclass only wishes to act upon certain specific
DockerClient calls then it may be clearer to override those specific
methods instead. This hook is intended for use by subclasses that need to act
upon "all methods" or need to act on methods that were not part of the
DockerClient API at the time they were implemented.
public com.github.dockerjava.api.command.AttachContainerCmd attachContainerCmd(String arg0)
attachContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.AuthCmd authCmd()
authCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.model.AuthConfig authConfig()
throws com.github.dockerjava.api.exception.DockerException
authConfig in interface com.github.dockerjava.api.DockerClientcom.github.dockerjava.api.exception.DockerExceptionpublic com.github.dockerjava.api.command.BuildImageCmd buildImageCmd()
buildImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.BuildImageCmd buildImageCmd(File arg0)
buildImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.BuildImageCmd buildImageCmd(InputStream arg0)
buildImageCmd in interface com.github.dockerjava.api.DockerClientpublic void close()
throws IOException
close in interface com.github.dockerjava.api.DockerClientclose in interface Closeableclose in interface AutoCloseableIOExceptionpublic com.github.dockerjava.api.command.CommitCmd commitCmd(String arg0)
commitCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ConnectToNetworkCmd connectToNetworkCmd()
connectToNetworkCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ContainerDiffCmd containerDiffCmd(String arg0)
containerDiffCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CopyArchiveFromContainerCmd copyArchiveFromContainerCmd(String arg0, String arg1)
copyArchiveFromContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CopyArchiveToContainerCmd copyArchiveToContainerCmd(String arg0)
copyArchiveToContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CopyFileFromContainerCmd copyFileFromContainerCmd(String arg0, String arg1)
copyFileFromContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CreateContainerCmd createContainerCmd(String arg0)
createContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CreateImageCmd createImageCmd(String arg0, InputStream arg1)
createImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CreateNetworkCmd createNetworkCmd()
createNetworkCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CreateVolumeCmd createVolumeCmd()
createVolumeCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.DisconnectFromNetworkCmd disconnectFromNetworkCmd()
disconnectFromNetworkCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.EventsCmd eventsCmd()
eventsCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ExecCreateCmd execCreateCmd(String arg0)
execCreateCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ExecStartCmd execStartCmd(String arg0)
execStartCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InfoCmd infoCmd()
infoCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectContainerCmd inspectContainerCmd(String arg0)
inspectContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectExecCmd inspectExecCmd(String arg0)
inspectExecCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectImageCmd inspectImageCmd(String arg0)
inspectImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectNetworkCmd inspectNetworkCmd()
inspectNetworkCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectVolumeCmd inspectVolumeCmd(String arg0)
inspectVolumeCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.KillContainerCmd killContainerCmd(String arg0)
killContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListContainersCmd listContainersCmd()
listContainersCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListImagesCmd listImagesCmd()
listImagesCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListNetworksCmd listNetworksCmd()
listNetworksCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListVolumesCmd listVolumesCmd()
listVolumesCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.LoadImageCmd loadImageCmd(InputStream arg0)
loadImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.LogContainerCmd logContainerCmd(String arg0)
logContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PauseContainerCmd pauseContainerCmd(String arg0)
pauseContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PingCmd pingCmd()
pingCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PullImageCmd pullImageCmd(String arg0)
pullImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PushImageCmd pushImageCmd(String arg0)
pushImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PushImageCmd pushImageCmd(com.github.dockerjava.api.model.Identifier arg0)
pushImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RemoveContainerCmd removeContainerCmd(String arg0)
removeContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RemoveImageCmd removeImageCmd(String arg0)
removeImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RemoveNetworkCmd removeNetworkCmd(String arg0)
removeNetworkCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RemoveVolumeCmd removeVolumeCmd(String arg0)
removeVolumeCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RenameContainerCmd renameContainerCmd(String arg0)
renameContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RestartContainerCmd restartContainerCmd(String arg0)
restartContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.SaveImageCmd saveImageCmd(String arg0)
saveImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.SearchImagesCmd searchImagesCmd(String arg0)
searchImagesCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.StartContainerCmd startContainerCmd(String arg0)
startContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.StatsCmd statsCmd(String arg0)
statsCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.StopContainerCmd stopContainerCmd(String arg0)
stopContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.TagImageCmd tagImageCmd(String arg0, String arg1, String arg2)
tagImageCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.TopContainerCmd topContainerCmd(String arg0)
topContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.UnpauseContainerCmd unpauseContainerCmd(String arg0)
unpauseContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.UpdateContainerCmd updateContainerCmd(String arg0)
updateContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.VersionCmd versionCmd()
versionCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.WaitContainerCmd waitContainerCmd(String arg0)
waitContainerCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InitializeSwarmCmd initializeSwarmCmd(com.github.dockerjava.api.model.SwarmSpec swarmSpec)
initializeSwarmCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectSwarmCmd inspectSwarmCmd()
inspectSwarmCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.JoinSwarmCmd joinSwarmCmd()
joinSwarmCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.LeaveSwarmCmd leaveSwarmCmd()
leaveSwarmCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.UpdateSwarmCmd updateSwarmCmd(com.github.dockerjava.api.model.SwarmSpec swarmSpec)
updateSwarmCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.UpdateSwarmNodeCmd updateSwarmNodeCmd()
updateSwarmNodeCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListSwarmNodesCmd listSwarmNodesCmd()
listSwarmNodesCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListServicesCmd listServicesCmd()
listServicesCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.CreateServiceCmd createServiceCmd(com.github.dockerjava.api.model.ServiceSpec serviceSpec)
createServiceCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.InspectServiceCmd inspectServiceCmd(String serviceId)
inspectServiceCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.UpdateServiceCmd updateServiceCmd(String serviceId, com.github.dockerjava.api.model.ServiceSpec serviceSpec)
updateServiceCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.RemoveServiceCmd removeServiceCmd(String serviceId)
removeServiceCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.ListTasksCmd listTasksCmd()
listTasksCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.LogSwarmObjectCmd logServiceCmd(String serviceId)
logServiceCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.LogSwarmObjectCmd logTaskCmd(String taskId)
logTaskCmd in interface com.github.dockerjava.api.DockerClientpublic com.github.dockerjava.api.command.PruneCmd pruneCmd(com.github.dockerjava.api.model.PruneType pruneType)
pruneCmd in interface com.github.dockerjava.api.DockerClientCopyright © 2016–2022. All rights reserved.