CloudControllerClient (Cloud Foundry Java Client Library 1.21.7 API)

All Known Implementing Classes:

CloudControllerClientImpl
```
public interface CloudControllerClient
```
The interface defining operations making up the Cloud Foundry Java client's API.

Author:

Ramnivas Laddad, A.B.Srinivasan, Jennifer Hickey, Dave Syer, Thomas Risberg, Alexander Orlov

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and 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.
`void`	`associateAuditorWithSpace(String spaceName)` Associate current user to the space auditors role
`void`	`associateAuditorWithSpace(String organizationName, String spaceName)` Associate current user to the space auditors role
`void`	`associateAuditorWithSpace(String organizationName, String spaceName, String userGuid)` Associate a user to the space auditors role
`void`	`associateDeveloperWithSpace(String spaceName)` Associate current user to the space developer role
`void`	`associateDeveloperWithSpace(String organizationName, String spaceName)` Associate current user to the space developer role
`void`	`associateDeveloperWithSpace(String organizationName, String spaceName, String userGuid)` Associate a user to the space developer role
`void`	`associateManagerWithSpace(String spaceName)` Associate current user to the space managers role
`void`	`associateManagerWithSpace(String organizationName, String spaceName)` Associate current user to the space managers role
`void`	`associateManagerWithSpace(String organizationName, String spaceName, String userGuid)` Associate a user to the space managers role
`UploadToken`	`asyncUploadApplication(String applicationName, File file)`
`UploadToken`	`asyncUploadApplication(String applicationName, File file, UploadStatusCallback callback)`
`void`	`bindDropletToApp(UUID dropletGuid, UUID applicationGuid)`
`void`	`bindRunningSecurityGroup(String securityGroupName)` Bind a security group to the list of security groups to be used for running applications.
`void`	`bindSecurityGroup(String organizationName, String spaceName, String securityGroupName)` Bind a security group to a space.
`void`	`bindService(String applicationName, String serviceName)` Associate (provision) a service with an application.
`void`	`bindService(String applicationName, String serviceName, Map<String,Object> parameters, ApplicationServicesUpdateCallback updateServicesCallback)` Associate (provision) a service with an application.
`void`	`bindStagingSecurityGroup(String securityGroupName)` Bind a security group to the list of security groups to be used for staging applications.
`CloudTask`	`cancelTask(UUID taskGuid)` Cancel the given task.
`void`	`createApplication(String applicationName, Staging staging, Integer disk, Integer memory, List<String> uris, List<String> serviceNames, DockerInfo dockerInfo)` Create application.
`void`	`createApplication(String applicationName, Staging staging, Integer memory, List<String> uris, List<String> serviceNames)` Create application.
`CloudBuild`	`createBuild(UUID packageGuid)`
`void`	`createQuota(CloudQuota quota)` Create quota
`void`	`createSecurityGroup(CloudSecurityGroup securityGroup)` Create a new CloudSecurityGroup.
`void`	`createSecurityGroup(String name, InputStream jsonRulesFile)` Create a new CloudSecurityGroup using a JSON rules file.
`void`	`createService(CloudService service)` Create a service.
`void`	`createServiceBroker(CloudServiceBroker serviceBroker)` Create a service broker.
`CloudServiceKey`	`createServiceKey(String serviceName, String serviceKeyName, Map<String,Object> parameters)` Create a service key.
`void`	`createSpace(String spaceName)` Create a space with the specified name
`void`	`createUserProvidedService(CloudService service, Map<String,Object> credentials)` Create a user-provided service.
`void`	`createUserProvidedService(CloudService service, Map<String,Object> credentials, String syslogDrainUrl)` Create a user-provided service for logging.
`void`	`deleteAllApplications()` Delete all applications.
`void`	`deleteAllServices()` Delete all services.
`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`	`deleteQuota(String quotaName)` Delete quota by name
`void`	`deleteRoute(String host, String domainName, String path)` Delete a registered route from the space of the current session.
`void`	`deleteSecurityGroup(String securityGroupName)` Deletes the security group with the given name.
`void`	`deleteService(String service)` Delete cloud service.
`void`	`deleteServiceBroker(String name)` Delete a service broker.
`void`	`deleteServiceKey(String service, String serviceKey)` Delete a service key.
`void`	`deleteSpace(String spaceName)` Delete a space with the specified name
`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 guid)` 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 cloud applications.
`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.
`Map<String,String>`	`getCrashLogs(String applicationName)` Deprecated. Use `#streamLogs(String, ApplicationLogListener)` or `getRecentLogs(String)`
`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.
`String`	`getFile(String applicationName, int instanceIndex, String filePath)` Get file from the deployed application.
`String`	`getFile(String applicationName, int instanceIndex, String filePath, int startPosition)` Get a the content, starting at a specific position, of a file from the deployed application.
`String`	`getFile(String applicationName, int instanceIndex, String filePath, int startPosition, int endPosition)` Get a range of content of a file from the deployed application.
`String`	`getFileTail(String applicationName, int instanceIndex, String filePath, int length)` Get a the last bytes, with length as specified, of content of a file from the deployed application.
`Map<String,String>`	`getLogs(String applicationName)` Deprecated. Use `#streamLogs(String, ApplicationLogListener)` or `getRecentLogs(String)`
`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 list of CloudOrganizations for the current cloud.
`Map<String,CloudUser>`	`getOrganizationUsers(String organizationName)` Get all users in the specified organization
`List<CloudDomain>`	`getPrivateDomains()` Get list of all private domains.
`CloudQuota`	`getQuota(String quotaName)` Get quota by name
`CloudQuota`	`getQuota(String quotaName, boolean required)` Get quota by name
`List<CloudQuota>`	`getQuotas()` Get quota definitions
`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.
`List<CloudSecurityGroup>`	`getRunningSecurityGroups()` List security groups in the set of security groups for running applications.
`CloudSecurityGroup`	`getSecurityGroup(String securityGroupName)` Get a specific security group by name.
`CloudSecurityGroup`	`getSecurityGroup(String securityGroupName, boolean required)` Get a specific security group by name.
`List<CloudSecurityGroup>`	`getSecurityGroups()` Get a List of all application security groups.
`CloudService`	`getService(String service)` Get cloud service.
`CloudService`	`getService(String service, boolean required)` Get cloud service.
`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 service)` Get a service instance.
`CloudServiceInstance`	`getServiceInstance(String service, boolean required)` Get a service instance.
`List<CloudServiceKey>`	`getServiceKeys(String serviceName)` Get service keys for a service.
`List<CloudServiceOffering>`	`getServiceOfferings()` Get all service offerings.
`Map<String,Object>`	`getServiceParameters(UUID guid)` Get all service parameters.
`List<CloudService>`	`getServices()` Get list of cloud services.
`List<CloudService>`	`getServicesByMetadataLabelSelector(String labelSelector)`
`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 list of CloudSpaces for the current cloud.
`List<CloudSpace>`	`getSpaces(String organizationName)` Get list of CloudSpaces for organization.
`List<CloudSpace>`	`getSpacesBoundToSecurityGroup(String securityGroupName)` Gets all the spaces that are bound to the given security group.
`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.
`List<CloudSecurityGroup>`	`getStagingSecurityGroups()` Lists security groups in the staging set for 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`	`register(String email, String password)` Register new user account with the provided credentials.
`void`	`registerRestLogListener(RestLogCallback callBack)` Register a new RestLogCallback
`void`	`removeDomain(String domainName)` Deprecated. alias for `deleteDomain(java.lang.String)`
`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.
`void`	`setQuotaToOrganization(String organizationName, String quotaName)` Set quota to organization
`void`	`setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)` Override the default REST response error handler with a custom error handler.
`StartingInfo`	`startApplication(String applicationName)` Start application.
`void`	`stopApplication(String applicationName)` Stop application.
`void`	`unbindRunningSecurityGroup(String securityGroupName)` Unbind a security group from the set of security groups for running applications.
`void`	`unbindSecurityGroup(String organizationName, String spaceName, String securityGroupName)` Unbind a security group from a space.
`void`	`unbindService(String applicationName, String serviceName)` Un-associate (unprovision) a service from an application.
`void`	`unbindService(String applicationName, String serviceName, ApplicationServicesUpdateCallback applicationServicesUpdateCallback)` Un-associate (unprovision) a service from an application.
`void`	`unbindStagingSecurityGroup(String securityGroupName)` Unbind a security group from the set of security groups for staging applications.
`void`	`unregister()` Unregister and log out the currently logged in user
`void`	`unRegisterRestLogListener(RestLogCallback callBack)` Un-register a RestLogCallback
`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`	`updatePassword(CloudCredentials credentials, String newPassword)` Update the password for the logged in user using the username/old_password provided in the credentials.
`void`	`updatePassword(String newPassword)` Update the password for the logged in user.
`void`	`updateQuota(CloudQuota quota, String name)` Update Quota definition
`void`	`updateSecurityGroup(CloudSecurityGroup securityGroup)` Update an existing security group.
`void`	`updateSecurityGroup(String name, InputStream jsonRulesFile)` Updates a existing CloudSecurityGroup using a JSON rules file.
`void`	`updateServiceBroker(CloudServiceBroker serviceBroker)` Update a service broker (unchanged forces catalog refresh).
`void`	`updateServiceMetadata(UUID guid, org.cloudfoundry.client.v3.Metadata metadata)`
`void`	`updateServicePlanVisibilityForBroker(String name, boolean visibility)` Service plans are private by default when a service broker's catalog is fetched/updated.
`void`	`uploadApplication(String applicationName, File file)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String applicationName, File file, UploadStatusCallback callback)` Upload an application to Cloud Foundry.
`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.

- Method Detail
  - addDomain
```
void addDomain(String domainName)
```
    Add a private domain in the current organization.
    
    Parameters:
    
    domainName - the domain to add
  - addRoute
```
void addRoute(String host,
              String domainName,
              String path)
