com.mulesoft.cloudhub.client

Interface CloudHubDomainConnectionI

All Superinterfaces:

CloudHubConnectionI

All Known Implementing Classes:

CloudHubDomainConnectionImpl

public interface CloudHubDomainConnectionI
extends CloudHubConnectionI

Method Summary

Methods

Modifier and Type	Method and Description
com.mulesoft.ch.rest.model.Tenant	createTenant(com.mulesoft.ch.rest.model.Tenant tenant) Creates a tenant in the given domain based on the given object
void	deleteApplication() Deletes the application by using the connection's domain.
void	deleteTenant(String tenantId) Deletes a tenant from the given domain based on the given tenant id
void	deleteTenantClientCertificates(String tenantId) This method revokes current certificates for the given tenant from the given domain
void	deleteTenants(List<String> tenantIds) Deletes a bunch of tenant from the given domain based on the given tenant ids
void	deployApplication(File file, long waitMaxTime) Deploys an application with the provided fileStream
void	deployApplication(InputStream fileStream, long waitMaxTime) Deploys an application with the provided fileStream
File	downloadApplicationLog(Map<String,String> queryParams) Downloads the application's logs as a file
String	getDomain() Returns the connected domain
com.mulesoft.ch.rest.model.Application	retrieveApplication() Retrieves the application based on the connected domain
com.mulesoft.ch.rest.model.LogResults	retrieveApplicationLog(Map<String,String> queryParams) Retrieves the application's logs
com.mulesoft.ch.rest.model.ApplicationStatus	retrieveApplicationStatus() Retrieves the application's status
com.mulesoft.ch.rest.model.Tenant	retrieveTenant(String tenantId) Retrieves an specific tenant from the given domain based on the given tenantId
InputStream	retrieveTenantClientCertificates(String tenantId) This method generates a new set of certificates used to establish a VPN connection between the given tenant and the remote location.
com.mulesoft.ch.rest.model.TenantResults	retrieveTenants(Integer limit, Integer offset, String query, Boolean enabled) Retrieves tenants from the given domain using the given parameters as filters.
com.mulesoft.ch.rest.model.Application	updateApplication(com.mulesoft.ch.rest.model.ApplicationUpdateInfo application) Updates an application's information on your CloudHub account.
void	updateApplicationStatus(com.mulesoft.ch.rest.model.ApplicationStatusChange applicationStatus, long waitMaxTime) Updates an application's status based on some specific commands.
com.mulesoft.ch.rest.model.Tenant	updateTenant(com.mulesoft.ch.rest.model.Tenant tenant) Updates a tenant in the given domain based on the given object

Methods inherited from interface com.mulesoft.cloudhub.client.CloudHubConnectionI

connectWithDomain, createApplication, createConnection, createNotification, getAccessToken, getEnvironmentId, getPassword, getSupportedMuleVersions, getUrl, getUsername, isCsAuthentication, isDomainAvailable, retrieveAccount, retrieveApplications, retrieveNotification, retrieveNotifications, updateNotificationsStatus, updateNotificationStatus

Method Detail

getDomain

String getDomain()

Returns the connected domain

Returns:

the connected domain

retrieveApplication

com.mulesoft.ch.rest.model.Application retrieveApplication()
                                                           throws CloudHubException

Retrieves the application based on the connected domain

Returns:

an instance of Application

Throws:

CloudHubException - if the domain does not exist

retrieveApplicationStatus

com.mulesoft.ch.rest.model.ApplicationStatus retrieveApplicationStatus()
                                                                       throws CloudHubException

Retrieves the application's status

Returns:

one of com.mulesoft.ch.rest.model.Application.ApplicationStatus

Throws:

CloudHubException - if there was an error when retrieving the application status

retrieveApplicationLog

com.mulesoft.ch.rest.model.LogResults retrieveApplicationLog(Map<String,String> queryParams)
                                                             throws CloudHubException

Retrieves the application's logs

Returns:

one of LogResults

Throws:

CloudHubException - if there was an error when retrieving the application logs

downloadApplicationLog

File downloadApplicationLog(Map<String,String> queryParams)
                            throws CloudHubException

Downloads the application's logs as a file

Returns:

one of File

Throws:

CloudHubException - if there was an error when retrieving the application logs

deployApplication

void deployApplication(InputStream fileStream,
                     long waitMaxTime)
                       throws CloudHubException

Deploys an application with the provided fileStream

Parameters:

fileStream - the stream containing the zip to be deployed

waitMaxTime - Maximum time allowed to deploy/undeploy in miliseconds. Case 1: 0, the connector won't wait CH to finish the deploy/undeploy process and will return a response based on CH API response status. Case 2: 1, the connector will wait until CH finish the deploy/undeploy process and will throw an exception if the deploy fails. Case 3: anyOthervalue, the connector will wait that amount of miliseconds for CH to finish the deploy/undeploy process. If takes longer, it will throw an exception. If takes shorter, it will follow the same process as case 2.

Throws:

CloudHubException - if there was an error while deploying the application

deployApplication

void deployApplication(File file,
                     long waitMaxTime)
                       throws CloudHubException

Deploys an application with the provided fileStream

Parameters:

file - the file to be deployed

