net.bluemind.node.client.impl.okhttp

Class OkHttpNodeClient

java.lang.Object

net.bluemind.node.client.impl.okhttp.OkHttpNodeClient

All Implemented Interfaces:

INodeClient

public class OkHttpNodeClient
extends java.lang.Object
implements INodeClient

Constructor Summary

Constructors

Constructor and Description
OkHttpNodeClient(okhttp3.OkHttpClient client, int port, java.lang.String baseUrl, java.lang.String wsUrl)

Method Summary

Modifier and Type	Method and Description
void	asyncExecute(ExecRequest req, ProcessHandler ph)
void	close()
void	deleteFile(java.lang.String path) Delete a file
TaskRef	executeCommand(ExecRequest tsk) Runs a command.
TaskRef	executeCommand(java.lang.String cmd) Starts a command in backend and returns a ref to track its progress.
TaskRef	executeCommandNoOut(java.lang.String cmd) Starts a command in backend and returns a ref to track its progress No output, receive "Done" when command finish.
java.util.List<ExecDescriptor>	getActiveExecutions(ActiveExecQuery query) Returns a list of running process matching the given query object.
TaskStatus	getExecutionStatus(TaskRef task) Tracks the progress of a task
void	interrupt(ExecDescriptor runningTask)
boolean	isSsl()
java.util.List<FileDescription>	listFiles(java.lang.String path) List files from path.
java.util.List<FileDescription>	listFiles(java.lang.String path, java.lang.String extensionPattern) List files from path matching extension.
java.io.InputStream	openStream(java.lang.String path) Opens a stream to a (maybe) remote file.
void	ping() Checks we can connect to a node.
byte[]	read(java.lang.String path) Fetches a file content into ram.
void	startWsAction(ExecRequest wsReq, ProcessHandler ph)
void	writeFile(java.lang.String path, java.io.InputStream content) (Over)writes the file at path with content.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpNodeClient

public OkHttpNodeClient(okhttp3.OkHttpClient client,
                        int port,
                        java.lang.String baseUrl,
                        java.lang.String wsUrl)

Method Detail

startWsAction

public void startWsAction(ExecRequest wsReq,
                          ProcessHandler ph)

isSsl

public boolean isSsl()

close

public void close()

ping

public void ping()
          throws ServerFault

Description copied from interface: INodeClient

Checks we can connect to a node.

Specified by:

ping in interface INodeClient

Throws:

ServerFault - if the connection does not work

read

public byte[] read(java.lang.String path)
            throws ServerFault

Description copied from interface: INodeClient

Fetches a file content into ram. If the file does not exist, a zero-length byte array is returned.

Specified by:

read in interface INodeClient

Returns:

Throws:

ServerFault

openStream

public java.io.InputStream openStream(java.lang.String path)
                               throws ServerFault

Description copied from interface: INodeClient

Opens a stream to a (maybe) remote file. Use this one when you can't predict the size of the file you want to read. WARNING: If you forget to close this stream, your BM Core will die from out of memory, too many open files, etc sooner or later.

Specified by:

openStream in interface INodeClient

Returns:

Throws:

ServerFault

writeFile

public void writeFile(java.lang.String path,
                      java.io.InputStream content)
               throws ServerFault

Description copied from interface: INodeClient

(Over)writes the file at path with content. Content is closed by this method. You don't need to do it in your code.

Specified by:

writeFile in interface INodeClient

Throws:

ServerFault

executeCommand

public TaskRef executeCommand(java.lang.String cmd)
                       throws ServerFault

Description copied from interface: INodeClient

Starts a command in backend and returns a ref to track its progress. Task return a String list as output.

Specified by:

executeCommand in interface INodeClient

Returns:

Throws:

ServerFault

executeCommand

public TaskRef executeCommand(ExecRequest tsk)
                       throws ServerFault

Description copied from interface: INodeClient

Runs a command. The optional ExecRequest.group and ExecRequest.name can be used to provide a stable name to tasks

Specified by:

executeCommand in interface INodeClient

Returns:

Throws:

ServerFault

asyncExecute

public void asyncExecute(ExecRequest req,
                         ProcessHandler ph)

Specified by:

asyncExecute in interface INodeClient

getActiveExecutions

public java.util.List<ExecDescriptor> getActiveExecutions(ActiveExecQuery query)

Description copied from interface: INodeClient

Returns a list of running process matching the given query object. ActiveExecQuery.group and ActiveExecQuery.name might be null for wider matches.

Specified by:

getActiveExecutions in interface INodeClient

Returns:

interrupt

public void interrupt(ExecDescriptor runningTask)

Specified by:

interrupt in interface INodeClient

executeCommandNoOut

public TaskRef executeCommandNoOut(java.lang.String cmd)
                            throws ServerFault

Description copied from interface: INodeClient

Starts a command in backend and returns a ref to track its progress No output, receive "Done" when command finish.

Specified by:

executeCommandNoOut in interface INodeClient

Returns:

Throws:

ServerFault

getExecutionStatus

public TaskStatus getExecutionStatus(TaskRef task)
                              throws ServerFault

Description copied from interface: INodeClient

Tracks the progress of a task

Specified by:

getExecutionStatus in interface INodeClient

Returns:

Throws:

ServerFault

listFiles

public java.util.List<FileDescription> listFiles(java.lang.String path,
                                                 java.lang.String extensionPattern)
                                          throws ServerFault

Description copied from interface: INodeClient

List files from path matching extension. Task return a list of FileDescription as output

Specified by:

listFiles in interface INodeClient

Returns:

empty list when the path does not exist

Throws:

ServerFault

listFiles

public java.util.List<FileDescription> listFiles(java.lang.String path)
                                          throws ServerFault

Description copied from interface: INodeClient

List files from path. Task return a FileDescription list as output.

Specified by:

listFiles in interface INodeClient

Returns:

empty list when the path does not exist

Throws:

ServerFault

deleteFile

public void deleteFile(java.lang.String path)
                throws ServerFault

Description copied from interface: INodeClient

Delete a file

Specified by:

deleteFile in interface INodeClient

Throws:

ServerFault