```
    Register a new route to the a domain.
    
    Parameters:
    
    host - the host of the route to register
    
    domainName - the domain of the route to register
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String spaceName)
```
    Associate current user to the space auditors role
    
    Parameters:
    
    spaceName - name of the space
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String organizationName,
                               String spaceName)
```
    Associate current user to the space auditors role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String organizationName,
                               String spaceName,
                               String userGuid)
```
    Associate a user to the space auditors role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    userGuid - guid of the user. If null, use current user. To retrieve user guid, use getOrganizationUsers and search for username
  - associateDeveloperWithSpace
```
void associateDeveloperWithSpace(String spaceName)
```
    Associate current user to the space developer role
    
    Parameters:
    
    spaceName - name of the space
  - associateDeveloperWithSpace
```
void associateDeveloperWithSpace(String organizationName,
                                 String spaceName)
```
    Associate current user to the space developer role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
  - associateDeveloperWithSpace
```
void associateDeveloperWithSpace(String organizationName,
                                 String spaceName,
                                 String userGuid)
```
    Associate a user to the space developer role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    userGuid - guid of the user. If null, use current user. To retrieve user guid, use getOrganizationUsers and search for username
  - associateManagerWithSpace
```
void associateManagerWithSpace(String spaceName)
```
    Associate current user to the space managers role
    
    Parameters:
    
    spaceName - name of the space
  - associateManagerWithSpace
