com.openshift.internal.restclient.capability.resources

Class OpenShiftBinaryPortForwarding

java.lang.Object

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

com.openshift.internal.restclient.capability.resources.OpenShiftBinaryPortForwarding

All Implemented Interfaces:

IBinaryCapability, ICapability, IPortForwardable

public class OpenShiftBinaryPortForwarding
extends AbstractOpenShiftBinaryCapability
implements IPortForwardable

Port forwarding implementation that wraps the OpenShift binary

Nested Class Summary

Nested classes/interfaces inherited from class com.openshift.internal.restclient.capability.resources.AbstractOpenShiftBinaryCapability

AbstractOpenShiftBinaryCapability.CommandLineBuilder

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

IPortForwardable.PortPair

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

IBinaryCapability.OpenShiftBinaryOption, IBinaryCapability.SkipTlsVerify

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORT_FORWARD_COMMAND

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

OPENSHIFT_BINARY_LOCATION, SKIP_TLS_VERIFY

Constructor Summary

Constructors

Constructor and Description
OpenShiftBinaryPortForwarding(IPod pod, IClient client)

Method Summary

Modifier and Type	Method and Description
protected String	buildArgs(List<IBinaryCapability.OpenShiftBinaryOption> options) Callback for building args to be sent to the oc command.
protected void	cleanup() Cleanup required when stopping the process
void	forwardPorts(Collection<IPortForwardable.PortPair> ports, IBinaryCapability.OpenShiftBinaryOption... options) Forward the ports to a pod.
String	getName() Well known name of the capability
Collection<IPortForwardable.PortPair>	getPortPairs() The port pairs.
boolean	isForwarding()
boolean	isSupported() Allow the implementation of the capability to determine if it is supported on the OpenShift server.
protected boolean	validate() Validate arguments before starting process

Methods inherited from class com.openshift.internal.restclient.capability.resources.AbstractOpenShiftBinaryCapability

getClient, getOpenShiftBinaryLocation, getProcess, start, startProcess, stop

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.resources.IPortForwardable

stop

Field Detail

PORT_FORWARD_COMMAND

public static final String PORT_FORWARD_COMMAND

See Also:

Constant Field Values

Constructor Detail

OpenShiftBinaryPortForwarding

public OpenShiftBinaryPortForwarding(IPod pod,
                                     IClient client)

Method Detail

cleanup

protected void cleanup()

Description copied from class: AbstractOpenShiftBinaryCapability

Cleanup required when stopping the process

Specified by:

cleanup in class AbstractOpenShiftBinaryCapability

validate

protected boolean validate()

Description copied from class: AbstractOpenShiftBinaryCapability

Validate arguments before starting process

Specified by:

validate in class AbstractOpenShiftBinaryCapability

Returns:

true if start should continue; false otherwise;

isForwarding

public boolean isForwarding()

Specified by:

isForwarding in interface IPortForwardable

Returns:

true if forwarding; false otherwise

isSupported

public boolean isSupported()

Description copied from interface: ICapability

Allow the implementation of the capability to determine if it is supported on the OpenShift server. Implementations should return false if they can not

Specified by:

isSupported in interface ICapability

Returns:

true if the capability exists

getName

public String getName()

Description copied from interface: ICapability

Well known name of the capability

Specified by:

getName in interface ICapability

getPortPairs

public Collection<IPortForwardable.PortPair> getPortPairs()

Description copied from interface: IPortForwardable

The port pairs.

Specified by:

getPortPairs in interface IPortForwardable

Returns:

The pairs when forwarding or an empty array;

forwardPorts

public void forwardPorts(Collection<IPortForwardable.PortPair> ports,
                         IBinaryCapability.OpenShiftBinaryOption... options)

Description copied from interface: IPortForwardable

Forward the ports to a pod. This is a non-blocking call

Specified by:

forwardPorts in interface IPortForwardable

Parameters:

ports - the pairs of local/remote ports to link together

options - the options to pass to the underlying oc command

buildArgs

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

Description copied from class: AbstractOpenShiftBinaryCapability

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

Specified by:

buildArgs in class AbstractOpenShiftBinaryCapability

Returns:

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