com.openshift.internal.restclient.capability.resources

Class PodLogRetrievalAsync

java.lang.Object

com.openshift.internal.restclient.capability.resources.PodLogRetrievalAsync

All Implemented Interfaces:

ICapability, IPodLogRetrievalAsync

public class PodLogRetrievalAsync
extends Object
implements IPodLogRetrievalAsync

Impl of Pod log retrieval using websocket

Nested Class Summary

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

IPodLogRetrievalAsync.IPodLogListener, IPodLogRetrievalAsync.Options

Constructor Summary

Constructors

Constructor and Description
PodLogRetrievalAsync(IPod pod, IClient client)

Method Summary

Modifier and Type	Method and Description
String	getName() Well known name of the capability
boolean	isSupported() Allow the implementation of the capability to determine if it is supported on the OpenShift server.
IStoppable	start(IPodLogRetrievalAsync.IPodLogListener listener) Start retrieving logs using the given listener and options
IStoppable	start(IPodLogRetrievalAsync.IPodLogListener listener, IPodLogRetrievalAsync.Options options) Start retrieving logs using the given listener and options

Methods inherited from class java.lang.Object

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

Constructor Detail

PodLogRetrievalAsync

public PodLogRetrievalAsync(IPod pod,
                            IClient client)

Method Detail

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

start

public IStoppable start(IPodLogRetrievalAsync.IPodLogListener listener)

Description copied from interface: IPodLogRetrievalAsync

Start retrieving logs using the given listener and options

Specified by:

start in interface IPodLogRetrievalAsync

Returns:

A Handle to allow termination of log streaming

start

public IStoppable start(IPodLogRetrievalAsync.IPodLogListener listener,
                        IPodLogRetrievalAsync.Options options)

Description copied from interface: IPodLogRetrievalAsync

Start retrieving logs using the given listener and options

Specified by:

start in interface IPodLogRetrievalAsync

options - options for retrieving logs

Returns:

A Handle to allow termination of log streaming