```
void associateManagerWithSpace(String organizationName,
                               String spaceName)
```
    Associate current user to the space managers role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
  - associateManagerWithSpace
```
void associateManagerWithSpace(String organizationName,
                               String spaceName,
                               String userGuid)
```
    Associate a user to the space managers role
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    userGuid - guid of the user. If null, use current user. To retrieve user guid, use getOrganizationUsers and search for username
  - bindRunningSecurityGroup
```
void bindRunningSecurityGroup(String securityGroupName)
```
    Bind a security group to the list of security groups to be used for running applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - bindSecurityGroup
```
void bindSecurityGroup(String organizationName,
                       String spaceName,
                       String securityGroupName)
```
    Bind a security group to a space.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    organizationName - The name of the organization that the space is in.
    
    spaceName - The name of the space
    
    securityGroupName - The name of the security group to bind to the space
    
    Throws:
    
    CloudOperationException - if the org, space, or security group do not exist
  - bindService
```
void bindService(String applicationName,
                 String serviceName)
```
    Associate (provision) a service with an application.
    
    Parameters:
    
    applicationName - the application name
    
    serviceName - the service name
  - bindService
```
void bindService(String applicationName,
                 String serviceName,
                 Map<String,Object> parameters,
                 ApplicationServicesUpdateCallback updateServicesCallback)
```
    Associate (provision) a service with an application.
    
    Parameters:
    
    applicationName - the application name
    
    serviceName - the service name
    
    parameters - the binding parameters
    
    applicationServicesUpdateCallback - callback used for error handling
  - bindStagingSecurityGroup
```
void bindStagingSecurityGroup(String securityGroupName)
```
    Bind a security group to the list of security groups to be used for staging applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - createApplication
```
void createApplication(String applicationName,
                       Staging staging,
                       Integer memory,
                       List<String> uris,
                       List<String> serviceNames)
```
    Create application.
    
    Parameters:
    
    applicationName - application name
    
    staging - staging info
    
    memory - memory to use in MB
    
    uris - list of URIs for the app
    
    serviceNames - list of service names to bind to app
  - createApplication
```
void createApplication(String applicationName,
                       Staging staging,
                       Integer disk,
                       Integer memory,
                       List<String> uris,
                       List<String> serviceNames,
                       DockerInfo dockerInfo)
```
    Create application.
    
    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
    
    serviceNames - list of service names to bind to app
    
    dockerInfo - docker params(image, username, password)
  - createQuota
```
void createQuota(CloudQuota quota)
```
    Create quota
    
    Parameters:
    
    quota -
  - createSecurityGroup
```
void createSecurityGroup(CloudSecurityGroup securityGroup)
```
    Create a new CloudSecurityGroup.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    securityGroup -
  - createSecurityGroup
```
void createSecurityGroup(String name,
                         InputStream jsonRulesFile)
```
    Create a new CloudSecurityGroup using a JSON rules file. This is equivalent to cf create-security-group SECURITY-GROUP PATH-TO-RULES-FILE when using the cf command line. See the Application Security Group documentation for more details.
    Example JSON-formatted rules file:
```
 
 [
  {
 		"protocol":"tcp",
 		"destination":"10.0.11.0/24",
 		"ports":"1-65535"
  },
  {
  	"protocol":"udp",
  	"destination":"10.0.11.0/24",
  	"ports":"1-65535"
  }
 ]
  
 
```
    This method requires the logged in user to have admin permissions in the cloud controller.
    Parameters:
    
    name - the name for the security group
    
    jsonRulesFile - An input stream that has a single array with JSON objects inside describing the rules
    
    See Also:
    
    http://docs.cloudfoundry.org/adminguide/app-sec-groups.html
  - createService
```
void createService(CloudService service)
```
    Create a service.
    
    Parameters:
    
    service - cloud service info
  - createServiceBroker
```
void createServiceBroker(CloudServiceBroker serviceBroker)
```
    Create a service broker.
    
    Parameters:
    
    serviceBroker - cloud service broker info
  - createServiceKey
```
CloudServiceKey createServiceKey(String serviceName,
                                 String serviceKeyName,
                                 Map<String,Object> parameters)
```
    Create a service key.
    
    Parameters:
    
    service - name of service
    
    serviceKey - name of service-key
    
    parameters - parameters of service-key
    
    Returns:
  - createSpace
```
void createSpace(String spaceName)
```
    Create a space with the specified name
    
    Parameters:
    
    spaceName -
  - createUserProvidedService
```
void createUserProvidedService(CloudService service,
                               Map<String,Object> credentials)
```
    Create a user-provided service.
    
    Parameters:
    
    service - cloud service info
    
    credentials - the user-provided service credentials
  - createUserProvidedService
```
void createUserProvidedService(CloudService service,
                               Map<String,Object> credentials,
                               String syslogDrainUrl)
```
    Create a user-provided service for logging.
    
    Parameters:
    
    service - cloud service info
    
    credentials - the user-provided service credentials
    
    syslogDrainUrl - for a logging service
  - deleteAllApplications
```
void deleteAllApplications()
```
    Delete all applications.
  - deleteAllServices
```
void deleteAllServices()
```
    Delete all services.
  - deleteApplication
```
void deleteApplication(String applicationName)
```
    Delete application.
    
    Parameters:
    
    applicationName - name of application
  - deleteDomain