waitMaxTime - Maximum time allowed to deploy/undeploy in miliseconds. Case 1: 0, the connector won't wait CH to finish the deploy/undeploy process and will return a response based on CH API response status. Case 2: 1, the connector will wait until CH finish the deploy/undeploy process and will throw an exception if the deploy fails. Case 3: anyOthervalue, the connector will wait that amount of miliseconds for CH to finish the deploy/undeploy process. If takes longer, it will throw an exception. If takes shorter, it will follow the same process as case 2.

Throws:

CloudHubException - if there was an error while deploying the application

updateApplication

com.mulesoft.ch.rest.model.Application updateApplication(com.mulesoft.ch.rest.model.ApplicationUpdateInfo application)
                                                         throws CloudHubException

Updates an application's information on your CloudHub account. This method just updates metaData like Mule Version, Description, etc. If you want to update a new stream, use deployApplication(java.io.InputStream, long) instead

Parameters:

applicationInfo - an instance of ApplicationUpdateInfo with the information to be updated

Returns:

an instance of Application containing all the new application's information provided by CloudHub

Throws:

CloudHubException - if there was an error while updating the application

updateApplicationStatus

void updateApplicationStatus(com.mulesoft.ch.rest.model.ApplicationStatusChange applicationStatus,
                           long waitMaxTime)
                             throws CloudHubException

Updates an application's status based on some specific commands. Can be START or STOP

Parameters:

applicationStatus - an instance of com.mulesoft.cloudhub.client.ApplicationStatusChange with the new application status

waitMaxTime - Maximum time allowed to deploy/undeploy in miliseconds. Case 1: 0, the connector won't wait CH to finish the deploy/undeploy process and will return a response based on CH API response status. Case 2: 1, the connector will wait until CH finish the deploy/undeploy process and will throw an exception if the deploy fails. Case 3: anyOthervalue, the connector will wait that amount of miliseconds for CH to finish the deploy/undeploy process. If takes longer, it will throw an exception. If takes shorter, it will follow the same process as case 2.

Throws:

CloudHubException - if there was an error while updating the application's status.

deleteApplication

void deleteApplication()
                       throws CloudHubException

Deletes the application by using the connection's domain. The domain can not be invalid since it was validated when creating the connection.

Throws:

CloudHubException - if there was an error while deleting the application

retrieveTenants

com.mulesoft.ch.rest.model.TenantResults retrieveTenants(Integer limit,
                                                       Integer offset,
                                                       String query,
                                                       Boolean enabled)
                                                         throws CloudHubException

Retrieves tenants from the given domain using the given parameters as filters.

Parameters:

limit - Optional. The maximum number of tenants you want to receive in each call.

offset - Optional. The off you want to start querying from.

query - Optional.

enabled - Optional. Flag indicating if you want to retrieve only enabled or disabled

Returns:

an instance of TenantResults

Throws:

CloudHubException - if there was an error while retrieving the tenants

retrieveTenant

com.mulesoft.ch.rest.model.Tenant retrieveTenant(String tenantId)
                                                 throws CloudHubException

Retrieves an specific tenant from the given domain based on the given tenantId

Parameters:

tenantId - The id the tenant you want to retrieve

Returns:

an instance of Tenant containing all the information provided by CloudHub

Throws:

CloudHubException - if there was an error while retrieving the tenant

retrieveTenantClientCertificates

InputStream retrieveTenantClientCertificates(String tenantId)
                                             throws CloudHubException

This method generates a new set of certificates used to establish a VPN connection between the given tenant and the remote location. Take into account that if the tenant already had a set of certificates, using this method will automatically revoke old ones and only those returned by current invocation will work.

Parameters:

tenantId - the id of the tenant you want to generate tenant certificates

Returns:

an instance of InputStream. A zip file containing new certificates

Throws:

CloudHubException - if there was an error while generating new certificates

createTenant

com.mulesoft.ch.rest.model.Tenant createTenant(com.mulesoft.ch.rest.model.Tenant tenant)
                                               throws CloudHubException

Creates a tenant in the given domain based on the given object

Parameters:

tenant - an instance of Tenant with the information

Returns:

an instance of Tenant containing all the information provided by CloudHub

Throws:

CloudHubException - if there was an error while creating the tenant

updateTenant

com.mulesoft.ch.rest.model.Tenant updateTenant(com.mulesoft.ch.rest.model.Tenant tenant)
                                               throws CloudHubException

Updates a tenant in the given domain based on the given object

Parameters:

tenant - an instance of Tenant with the information

Returns:

an instance of Tenant containing all the information provided by CloudHub

Throws:

CloudHubException - if there was an error while updating the tenant

deleteTenant

void deleteTenant(String tenantId)
                  throws CloudHubException

Deletes a tenant from the given domain based on the given tenant id

Parameters:

tenantId - the id of the tenant you want to delete

Throws:

CloudHubException - if there was an error while deleting the tenant

deleteTenants

void deleteTenants(List<String> tenantIds)
                   throws CloudHubException

Deletes a bunch of tenant from the given domain based on the given tenant ids

Parameters:

tenantIds - the list of tenant's ids you want to delete. IMPORTANT: If null or empty, all tenants will be deleted.

Throws:

CloudHubException - if there was an error while deleting the tenants

deleteTenantClientCertificates

void deleteTenantClientCertificates(String tenantId)
                                    throws CloudHubException

This method revokes current certificates for the given tenant from the given domain

Parameters:

tenantId - the id of the tenant you want to generate tenant certificates

Throws:

CloudHubException - if there was an error while deleting certificates