com.openshift.internal.restclient.api.capabilities

Class PodExec

java.lang.Object

com.openshift.internal.restclient.capability.AbstractCapability

com.openshift.internal.restclient.api.capabilities.PodExec

All Implemented Interfaces:

IPodExec, ICapability

public class PodExec
extends AbstractCapability
implements IPodExec

Nested Class Summary

Nested classes/interfaces inherited from interface com.openshift.restclient.api.capabilities.IPodExec

IPodExec.IPodExecOutputListener, IPodExec.Options

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANNEL_EXECERR
static int	CHANNEL_STDERR
static int	CHANNEL_STDOUT

Constructor Summary

Constructors

Constructor and Description
PodExec(IPod pod, IClient client)

Method Summary

Modifier and Type	Method and Description
String	getName() Well known name of the capability
IStoppable	start(IPodExec.IPodExecOutputListener listener, IPodExec.Options options, String... commands) Execute a command on a named container in this pod

Methods inherited from class com.openshift.internal.restclient.capability.AbstractCapability

isSupported

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

isSupported

Field Detail

CHANNEL_STDOUT

public static final int CHANNEL_STDOUT

See Also:

Constant Field Values

CHANNEL_STDERR

public static final int CHANNEL_STDERR

See Also:

Constant Field Values

CHANNEL_EXECERR

public static final int CHANNEL_EXECERR

See Also:

Constant Field Values

Constructor Detail

PodExec

public PodExec(IPod pod,
               IClient client)

Method Detail

getName

public String getName()

Description copied from interface: ICapability

Well known name of the capability

Specified by:

getName in interface ICapability

start

public IStoppable start(IPodExec.IPodExecOutputListener listener,
                        IPodExec.Options options,
                        String... commands)

Description copied from interface: IPodExec

Execute a command on a named container in this pod

Specified by:

start in interface IPodExec

Parameters:

listener - Listener for command output

options - Options for the exec

commands - A command to run and any arguments

Returns:

A Handle to allow termination of the connection