Module com.sap.cloudfoundry.client.facade

Package com.sap.cloudfoundry.client.facade

Class CloudControllerClientImpl

java.lang.Object

com.sap.cloudfoundry.client.facade.CloudControllerClientImpl

All Implemented Interfaces:

CloudControllerClient

public class CloudControllerClientImpl
extends Object
implements CloudControllerClient

A Java client to exercise the Cloud Foundry API.

Constructor Summary

Constructors

Constructor	Description
CloudControllerClientImpl(CloudControllerRestClient delegate)	Construct a client with a pre-configured CloudControllerClient
CloudControllerClientImpl(URL controllerUrl, CloudCredentials credentials)	Construct client without a default organization and space.
CloudControllerClientImpl(URL controllerUrl, CloudCredentials credentials, boolean trustSelfSignedCerts)
CloudControllerClientImpl(URL controllerUrl, CloudCredentials credentials, CloudSpace target, boolean trustSelfSignedCerts)

Method Summary

Modifier and Type	Method	Description
void	addDomain(String domainName)	Add a private domain in the current organization.
void	addRoute(String host, String domainName, String path)	Register a new route to the a domain.
CloudPackage	asyncUploadApplication(String applicationName, Path file)
CloudPackage	asyncUploadApplication(String applicationName, Path file, UploadStatusCallback callback)
void	bindDropletToApp(UUID dropletGuid, UUID applicationGuid)
void	bindServiceInstance(String applicationName, String serviceInstanceName)	Associate (provision) a service with an application.
void	bindServiceInstance(String applicationName, String serviceInstanceName, Map<String,Object> parameters, ApplicationServicesUpdateCallback updateServicesCallback)	Associate (provision) a service with an application.
CloudTask	cancelTask(UUID taskGuid)	Cancel the given task.
void	createApplication(String applicationName, Staging staging, Integer disk, Integer memory, List<String> uris, DockerInfo dockerInfo)	Create application.
void	createApplication(String applicationName, Staging staging, Integer memory, List<String> uris)	Create application.
CloudBuild	createBuild(UUID packageGuid)
void	createServiceBroker(CloudServiceBroker serviceBroker)	Create a service broker.
void	createServiceInstance(CloudServiceInstance serviceInstance)	Create a service instance.
CloudServiceKey	createServiceKey(String serviceInstanceName, String serviceKeyName, Map<String,Object> parameters)	Create a service key.
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance, Map<String,Object> credentials)	Create a user-provided service instance.
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance, Map<String,Object> credentials, String syslogDrainUrl)	Create a user-provided service instance for logging.
void	deleteAllApplications()	Delete all applications.
void	deleteAllServiceInstances()	Delete all service instances.
void	deleteApplication(String applicationName)	Delete application.
void	deleteDomain(String domainName)	Delete a private domain in the current organization.
List<CloudRoute>	deleteOrphanedRoutes()	Delete routes that do not have any application which is assigned to them.
void	deleteRoute(String host, String domainName, String path)	Delete a registered route from the space of the current session.
void	deleteServiceBroker(String name)	Delete a service broker.
void	deleteServiceInstance(CloudServiceInstance serviceInstance)
void	deleteServiceInstance(String serviceInstanceName)	Delete cloud service instance.
void	deleteServiceKey(CloudServiceKey serviceKey)	Delete a service key.
void	deleteServiceKey(String serviceInstanceName, String serviceKeyName)	Delete a service key.
CloudApplication	getApplication(String applicationName)	Get cloud application with the specified name.
CloudApplication	getApplication(String applicationName, boolean required)	Get cloud application with the specified name.
CloudApplication	getApplication(UUID applicationGuid)	Get cloud application with the specified GUID.
Map<String,String>	getApplicationEnvironment(String applicationName)	Get application environment variables for the app with the specified name.
Map<String,String>	getApplicationEnvironment(UUID applicationGuid)	Get application environment variables for the app with the specified GUID.
List<CloudEvent>	getApplicationEvents(String applicationName)	Get application events.
InstancesInfo	getApplicationInstances(CloudApplication app)	Get application instances info for application.
InstancesInfo	getApplicationInstances(String applicationName)	Get application instances info for application.
List<CloudApplication>	getApplications()	Get all applications in the currently targeted space.
List<CloudApplication>	getApplicationsByMetadataLabelSelector(String labelSelector)
CloudBuild	getBuild(UUID buildGuid)
List<CloudBuild>	getBuildsForApplication(UUID applicationGuid)
List<CloudBuild>	getBuildsForPackage(UUID packageGuid)
URL	getCloudControllerUrl()	Get the URL used for the cloud controller.
CloudInfo	getCloudInfo()	Get CloudInfo for the current cloud.
DropletInfo	getCurrentDropletForApplication(UUID applicationGuid)
CloudDomain	getDefaultDomain()	Gets the default domain for the current org, which is the first shared domain.
List<CloudDomain>	getDomains()	Get list of all domain shared and private domains.
List<CloudDomain>	getDomainsForOrganization()	Get list of all domain registered for the current organization.
List<CloudEvent>	getEvents()	Get system events.
List<CloudEvent>	getEventsByActee(UUID uuid)
CloudOrganization	getOrganization(String organizationName)	Get the organization with the specified name.
CloudOrganization	getOrganization(String organizationName, boolean required)	Get the organization with the specified name.
List<CloudOrganization>	getOrganizations()	Get all organizations for the current cloud.
CloudPackage	getPackage(UUID packageGuid)
List<CloudPackage>	getPackagesForApplication(UUID applicationGuid)
List<CloudDomain>	getPrivateDomains()	Get list of all private domains.
List<ApplicationLog>	getRecentLogs(String applicationName)	Stream recent log entries.
List<ApplicationLog>	getRecentLogs(UUID applicationGuid)	Get recent log entries.
List<CloudRoute>	getRoutes(String domainName)	Get the info for all routes for a domain.
Map<String,Object>	getServiceBindingParameters(UUID guid)	Get all service binding parameters.
List<CloudServiceBinding>	getServiceBindings(UUID serviceInstanceGuid)	Get the bindings for a particular service instance.
CloudServiceBroker	getServiceBroker(String name)	Get a service broker.
CloudServiceBroker	getServiceBroker(String name, boolean required)	Get a service broker.
List<CloudServiceBroker>	getServiceBrokers()	Get all service brokers.
CloudServiceInstance	getServiceInstance(String serviceInstanceName)	Get a service instance.
CloudServiceInstance	getServiceInstance(String serviceInstanceName, boolean required)	Get a service instance.
Map<String,Object>	getServiceInstanceParameters(UUID guid)	Get all service instance parameters.
List<CloudServiceInstance>	getServiceInstances()	Get all service instances in the currently targeted space.
List<CloudServiceInstance>	getServiceInstancesByMetadataLabelSelector(String labelSelector)
List<CloudServiceKey>	getServiceKeys(CloudServiceInstance serviceInstance)	Get service keys for a service instance.
List<CloudServiceKey>	getServiceKeys(String serviceInstanceName)	Get service keys for a service instance.
List<CloudServiceOffering>	getServiceOfferings()	Get all service offerings.
List<CloudDomain>	getSharedDomains()	Get list of all shared domains.
CloudSpace	getSpace(String spaceName)	Get space name with the specified name.
CloudSpace	getSpace(String spaceName, boolean required)	Get space name with the specified name.
CloudSpace	getSpace(String organizationName, String spaceName)	Get space name with the specified name.
CloudSpace	getSpace(String organizationName, String spaceName, boolean required)	Get space name with the specified name.
CloudSpace	getSpace(UUID spaceGuid)	Get space name with the specified GUID.
List<UUID>	getSpaceAuditors()
List<UUID>	getSpaceAuditors(String spaceName)	Get list of space auditor UUID for the space.
List<UUID>	getSpaceAuditors(String organizationName, String spaceName)	Get list of space auditor UUID for the space.
List<UUID>	getSpaceAuditors(UUID spaceGuid)
List<UUID>	getSpaceDevelopers()
List<UUID>	getSpaceDevelopers(String spaceName)	Get list of space developer UUID for the space.
List<UUID>	getSpaceDevelopers(String organizationName, String spaceName)	Get list of space developer UUID for the space.
List<UUID>	getSpaceDevelopers(UUID spaceGuid)
List<UUID>	getSpaceManagers()
List<UUID>	getSpaceManagers(String spaceName)	Get list of space manager UUID for the space.
List<UUID>	getSpaceManagers(String organizationName, String spaceName)	Get list of space manager UUID for the space.
List<UUID>	getSpaceManagers(UUID spaceGuid)
List<CloudSpace>	getSpaces()	Get all spaces for the current cloud.
List<CloudSpace>	getSpaces(String organizationName)	Get list of CloudSpaces for organization.
CloudStack	getStack(String name)	Get a stack by name.
CloudStack	getStack(String name, boolean required)	Get a stack by name.
List<CloudStack>	getStacks()	Get the list of stacks available for staging applications.
CloudTask	getTask(UUID taskGuid)
List<CloudTask>	getTasks(String applicationName)	Get the list of one-off tasks currently known for the given application.
Upload	getUploadStatus(UUID packageGuid)
org.springframework.security.oauth2.common.OAuth2AccessToken	login()	Login using the credentials already set for the client.
void	logout()	Logout closing the current session.
void	rename(String applicationName, String newName)	Rename an application.
StartingInfo	restartApplication(String applicationName)	Restart application.
CloudTask	runTask(String applicationName, CloudTask task)	Run a one-off task on an application.
StartingInfo	startApplication(String applicationName)	Start application.
void	stopApplication(String applicationName)	Stop application.
void	unbindServiceInstance(CloudApplication application, CloudServiceInstance serviceInstance)	Un-associate (unprovision) a service from an application.
void	unbindServiceInstance(String applicationName, String serviceInstanceName)	Un-associate (unprovision) a service from an application.
void	unbindServiceInstance(String applicationName, String serviceInstanceName, ApplicationServicesUpdateCallback applicationServicesUpdateCallback)	Un-associate (unprovision) a service from an application.
void	updateApplicationDiskQuota(String applicationName, int disk)	Update application disk quota.
void	updateApplicationEnv(String applicationName, Map<String,String> env)	Update application env using a map where the key specifies the name of the environment variable and the value the value of the environment variable..
void	updateApplicationInstances(String applicationName, int instances)	Update application instances.
void	updateApplicationMemory(String applicationName, int memory)	Update application memory.
void	updateApplicationMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
void	updateApplicationStaging(String applicationName, Staging staging)	Update application staging information.
void	updateApplicationUris(String applicationName, List<String> uris)	Update application URIs.
void	updateServiceBroker(CloudServiceBroker serviceBroker)	Update a service broker (unchanged forces catalog refresh).
void	updateServiceInstanceMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
void	updateServiceParameters(String serviceName, Map<String,Object> parameters)
void	updateServicePlan(String serviceName, String planName)
void	updateServicePlanVisibilityForBroker(String name, boolean visibility)	Service plans are private by default when a service broker's catalog is fetched/updated.
void	updateServiceTags(String serviceName, List<String> tags)
void	uploadApplication(String applicationName, InputStream inputStream)	Upload an application to Cloud Foundry.
void	uploadApplication(String applicationName, InputStream inputStream, UploadStatusCallback callback)	Upload an application to Cloud Foundry.
void	uploadApplication(String applicationName, String file)	Upload an application to Cloud Foundry.
void	uploadApplication(String applicationName, Path file)	Upload an application to Cloud Foundry.
void	uploadApplication(String applicationName, Path file, UploadStatusCallback callback)	Upload an application to Cloud Foundry.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudControllerClientImpl

