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, 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)
Optional<String>	bindServiceInstance(String applicationName, String serviceInstanceName)	Associate (provision) a service with an application.
Optional<String>	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.
CloudServiceKey	createAndFetchServiceKey(CloudServiceKey keyModel, String serviceInstanceName)
void	createApplication(ApplicationToCreateDto applicationToCreateDto)	Create application
CloudBuild	createBuild(UUID packageGuid)
CloudPackage	createDockerPackage(UUID applicationGuid, DockerInfo dockerInfo)
String	createServiceBroker(CloudServiceBroker serviceBroker)	Create a service broker.
void	createServiceInstance(CloudServiceInstance serviceInstance)	Create a service instance.
Optional<String>	createServiceKey(CloudServiceKey keyModel, String serviceInstanceName)
Optional<String>	createServiceKey(String serviceInstanceName, String serviceKeyName, Map<String,Object> parameters)	Create a service key.
void	createUserProvidedServiceInstance(CloudServiceInstance serviceInstance)	Create a user-provided service instance.
void	deleteApplication(String applicationName)	Delete application.
void	deleteDomain(String domainName)	Delete a private domain in the current organization.
void	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.
Optional<String>	deleteServiceBinding(String serviceInstanceName, String serviceKeyName)	Delete a service binding.
Optional<String>	deleteServiceBinding(UUID bindingGuid)	Delete a service binding.
Optional<String>	deleteServiceBinding(UUID bindingGuid, ServiceBindingOperationCallback serviceBindingOperationCallback)	Delete a service binding.
String	deleteServiceBroker(String name)	Delete a service broker.
void	deleteServiceInstance(CloudServiceInstance serviceInstance)
void	deleteServiceInstance(String serviceInstanceName)	Delete cloud service instance.
List<CloudServiceBinding>	getAppBindings(UUID applicationGuid)	Get the bindings for a particular application.
CloudApplication	getApplication(String applicationName)	Get cloud application with the specified name.
CloudApplication	getApplication(String applicationName, boolean required)	Get cloud application with the specified name.
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.
UUID	getApplicationGuid(String applicationName)	Get the GUID of the cloud application with the specified name.
InstancesInfo	getApplicationInstances(CloudApplication app)	Get application instances info for application.
InstancesInfo	getApplicationInstances(UUID applicationGuid)
String	getApplicationName(UUID applicationGuid)
CloudProcess	getApplicationProcess(UUID applicationGuid)
List<CloudRoute>	getApplicationRoutes(UUID applicationGuid)
List<CloudApplication>	getApplications()	Get all applications in the currently targeted space.
List<CloudApplication>	getApplicationsByMetadataLabelSelector(String labelSelector)
boolean	getApplicationSshEnabled(UUID applicationGuid)
CloudAsyncJob	getAsyncJob(String jobId)
CloudBuild	getBuild(UUID buildGuid)
List<CloudBuild>	getBuildsForApplication(UUID applicationGuid)
List<CloudBuild>	getBuildsForPackage(UUID packageGuid)
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)
CloudPackage	getPackage(UUID packageGuid)
List<CloudPackage>	getPackagesForApplication(UUID applicationGuid)
List<CloudDomain>	getPrivateDomains()	Get list of all private domains.
UUID	getRequiredServiceInstanceGuid(String name)	Get the GUID of a service instance.
List<CloudRoute>	getRoutes(String domainName)	Get the info for all routes for a domain.
List<CloudServiceBinding>	getServiceAppBindings(UUID serviceInstanceGuid)	Get the bindings for a particular service instance.
CloudServiceBinding	getServiceBinding(UUID serviceBindingId)	Get a service binding
CloudServiceBinding	getServiceBindingForApplication(UUID applicationId, UUID serviceInstanceGuid)	Get the binding between an application and a service instance.
Map<String,Object>	getServiceBindingParameters(UUID guid)	Get all service binding parameters.
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.
String	getServiceInstanceName(UUID serviceInstanceGuid)	Get a service instance name.
Map<String,Object>	getServiceInstanceParameters(UUID guid)	Get all service instance parameters.
List<CloudServiceInstance>	getServiceInstancesByMetadataLabelSelector(String labelSelector)
List<CloudServiceInstance>	getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector(String labelSelector)
List<CloudServiceInstance>	getServiceInstancesWithoutAuxiliaryContentByNames(List<String> names)
CloudServiceInstance	getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName)	Get a service instance.
CloudServiceInstance	getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName, boolean required)	Get a service instance.
CloudServiceKey	getServiceKey(String serviceInstanceName, String serviceKeyName)	Get a service key.
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<CloudServiceKey>	getServiceKeysWithCredentials(CloudServiceInstance serviceInstance)
List<CloudServiceKey>	getServiceKeysWithCredentials(String serviceInstanceName)
List<CloudServiceOffering>	getServiceOfferings()	Get all service offerings.
List<CloudDomain>	getSharedDomains()	Get list of all shared domains.
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.
CloudSpace	getTarget()
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)
Map<String,Object>	getUserProvidedServiceInstanceParameters(UUID guid)	Get all user-provided service instance parameters
Set<UserRole>	getUserRolesBySpaceAndUser(UUID spaceGuid, UUID userGuid)
void	rename(String applicationName, String newName)	Rename an application.
void	restartApplication(String applicationName)	Restart application.
CloudTask	runTask(String applicationName, CloudTask task)	Run a one-off task on an application.
void	startApplication(String applicationName)	Start application.
void	stopApplication(String applicationName)	Stop application.
Optional<String>	unbindServiceInstance(String applicationName, String serviceInstanceName)	Un-associate (unprovision) a service from an application.
Optional<String>	unbindServiceInstance(String applicationName, String serviceInstanceName, ApplicationServicesUpdateCallback applicationServicesUpdateCallback)	Un-associate (unprovision) a service from an application.
Optional<String>	unbindServiceInstance(UUID applicationGuid, UUID serviceInstanceGuid)	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	updateApplicationRoutes(String applicationName, Set<CloudRoute> routes)	Update application Routes.
void	updateApplicationStaging(String applicationName, Staging staging)	Update application staging information.
void	updateServiceBindingMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)
String	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, ServicePlanVisibility visibility)	Service plans are private by default when a service broker's catalog is fetched/updated.
void	updateServiceSyslogDrainUrl(String serviceName, String syslogDrainUrl)
void	updateServiceTags(String serviceName, List<String> tags)

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,
                                 CloudSpace target,
                                 boolean trustSelfSignedCerts)

