com.mulesoft.cloudhub.client

Class CloudHubConnectionImpl

java.lang.Object

com.mulesoft.cloudhub.client.CloudHubConnectionImpl

All Implemented Interfaces:

CloudHubConnectionI

Direct Known Subclasses:

CloudHubDomainConnectionImpl

public class CloudHubConnectionImpl
extends Object
implements CloudHubConnectionI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudHubConnectionImpl.ObjectMapper

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessToken
protected String	apiToken
protected com.sun.jersey.api.client.Client	client
protected boolean	csAuthentication
static String	DEFAULT_URL Deprecated.
protected String	environmentId
protected org.slf4j.Logger	logger
static String	NEW_DEFAULT_URL
protected String	password
protected String	url
protected String	username

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudHubConnectionImpl()
	CloudHubConnectionImpl(String url, String accessToken, boolean debug)
	CloudHubConnectionImpl(String url, String accessToken, String environmentId, boolean debug)
	CloudHubConnectionImpl(String url, String username, String password, String sandbox, boolean debug)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.sun.jersey.api.client.WebResource.Builder	authorizeResource(com.sun.jersey.api.client.WebResource pathResource)
protected CloudHubException	buildExpception(com.sun.jersey.api.client.ClientResponse clientResponse)
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.
protected com.sun.jersey.api.client.WebResource.Builder	createApplicationBuilder(String path)
protected com.sun.jersey.api.client.WebResource.Builder	createBuilder(String path)
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
protected com.sun.jersey.api.client.WebResource.Builder	createNotificationBuilder(String path)
protected com.sun.jersey.api.client.WebResource	createResource(String path)
String	getAccessToken()
String	getEnvironmentId()
String	getPassword()
List<String>	getSupportedMuleVersions() This method returns all the supported mule versions by CloudHub
String	getUrl()
String	getUsername()
protected void	init(String url, boolean debug)
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 status) Updates all notifications status.
void	updateNotificationStatus(String notificationId, com.mulesoft.ch.rest.model.Notification.NotificationStatus status) Updates a notification status.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

DEFAULT_URL

@Deprecated
public static final String DEFAULT_URL

Deprecated.

See Also:

Constant Field Values

NEW_DEFAULT_URL

public static final String NEW_DEFAULT_URL

See Also:

Constant Field Values

url

protected String url

client

protected com.sun.jersey.api.client.Client client

username

protected String username

password

protected String password

apiToken

protected String apiToken

accessToken

protected String accessToken

environmentId

protected String environmentId

csAuthentication

protected boolean csAuthentication

Constructor Detail

CloudHubConnectionImpl

protected CloudHubConnectionImpl()

CloudHubConnectionImpl

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

CloudHubConnectionImpl

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

CloudHubConnectionImpl

public CloudHubConnectionImpl(String url,
                      String username,
                      String password,
                      String sandbox,
                      boolean debug)

Method Detail

init

protected void init(String url,
        boolean debug)

createConnection

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

Description copied from interface: CloudHubConnectionI

Creates a connection against an specific CloudHub Account

Specified by:

createConnection in interface CloudHubConnectionI

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

public CloudHubDomainConnectionI connectWithDomain(String domain)

Description copied from interface: CloudHubConnectionI

Returns a connection against a given domain of the CloudHub account

Specified by:

connectWithDomain in interface CloudHubConnectionI

Parameters:

domain - the domain to which you want to connect

Returns:

an instance of CloudHubDomainConnectionImpl connected with the specified domain

retrieveAccount

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

Description copied from interface: CloudHubConnectionI

Retrieves the CloudHub Account

Specified by:

retrieveAccount in interface CloudHubConnectionI

Returns:

an instance of Account

Throws:

CloudHubException - if there is an error when retrieving the account

isDomainAvailable

public boolean isDomainAvailable(String domain)
                          throws CloudHubException

Description copied from interface: CloudHubConnectionI

Checks if the domain is valid and available

Specified by:

isDomainAvailable in interface CloudHubConnectionI

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

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

Description copied from interface: CloudHubConnectionI

Retrieves All Applications from an specific CloudHub account

Specified by:

retrieveApplications in interface CloudHubConnectionI

Returns:

a collection of Application

createApplication

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

Description copied from interface: CloudHubConnectionI

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

Specified by:

createApplication in interface CloudHubConnectionI

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

public 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

Description copied from interface: CloudHubConnectionI

Retrieves a bunch of notifications based on given filters

Specified by:

retrieveNotifications in interface CloudHubConnectionI

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

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

Description copied from interface: CloudHubConnectionI

Retrieves a single notification, based on the given id.

Specified by:

retrieveNotification in interface CloudHubConnectionI

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

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

Description copied from interface: CloudHubConnectionI

Creates a notification based on the given object

Specified by:

createNotification in interface CloudHubConnectionI

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

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

Description copied from interface: CloudHubConnectionI

Updates all notifications status. Can be READ or UNREAD.

Specified by:

updateNotificationsStatus in interface CloudHubConnectionI

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.

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

Throws:

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

updateNotificationStatus

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

Description copied from interface: CloudHubConnectionI

Updates a notification status. Can be READ or UNREAD.

Specified by:

updateNotificationStatus in interface CloudHubConnectionI

Parameters:

notificationId - The id of the notification you want to update

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

Throws:

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

getSupportedMuleVersions

public List<String> getSupportedMuleVersions()
                                      throws CloudHubException

Description copied from interface: CloudHubConnectionI

This method returns all the supported mule versions by CloudHub

Specified by:

getSupportedMuleVersions in interface CloudHubConnectionI

Returns:

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

Throws:

CloudHubException

createBuilder

protected com.sun.jersey.api.client.WebResource.Builder createBuilder(String path)

authorizeResource

protected com.sun.jersey.api.client.WebResource.Builder authorizeResource(com.sun.jersey.api.client.WebResource pathResource)

createResource

protected com.sun.jersey.api.client.WebResource createResource(String path)

createApplicationBuilder

protected final com.sun.jersey.api.client.WebResource.Builder createApplicationBuilder(String path)

createNotificationBuilder

protected final com.sun.jersey.api.client.WebResource.Builder createNotificationBuilder(String path)

buildExpception

protected CloudHubException buildExpception(com.sun.jersey.api.client.ClientResponse clientResponse)
                                     throws CloudHubException

Throws:

CloudHubException

getUrl

public String getUrl()

Specified by:

getUrl in interface CloudHubConnectionI

getUsername

public String getUsername()

Specified by:

getUsername in interface CloudHubConnectionI

getPassword

public String getPassword()

Specified by:

getPassword in interface CloudHubConnectionI

getEnvironmentId

public String getEnvironmentId()

Specified by:

getEnvironmentId in interface CloudHubConnectionI

getAccessToken

public String getAccessToken()

Specified by:

getAccessToken in interface CloudHubConnectionI

isCsAuthentication

public boolean isCsAuthentication()

Specified by:

isCsAuthentication in interface CloudHubConnectionI