Package io.bdeploy.jersey.cli

Class RemoteServiceTool<T extends Annotation>

java.lang.Object

io.bdeploy.common.cli.ToolBase.CliTool

io.bdeploy.common.cli.ToolBase.ConfiguredCliTool<T>

io.bdeploy.jersey.cli.RemoteServiceTool<T>

Direct Known Subclasses:

FetchTool, ManifestTool, PushTool

public abstract class RemoteServiceTool<T extends Annotation>
extends ToolBase.ConfiguredCliTool<T>

Base class for all CLI tools which need to access a remote service. Figuring out the RemoteService based on command line arguments is don entirely here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static @interface	RemoteServiceTool.RemoteOptional

Nested classes/interfaces inherited from class io.bdeploy.common.cli.ToolBase.CliTool

ToolBase.CliTool.CliName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RemoteServiceTool(Class<T> configClass)

Method Summary

Modifier and Type	Method	Description
protected List<Class<? extends Annotation>>	getConfigsForHelp()
protected jakarta.ws.rs.core.SecurityContext	getLocalContext()
protected final RenderableResult	run(T config)	Run the configured tool using configuration from the command line.
protected abstract RenderableResult	run(T config, RemoteService remote)

Methods inherited from class io.bdeploy.common.cli.ToolBase.ConfiguredCliTool

getConfig, getPrimaryConfigClass, getRawConfiguration, helpAndFail, helpAndFailIfMissing, run

Methods inherited from class io.bdeploy.common.cli.ToolBase.CliTool

createDataTable, createEmptyResult, createNoOp, createResultWithErrorMessage, createResultWithSuccessMessage, createSuccess, getActivityReporter, getAuditorFactory, getDataFormat, isVerbose, out, setActivityReporter, setAuditorFactory, setDataFormat, setOutput, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteServiceTool

protected RemoteServiceTool(Class<T> configClass)

Method Details

getConfigsForHelp

protected List<Class<? extends Annotation>> getConfigsForHelp()

Overrides:

getConfigsForHelp in class ToolBase.ConfiguredCliTool<T extends Annotation>

Returns:

all Annotations for which to render help output.

run

protected final RenderableResult run(T config)

Description copied from class: ToolBase.ConfiguredCliTool

Run the configured tool using configuration from the command line.

Specified by:

run in class ToolBase.ConfiguredCliTool<T extends Annotation>

Parameters:

config - the configuration instance for the tool.

getLocalContext

protected jakarta.ws.rs.core.SecurityContext getLocalContext()

run

protected abstract RenderableResult run(T config,
 RemoteService remote)