```
void deleteDomain(String domainName)
```
    Delete a private domain in the current organization.
    
    Parameters:
    
    domainName - the domain to delete
  - deleteOrphanedRoutes
```
List<CloudRoute> deleteOrphanedRoutes()
```
    Delete routes that do not have any application which is assigned to them.
  - deleteQuota
```
void deleteQuota(String quotaName)
```
    Delete quota by name
    
    Parameters:
    
    quotaName -
  - deleteRoute
```
void deleteRoute(String host,
                 String domainName,
                 String path)
```
    Delete a registered route from the space of the current session.
    
    Parameters:
    
    host - the host of the route to delete
    
    domainName - the domain of the route to delete
  - deleteSecurityGroup
```
void deleteSecurityGroup(String securityGroupName)
```
    Deletes the security group with the given name.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    securityGroupName -
    
    Throws:
    
    CloudOperationException - if a security group does not exist with the given name
  - deleteService
```
void deleteService(String service)
```
    Delete cloud service.
    
    Parameters:
    
    service - name of service
  - deleteServiceBroker
```
void deleteServiceBroker(String name)
```
    Delete a service broker.
    
    Parameters:
    
    name - the service broker name
  - deleteServiceKey
```
void deleteServiceKey(String service,
                      String serviceKey)
```
    Delete a service key.
    
    Parameters:
    
    serviceName - name of service
    
    serviceKey - name of service key
  - deleteSpace
```
void deleteSpace(String spaceName)
```
    Delete a space with the specified name
    
    Parameters:
    
    spaceName - name of the space
  - getApplication
```
CloudApplication getApplication(String applicationName)
```
    Get cloud application with the specified name.
    
    Parameters:
    
    applicationName - name of the app
    
    Returns:
    
    the cloud application
  - getApplication
```
CloudApplication getApplication(String applicationName,
                                boolean required)
```
    Get cloud application with the specified name.
    
    Parameters:
    
    applicationName - name of the app
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    the cloud application
  - getApplication
```
CloudApplication getApplication(UUID guid)
```
    Get cloud application with the specified GUID.
    
    Parameters:
    
    guid - GUID of the app
    
    Returns:
    
    the cloud application
  - getApplicationEnvironment
```
Map<String,String> getApplicationEnvironment(String applicationName)
```
    Get application environment variables for the app with the specified name.
    
    Parameters:
    
    applicationName - name of the app
    
    Returns:
    
    the cloud application environment variables
  - getApplicationEnvironment
```
Map<String,String> getApplicationEnvironment(UUID applicationGuid)
```
    Get application environment variables for the app with the specified GUID.
    
    Parameters:
    
    applicationGuid - GUID of the app
    
    Returns:
    
    the cloud application environment variables
  - getApplicationEvents
```
List<CloudEvent> getApplicationEvents(String applicationName)
```
    Get application events.
    
    Parameters:
    
    applicationName - name of application
    
    Returns:
    
    application events
  - getApplicationInstances
```
InstancesInfo getApplicationInstances(String applicationName)
```
    Get application instances info for application.
    
    Parameters:
    
    applicationName - name of application.
    
    Returns:
    
    instances info
  - getApplicationInstances
```
InstancesInfo getApplicationInstances(CloudApplication app)
```
    Get application instances info for application.
    
    Parameters:
    
    app - the application.
    
    Returns:
    
    instances info
  - getApplications
```
List<CloudApplication> getApplications()
```
    Get all cloud applications.
    
    Returns:
    
    list of cloud applications
  - getCloudControllerUrl
```
URL getCloudControllerUrl()
```
    Get the URL used for the cloud controller.
    
    Returns:
    
    the cloud controller URL
  - getCloudInfo
```
CloudInfo getCloudInfo()
```
    Get CloudInfo for the current cloud.
    
    Returns:
    
    CloudInfo object containing the cloud info
  - getCrashLogs
```
@Deprecated
Map<String,String> getCrashLogs(String applicationName)
```
    Deprecated. Use #streamLogs(String, ApplicationLogListener) or getRecentLogs(String)
    
    Get logs from most recent crash of the deployed application. The logs will be returned in a Map keyed by the path of the log file (logs/stderr.log, logs/stdout.log).
    
    Parameters:
    
    applicationName - name of the application
    
    Returns:
    
    a Map containing the logs. The logs will be returned with the path to the log file used as the key and the full content of the log file will be returned as a String value for the corresponding key.
  - getDefaultDomain
```
CloudDomain getDefaultDomain()
```
    Gets the default domain for the current org, which is the first shared domain.
    
    Returns:
    
    the default domain
  - getDomains
```
List<CloudDomain> getDomains()
```
    Get list of all domain shared and private domains.
    
    Returns:
    
    list of domains
  - getDomainsForOrganization
```
List<CloudDomain> getDomainsForOrganization()
```
    Get list of all domain registered for the current organization.
    
    Returns:
    
    list of domains
  - getEvents
```
List<CloudEvent> getEvents()
```
    Get system events.
    
    Returns:
    
    all system events
  - getFile
```
String getFile(String applicationName,
               int instanceIndex,
               String filePath)
```
    Get file from the deployed application.
    
    Parameters:
    
    applicationName - name of the application
    
    instanceIndex - instance index
    
    filePath - path to the file
    
    Returns:
    
    the contents of the file
  - getFile
```
String getFile(String applicationName,
               int instanceIndex,
               String filePath,
               int startPosition)
```
    Get a the content, starting at a specific position, of a file from the deployed application.
    
    Parameters:
    
    applicationName - name of the application
    
    instanceIndex - instance index
    
    filePath - path to the file
    
    startPosition - the starting position of the file contents (inclusive)
    
    Returns:
    
    the contents of the file
  - getFile