public CloudControllerClientImpl(URL controllerUrl,
                                 CloudCredentials credentials)

Construct client without a default organization and space.

CloudControllerClientImpl

public CloudControllerClientImpl(URL controllerUrl,
                                 CloudCredentials credentials,
                                 boolean trustSelfSignedCerts)

CloudControllerClientImpl

public CloudControllerClientImpl(URL controllerUrl,
                                 CloudCredentials credentials,
                                 CloudSpace target,
                                 boolean trustSelfSignedCerts)

CloudControllerClientImpl

public CloudControllerClientImpl(CloudControllerRestClient delegate)

Construct a client with a pre-configured CloudControllerClient

Method Detail

addDomain

public void addDomain(String domainName)

Description copied from interface: CloudControllerClient

Add a private domain in the current organization.

Specified by:

addDomain in interface CloudControllerClient

Parameters:

domainName - the domain to add

addRoute

public void addRoute(String host,
                     String domainName,
                     String path)

Description copied from interface: CloudControllerClient

Register a new route to the a domain.

Specified by:

addRoute in interface CloudControllerClient

Parameters:

host - the host of the route to register

domainName - the domain of the route to register

bindServiceInstance

public void bindServiceInstance(String applicationName,
                                String serviceInstanceName)

Description copied from interface: CloudControllerClient

