com.openshift.restclient.capability.resources

Interface IPortForwardable

All Superinterfaces:

IBinaryCapability, ICapability

All Known Implementing Classes:

OpenShiftBinaryPortForwarding

public interface IPortForwardable
extends IBinaryCapability

Defines if a pod can support port forwarding

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPortForwardable.PortPair Pairing a local port to the remote port of a container.

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

IBinaryCapability.OpenShiftBinaryOption, IBinaryCapability.SkipTlsVerify

Field Summary

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

OPENSHIFT_BINARY_LOCATION, SKIP_TLS_VERIFY

Method Summary

Modifier and Type	Method and Description
void	forwardPorts(Collection<IPortForwardable.PortPair> pairs, IBinaryCapability.OpenShiftBinaryOption... options) Forward the ports to a pod.
Collection<IPortForwardable.PortPair>	getPortPairs() The port pairs.
boolean	isForwarding()
void	stop() Stop forwarding ports, forcibly if necessary

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

getName, isSupported

Method Detail

forwardPorts

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

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

Parameters:

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

options - the options to pass to the underlying oc command

Throws:

OpenShiftException - if unable to forward ports

getPortPairs

Collection<IPortForwardable.PortPair> getPortPairs()

The port pairs.

Returns:

The pairs when forwarding or an empty array;

stop

void stop()

Stop forwarding ports, forcibly if necessary

isForwarding

boolean isForwarding()

Returns:

true if forwarding; false otherwise