com.mulesoft.cloudhub.client

Interface CloudHubConnectionI

All Known Subinterfaces:

CloudHubDomainConnectionI

All Known Implementing Classes:

CloudHubConnectionImpl, CloudHubDomainConnectionImpl

public interface CloudHubConnectionI

Method Summary

Methods

Modifier and Type	Method and Description
CloudHubDomainConnectionI	connectWithDomain(String domain) Returns a connection against a given domain of the CloudHub account
com.mulesoft.ch.rest.model.Application	createApplication(com.mulesoft.ch.rest.model.Application application) Creates an application on your CloudHub account.
CloudHubConnectionI	createConnection(String url, String username, String password, String sandbox) Creates a connection against an specific CloudHub Account
com.mulesoft.ch.rest.model.Notification	createNotification(com.mulesoft.ch.rest.model.Notification notification) Creates a notification based on the given object
String	getAccessToken()
String	getEnvironmentId()
String	getPassword()
List<String>	getSupportedMuleVersions() This method returns all the supported mule versions by CloudHub
String	getUrl()
String	getUsername()
boolean	isCsAuthentication()
boolean	isDomainAvailable(String domain) Checks if the domain is valid and available
com.mulesoft.ch.rest.model.Account	retrieveAccount() Retrieves the CloudHub Account
Collection<com.mulesoft.ch.rest.model.Application>	retrieveApplications() Retrieves All Applications from an specific CloudHub account
com.mulesoft.ch.rest.model.Notification	retrieveNotification(String notificationId) Retrieves a single notification, based on the given id.
com.mulesoft.ch.rest.model.NotificationResults	retrieveNotifications(String domain, String tenantId, Integer limit, Integer offset, com.mulesoft.ch.rest.model.Notification.NotificationStatus status, String message) Retrieves a bunch of notifications based on given filters
void	updateNotificationsStatus(String domain, String tenantId, com.mulesoft.ch.rest.model.Notification.NotificationStatus newStatus) Updates all notifications status.
void	updateNotificationStatus(String notificationId, com.mulesoft.ch.rest.model.Notification.NotificationStatus newStatus) Updates a notification status.

Method Detail

getUrl

String getUrl()

getUsername

String getUsername()

getPassword

String getPassword()

getAccessToken

String getAccessToken()

getEnvironmentId

String getEnvironmentId()

isCsAuthentication

boolean isCsAuthentication()

createConnection

CloudHubConnectionI createConnection(String url,
                                   String username,
                                   String password,
                                   String sandbox)

Creates a connection against an specific CloudHub Account

Parameters:

url - Optional. CloudHub URL. If null, default value is https://cloudhub.io/

username - CloudHub username to log in

password - CloudHub password to log in

sandbox - Optional. Only necessary if you want to connect to the non-default sandbox of the account. If null, the connection will be established against the default sandbox

Returns:

an instance of CloudHubConnectionImpl

connectWithDomain

CloudHubDomainConnectionI connectWithDomain(String domain)

Returns a connection against a given domain of the CloudHub account

Parameters:

domain - the domain to which you want to connect

Returns:

an instance of CloudHubDomainConnectionImpl connected with the specified domain

retrieveAccount

com.mulesoft.ch.rest.model.Account retrieveAccount()
                                                   throws CloudHubException

Retrieves the CloudHub Account

Returns:

an instance of Account

Throws:

CloudHubException - if there is an error when retrieving the account

isDomainAvailable

boolean isDomainAvailable(String domain)
                          throws CloudHubException

Checks if the domain is valid and available

Parameters:

domain - the domain to be validated

Returns:

true if the domain is valid and available to be used. False if the domain is already taken.

Throws:

CloudHubException - if there is an error when validating the domain

retrieveApplications

Collection<com.mulesoft.ch.rest.model.Application> retrieveApplications()
                                                                        throws CloudHubException

Retrieves All Applications from an specific CloudHub account

Returns:

a collection of Application

Throws:

CloudHubException - if there is an error when retrieving the applications

createApplication

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

Creates an application on your CloudHub account. This method does not deploy your application.

Parameters:

application - an instance of Application containing all the application's information

Returns:

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

Throws:

CloudHubException - if there was an error while creating the application

retrieveNotifications

com.mulesoft.ch.rest.model.NotificationResults retrieveNotifications(String domain,
                                                                   String tenantId,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   com.mulesoft.ch.rest.model.Notification.NotificationStatus status,
                                                                   String message)
                                                                     throws CloudHubException

Retrieves a bunch of notifications based on given filters

Parameters:

domain - the domain you want to retrieve the notifications from

tenantId - the id of the tenant you want to retrieve the notifications from

limit - Optional. The maximum number of notifications you want to retrieve

offset - Optional. The beginning index from which notifications will be retrieved. For example, if you have an offset of 5, and your original search returns 10 notifications, only the last 5 notifications will be returned.

status - Optional. One of Notification.NotificationStatus

message - Optional. If provided, only notifications containing this message in their body will be returned.

Returns:

an instance of NotificationResults

Throws:

CloudHubException - if there was an error while retrieving of filtering the notifications

retrieveNotification

com.mulesoft.ch.rest.model.Notification retrieveNotification(String notificationId)
                                                             throws CloudHubException

Retrieves a single notification, based on the given id.

Parameters:

notificationId - The id of the notification you want to retrieve

Returns:

an instance of Notification

Throws:

CloudHubException - if there was an error while retrieving the specified notification

createNotification

com.mulesoft.ch.rest.model.Notification createNotification(com.mulesoft.ch.rest.model.Notification notification)
                                                           throws CloudHubException

Creates a notification based on the given object

Parameters:

notification - an instance of Notification you want to create

Returns:

an instance of Notification with the created notification's information provided by CloudHub

Throws:

CloudHubException - if there was an error while creating the notification

updateNotificationsStatus

void updateNotificationsStatus(String domain,
                             String tenantId,
                             com.mulesoft.ch.rest.model.Notification.NotificationStatus newStatus)
                               throws CloudHubException

Updates all notifications status. Can be READ or UNREAD.

Parameters:

domain - The domain of the notifications you want to update.

tenantId - The id of the tenant from which the notifications you want to update belong to.

newStatus - one of Notification.NotificationStatus representing the new status for the notification

Throws:

CloudHubException - if there was an error while updating the notification status

updateNotificationStatus

void updateNotificationStatus(String notificationId,
                            com.mulesoft.ch.rest.model.Notification.NotificationStatus newStatus)
                              throws CloudHubException

Updates a notification status. Can be READ or UNREAD.

Parameters:

notificationId - The id of the notification you want to update

newStatus - one of Notification.NotificationStatus representing the new status for the notification

Throws:

CloudHubException - if there was an error while updating the notification status

getSupportedMuleVersions

List<String> getSupportedMuleVersions()
                                      throws CloudHubException

This method returns all the supported mule versions by CloudHub

Returns:

a list of strings, with all the supported mule versions by CloudHub

Throws:

CloudHubException