Associate (provision) a service with an application.

Specified by:

bindServiceInstance in interface CloudControllerClient

Parameters:

applicationName - the application name

serviceInstanceName - the service instance name

bindServiceInstance

public void bindServiceInstance(String applicationName,
                                String serviceInstanceName,
                                Map<String,Object> parameters,
                                ApplicationServicesUpdateCallback updateServicesCallback)

Description copied from interface: CloudControllerClient

Associate (provision) a service with an application.

Specified by:

bindServiceInstance in interface CloudControllerClient

Parameters:

applicationName - the application name

serviceInstanceName - the service instance name

parameters - the binding parameters

updateServicesCallback - callback used for error handling

createApplication

public void createApplication(String applicationName,
                              Staging staging,
                              Integer memory,
                              List<String> uris)

Description copied from interface: CloudControllerClient

Create application.

Specified by:

createApplication in interface CloudControllerClient

Parameters:

applicationName - application name

staging - staging info

memory - memory to use in MB

uris - list of URIs for the app

createApplication

public void createApplication(String applicationName,
                              Staging staging,
                              Integer disk,
                              Integer memory,
                              List<String> uris,
                              DockerInfo dockerInfo)

Description copied from interface: CloudControllerClient

Create application.

Specified by:

createApplication in interface CloudControllerClient

Parameters:

applicationName - application name

staging - staging info

disk - disk quota to use in MB

memory - memory to use in MB

uris - list of URIs for the app

dockerInfo - docker params(image, username, password)

createServiceInstance

public void createServiceInstance(CloudServiceInstance serviceInstance)

Description copied from interface: CloudControllerClient

Create a service instance.

Specified by:

createServiceInstance in interface CloudControllerClient

Parameters:

serviceInstance - cloud service instance info

createServiceBroker

public void createServiceBroker(CloudServiceBroker serviceBroker)

Description copied from interface: CloudControllerClient

Create a service broker.

Specified by:

createServiceBroker in interface CloudControllerClient

Parameters:

serviceBroker - cloud service broker info

createServiceKey

public CloudServiceKey createServiceKey(String serviceInstanceName,
                                        String serviceKeyName,
                                        Map<String,Object> parameters)

Description copied from interface: CloudControllerClient

Create a service key.

Specified by:

createServiceKey in interface CloudControllerClient

Parameters:

serviceInstanceName - name of service instance

serviceKeyName - name of service-key

parameters - parameters of service-key

Returns:

createUserProvidedServiceInstance

public void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance,
                                              Map<String,Object> credentials)

Description copied from interface: CloudControllerClient

Create a user-provided service instance.

Specified by:

createUserProvidedServiceInstance in interface CloudControllerClient

Parameters:

serviceInstance - cloud service instance info

credentials - the user-provided service instance credentials

createUserProvidedServiceInstance

public void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance,
                                              Map<String,Object> credentials,
                                              String syslogDrainUrl)

Description copied from interface: CloudControllerClient

Create a user-provided service instance for logging.

Specified by:

createUserProvidedServiceInstance in interface CloudControllerClient

Parameters:

serviceInstance - cloud service instance info

credentials - the user-provided service instance credentials

syslogDrainUrl - for a logging service instance

deleteAllApplications

public void deleteAllApplications()

Description copied from interface: CloudControllerClient

Delete all applications.

Specified by:

deleteAllApplications in interface CloudControllerClient

deleteAllServiceInstances

public void deleteAllServiceInstances()

Description copied from interface: CloudControllerClient

Delete all service instances.

Specified by:

deleteAllServiceInstances in interface CloudControllerClient

deleteApplication

public void deleteApplication(String applicationName)

Description copied from interface: CloudControllerClient

Delete application.

Specified by:

deleteApplication in interface CloudControllerClient

Parameters:

applicationName - name of application

deleteDomain

public void deleteDomain(String domainName)

Description copied from interface: CloudControllerClient

Delete a private domain in the current organization.

Specified by:

deleteDomain in interface CloudControllerClient

