com.github.automately.java

Class Automately

java.lang.Object

com.github.automately.java.Automately

public class Automately
extends Object

The Automately static class provides a simple interface to interact with the Automately API and MessageBus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Automately.MessageBus The MessageBus is a pretty powerful feature that Automately offers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_ENDPOINT
protected static okhttp3.OkHttpClient	httpClient

Constructor Summary

Constructors

Constructor and Description
Automately()

Method Summary

Modifier and Type	Method and Description
protected static void	checkAuthorized(String response)
static VirtualFile	createFile(String name, String pathAlias, byte[] data, boolean isPublic)
static boolean	deleteFile(String token)
static boolean	downloadFile(String token, Path destination)
static boolean	downloadPublicFile(String token, Path destination)
static boolean	downloadPublicFile(String token, Path destination, String username)
static boolean	fileExists(String fullPath)
static VirtualFile	findFile(String fullPath)
static String	getApiEndpoint() This will return the HTTP REST API endpoint that the Automately library will use.
static String	getApiKey() This will return the API key that the Automately library will use.
static String	getApiUsername() This returns the username that you have specified for the Automately library to use.
static VirtualFile	getFile(String token)
static Collection<VirtualFile>	getFiles()
static Collection<VirtualFile>	getFiles(int page)
static Collection<VirtualFile>	getFiles(int page, int count)
static Collection<VirtualFile>	getFiles(int page, int count, String path)
static Collection<VirtualFile>	getFiles(int page, int count, String path, String name)
static Collection<VirtualFile>	getFiles(int page, int count, String path, String name, boolean recursive)
protected static void	getFormattedError(String errorCode, String message)
static Job	getJob(String token)
static String	getJobConsole(String token)
static Collection<Job>	getJobs()
static Collection<Job>	getJobs(int page)
static Collection<Job>	getJobs(int page, int count)
static VirtualFile	getPublicFile(String token)
static VirtualFile	getPublicFile(String token, String username)
static Collection<VirtualFile>	getPublicFiles()
static Collection<VirtualFile>	getPublicFiles(int page)
static Collection<VirtualFile>	getPublicFiles(int page, int count)
static Collection<VirtualFile>	getPublicFiles(int page, int count, String path)
static Collection<VirtualFile>	getPublicFiles(int page, int count, String path, String name)
static Collection<VirtualFile>	getPublicFiles(int page, int count, String path, String name, boolean recursive)
static Collection<VirtualFile>	getPublicFiles(int page, int count, String path, String name, boolean recursive, String username)
static Collection<Job>	getRunningJobs()
static Collection<Job>	getRunningJobs(int page)
static Collection<Job>	getRunningJobs(int page, int count)
static Collection<Job>	getRunningServices()
static Collection<Job>	getRunningServices(int page)
static Collection<Job>	getRunningServices(int page, int count)
static io.jsync.json.JsonObject	getUserInfo() This method will return a JsonObject with some basic user information from the cluster such as your private api key and your public api key.
static boolean	pathExists(String fullPath)
static void	setApiEndpoint(String endpoint) This is used to set the HTTP REST API endpoint that the Automately library will use.
static void	setApiKey(String apiKey) This will set the apiKey that the Automately library will use.
static void	setApiUsername(String username) This will set the username that the Automately library will use.
static Job	startJob(boolean attachConsole, io.jsync.json.JsonObject config)
static Job	startJob(io.jsync.json.JsonObject config)
static Job	startJob(String scriptData, String scriptPath)
static Job	startJob(String scriptData, String scriptPath, boolean attachConsole)
static Job	startJob(String scriptData, String scriptPath, boolean attachConsole, io.jsync.json.JsonObject config)
static boolean	stopJob(String jobToken)
static VirtualFile	updateFile(String token, String name, String pathAlias, byte[] data)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_API_ENDPOINT

public static String DEFAULT_API_ENDPOINT

httpClient

protected static okhttp3.OkHttpClient httpClient

Constructor Detail

Automately

public Automately()

Method Detail

checkAuthorized

protected static void checkAuthorized(String response)

getFormattedError

protected static void getFormattedError(String errorCode,
                                        String message)

getApiEndpoint

public static String getApiEndpoint()

This will return the HTTP REST API endpoint that the Automately library will use.

Returns:

