net.scattersphere.api

Class Client

java.lang.Object

net.scattersphere.api.Client

public class Client
extends Object

This portion of the API handles commands sent to a client endpoint. This API is designed to make it easier to programmatically control jobs on servers, and control servers. Created by kenji on 1/2/15.

Constructor Summary

Constructors

Constructor and Description
Client() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addClient(String clientName, String clientAddress) Adds a connection to a server, assigning a name to that connection.
ClientConnection	getClientConnection(String clientName) Retrieves the underlying ClientConnection, which is the communication layer to the endpoint.
void	listJobs(String clientName) Requests a list of jobs from the specified server.
void	listJobs(String clientName, String jobType)
void	onConnect(Consumer<String> function) Lambda function called when a connection is successful.
void	onDisconnect(Consumer<String> function) Lambda function called when a connection is lost, or dropped.
void	onMessage(BiConsumer<String,net.scattersphere.data.message.JobMessage> function) Lambda function called when a message is received from a server.
void	send(String clientName, net.scattersphere.data.message.JobMessage message) Sends a message to the specified server.
void	startJob(String clientName, String jobName, String[] arguments) Starts a job by name, with specified arguments.
void	statusJob(String clientName, String jobId) Retrieves status for a job by ID.
void	stopJob(String clientName, String jobId, String reason) Stops a job by its ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Constructor.

Method Detail

addClient

public void addClient(String clientName,
                      String clientAddress)

Adds a connection to a server, assigning a name to that connection.

Parameters:

clientName - The name of the connection to assign.

clientAddress - The address to connect to.

getClientConnection

public ClientConnection getClientConnection(String clientName)

Retrieves the underlying ClientConnection, which is the communication layer to the endpoint. This is available for use if required.

Parameters:

clientName - The name of the connection to retrieve.

Returns:

ClientConnection if found.

listJobs

public void listJobs(String clientName)

Requests a list of jobs from the specified server.

Parameters:

clientName - The server to request jobs from.

listJobs

public void listJobs(String clientName,
                     String jobType)

startJob

public void startJob(String clientName,
                     String jobName,
                     String[] arguments)

Starts a job by name, with specified arguments.

Parameters:

clientName - The server to start a job on.

jobName - The name of the job to start.

arguments - The arguments to send to the job.

stopJob

public void stopJob(String clientName,
                    String jobId,
                    String reason)

Stops a job by its ID.

Parameters:

clientName - The server to stop a job on.

jobId - The ID of the job to stop.

statusJob

public void statusJob(String clientName,
                      String jobId)

Retrieves status for a job by ID.

Parameters:

clientName - The server to get a job status from.

jobId - The ID of the job to retrieve status for.

onConnect

public void onConnect(Consumer<String> function)

Lambda function called when a connection is successful.

Parameters:

function - The Consumer function to set.

onDisconnect

public void onDisconnect(Consumer<String> function)

Lambda function called when a connection is lost, or dropped.

Parameters:

function - The Consumer function to set.

onMessage

public void onMessage(BiConsumer<String,net.scattersphere.data.message.JobMessage> function)

Lambda function called when a message is received from a server.

Parameters:

function - The BiConsumer function to set.

send

public void send(String clientName,
                 net.scattersphere.data.message.JobMessage message)

Sends a message to the specified server.

Parameters:

clientName - The server to send a message to.

message - The message to send.