net.bluemind.node.api

Interface INodeClient

All Known Implementing Classes:

AHCHttpNodeClient, OkHttpNodeClient

public interface INodeClient

local or remote BM Host manipulation API.

Method Summary

Modifier and Type	Method and Description
void	asyncExecute(ExecRequest req, ProcessHandler ph)
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)
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	writeFile(java.lang.String path, java.io.InputStream content) (Over)writes the file at path with content.

Method Detail

ping

void ping()
   throws ServerFault

Checks we can connect to a node.

Throws:

ServerFault - if the connection does not work

read

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

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

Parameters:

path -

Returns:

Throws:

ServerFault

openStream

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

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.

Parameters:

path -

Returns:

Throws:

ServerFault

writeFile

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

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

Parameters:

path -

content -

Throws:

ServerFault

executeCommand

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

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

Parameters:

cmd -

Returns:

Throws:

ServerFault

executeCommand

TaskRef executeCommand(ExecRequest tsk)
                throws ServerFault

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

Parameters:

tsk -

Returns:

Throws:

ServerFault

asyncExecute

void asyncExecute(ExecRequest req,
                  ProcessHandler ph)

getActiveExecutions

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

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

Returns:

interrupt

void interrupt(ExecDescriptor runningTask)

executeCommandNoOut

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

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

Parameters:

cmd -

Returns:

Throws:

ServerFault

getExecutionStatus

TaskStatus getExecutionStatus(TaskRef task)
                       throws ServerFault

Tracks the progress of a task

Parameters:

task -

Returns:

Throws:

ServerFault

listFiles

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

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

Parameters:

path -

extensionPattern -

Returns:

empty list when the path does not exist

Throws:

ServerFault

listFiles

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

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

Parameters:

path -

extensionPattern -

Returns:

empty list when the path does not exist

Throws:

ServerFault

deleteFile

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

Delete a file

Parameters:

path -

Throws:

ServerFault