org.mule.tools.client.cloudhub

Class CloudHubClient

java.lang.Object

org.mule.tools.client.core.AbstractClient

org.mule.tools.client.AbstractMuleClient

org.mule.tools.client.cloudhub.CloudHubClient

public class CloudHubClient
extends AbstractMuleClient

Client to hit the CloudHub API

Field Summary

Fields

Modifier and Type	Field and Description
static String	A_APPLICATION_LOGS
static String	A_APPLICATION_PATH
static String	A_INSTANCE_LOGS
static String	APPLICATION_ENVIRONMENT
static String	APPLICATION_STATUS
static String	APPLICATIONS_DOMAINS_PATH
static String	APPLICATIONS_PATH
static String	BASE_API_PATH
static String	BASE_API_VERSION_PATH
static String	DEPLOYMENTS_PATH
static String	SUPPORTED_VERSIONS_PATH

Fields inherited from class org.mule.tools.client.AbstractMuleClient

authenticationServiceClient, baseUri, CLIENT, DEFAULT_BASE_URL, ID, NAME, ORGANIZATION, SUB_ORGANIZATION_IDS, UNAUTHORIZED, USER

Fields inherited from class org.mule.tools.client.core.AbstractClient

log

Constructor Summary

Constructors

Constructor and Description
CloudHubClient(CloudHubDeployment cloudhubDeployment, DeployerLog log)

Method Summary

Modifier and Type	Method and Description
Application	createApplication(Application application, File file) Creates an Application
void	deleteApplications(String domain) Deletes an Application based on its domain name
List<Application>	getApplications() Look up all the applications
Application	getApplications(String domain) Look up a Application based on its domain name
List<Deployment>	getDeployments(Application application) Retrieve the list of Deployment for an Application
InputStream	getEntireLogs(Application application, String instanceId) Retrieves the entire logs records from an Application given the instanceId
Environment	getEnvironment()
List<LogRecord>	getLogs(Application application, DeploymentLogRequest deploymentLogRequest) Retrieves the logs records from an Application given a DeploymentLogRequest
List<SupportedVersion>	getSupportedMuleVersions() Retrieve a list of SupportedVersion
boolean	isDomainAvailable(String domain) It checks the availability of a given doamain name
void	startApplications(String domain) Starts an Application based on its domain name
void	stopApplications(String domain) Stops an Application based on its domain name
Application	updateApplication(Application application, File file) Update an already existing Application

Methods inherited from class org.mule.tools.client.AbstractMuleClient

buildOrganization, configureRequest, createBusinessGroupPath, findEnvironmentByName, getBusinessGroupIdByBusinessGroupPath, getEnvId, getEnvironments, getMe, getOrgId, getSuborganizationIds, init, renewToken

Methods inherited from class org.mule.tools.client.core.AbstractClient

checkResponseStatus, checkResponseStatus, configureSecurityContext, delete, delete, get, get, get, getTarget, getUserAgent, initialize, patch, patch, post, post, post, put, put, readJsonEntity, setUserAgent

Methods inherited from class java.lang.Object

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

Field Detail

BASE_API_PATH

public static final String BASE_API_PATH

See Also:

Constant Field Values

SUPPORTED_VERSIONS_PATH

public static final String SUPPORTED_VERSIONS_PATH

See Also:

Constant Field Values

APPLICATION_STATUS

public static final String APPLICATION_STATUS

See Also:

Constant Field Values

APPLICATIONS_DOMAINS_PATH

public static final String APPLICATIONS_DOMAINS_PATH

See Also:

Constant Field Values

BASE_API_VERSION_PATH

public static final String BASE_API_VERSION_PATH

See Also:

Constant Field Values

APPLICATIONS_PATH

public static final String APPLICATIONS_PATH

See Also:

Constant Field Values

A_APPLICATION_PATH

public static final String A_APPLICATION_PATH

See Also:

Constant Field Values

A_APPLICATION_LOGS

public static final String A_APPLICATION_LOGS

See Also:

Constant Field Values

A_INSTANCE_LOGS

public static final String A_INSTANCE_LOGS

See Also:

Constant Field Values

DEPLOYMENTS_PATH

public static final String DEPLOYMENTS_PATH

See Also:

Constant Field Values

APPLICATION_ENVIRONMENT

public static final String APPLICATION_ENVIRONMENT

See Also:

Constant Field Values

Constructor Detail

CloudHubClient

public CloudHubClient(CloudHubDeployment cloudhubDeployment,
                      DeployerLog log)

Method Detail

getApplications

public List<Application> getApplications()

Look up all the applications

Returns:

a list with all the Application

getApplications

public Application getApplications(String domain)

Look up a Application based on its domain name

Parameters:

domain - the domain name of the application

Returns:

null if none found, otherwise the Application

createApplication

public Application createApplication(Application application,
                                     File file)

Creates an Application

Parameters:

application - the Application entity

file - the file of the Application

Returns:

the Application just created

updateApplication

public Application updateApplication(Application application,
                                     File file)

Update an already existing Application

Parameters:

application - the Application entity

file - the file of the Application

Returns:

the Application just updated

deleteApplications

public void deleteApplications(String domain)

Deletes an Application based on its domain name

Parameters:

domain - the domain name of the application

startApplications

public void startApplications(String domain)

Starts an Application based on its domain name

Parameters:

domain - the domain name of the application

stopApplications

public void stopApplications(String domain)

Stops an Application based on its domain name

Parameters:

domain - the domain name of the application

isDomainAvailable

public boolean isDomainAvailable(String domain)

It checks the availability of a given doamain name

Parameters:

domain - the domain name

Returns:

false if the domain is not available, true otherwise

getSupportedMuleVersions

public List<SupportedVersion> getSupportedMuleVersions()

Retrieve a list of SupportedVersion

Returns:

a list of the SupportedVersion

getDeployments

public List<Deployment> getDeployments(Application application)

Retrieve the list of Deployment for an Application

Parameters:

application - the application

Returns:

a list of Deployment

getLogs

public List<LogRecord> getLogs(Application application,
                               DeploymentLogRequest deploymentLogRequest)

Retrieves the logs records from an Application given a DeploymentLogRequest

Parameters:

application - the application

deploymentLogRequest - the specific request filter for the logs

Returns:

a list of LogRecord

getEntireLogs

public InputStream getEntireLogs(Application application,
                                 String instanceId)

Retrieves the entire logs records from an Application given the instanceId

Parameters:

application - the application

instanceId - the id of the instance to get the logs

Returns:

a InputStream

getEnvironment

public Environment getEnvironment()