```
String getFile(String applicationName,
               int instanceIndex,
               String filePath,
               int startPosition,
               int endPosition)
```
    Get a range of content of a file from the deployed application. The range begins at the specified startPosition and extends to the character at endPosition - 1.
    
    Parameters:
    
    applicationName - name of the application
    
    instanceIndex - instance index
    
    filePath - path to the file
    
    startPosition - the starting position of the file contents (inclusive)
    
    endPosition - the ending position of the file contents (exclusive)
    
    Returns:
    
    the contents of the file
  - getFileTail
```
String getFileTail(String applicationName,
                   int instanceIndex,
                   String filePath,
                   int length)
```
    Get a the last bytes, with length as specified, of content of a file from the deployed application.
    
    Parameters:
    
    applicationName - name of the application
    
    instanceIndex - instance index
    
    filePath - path to the file
    
    length - the length of the file contents to retrieve
    
    Returns:
    
    the contents of the file
  - getLogs
```
@Deprecated
Map<String,String> getLogs(String applicationName)
```
    Deprecated. Use #streamLogs(String, ApplicationLogListener) or getRecentLogs(String)
    
    Get logs from the deployed application. The logs will be returned in a Map keyed by the path of the log file (logs/stderr.log, logs/stdout.log).
    
    Parameters:
    
    applicationName - name of the application
    
    Returns:
    
    a Map containing the logs. The logs will be returned with the path to the log file used as the key and the full content of the log file will be returned as a String value for the corresponding key.
  - getOrganization
```
CloudOrganization getOrganization(String organizationName)
```
    Get the organization with the specified name.
    
    Parameters:
    
    organizationName - name of organization
    
    Returns:
  - getOrganization
```
CloudOrganization getOrganization(String organizationName,
                                  boolean required)
```
    Get the organization with the specified name.
    
    Parameters:
    
    organizationName - name of organization
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
  - getOrganizationUsers
```
Map<String,CloudUser> getOrganizationUsers(String organizationName)
```
    Get all users in the specified organization
    
    Parameters:
    
    organizationName - organization name
    
    Returns:
    
    a Map CloudUser with username as key
    
    Throws:
    
    CloudOperationException - if the organization do not exist
  - getOrganizations
```
List<CloudOrganization> getOrganizations()
```
    Get list of CloudOrganizations for the current cloud.
    
    Returns:
    
    List of CloudOrganizations objects containing the organization info
  - getPrivateDomains
```
List<CloudDomain> getPrivateDomains()
```
    Get list of all private domains.
    
    Returns:
    
    list of private domains
  - getQuota
```
CloudQuota getQuota(String quotaName)
```
    Get quota by name
    
    Parameters:
    
    quotaName -
    
    Returns:
    
    CloudQuota instance
  - getQuota
```
CloudQuota getQuota(String quotaName,
                    boolean required)
```
    Get quota by name
    
    Parameters:
    
    quotaName -
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    CloudQuota instance
  - getQuotas
```
List<CloudQuota> getQuotas()
```
    Get quota definitions
    
    Returns:
    
    List
  - getRecentLogs
```
List<ApplicationLog> getRecentLogs(String applicationName)
```
    Stream recent log entries. Stream logs that were recently produced for an app.
    
    Parameters:
    
    applicationName - the name of the application
    
    Returns:
    
    the list of recent log entries
  - getRecentLogs
```
List<ApplicationLog> getRecentLogs(UUID applicationGuid)
```
    Get recent log entries. Get logs that were recently produced for an app.
    
    Parameters:
    
    applicationGuid - the guid of the application
    
    Returns:
    
    the list of recent log entries
  - getRoutes
```
List<CloudRoute> getRoutes(String domainName)
```
    Get the info for all routes for a domain.
    
    Parameters:
    
    domainName - the domain the routes belong to
    
    Returns:
    
    list of routes
  - getRunningSecurityGroups
```
List<CloudSecurityGroup> getRunningSecurityGroups()
```
    List security groups in the set of security groups for running applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - getSecurityGroup
```
CloudSecurityGroup getSecurityGroup(String securityGroupName)
```
    Get a specific security group by name.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    securityGroupName - The name of the security group
    
    Returns:
    
    the CloudSecurityGroup
  - getSecurityGroup
```
CloudSecurityGroup getSecurityGroup(String securityGroupName,
                                    boolean required)
```
    Get a specific security group by name.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    securityGroupName - The name of the security group
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    the CloudSecurityGroup or null if no security groups exist with the given name
  - getSecurityGroups
```
List<CloudSecurityGroup> getSecurityGroups()
```
    Get a List of all application security groups.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Returns:
    
    a list of all the CloudSecurityGroups in the system
  - getService
```
CloudService getService(String service)
```
    Get cloud service.
    
    Parameters:
    
    service - name of service
    
    Returns:
    
    the cloud service info
  - getService
```
CloudService getService(String service,
                        boolean required)
```
    Get cloud service.
    
    Parameters:
    
    service - name of service
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    the cloud service info
  - getServiceBroker
```
CloudServiceBroker getServiceBroker(String name)
```
    Get a service broker.
    
    Parameters:
    
    name - the service broker name
    
    Returns:
    
    the service broker
  - getServiceBroker
```
CloudServiceBroker getServiceBroker(String name,
                                    boolean required)
```
    Get a service broker.
    
    Parameters:
    
    name - the service broker name
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    the service broker
  - getServiceBrokers
```
List<CloudServiceBroker> getServiceBrokers()
```
    Get all service brokers.
    
    Returns:
  - getServiceInstance