Parameters:

domainName - the domain to delete

deleteOrphanedRoutes

public List<CloudRoute> deleteOrphanedRoutes()

Description copied from interface: CloudControllerClient

Delete routes that do not have any application which is assigned to them.

Specified by:

deleteOrphanedRoutes in interface CloudControllerClient

deleteRoute

public void deleteRoute(String host,
                        String domainName,
                        String path)

Description copied from interface: CloudControllerClient

Delete a registered route from the space of the current session.

Specified by:

deleteRoute in interface CloudControllerClient

Parameters:

host - the host of the route to delete

domainName - the domain of the route to delete

deleteServiceInstance

public void deleteServiceInstance(String serviceInstanceName)

Description copied from interface: CloudControllerClient

Delete cloud service instance.

Specified by:

deleteServiceInstance in interface CloudControllerClient

Parameters:

serviceInstanceName - name of service instance

deleteServiceInstance

public void deleteServiceInstance(CloudServiceInstance serviceInstance)

Specified by:

deleteServiceInstance in interface CloudControllerClient

Parameters:

serviceInstance - CloudServiceInstance

deleteServiceBroker

public void deleteServiceBroker(String name)

Description copied from interface: CloudControllerClient

Delete a service broker.

Specified by:

deleteServiceBroker in interface CloudControllerClient

Parameters:

name - the service broker name

deleteServiceKey

public void deleteServiceKey(String serviceInstanceName,
                             String serviceKeyName)

Description copied from interface: CloudControllerClient

Delete a service key.

Specified by:

deleteServiceKey in interface CloudControllerClient

Parameters:

serviceInstanceName - name of service instance

serviceKeyName - name of service key

deleteServiceKey

public void deleteServiceKey(CloudServiceKey serviceKey)

Description copied from interface: CloudControllerClient

Delete a service key.

Specified by:

deleteServiceKey in interface CloudControllerClient

Parameters:

serviceKey - CloudServiceKey object

getApplication

public CloudApplication getApplication(String applicationName)

Description copied from interface: CloudControllerClient

Get cloud application with the specified name.

Specified by:

getApplication in interface CloudControllerClient

Parameters:

applicationName - name of the app

Returns:

the cloud application

getApplication

public CloudApplication getApplication(String applicationName,
                                       boolean required)

Description copied from interface: CloudControllerClient

Get cloud application with the specified name.

Specified by:

getApplication in interface CloudControllerClient

Parameters:

applicationName - name of the app

required - if true, and organization is not found, throw an exception

Returns:

the cloud application

getApplication

public CloudApplication getApplication(UUID applicationGuid)

Description copied from interface: CloudControllerClient

Get cloud application with the specified GUID.

Specified by:

getApplication in interface CloudControllerClient

Parameters:

applicationGuid - GUID of the app

Returns:

the cloud application

getApplicationEnvironment

public Map<String,String> getApplicationEnvironment(UUID applicationGuid)

Description copied from interface: CloudControllerClient

Get application environment variables for the app with the specified GUID.

Specified by:

getApplicationEnvironment in interface CloudControllerClient

Parameters:

applicationGuid - GUID of the app

Returns:

the cloud application environment variables

getApplicationEnvironment

public Map<String,String> getApplicationEnvironment(String applicationName)

Description copied from interface: CloudControllerClient

Get application environment variables for the app with the specified name.

Specified by:

getApplicationEnvironment in interface CloudControllerClient

Parameters:

applicationName - name of the app

Returns:

the cloud application environment variables

getApplicationEvents

public List<CloudEvent> getApplicationEvents(String applicationName)

Description copied from interface: CloudControllerClient

Get application events.

Specified by:

getApplicationEvents in interface CloudControllerClient

Parameters:

applicationName - name of application

Returns:

application events

getEventsByActee

public List<CloudEvent> getEventsByActee(UUID uuid)

Specified by:

getEventsByActee in interface CloudControllerClient

getApplicationInstances

public InstancesInfo getApplicationInstances(String applicationName)

Description copied from interface: CloudControllerClient

Get application instances info for application.

Specified by:

getApplicationInstances in interface CloudControllerClient

Parameters:

applicationName - name of application.

Returns:

instances info

getApplicationInstances

public InstancesInfo getApplicationInstances(CloudApplication app)

Description copied from interface: CloudControllerClient

Get application instances info for application.

Specified by:

getApplicationInstances in interface CloudControllerClient

Parameters:

app - the application.

Returns:

instances info

getApplications

public List<CloudApplication> getApplications()

Description copied from interface: CloudControllerClient

Get all applications in the currently targeted space. This method has EXTREMELY poor performance for spaces with a lot of applications.

Specified by:

getApplications in interface CloudControllerClient

Returns:

list of applications

getApplicationsByMetadataLabelSelector

public List<CloudApplication> getApplicationsByMetadataLabelSelector(String labelSelector)

Specified by:

getApplicationsByMetadataLabelSelector in interface CloudControllerClient

getCloudControllerUrl

public URL getCloudControllerUrl()

Description copied from interface: CloudControllerClient

Get the URL used for the cloud controller.

Specified by:

getCloudControllerUrl in interface CloudControllerClient

Returns:

the cloud controller URL

getCloudInfo

public CloudInfo getCloudInfo()

Description copied from interface: CloudControllerClient

Get CloudInfo for the current cloud.

Specified by:

getCloudInfo in interface CloudControllerClient

Returns:

CloudInfo object containing the cloud info

getDefaultDomain

public CloudDomain getDefaultDomain()

Description copied from interface: CloudControllerClient

Gets the default domain for the current org, which is the first shared domain.

Specified by:

getDefaultDomain in interface CloudControllerClient

Returns:

the default domain