the REST API Endpoint

setApiEndpoint

public static void setApiEndpoint(String endpoint)

This is used to set the HTTP REST API endpoint that the Automately library will use.

Parameters:

endpoint - the api endpoint the library is using

getApiUsername

public static String getApiUsername()

This returns the username that you have specified for the Automately library to use.

Returns:

the username the library is using

setApiUsername

public static void setApiUsername(String username)

This will set the username that the Automately library will use.

Parameters:

username - the username you wish to use

getApiKey

public static String getApiKey()

This will return the API key that the Automately library will use.

Returns:

the api key the library is using

setApiKey

public static void setApiKey(String apiKey)

This will set the apiKey that the Automately library will use.

Parameters:

apiKey - the apiKey you wish to use

getUserInfo

public static io.jsync.json.JsonObject getUserInfo()

This method will return a JsonObject with some basic user information from the cluster such as your private api key and your public api key.

Returns:

getPublicFiles

public static Collection<VirtualFile> getPublicFiles()

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page)

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page,
                                                     int count)

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page,
                                                     int count,
                                                     String path)

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page,
                                                     int count,
                                                     String path,
                                                     String name)

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page,
                                                     int count,
                                                     String path,
                                                     String name,
                                                     boolean recursive)

getPublicFiles

public static Collection<VirtualFile> getPublicFiles(int page,
                                                     int count,
                                                     String path,
                                                     String name,
                                                     boolean recursive,
                                                     String username)

getPublicFile

public static VirtualFile getPublicFile(String token)

getPublicFile

public static VirtualFile getPublicFile(String token,
                                        String username)

downloadPublicFile

public static boolean downloadPublicFile(String token,
                                         Path destination)

downloadPublicFile

public static boolean downloadPublicFile(String token,
                                         Path destination,
                                         String username)

getFiles

public static Collection<VirtualFile> getFiles()

getFiles

public static Collection<VirtualFile> getFiles(int page)

getFiles

public static Collection<VirtualFile> getFiles(int page,
                                               int count)

getFiles

public static Collection<VirtualFile> getFiles(int page,
                                               int count,
                                               String path)

getFiles

public static Collection<VirtualFile> getFiles(int page,
                                               int count,
                                               String path,
                                               String name)

getFiles

public static Collection<VirtualFile> getFiles(int page,
                                               int count,
                                               String path,
                                               String name,
                                               boolean recursive)

getFile

public static VirtualFile getFile(String token)

updateFile

public static VirtualFile updateFile(String token,
                                     String name,
                                     String pathAlias,
                                     byte[] data)

createFile

public static VirtualFile createFile(String name,
                                     String pathAlias,
                                     byte[] data,
                                     boolean isPublic)

deleteFile

public static boolean deleteFile(String token)

downloadFile

public static boolean downloadFile(String token,
                                   Path destination)

pathExists

public static boolean pathExists(String fullPath)

fileExists

public static boolean fileExists(String fullPath)

findFile

public static VirtualFile findFile(String fullPath)

startJob

public static Job startJob(boolean attachConsole,
                           io.jsync.json.JsonObject config)

startJob

public static Job startJob(io.jsync.json.JsonObject config)

startJob

public static Job startJob(String scriptData,
                           String scriptPath)

startJob

public static Job startJob(String scriptData,
                           String scriptPath,
                           boolean attachConsole)

startJob

public static Job startJob(String scriptData,
                           String scriptPath,
                           boolean attachConsole,
                           io.jsync.json.JsonObject config)

stopJob

public static boolean stopJob(String jobToken)

getRunningServices

public static Collection<Job> getRunningServices()

getRunningServices

public static Collection<Job> getRunningServices(int page)

getRunningServices

public static Collection<Job> getRunningServices(int page,
                                                 int count)

getRunningJobs

public static Collection<Job> getRunningJobs()

getRunningJobs

public static Collection<Job> getRunningJobs(int page)

getRunningJobs

public static Collection<Job> getRunningJobs(int page,
                                             int count)

getJobs

public static Collection<Job> getJobs()

getJobs

public static Collection<Job> getJobs(int page)

getJobs

public static Collection<Job> getJobs(int page,
                                      int count)

getJob

public static Job getJob(String token)

getJobConsole

public static String getJobConsole(String token)