CloudControllerClientImpl

public CloudControllerClientImpl(CloudControllerRestClient delegate)

Construct a client with a pre-configured CloudControllerClient

Method Detail

getTarget

public CloudSpace getTarget()

Specified by:

getTarget in interface CloudControllerClient

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 Optional<String> 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

Returns:

job id for async polling if present

bindServiceInstance

public Optional<String> 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

Returns:

job id for async polling if present

createApplication

public void createApplication(ApplicationToCreateDto applicationToCreateDto)

Description copied from interface: CloudControllerClient

Create application

Specified by:

createApplication in interface CloudControllerClient

Parameters:

applicationToCreateDto - the application's parameters used for its creation

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 String createServiceBroker(CloudServiceBroker serviceBroker)

Description copied from interface: CloudControllerClient

Create a service broker.

Specified by:

createServiceBroker in interface CloudControllerClient

Parameters:

serviceBroker - cloud service broker info

Returns:

job id for async poll

createAndFetchServiceKey

public CloudServiceKey createAndFetchServiceKey(CloudServiceKey keyModel,
                                                String serviceInstanceName)

Specified by:

createAndFetchServiceKey in interface CloudControllerClient

Parameters:

keyModel - service-key cloud object

serviceInstanceName - name of related service instance

Returns:

the service-key object populated with new guid

createServiceKey

public Optional<String> createServiceKey(CloudServiceKey keyModel,
                                         String serviceInstanceName)

Specified by:

createServiceKey in interface CloudControllerClient

Parameters:

keyModel - service-key cloud object

serviceInstanceName - name of related service instance

Returns:

job id for async polling if present

createServiceKey

public Optional<String> 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:

job id for async polling if present

createUserProvidedServiceInstance

public void createUserProvidedServiceInstance(CloudServiceInstance serviceInstance)

Description copied from interface: CloudControllerClient

Create a user-provided service instance.

Specified by:

createUserProvidedServiceInstance in interface CloudControllerClient

Parameters:

serviceInstance - cloud service instance info

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 void 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 String deleteServiceBroker(String name)

Description copied from interface: CloudControllerClient

Delete a service broker.

Specified by:

deleteServiceBroker in interface CloudControllerClient

Parameters:

name - the service broker name

Returns:

async job id

getServiceBinding

public CloudServiceBinding getServiceBinding(UUID serviceBindingId)

Description copied from interface: CloudControllerClient

Get a service binding

Specified by:

getServiceBinding in interface CloudControllerClient

Parameters:

serviceBindingId - the id of the service binding

Returns:

the service binding

