com.openshift.internal.restclient.capability.resources

Class AbstractOpenShiftBinaryCapability

java.lang.Object

com.openshift.internal.restclient.capability.resources.AbstractOpenShiftBinaryCapability

All Implemented Interfaces:

IBinaryCapability, ICapability

Direct Known Subclasses:

OpenShiftBinaryPortForwarding, OpenShiftBinaryRSync

public abstract class AbstractOpenShiftBinaryCapability
extends Object
implements IBinaryCapability

Capability that wraps the OpenShift binary

Author:

Jeff Cantrill

Nested Class Summary

Nested classes/interfaces inherited from interface com.openshift.restclient.capability.IBinaryCapability

IBinaryCapability.OpenShiftBinaryOption

Field Summary

Fields inherited from interface com.openshift.restclient.capability.IBinaryCapability

OPENSHIFT_BINARY_LOCATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOpenShiftBinaryCapability()
protected	AbstractOpenShiftBinaryCapability(IClient client)

Method Summary

Modifier and Type	Method and Description
protected abstract String	buildArgs(List<IBinaryCapability.OpenShiftBinaryOption> options) Callback for building args to be sent to the oc command.
protected abstract void	cleanup() Cleanup required when stopping the process
protected IClient	getClient()
protected String	getDeleteFlags()
protected String	getGitFolderExclusionFlag()
protected String	getNoPermsFlags()
protected String	getOpenShiftBinaryLocation()
protected Process	getProcess()
protected String	getServerFlag()
protected String	getSkipTlsVerifyFlag()
protected String	getTokenFlag() Adds the authentication token
protected String	getUserFlag()
void	start(IBinaryCapability.OpenShiftBinaryOption... options) Starts the Process to run the oc command.
void	stop() Stops the Process running the oc command.
protected abstract boolean	validate() Validate arguments before starting process

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openshift.restclient.capability.ICapability

getName, isSupported

Constructor Detail

AbstractOpenShiftBinaryCapability

protected AbstractOpenShiftBinaryCapability(IClient client)

AbstractOpenShiftBinaryCapability

protected AbstractOpenShiftBinaryCapability()

Method Detail

cleanup

protected abstract void cleanup()

Cleanup required when stopping the process

validate

protected abstract boolean validate()

Validate arguments before starting process

Returns:

true if start should continue; false otherwise;

buildArgs

protected abstract String buildArgs(List<IBinaryCapability.OpenShiftBinaryOption> options)

Callback for building args to be sent to the oc command.

Returns:

the String representation of all the arguments to use when running the oc command.

getClient

protected IClient getClient()

getProcess

protected Process getProcess()

getUserFlag

protected String getUserFlag()

getServerFlag

protected String getServerFlag()

Returns:

getTokenFlag

protected String getTokenFlag()

Adds the authentication token

Returns:

the command-line argument to use the current token

getSkipTlsVerifyFlag

protected String getSkipTlsVerifyFlag()

Returns:

the command-line flag to use insecure connection (skip TLS verification)

getGitFolderExclusionFlag

protected String getGitFolderExclusionFlag()

Returns:

the command-line flag to exclude some files/directories that do not need to be synchronized between the remote pod and the local deployment directory.

getNoPermsFlags

protected String getNoPermsFlags()

Returns:

the command-line flag to avoid transferring permissions.

getDeleteFlags

protected String getDeleteFlags()

Returns:

the command-line flag to delete extraneous file from destination directories.

start

public final void start(IBinaryCapability.OpenShiftBinaryOption... options)

Starts the Process to run the oc command.

Parameters:

options - the command line options

stop

public final void stop()

Stops the Process running the oc command.

getOpenShiftBinaryLocation

protected String getOpenShiftBinaryLocation()