com.openshift.internal.restclient.capability.resources

Class OpenShiftBinaryRSync

java.lang.Object

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

com.openshift.internal.restclient.capability.resources.OpenShiftBinaryRSync

All Implemented Interfaces:

IBinaryCapability, ICapability, IRSyncable

public class OpenShiftBinaryRSync
extends AbstractOpenShiftBinaryCapability
implements IRSyncable

Port forwarding implementation that wraps the OpenShift binary

Author:

Andre Dietisheim

Nested Class Summary

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

IRSyncable.LocalPeer, IRSyncable.Peer, IRSyncable.PodPeer

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

IBinaryCapability.OpenShiftBinaryOption

Field Summary

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

OPENSHIFT_BINARY_LOCATION

Constructor Summary

Constructors

Constructor and Description
OpenShiftBinaryRSync(IClient client) Constructor.

Method Summary

Modifier and Type	Method and Description
void	await() Blocks until the process is done.
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
int	exitValue()
protected String	getDeleteFlags()
protected String	getGitFolderExclusionFlag()
String	getName() Well known name of the capability
protected String	getNoPermsFlags()
boolean	isDone() Indicates if the Process completed or not
boolean	isSupported() Allow the implementation of the capability to determine if it is supported on the OpenShift server.
InputStream	sync(IRSyncable.Peer source, IRSyncable.Peer destination, IBinaryCapability.OpenShiftBinaryOption... options) Synchronize the give destination with the given source
protected boolean	validate() Validate arguments before starting process

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

getClient, getOpenShiftBinaryLocation, getProcess, getServerFlag, getSkipTlsVerifyFlag, getTokenFlag, getUserFlag, start, 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.IRSyncable

stop

Constructor Detail

OpenShiftBinaryRSync

public OpenShiftBinaryRSync(IClient client)

Constructor.

Parameters:

client - the client to connect to OpenShift.

Method Detail

sync

public InputStream sync(IRSyncable.Peer source,
                        IRSyncable.Peer destination,
                        IBinaryCapability.OpenShiftBinaryOption... options)
                 throws OpenShiftException

Description copied from interface: IRSyncable

Synchronize the give destination with the given source

Specified by:

sync in interface IRSyncable

Parameters:

source - the source of the rsync

destination - the destination of the rsync

options - the options to pass to the underlying oc rsync command

Returns:

the underlying Process streams to be displayed in a console.

Throws:

OpenShiftException

isDone

public boolean isDone()

Description copied from interface: IRSyncable

Indicates if the Process completed or not

Specified by:

isDone in interface IRSyncable

Returns:

true if the Process completed, false otherwise.

exitValue

public int exitValue()

Specified by:

exitValue in interface IRSyncable

Returns:

the Process exit value when it completed, -1 if it's still running

await

public void await()
           throws InterruptedException

Description copied from interface: IRSyncable

Blocks until the process is done.

Specified by:

await in interface IRSyncable

Throws:

InterruptedException - if the current thread is interrupted while waiting

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;

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:

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.

getGitFolderExclusionFlag

protected String getGitFolderExclusionFlag()

Returns:

the command-line flag to exclude some files/directories that do not need to be synchronized between the remote pod and the local deployment directory.

getNoPermsFlags

protected String getNoPermsFlags()

Returns:

the command-line flag to avoid transferring permissions.

getDeleteFlags

protected String getDeleteFlags()

Returns:

the command-line flag to delete extraneous file from destination directories.