deleteServiceBinding

public Optional<String> deleteServiceBinding(String serviceInstanceName,
                                             String serviceKeyName)

Description copied from interface: CloudControllerClient

Delete a service binding.

Specified by:

deleteServiceBinding in interface CloudControllerClient

Parameters:

serviceInstanceName - name of service instance

serviceKeyName - name of service key

Returns:

job id for async polling if present

deleteServiceBinding

public Optional<String> deleteServiceBinding(UUID bindingGuid,
                                             ServiceBindingOperationCallback serviceBindingOperationCallback)

Description copied from interface: CloudControllerClient

Delete a service binding.

Specified by:

deleteServiceBinding in interface CloudControllerClient

Parameters:

bindingGuid - The GUID of the binding

serviceBindingOperationCallback - callback used for error handling

Returns:

job id for async polling if present

deleteServiceBinding

public Optional<String> deleteServiceBinding(UUID bindingGuid)

Description copied from interface: CloudControllerClient

Delete a service binding.

Specified by:

deleteServiceBinding in interface CloudControllerClient

Parameters:

bindingGuid - The GUID of the binding

Returns:

job id for async polling if present

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

getApplicationGuid

public UUID getApplicationGuid(String applicationName)

Description copied from interface: CloudControllerClient

Get the GUID of the cloud application with the specified name.

Specified by:

getApplicationGuid in interface CloudControllerClient

Parameters:

applicationName - name of the app

Returns:

the cloud application's guid

getApplicationName

public String getApplicationName(UUID applicationGuid)

Specified by:

getApplicationName in interface CloudControllerClient

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

getApplicationInstances

public InstancesInfo getApplicationInstances(UUID applicationGuid)

Specified by:

getApplicationInstances in interface CloudControllerClient

getApplicationProcess

public CloudProcess getApplicationProcess(UUID applicationGuid)

Specified by:

getApplicationProcess in interface CloudControllerClient

getApplicationRoutes

public List<CloudRoute> getApplicationRoutes(UUID applicationGuid)

Specified by:

getApplicationRoutes in interface CloudControllerClient

getApplicationSshEnabled

public boolean getApplicationSshEnabled(UUID applicationGuid)

Specified by:

getApplicationSshEnabled in interface CloudControllerClient

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

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

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

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:

the service brokers

getRequiredServiceInstanceGuid

public UUID getRequiredServiceInstanceGuid(String name)

Description copied from interface: CloudControllerClient

Get the GUID of a service instance.

Specified by:

getRequiredServiceInstanceGuid in interface CloudControllerClient

Parameters:

name - the name of the service instance

Returns:

the service instance GUID

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 service instance is not found, throw an exception

Returns:

the service instance info

getServiceInstanceName

public String getServiceInstanceName(UUID serviceInstanceGuid)

Description copied from interface: CloudControllerClient

Get a service instance name.

Specified by:

getServiceInstanceName in interface CloudControllerClient

Parameters:

serviceInstanceGuid - GUID of the service instance

Returns:

the service instance name

getServiceInstanceWithoutAuxiliaryContent

public CloudServiceInstance getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName)

Description copied from interface: CloudControllerClient

Get a service instance.

Specified by:

getServiceInstanceWithoutAuxiliaryContent in interface CloudControllerClient

Parameters:

serviceInstanceName - name of the service instance

Returns:

the service instance info

getServiceInstanceWithoutAuxiliaryContent

public CloudServiceInstance getServiceInstanceWithoutAuxiliaryContent(String serviceInstanceName,
                                                                      boolean required)

Description copied from interface: CloudControllerClient

Get a service instance.

Specified by:

getServiceInstanceWithoutAuxiliaryContent in interface CloudControllerClient

Parameters:

serviceInstanceName - name of the service instance

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

Returns:

the service instance info

getServiceAppBindings

public List<CloudServiceBinding> getServiceAppBindings(UUID serviceInstanceGuid)

Description copied from interface: CloudControllerClient

Get the bindings for a particular service instance.

Specified by:

getServiceAppBindings in interface CloudControllerClient

Parameters:

serviceInstanceGuid - the GUID of the service instance

Returns:

the bindings

getAppBindings

public List<CloudServiceBinding> getAppBindings(UUID applicationGuid)

Description copied from interface: CloudControllerClient

Get the bindings for a particular application.

Specified by:

getAppBindings in interface CloudControllerClient

Parameters:

applicationGuid - the GUID of the application

Returns:

the bindings

getServiceBindingForApplication