getDomains

public List<CloudDomain> getDomains()

Description copied from interface: CloudControllerClient

Get list of all domain shared and private domains.

Specified by:

getDomains in interface CloudControllerClient

Returns:

list of domains

getDomainsForOrganization

public List<CloudDomain> getDomainsForOrganization()

Description copied from interface: CloudControllerClient

Get list of all domain registered for the current organization.

Specified by:

getDomainsForOrganization in interface CloudControllerClient

Returns:

list of domains

getEvents

public List<CloudEvent> getEvents()

Description copied from interface: CloudControllerClient

Get system events.

Specified by:

getEvents in interface CloudControllerClient

Returns:

all system events

getOrganization

public CloudOrganization getOrganization(String organizationName)

Description copied from interface: CloudControllerClient

Get the organization with the specified name.

Specified by:

getOrganization in interface CloudControllerClient

Parameters:

organizationName - name of organization

Returns:

getOrganization

public CloudOrganization getOrganization(String organizationName,
                                         boolean required)

Description copied from interface: CloudControllerClient

Get the organization with the specified name.

Specified by:

getOrganization in interface CloudControllerClient

Parameters:

organizationName - name of organization

required - if true, and organization is not found, throw an exception

Returns:

getOrganizations

public List<CloudOrganization> getOrganizations()

Description copied from interface: CloudControllerClient

Get all organizations for the current cloud. This method has poor performance when there are a lot of organizations.

Specified by:

getOrganizations in interface CloudControllerClient

Returns:

list of organizations

getPrivateDomains

public List<CloudDomain> getPrivateDomains()

Description copied from interface: CloudControllerClient

Get list of all private domains.

Specified by:

getPrivateDomains in interface CloudControllerClient

Returns:

list of private domains

getRecentLogs

public List<ApplicationLog> getRecentLogs(String applicationName)

Description copied from interface: CloudControllerClient

Stream recent log entries. Stream logs that were recently produced for an app.

Specified by:

getRecentLogs in interface CloudControllerClient

Parameters:

applicationName - the name of the application

Returns:

the list of recent log entries

getRecentLogs

public List<ApplicationLog> getRecentLogs(UUID applicationGuid)

Description copied from interface: CloudControllerClient

Get recent log entries. Get logs that were recently produced for an app.

Specified by:

getRecentLogs in interface CloudControllerClient

Parameters:

applicationGuid - the guid of the application

Returns:

the list of recent log entries

getRoutes

public List<CloudRoute> getRoutes(String domainName)

Description copied from interface: CloudControllerClient

Get the info for all routes for a domain.

Specified by:

getRoutes in interface CloudControllerClient

Parameters:

domainName - the domain the routes belong to

Returns:

list of routes

getServiceBroker

public CloudServiceBroker getServiceBroker(String name)

Description copied from interface: CloudControllerClient

Get a service broker.

Specified by:

getServiceBroker in interface CloudControllerClient

Parameters:

name - the service broker name

Returns:

the service broker

getServiceBroker

public CloudServiceBroker getServiceBroker(String name,
                                           boolean required)

Description copied from interface: CloudControllerClient

Get a service broker.

Specified by:

getServiceBroker in interface CloudControllerClient

Parameters:

name - the service broker name

required - if true, and organization is not found, throw an exception

Returns:

the service broker

getServiceBrokers

public List<CloudServiceBroker> getServiceBrokers()

Description copied from interface: CloudControllerClient

Get all service brokers.

Specified by:

getServiceBrokers in interface CloudControllerClient

Returns:

getServiceInstance

public CloudServiceInstance getServiceInstance(String serviceInstanceName)

Description copied from interface: CloudControllerClient

Get a service instance.

Specified by:

getServiceInstance in interface CloudControllerClient

Parameters:

serviceInstanceName - name of the service instance

Returns:

the service instance info

getServiceInstance

public CloudServiceInstance getServiceInstance(String serviceInstanceName,
                                               boolean required)

Description copied from interface: CloudControllerClient

Get a service instance.

Specified by:

getServiceInstance in interface CloudControllerClient

Parameters:

serviceInstanceName - name of the service instance

required - if true, and organization is not found, throw an exception

Returns:

the service instance info

getServiceBindings

public List<CloudServiceBinding> getServiceBindings(UUID serviceInstanceGuid)

Description copied from interface: CloudControllerClient

Get the bindings for a particular service instance.

Specified by:

getServiceBindings in interface CloudControllerClient

Parameters:

serviceInstanceGuid - the GUID of the service instance

Returns:

the bindings

getServiceInstanceParameters

public Map<String,Object> getServiceInstanceParameters(UUID guid)

Description copied from interface: CloudControllerClient

Get all service instance parameters.

Specified by:

getServiceInstanceParameters in interface CloudControllerClient

Parameters:

guid - The service instance guid

Returns:

service instance parameters in key-value pairs

getServiceBindingParameters

public Map<String,Object> getServiceBindingParameters(UUID guid)

Description copied from interface: CloudControllerClient

Get all service binding parameters.

Specified by:

getServiceBindingParameters in interface CloudControllerClient

Parameters:

guid - The service binding guid

Returns:

service binding parameters in key-value pairs

getServiceKeys

public List<CloudServiceKey> getServiceKeys(String serviceInstanceName)

Description copied from interface: CloudControllerClient

Get service keys for a service instance.

Specified by:

getServiceKeys in interface CloudControllerClient

Parameters:

serviceInstanceName - name containing service keys

Returns:

the service keys info

getServiceKeys

public List<CloudServiceKey> getServiceKeys(CloudServiceInstance serviceInstance)

Description copied from interface: CloudControllerClient

Get service keys for a service instance.

Specified by:

getServiceKeys in interface CloudControllerClient

Parameters:

serviceInstance - instance containing service keys

Returns:

the service keys info

getServiceOfferings

public List<CloudServiceOffering> getServiceOfferings()

Description copied from interface: CloudControllerClient

Get all service offerings.

Specified by:

getServiceOfferings in interface CloudControllerClient

Returns:

list of service offerings

getServiceInstances

public List<CloudServiceInstance> getServiceInstances()

Description copied from interface: CloudControllerClient

Get all service instances in the currently targeted space. This method has EXTREMELY poor performance for spaces with a lot of service instances.

Specified by:

getServiceInstances in interface CloudControllerClient

Returns:

list of service instances

getServiceInstancesByMetadataLabelSelector

public List<CloudServiceInstance> getServiceInstancesByMetadataLabelSelector(String labelSelector)

Specified by:

getServiceInstancesByMetadataLabelSelector in interface CloudControllerClient

getSharedDomains

public List<CloudDomain> getSharedDomains()

Description copied from interface: CloudControllerClient

Get list of all shared domains.

Specified by:

getSharedDomains in interface CloudControllerClient

Returns:

list of shared domains

getSpace

public CloudSpace getSpace(UUID spaceGuid)

Description copied from interface: CloudControllerClient

Get space name with the specified GUID.

Specified by:

getSpace in interface CloudControllerClient

getSpace

public CloudSpace getSpace(String organizationName,
                           String spaceName)

Description copied from interface: CloudControllerClient

Get space name with the specified name.

Specified by:

getSpace in interface CloudControllerClient

getSpace

public CloudSpace getSpace(String organizationName,
                           String spaceName,
                           boolean required)

Description copied from interface: CloudControllerClient

Get space name with the specified name.

Specified by:

getSpace in interface CloudControllerClient

getSpace

public CloudSpace getSpace(String spaceName)

Description copied from interface: CloudControllerClient

Get space name with the specified name.

Specified by:

getSpace in interface CloudControllerClient

getSpace

public CloudSpace getSpace(String spaceName,
                           boolean required)

Description copied from interface: CloudControllerClient

Get space name with the specified name.

Specified by:

getSpace in interface CloudControllerClient

getSpaceAuditors

public List<UUID> getSpaceAuditors()

Specified by:

getSpaceAuditors in interface CloudControllerClient

getSpaceAuditors

public List<UUID> getSpaceAuditors(String spaceName)

Description copied from interface: CloudControllerClient

Get list of space auditor UUID for the space.

Specified by:

getSpaceAuditors in interface CloudControllerClient

Parameters:

spaceName - name of the space

Returns:

List of space auditor UUID

getSpaceAuditors

public List<UUID> getSpaceAuditors(String organizationName,
                                   String spaceName)

Description copied from interface: CloudControllerClient

Get list of space auditor UUID for the space.

Specified by:

getSpaceAuditors in interface CloudControllerClient

Parameters:

organizationName - name of the organization containing the space

spaceName - name of the space

Returns:

List of space auditor UUID

getSpaceAuditors

public List<UUID> getSpaceAuditors(UUID spaceGuid)

Specified by:

getSpaceAuditors in interface CloudControllerClient

getSpaceDevelopers

public List<UUID> getSpaceDevelopers()

Specified by:

getSpaceDevelopers in interface CloudControllerClient

getSpaceDevelopers

public List<UUID> getSpaceDevelopers(String spaceName)

Description copied from interface: CloudControllerClient

Get list of space developer UUID for the space.

Specified by:

getSpaceDevelopers in interface CloudControllerClient

Parameters:

spaceName - name of the space

Returns:

List of space developer UUID

getSpaceDevelopers

public List<UUID> getSpaceDevelopers(String organizationName,
                                     String spaceName)

Description copied from interface: CloudControllerClient

Get list of space developer UUID for the space.

Specified by:

getSpaceDevelopers in interface CloudControllerClient

Parameters:

organizationName - name of the organization containing the space

spaceName - name of the space

Returns:

List of space developer UUID

getSpaceDevelopers

public List<UUID> getSpaceDevelopers(UUID spaceGuid)

Specified by:

getSpaceDevelopers in interface CloudControllerClient

getSpaceManagers

public List<UUID> getSpaceManagers()

Specified by:

getSpaceManagers in interface CloudControllerClient

getSpaceManagers

public List<UUID> getSpaceManagers(String spaceName)

Description copied from interface: CloudControllerClient

Get list of space manager UUID for the space.

Specified by:

getSpaceManagers in interface CloudControllerClient

Parameters:

spaceName - name of the space

Returns:

List of space manager UUID

getSpaceManagers

public List<UUID> getSpaceManagers(String organizationName,
                                   String spaceName)

Description copied from interface: CloudControllerClient

Get list of space manager UUID for the space.

Specified by:

getSpaceManagers in interface CloudControllerClient

Parameters:

organizationName - name of the organization containing the space

spaceName - name of the space

Returns:

List of space manager UUID

getSpaceManagers

public List<UUID> getSpaceManagers(UUID spaceGuid)

Specified by:

getSpaceManagers in interface CloudControllerClient

getSpaces

public List<CloudSpace> getSpaces()

Description copied from interface: CloudControllerClient

Get all spaces for the current cloud. This method has EXTREMELY poor performance when there are a lot of spaces.

Specified by:

getSpaces in interface CloudControllerClient

Returns:

list of spaces

getSpaces

public List<CloudSpace> getSpaces(String organizationName)

Description copied from interface: CloudControllerClient

Get list of CloudSpaces for organization.

Specified by:

getSpaces in interface CloudControllerClient

Returns:

List of CloudSpace objects containing the space info

getStack

