com.mulesoft.cloudhub.client

Class CloudHubDomainConnectionImpl

java.lang.Object

com.mulesoft.cloudhub.client.CloudHubConnectionImpl

com.mulesoft.cloudhub.client.CloudHubDomainConnectionImpl

All Implemented Interfaces:

CloudHubConnectionI, CloudHubDomainConnectionI

public class CloudHubDomainConnectionImpl
extends CloudHubConnectionImpl
implements CloudHubDomainConnectionI

Nested Class Summary

Nested classes/interfaces inherited from class com.mulesoft.cloudhub.client.CloudHubConnectionImpl

CloudHubConnectionImpl.ObjectMapper

Field Summary

Fields inherited from class com.mulesoft.cloudhub.client.CloudHubConnectionImpl

accessToken, apiToken, client, csAuthentication, DEFAULT_URL, environmentId, logger, NEW_DEFAULT_URL, password, url, username

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudHubDomainConnectionImpl(CloudHubConnectionI con, boolean csAuthentication, String domain)
protected	CloudHubDomainConnectionImpl(CloudHubConnectionI con, String domain)
	CloudHubDomainConnectionImpl(String url, String accessToken, boolean debug)
	CloudHubDomainConnectionImpl(String url, String accessToken, String environmentId, boolean debug)

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 maxWaitTime) Deploys an application with the provided fileStream
void	deployApplication(InputStream fileStream, long maxWaitTime) 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 newApplicationInfo) Updates an application's information on your CloudHub account.
void	updateApplicationStatus(com.mulesoft.ch.rest.model.ApplicationStatusChange applicationStatusChange, long maxWaitTime) 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 class com.mulesoft.cloudhub.client.CloudHubConnectionImpl

authorizeResource, buildExpception, connectWithDomain, createApplication, createApplicationBuilder, createBuilder, createConnection, createNotification, createNotificationBuilder, createResource, getAccessToken, getEnvironmentId, getPassword, getSupportedMuleVersions, getUrl, getUsername, init, isCsAuthentication, isDomainAvailable, retrieveAccount, retrieveApplications, retrieveNotification, retrieveNotifications, updateNotificationsStatus, updateNotificationStatus

Methods inherited from class java.lang.Object

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

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

Constructor Detail

CloudHubDomainConnectionImpl

protected CloudHubDomainConnectionImpl(CloudHubConnectionI con,
                            String domain)

CloudHubDomainConnectionImpl

protected CloudHubDomainConnectionImpl(CloudHubConnectionI con,
                            boolean csAuthentication,
                            String domain)

CloudHubDomainConnectionImpl

public CloudHubDomainConnectionImpl(String url,
                            String accessToken,
                            boolean debug)

CloudHubDomainConnectionImpl

public CloudHubDomainConnectionImpl(String url,
                            String accessToken,
                            String environmentId,
                            boolean debug)

Method Detail

getDomain

public String getDomain()

Description copied from interface: CloudHubDomainConnectionI

Returns the connected domain

Specified by:

getDomain in interface CloudHubDomainConnectionI

Returns:

the connected domain

retrieveApplication

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

Description copied from interface: CloudHubDomainConnectionI

Retrieves the application based on the connected domain

Specified by:

retrieveApplication in interface CloudHubDomainConnectionI

Returns:

an instance of Application

Throws:

CloudHubException - if the domain does not exist

retrieveApplicationLog

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

Description copied from interface: CloudHubDomainConnectionI

Retrieves the application's logs

Specified by:

retrieveApplicationLog in interface CloudHubDomainConnectionI

Returns:

one of LogResults

Throws:

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

downloadApplicationLog

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

Description copied from interface: CloudHubDomainConnectionI

Downloads the application's logs as a file

Specified by:

downloadApplicationLog in interface CloudHubDomainConnectionI

Returns:

one of File

Throws:

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

retrieveApplicationStatus

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

Description copied from interface: CloudHubDomainConnectionI

Retrieves the application's status

Specified by:

retrieveApplicationStatus in interface CloudHubDomainConnectionI

Returns:

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

Throws:

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

deployApplication

public void deployApplication(InputStream fileStream,
                     long maxWaitTime)

Description copied from interface: CloudHubDomainConnectionI

Deploys an application with the provided fileStream

Specified by:

deployApplication in interface CloudHubDomainConnectionI

Parameters:

fileStream - the stream containing the zip to be deployed

maxWaitTime - 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.

deployApplication

public void deployApplication(File file,
                     long maxWaitTime)

Description copied from interface: CloudHubDomainConnectionI

Deploys an application with the provided fileStream

Specified by:

deployApplication in interface CloudHubDomainConnectionI

Parameters:

file - the file to be deployed

maxWaitTime - 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.

updateApplication

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

Description copied from interface: CloudHubDomainConnectionI

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 CloudHubDomainConnectionI.deployApplication(java.io.InputStream, long) instead

Specified by:

updateApplication in interface CloudHubDomainConnectionI

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

public void updateApplicationStatus(com.mulesoft.ch.rest.model.ApplicationStatusChange applicationStatusChange,
                           long maxWaitTime)
                             throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

updateApplicationStatus in interface CloudHubDomainConnectionI

Parameters:

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

maxWaitTime - 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

public void deleteApplication()
                       throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

deleteApplication in interface CloudHubDomainConnectionI

Throws:

CloudHubException - if there was an error while deleting the application

retrieveTenants

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

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

retrieveTenants in interface CloudHubDomainConnectionI

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

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

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

retrieveTenant in interface CloudHubDomainConnectionI

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

public InputStream retrieveTenantClientCertificates(String tenantId)
                                             throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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.

Specified by:

retrieveTenantClientCertificates in interface CloudHubDomainConnectionI

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

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

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

createTenant in interface CloudHubDomainConnectionI

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

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

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

updateTenant in interface CloudHubDomainConnectionI

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

public void deleteTenant(String tenantId)
                  throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

deleteTenant in interface CloudHubDomainConnectionI

Parameters:

tenantId - the id of the tenant you want to delete

Throws:

CloudHubException - if there was an error while deleting the tenant

deleteTenants

public void deleteTenants(List<String> tenantIds)
                   throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

deleteTenants in interface CloudHubDomainConnectionI

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

public void deleteTenantClientCertificates(String tenantId)
                                    throws CloudHubException

Description copied from interface: CloudHubDomainConnectionI

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

Specified by:

deleteTenantClientCertificates in interface CloudHubDomainConnectionI

Parameters:

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

Throws:

CloudHubException - if there was an error while deleting certificates