public CloudServiceBinding getServiceBindingForApplication(UUID applicationId,
                                                           UUID serviceInstanceGuid)

Description copied from interface: CloudControllerClient

Get the binding between an application and a service instance.

Specified by:

getServiceBindingForApplication in interface CloudControllerClient

Parameters:

applicationId - the GUID of the application

serviceInstanceGuid - the GUID of the service instance

Returns:

the binding

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

getUserProvidedServiceInstanceParameters

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

Description copied from interface: CloudControllerClient

Get all user-provided service instance parameters

Specified by:

getUserProvidedServiceInstanceParameters in interface CloudControllerClient

Parameters:

guid - The service instance guid

Returns:

user-provided 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

getServiceKey

public CloudServiceKey getServiceKey(String serviceInstanceName,
                                     String serviceKeyName)

Description copied from interface: CloudControllerClient

Get a service key.

Specified by:

getServiceKey in interface CloudControllerClient

Parameters:

serviceInstanceName - The service instance name

serviceKeyName - The service key name

Returns:

the service key info

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

getServiceKeysWithCredentials

public List<CloudServiceKey> getServiceKeysWithCredentials(String serviceInstanceName)

Specified by:

getServiceKeysWithCredentials in interface CloudControllerClient

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

getServiceKeysWithCredentials

public List<CloudServiceKey> getServiceKeysWithCredentials(CloudServiceInstance serviceInstance)

Specified by:

getServiceKeysWithCredentials in interface CloudControllerClient

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

getServiceInstancesByMetadataLabelSelector

public List<CloudServiceInstance> getServiceInstancesByMetadataLabelSelector(String labelSelector)

Specified by:

getServiceInstancesByMetadataLabelSelector in interface CloudControllerClient

getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector

public List<CloudServiceInstance> getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector(String labelSelector)

Specified by:

getServiceInstancesWithoutAuxiliaryContentByMetadataLabelSelector 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

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

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 void restartApplication(String applicationName)

Description copied from interface: CloudControllerClient

Restart application.

Specified by:

restartApplication in interface CloudControllerClient

Parameters:

applicationName - name of application

startApplication

public void 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

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 Optional<String> 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

Returns:

job id for async polling if present

unbindServiceInstance

public Optional<String> 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

Returns:

job id for async polling if present

unbindServiceInstance

public Optional<String> unbindServiceInstance(UUID applicationGuid,
                                              UUID serviceInstanceGuid)

Description copied from interface: CloudControllerClient

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

Specified by:

unbindServiceInstance in interface CloudControllerClient

Parameters:

applicationGuid - the application guid

serviceInstanceGuid - the service instance guid

Returns:

job id for async polling if present

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

getServiceInstancesWithoutAuxiliaryContentByNames

public List<CloudServiceInstance> getServiceInstancesWithoutAuxiliaryContentByNames(List<String> names)

Specified by:

getServiceInstancesWithoutAuxiliaryContentByNames 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

updateApplicationRoutes

public void updateApplicationRoutes(String applicationName,
                                    Set<CloudRoute> routes)

Description copied from interface: CloudControllerClient

Update application Routes.

Specified by:

updateApplicationRoutes in interface CloudControllerClient

Parameters:

applicationName - name of application

routes - list of route summary info for the routes the app should use

updateApplicationMetadata

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

Specified by:

updateApplicationMetadata in interface CloudControllerClient

updateServiceInstanceMetadata

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

Specified by:

updateServiceInstanceMetadata in interface CloudControllerClient

updateServiceBindingMetadata

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

Specified by:

updateServiceBindingMetadata in interface CloudControllerClient

updateServiceBroker

public String 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

Returns:

async job id

updateServicePlanVisibilityForBroker

public void updateServicePlanVisibilityForBroker(String name,
                                                 ServicePlanVisibility 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

updateServiceSyslogDrainUrl

public void updateServiceSyslogDrainUrl(String serviceName,
                                        String syslogDrainUrl)

Specified by:

updateServiceSyslogDrainUrl in interface CloudControllerClient

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

getUserRolesBySpaceAndUser

public Set<UserRole> getUserRolesBySpaceAndUser(UUID spaceGuid,
                                                UUID userGuid)

Specified by:

getUserRolesBySpaceAndUser in interface CloudControllerClient

createDockerPackage

public CloudPackage createDockerPackage(UUID applicationGuid,
                                        DockerInfo dockerInfo)

Specified by:

createDockerPackage in interface CloudControllerClient

getAsyncJob

public CloudAsyncJob getAsyncJob(String jobId)

Specified by:

getAsyncJob in interface CloudControllerClient