```
CloudServiceInstance getServiceInstance(String service)
```
    Get a service instance.
    
    Parameters:
    
    service - name of the service instance
    
    Returns:
    
    the service instance info
  - getServiceParameters
```
Map<String,Object> getServiceParameters(UUID guid)
```
    Get all service parameters.
    
    Parameters:
    
    guid - The service instance guid
    
    Returns:
    
    service parameters in key-value pairs
  - getServiceInstance
```
CloudServiceInstance getServiceInstance(String service,
                                        boolean required)
```
    Get a service instance.
    
    Parameters:
    
    service - name of the service instance
    
    required - if true, and organization is not found, throw an exception
    
    Returns:
    
    the service instance info
  - getServiceKeys
```
List<CloudServiceKey> getServiceKeys(String serviceName)
```
    Get service keys for a service.
    
    Parameters:
    
    service - name containing service keys
    
    Returns:
    
    the service keys info
  - getServiceOfferings
```
List<CloudServiceOffering> getServiceOfferings()
```
    Get all service offerings.
    
    Returns:
    
    list of service offerings
  - getServices
```
List<CloudService> getServices()
```
    Get list of cloud services.
    
    Returns:
    
    list of cloud services
  - getSharedDomains
```
List<CloudDomain> getSharedDomains()
```
    Get list of all shared domains.
    
    Returns:
    
    list of shared domains
  - getSpace
```
CloudSpace getSpace(UUID spaceGuid)
```
    Get space name with the specified GUID.
  - getSpace
```
CloudSpace getSpace(String organizationName,
                    String spaceName)
```
    Get space name with the specified name.
  - getSpace
```
CloudSpace getSpace(String organizationName,
                    String spaceName,
                    boolean required)
```
    Get space name with the specified name.
  - getSpace
```
CloudSpace getSpace(String spaceName)
```
    Get space name with the specified name.
  - getSpace
```
CloudSpace getSpace(String spaceName,
                    boolean required)
```
    Get space name with the specified name.
  - getSpaceAuditors
```
List<UUID> getSpaceAuditors()
```
  - getSpaceAuditors
```
List<UUID> getSpaceAuditors(String spaceName)
```
    Get list of space auditor UUID for the space.
    
    Parameters:
    
    spaceName - name of the space
    
    Returns:
    
    List of space auditor UUID
  - getSpaceAuditors
```
List<UUID> getSpaceAuditors(String organizationName,
                            String spaceName)
```
    Get list of space auditor UUID for the space.
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    Returns:
    
    List of space auditor UUID
  - getSpaceAuditors
```
List<UUID> getSpaceAuditors(UUID spaceGuid)
```
  - getSpaceDevelopers
```
List<UUID> getSpaceDevelopers()
```
  - getSpaceDevelopers
```
List<UUID> getSpaceDevelopers(String spaceName)
```
    Get list of space developer UUID for the space.
    
    Parameters:
    
    spaceName - name of the space
    
    Returns:
    
    List of space developer UUID
  - getSpaceDevelopers
```
List<UUID> getSpaceDevelopers(String organizationName,
                              String spaceName)
```
    Get list of space developer UUID for the space.
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    Returns:
    
    List of space developer UUID
  - getSpaceDevelopers
```
List<UUID> getSpaceDevelopers(UUID spaceGuid)
```
  - getSpaceManagers
```
List<UUID> getSpaceManagers()
```
  - getSpaceManagers
```
List<UUID> getSpaceManagers(String spaceName)
```
    Get list of space manager UUID for the space.
    
    Parameters:
    
    spaceName - name of the space
    
    Returns:
    
    List of space manager UUID
  - getSpaceManagers
```
List<UUID> getSpaceManagers(String organizationName,
                            String spaceName)
```
    Get list of space manager UUID for the space.
    
    Parameters:
    
    organizationName - name of the organization containing the space
    
    spaceName - name of the space
    
    Returns:
    
    List of space manager UUID
  - getSpaceManagers
```
List<UUID> getSpaceManagers(UUID spaceGuid)
```
  - getSpaces
```
List<CloudSpace> getSpaces()
```
    Get list of CloudSpaces for the current cloud.
    
    Returns:
    
    List of CloudSpace objects containing the space info
  - getSpaces
```
List<CloudSpace> getSpaces(String organizationName)
```
    Get list of CloudSpaces for organization.
    
    Returns:
    
    List of CloudSpace objects containing the space info
  - getSpacesBoundToSecurityGroup
```
List<CloudSpace> getSpacesBoundToSecurityGroup(String securityGroupName)
```
    Gets all the spaces that are bound to the given security group.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - getStack
```
CloudStack getStack(String name)
```
    Get a stack by name.
    
    Parameters:
    
    name - the name of the stack to get
    
    Returns:
    
    the stack
  - getStack
```
CloudStack getStack(String name,
                    boolean required)
```
    Get a stack by name.
    
    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
```
List<CloudStack> getStacks()
```
    Get the list of stacks available for staging applications.
    
    Returns:
    
    the list of available stacks
  - getStagingSecurityGroups
```
List<CloudSecurityGroup> getStagingSecurityGroups()
```
    Lists security groups in the staging set for applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - login
```
org.springframework.security.oauth2.common.OAuth2AccessToken login()
```
    Login using the credentials already set for the client.
    
    Returns:
    
    authentication token
  - logout
```
void logout()
```
    Logout closing the current session.
  - register
```
void register(String email,
              String password)
```
    Register new user account with the provided credentials.
    
    Parameters:
    
    email - the email account
    
    password - the password
  - registerRestLogListener
