com.openshift.internal.restclient.capability.resources

Class OpenShiftBinaryPodLogRetrieval

java.lang.Object

com.openshift.internal.restclient.capability.resources.OpenShiftBinaryPodLogRetrieval

All Implemented Interfaces:

ICapability, IPodLogRetrieval

public class OpenShiftBinaryPodLogRetrieval
extends Object
implements IPodLogRetrieval

Constructor Summary

Constructors

Constructor and Description
OpenShiftBinaryPodLogRetrieval(IPod pod, IClient client)

Method Summary

Modifier and Type	Method and Description
InputStream	getLogs(boolean follow, IBinaryCapability.OpenShiftBinaryOption... options) Return the logs from the pod, optionally following them.
InputStream	getLogs(boolean follow, String container, IBinaryCapability.OpenShiftBinaryOption... options) Return the logs from the pod, optionally following them
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.
void	stop() Stop retrieving logs for all containers
void	stop(String container) Stop retrieving logs for a specific container

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenShiftBinaryPodLogRetrieval

public OpenShiftBinaryPodLogRetrieval(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

Returns:

getLogs

public InputStream getLogs(boolean follow,
                           IBinaryCapability.OpenShiftBinaryOption... options)

Description copied from interface: IPodLogRetrieval

Return the logs from the pod, optionally following them.

Specified by:

getLogs in interface IPodLogRetrieval

Parameters:

follow - true if following. Default: false

options - the options to pass to the underlying oc command

Returns:

the log output stream

getLogs

public InputStream getLogs(boolean follow,
                           String container,
                           IBinaryCapability.OpenShiftBinaryOption... options)

Description copied from interface: IPodLogRetrieval

Return the logs from the pod, optionally following them

Specified by:

getLogs in interface IPodLogRetrieval

Parameters:

follow - true; if following, Default: false

container - the name of the container in the pod to get logs uses the first container if empty

options - the options to pass to the underlying oc command

Returns:

the log output stream

stop

public void stop()

Description copied from interface: IPodLogRetrieval

Stop retrieving logs for all containers

Specified by:

stop in interface IPodLogRetrieval

stop

public void stop(String container)

Description copied from interface: IPodLogRetrieval

Stop retrieving logs for a specific container

Specified by:

stop in interface IPodLogRetrieval

Parameters:

container - the name of the container