public CloudStack getStack(String name)

Description copied from interface: CloudControllerClient

Get a stack by name.

Specified by:

getStack in interface CloudControllerClient

Parameters:

name - the name of the stack to get

Returns:

the stack

getStack

public CloudStack getStack(String name,
                           boolean required)

Description copied from interface: CloudControllerClient

Get a stack by name.

Specified by:

getStack in interface CloudControllerClient

Parameters:

name - the name of the stack to get

required - if true, and organization is not found, throw an exception

Returns:

the stack, or null if not found

getStacks

public List<CloudStack> getStacks()

Description copied from interface: CloudControllerClient

Get the list of stacks available for staging applications.

Specified by:

getStacks in interface CloudControllerClient

Returns:

the list of available stacks

login

public org.springframework.security.oauth2.common.OAuth2AccessToken login()

Description copied from interface: CloudControllerClient

Login using the credentials already set for the client.

Specified by:

login in interface CloudControllerClient

Returns:

authentication token

logout

public void logout()

Description copied from interface: CloudControllerClient

Logout closing the current session.

Specified by:

logout in interface CloudControllerClient

rename

public void rename(String applicationName,
                   String newName)

Description copied from interface: CloudControllerClient

Rename an application.

Specified by:

rename in interface CloudControllerClient

Parameters:

applicationName - the current name

newName - the new name

restartApplication

public StartingInfo restartApplication(String applicationName)

Description copied from interface: CloudControllerClient

Restart application.

Specified by:

restartApplication in interface CloudControllerClient

Parameters:

applicationName - name of application

startApplication

public StartingInfo startApplication(String applicationName)

Description copied from interface: CloudControllerClient

Start application. May return starting info if the response obtained after the start request contains headers . If the response does not contain headers, null is returned instead.

Specified by:

startApplication in interface CloudControllerClient

Parameters:

applicationName - name of application

Returns:

Starting info containing response headers, if headers are present in the response. If there are no headers, return null.

stopApplication

public void stopApplication(String applicationName)

Description copied from interface: CloudControllerClient

Stop application.

Specified by:

stopApplication in interface CloudControllerClient

Parameters:

applicationName - name of application

unbindServiceInstance

public void unbindServiceInstance(String applicationName,
                                  String serviceInstanceName,
                                  ApplicationServicesUpdateCallback applicationServicesUpdateCallback)

Description copied from interface: CloudControllerClient

Un-associate (unprovision) a service from an application.

Specified by:

unbindServiceInstance in interface CloudControllerClient

Parameters:

applicationName - the application name

serviceInstanceName - the service instance name

applicationServicesUpdateCallback - callback used for error handling

unbindServiceInstance

public void unbindServiceInstance(String applicationName,
                                  String serviceInstanceName)

Description copied from interface: CloudControllerClient

Un-associate (unprovision) a service from an application.

Specified by:

unbindServiceInstance in interface CloudControllerClient

Parameters:

applicationName - the application name

serviceInstanceName - the service instance name

unbindServiceInstance

public void unbindServiceInstance(CloudApplication application,
                                  CloudServiceInstance serviceInstance)

Description copied from interface: CloudControllerClient

Un-associate (unprovision) a service from an application.

Specified by:

unbindServiceInstance in interface CloudControllerClient

Parameters:

application - the application instance

serviceInstance - the service instance

updateApplicationDiskQuota

public void updateApplicationDiskQuota(String applicationName,
                                       int disk)

Description copied from interface: CloudControllerClient

Update application disk quota.

Specified by:

updateApplicationDiskQuota in interface CloudControllerClient

Parameters:

applicationName - name of application

disk - new disk setting in MB

updateApplicationEnv

public void updateApplicationEnv(String applicationName,
                                 Map<String,String> env)

Description copied from interface: CloudControllerClient

Update application env using a map where the key specifies the name of the environment variable and the value the value of the environment variable..

Specified by:

updateApplicationEnv in interface CloudControllerClient

Parameters:

applicationName - name of application

env - map of environment settings

updateApplicationInstances

public void updateApplicationInstances(String applicationName,
                                       int instances)

Description copied from interface: CloudControllerClient

Update application instances.

Specified by:

updateApplicationInstances in interface CloudControllerClient

Parameters:

applicationName - name of application

instances - number of instances to use

updateApplicationMetadata

public void updateApplicationMetadata(UUID guid,
                                      org.cloudfoundry.client.v3.Metadata metadata)

Specified by:

updateApplicationMetadata in interface CloudControllerClient

updateApplicationMemory

public void updateApplicationMemory(String applicationName,
                                    int memory)

Description copied from interface: CloudControllerClient

Update application memory.

Specified by:

updateApplicationMemory in interface CloudControllerClient

Parameters:

applicationName - name of application

memory - new memory setting in MB

updateApplicationStaging

public void updateApplicationStaging(String applicationName,
                                     Staging staging)

Description copied from interface: CloudControllerClient

Update application staging information.

Specified by:

updateApplicationStaging in interface CloudControllerClient

Parameters:

applicationName - name of appplication

staging - staging information for the app

updateApplicationUris

public void updateApplicationUris(String applicationName,
                                  List<String> uris)

Description copied from interface: CloudControllerClient

Update application URIs.

Specified by:

updateApplicationUris in interface CloudControllerClient

Parameters:

applicationName - name of application

uris - list of URIs the app should use

updateServiceInstanceMetadata

public void updateServiceInstanceMetadata(UUID guid,
                                          org.cloudfoundry.client.v3.Metadata metadata)

Specified by:

updateServiceInstanceMetadata in interface CloudControllerClient

updateServiceBroker

public void updateServiceBroker(CloudServiceBroker serviceBroker)

Description copied from interface: CloudControllerClient