```
void registerRestLogListener(RestLogCallback callBack)
```
    Register a new RestLogCallback
    
    Parameters:
    
    callBack - the callback to be registered
  - removeDomain
```
@Deprecated
void removeDomain(String domainName)
```
    Deprecated. alias for deleteDomain(java.lang.String)
    
    Delete a private domain in the current organization.
    
    Parameters:
    
    domainName - the domain to remove
  - rename
```
void rename(String applicationName,
            String newName)
```
    Rename an application.
    
    Parameters:
    
    applicationName - the current name
    
    newName - the new name
  - restartApplication
```
StartingInfo restartApplication(String applicationName)
```
    Restart application.
    
    Parameters:
    
    applicationName - name of application
  - setQuotaToOrganization
```
void setQuotaToOrganization(String organizationName,
                            String quotaName)
```
    Set quota to organization
    
    Parameters:
    
    organizationName -
    
    quotaName -
  - setResponseErrorHandler
```
void setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)
```
    Override the default REST response error handler with a custom error handler.
    
    Parameters:
    
    errorHandler -
  - startApplication
```
StartingInfo startApplication(String applicationName)
```
    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.
    
    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
```
void stopApplication(String applicationName)
```
    Stop application.
    
    Parameters:
    
    applicationName - name of application
  - unRegisterRestLogListener
```
void unRegisterRestLogListener(RestLogCallback callBack)
```
    Un-register a RestLogCallback
    
    Parameters:
    
    callBack - the callback to be un-registered
  - unbindRunningSecurityGroup
```
void unbindRunningSecurityGroup(String securityGroupName)
```
    Unbind a security group from the set of security groups for running applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - unbindSecurityGroup
```
void unbindSecurityGroup(String organizationName,
                         String spaceName,
                         String securityGroupName)
```
    Unbind a security group from a space.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    organizationName - The name of the organization that the space is in.
    
    spaceName - The name of the space
    
    securityGroupName - The name of the security group to bind to the space
    
    Throws:
    
    CloudOperationException - if the org, space, or security group do not exist
  - unbindService
```
void unbindService(String applicationName,
                   String serviceName,
                   ApplicationServicesUpdateCallback applicationServicesUpdateCallback)
```
    Un-associate (unprovision) a service from an application.
    
    Parameters:
    
    applicationName - the application name
    
    serviceName - the service name
    
    applicationServicesUpdateCallback - callback used for error handling
  - unbindService
```
void unbindService(String applicationName,
                   String serviceName)
```
    Un-associate (unprovision) a service from an application.
    
    Parameters:
    
    applicationName - the application name
    
    serviceName - the service name
  - unbindStagingSecurityGroup
```
void unbindStagingSecurityGroup(String securityGroupName)
```
    Unbind a security group from the set of security groups for staging applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
  - unregister
```
void unregister()
```
    Unregister and log out the currently logged in user
  - updateApplicationDiskQuota
```
void updateApplicationDiskQuota(String applicationName,
                                int disk)
```
    Update application disk quota.
    
    Parameters:
    
    applicationName - name of application
    
    disk - new disk setting in MB
  - updateApplicationEnv
```
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..
    
    Parameters:
    
    applicationName - name of application
    
    env - map of environment settings
  - updateApplicationInstances
```
void updateApplicationInstances(String applicationName,
                                int instances)
```
    Update application instances.
    
    Parameters:
    
    applicationName - name of application
    
    instances - number of instances to use
  - updateApplicationMemory
```
void updateApplicationMemory(String applicationName,
                             int memory)
```
    Update application memory.
    
    Parameters:
    
    applicationName - name of application
    
    memory - new memory setting in MB
  - updateApplicationStaging
```
void updateApplicationStaging(String applicationName,
                              Staging staging)
```
    Update application staging information.
    
    Parameters:
    
    applicationName - name of appplication
    
    staging - staging information for the app
  - updateApplicationUris
```
void updateApplicationUris(String applicationName,
                           List<String> uris)
```
    Update application URIs.
    
    Parameters:
    
    applicationName - name of application
    
    uris - list of URIs the app should use
  - updatePassword
```
void updatePassword(String newPassword)
```
    Update the password for the logged in user.
    
    Parameters:
    
    newPassword - the new password
  - updatePassword
```
void updatePassword(CloudCredentials credentials,
                    String newPassword)
```
    Update the password for the logged in user using the username/old_password provided in the credentials.
    
    Parameters:
    
    credentials - current credentials
    
    newPassword - the new password
  - updateQuota
```
void updateQuota(CloudQuota quota,
                 String name)
```
    Update Quota definition
    
    Parameters:
    
    quota -
    
    name -
  - updateSecurityGroup
```
void updateSecurityGroup(CloudSecurityGroup securityGroup)
```
    Update an existing security group.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Parameters:
    
    securityGroup -
    
    Throws:
    
    CloudOperationException - if a security group does not exist with the name of the given CloudSecurityGroup
  - updateSecurityGroup
```
void updateSecurityGroup(String name,
                         InputStream jsonRulesFile)
```
    Updates a existing CloudSecurityGroup using a JSON rules file. This is equivalent to cf update-security-group SECURITY-GROUP PATH-TO-RULES-FILE when using the cf command line. See the Application Security Group documentation for more details.
    Example JSON-formatted rules file:
```
 
 [
  {
 		"protocol":"tcp",
 		"destination":"10.0.11.0/24",
 		"ports":"1-65535"
  },
  {
  	"protocol":"udp",
  	"destination":"10.0.11.0/24",
  	"ports":"1-65535"
  }
 ]
  
 
```
    This method requires the logged in user to have admin permissions in the cloud controller.
    Parameters:
    
    jsonRulesFile - An input stream that has a single array with JSON objects inside describing the rules
    
    Throws:
    
    CloudOperationException - if a security group does not exist with the given name
    
    See Also:
    
    http://docs.cloudfoundry.org/adminguide/app-sec-groups.html
  - updateServiceBroker
```
void updateServiceBroker(CloudServiceBroker serviceBroker)
```
    Update a service broker (unchanged forces catalog refresh).
    
    Parameters:
    
    serviceBroker - cloud service broker info
  - updateServicePlanVisibilityForBroker
```
void updateServicePlanVisibilityForBroker(String name,
                                          boolean visibility)
```
    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.
    
    Parameters:
    
    name - the service broker name
    
    visibility - true for public, false for private
  - uploadApplication
```
void uploadApplication(String applicationName,
                       String file)
                throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    
    applicationName - application name
    
    file - path to the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String applicationName,
                       File file)
                throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    
    applicationName - the application name
    
    file - the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String applicationName,
                       File file,
                       UploadStatusCallback callback)
                throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    
    applicationName - the application name
    
    file - the application archive
    
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String applicationName,
                       InputStream inputStream)
                throws IOException
```
    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.
    
    Parameters:
    
    applicationName - the application name
    
    inputStream - the InputStream to read from
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String applicationName,
                       InputStream inputStream,
                       UploadStatusCallback callback)
                throws IOException
```
    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.
    
    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
```
UploadToken asyncUploadApplication(String applicationName,
                                   File file)
                            throws IOException
```
    Throws:
    
    IOException
  - asyncUploadApplication
```
UploadToken asyncUploadApplication(String applicationName,
                                   File file,
                                   UploadStatusCallback callback)
                            throws IOException
```
    Throws:
    
    IOException
  - getUploadStatus
```
Upload getUploadStatus(UUID packageGuid)
```
  - getTask
```
CloudTask getTask(UUID taskGuid)
```
  - getTasks
```
List<CloudTask> getTasks(String applicationName)
```
    Get the list of one-off tasks currently known for the given application.
    
    Parameters:
    
    applicationName - the application to look for tasks
    
    Returns:
    
    the list of known tasks
    
    Throws:
    
    UnsupportedOperationException - if the targeted controller does not support tasks
  - runTask
```
CloudTask runTask(String applicationName,
                  CloudTask task)
```
    Run a one-off task on an application.
    
    Parameters:
    
    applicationName - the application to run the task on
    
    task - the task to run
    
    Returns:
    
    the ran task
    
    Throws:
    
    UnsupportedOperationException - if the targeted controller does not support tasks
  - cancelTask
```
CloudTask cancelTask(UUID taskGuid)
```
    Cancel the given task.
    
    Parameters:
    
    taskGuid - the GUID of the task to cancel
    
    Returns:
    
    the cancelled task
  - createBuild
```
CloudBuild createBuild(UUID packageGuid)
```
  - getBuild
```
CloudBuild getBuild(UUID buildGuid)
```
  - bindDropletToApp
```
void bindDropletToApp(UUID dropletGuid,
                      UUID applicationGuid)
```
  - getBuildsForApplication
```
List<CloudBuild> getBuildsForApplication(UUID applicationGuid)
```
  - getBuildsForPackage
```
List<CloudBuild> getBuildsForPackage(UUID packageGuid)
```
  - getApplicationsByMetadataLabelSelector
```
List<CloudApplication> getApplicationsByMetadataLabelSelector(String labelSelector)
```
  - updateApplicationMetadata
```
void updateApplicationMetadata(UUID guid,
                               org.cloudfoundry.client.v3.Metadata metadata)
```
  - getServicesByMetadataLabelSelector
```
List<CloudService> getServicesByMetadataLabelSelector(String labelSelector)
```
  - updateServiceMetadata
```
void updateServiceMetadata(UUID guid,
                           org.cloudfoundry.client.v3.Metadata metadata)
```

Interface CloudControllerClient

Method Summary

Method Detail

addDomain

addRoute

associateAuditorWithSpace

associateAuditorWithSpace

associateAuditorWithSpace

associateDeveloperWithSpace

associateDeveloperWithSpace

associateDeveloperWithSpace

associateManagerWithSpace

associateManagerWithSpace

associateManagerWithSpace

bindRunningSecurityGroup

bindSecurityGroup

bindService

bindService

bindStagingSecurityGroup

createApplication

createApplication

createQuota

createSecurityGroup

createSecurityGroup

createService

createServiceBroker

createServiceKey

createSpace

createUserProvidedService

createUserProvidedService

deleteAllApplications

deleteAllServices

deleteApplication

deleteDomain

deleteOrphanedRoutes

deleteQuota

deleteRoute

deleteSecurityGroup

deleteService

deleteServiceBroker

deleteServiceKey

deleteSpace

getApplication

getApplication

getApplication

getApplicationEnvironment

getApplicationEnvironment

getApplicationEvents

getApplicationInstances

getApplicationInstances

getApplications

getCloudControllerUrl

getCloudInfo

getCrashLogs

getDefaultDomain

getDomains

getDomainsForOrganization

getEvents

getFile

getFile

getFile

getFileTail

getLogs

getOrganization

getOrganization

getOrganizationUsers

getOrganizations

getPrivateDomains

getQuota

getQuota

getQuotas

getRecentLogs

getRecentLogs

getRoutes

getRunningSecurityGroups

getSecurityGroup

getSecurityGroup

getSecurityGroups

getService

getService