Update a service broker (unchanged forces catalog refresh).

Specified by:

updateServiceBroker in interface CloudControllerClient

Parameters:

serviceBroker - cloud service broker info

updateServicePlanVisibilityForBroker

public void updateServicePlanVisibilityForBroker(String name,
                                                 boolean visibility)

Description copied from interface: CloudControllerClient

Service plans are private by default when a service broker's catalog is fetched/updated. This method will update the visibility of all plans for a broker to either public or private.

Specified by:

updateServicePlanVisibilityForBroker in interface CloudControllerClient

Parameters:

name - the service broker name

visibility - true for public, false for private

updateServicePlan

public void updateServicePlan(String serviceName,
                              String planName)

Specified by:

updateServicePlan in interface CloudControllerClient

updateServiceParameters

public void updateServiceParameters(String serviceName,
                                    Map<String,Object> parameters)

Specified by:

updateServiceParameters in interface CloudControllerClient

updateServiceTags

public void updateServiceTags(String serviceName,
                              List<String> tags)

Specified by:

updateServiceTags in interface CloudControllerClient

uploadApplication

public void uploadApplication(String applicationName,
                              String file)

Description copied from interface: CloudControllerClient

Upload an application to Cloud Foundry.

Specified by:

uploadApplication in interface CloudControllerClient

Parameters:

applicationName - application name

file - path to the application archive or folder

uploadApplication

public void uploadApplication(String applicationName,
                              Path file)

Description copied from interface: CloudControllerClient

Upload an application to Cloud Foundry.

Specified by:

uploadApplication in interface CloudControllerClient

Parameters:

applicationName - the application name

file - the application archive or folder

uploadApplication

public void uploadApplication(String applicationName,
                              Path file,
                              UploadStatusCallback callback)

Description copied from interface: CloudControllerClient

Upload an application to Cloud Foundry.

Specified by:

uploadApplication in interface CloudControllerClient

Parameters:

applicationName - the application name

file - the application archive

callback - a callback interface used to provide progress information or null

uploadApplication

public void uploadApplication(String applicationName,
                              InputStream inputStream)
                       throws IOException

Description copied from interface: CloudControllerClient

Upload an application to Cloud Foundry. This form of uploadApplication will read the passed InputStream and copy the contents to a temporary file for upload.

Specified by:

uploadApplication in interface CloudControllerClient

Parameters:

applicationName - the application name

inputStream - the InputStream to read from

Throws:

IOException

uploadApplication

public void uploadApplication(String applicationName,
                              InputStream inputStream,
                              UploadStatusCallback callback)
                       throws IOException

Description copied from interface: CloudControllerClient

Upload an application to Cloud Foundry. This form of uploadApplication will read the passed InputStream and copy the contents to a temporary file for upload.

Specified by:

uploadApplication in interface CloudControllerClient

Parameters:

applicationName - the application name

inputStream - the InputStream to read from

callback - a callback interface used to provide progress information or null

Throws:

IOException

asyncUploadApplication

public CloudPackage asyncUploadApplication(String applicationName,
                                           Path file)

Specified by:

asyncUploadApplication in interface CloudControllerClient

asyncUploadApplication

public CloudPackage asyncUploadApplication(String applicationName,
                                           Path file,
                                           UploadStatusCallback callback)

Specified by:

asyncUploadApplication in interface CloudControllerClient

getUploadStatus

public Upload getUploadStatus(UUID packageGuid)

Specified by:

getUploadStatus in interface CloudControllerClient

createBuild

public CloudBuild createBuild(UUID packageGuid)

Specified by:

createBuild in interface CloudControllerClient

getBuild

public CloudBuild getBuild(UUID buildGuid)

Specified by:

getBuild in interface CloudControllerClient

getTask

public CloudTask getTask(UUID taskGuid)

Specified by:

getTask in interface CloudControllerClient

getTasks

public List<CloudTask> getTasks(String applicationName)

Description copied from interface: CloudControllerClient

Get the list of one-off tasks currently known for the given application.

Specified by:

getTasks in interface CloudControllerClient

Parameters:

applicationName - the application to look for tasks

Returns:

the list of known tasks

runTask

public CloudTask runTask(String applicationName,
                         CloudTask task)

Description copied from interface: CloudControllerClient

Run a one-off task on an application.

Specified by:

runTask in interface CloudControllerClient

Parameters:

applicationName - the application to run the task on

task - the task to run

Returns:

the ran task

cancelTask

public CloudTask cancelTask(UUID taskGuid)

Description copied from interface: CloudControllerClient

Cancel the given task.

Specified by:

cancelTask in interface CloudControllerClient

Parameters:

taskGuid - the GUID of the task to cancel

Returns:

the cancelled task

bindDropletToApp

public void bindDropletToApp(UUID dropletGuid,
                             UUID applicationGuid)

Specified by:

bindDropletToApp in interface CloudControllerClient

getBuildsForApplication

public List<CloudBuild> getBuildsForApplication(UUID applicationGuid)

Specified by:

getBuildsForApplication in interface CloudControllerClient

getBuildsForPackage

public List<CloudBuild> getBuildsForPackage(UUID packageGuid)

Specified by:

getBuildsForPackage in interface CloudControllerClient

getCurrentDropletForApplication

public DropletInfo getCurrentDropletForApplication(UUID applicationGuid)

Specified by:

getCurrentDropletForApplication in interface CloudControllerClient

getPackage

public CloudPackage getPackage(UUID packageGuid)

Specified by:

getPackage in interface CloudControllerClient

getPackagesForApplication

public List<CloudPackage> getPackagesForApplication(UUID applicationGuid)

Specified by:

getPackagesForApplication in interface CloudControllerClient