CloudFoundryClient (Cloud Foundry Java Client Library 1.1.2 API)

java.lang.Object
- org.cloudfoundry.client.lib.CloudFoundryClient

All Implemented Interfaces:

CloudFoundryOperations
```
public class CloudFoundryClient
extends Object
implements CloudFoundryOperations
```
A Java client to exercise the Cloud Foundry API.

Author:

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

Constructor Summary

Constructors
Constructor and Description
`CloudFoundryClient(CloudControllerClient cc)` Construct a client with a pre-configured CloudControllerClient
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl)` Construct client without a default org and space.
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, boolean trustSelfSignedCerts)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, CloudSpace sessionSpace)` Construct a client with a default CloudSpace.
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, CloudSpace sessionSpace, boolean trustSelfSignedCerts)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, CloudSpace sessionSpace, HttpProxyConfiguration httpProxyConfiguration)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, CloudSpace sessionSpace, HttpProxyConfiguration httpProxyConfiguration, boolean trustSelfSignedCerts)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, HttpProxyConfiguration httpProxyConfiguration)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, HttpProxyConfiguration httpProxyConfiguration, boolean trustSelfSignedCerts)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, String orgName, String spaceName)` Construct a client with a default space name and org name.
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, String orgName, String spaceName, boolean trustSelfSignedCerts)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, String orgName, String spaceName, HttpProxyConfiguration httpProxyConfiguration)`
`CloudFoundryClient(CloudCredentials credentials, URL cloudControllerUrl, String orgName, String spaceName, HttpProxyConfiguration httpProxyConfiguration, boolean trustSelfSignedCerts)`
`CloudFoundryClient(URL cloudControllerUrl)` Construct client for anonymous user.
`CloudFoundryClient(URL cloudControllerUrl, boolean trustSelfSignedCerts)`
`CloudFoundryClient(URL cloudControllerUrl, HttpProxyConfiguration httpProxyConfiguration)`
`CloudFoundryClient(URL cloudControllerUrl, HttpProxyConfiguration httpProxyConfiguration, boolean trustSelfSignedCerts)`

Method Summary

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)` Register a new route to the a domain.
`void`	`associateAuditorWithSpace(String spaceName)` Associate current user to the space auditors role
`void`	`associateAuditorWithSpace(String orgName, String spaceName)` Associate current user to the space auditors role
`void`	`associateDeveloperWithSpace(String spaceName)` Associate current user to the space developer role
`void`	`associateDeveloperWithSpace(String orgName, String spaceName)` Associate current user to the space developer role
`void`	`associateManagerWithSpace(String spaceName)` Associate current user to the space managers role
`void`	`associateManagerWithSpace(String orgName, String spaceName)` Associate current user to the space managers role
`void`	`bindRunningSecurityGroup(String securityGroupName)` Bind a security group to the list of security groups to be used for running applications.
`void`	`bindSecurityGroup(String orgName, String spaceName, String securityGroupName)` Bind a security group to a space.
`void`	`bindService(String appName, String serviceName)` 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.
`void`	`createApplication(String appName, Staging staging, Integer disk, Integer memory, List<String> uris, List<String> serviceNames)` Create application.
`void`	`createApplication(String appName, Staging staging, Integer memory, List<String> uris, List<String> serviceNames)` Create application.
`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.
`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`	`debugApplication(String appName, CloudApplication.DebugMode mode)` Debug application.
`void`	`deleteAllApplications()` Delete all applications.
`void`	`deleteAllServices()` Delete all services.
`void`	`deleteApplication(String appName)` 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)` 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`	`deleteSpace(String spaceName)` Delete a space with the specified name
`CloudApplication`	`getApplication(String appName)` Get cloud application with the specified name.
`CloudApplication`	`getApplication(UUID appGuid)` Get cloud application with the specified GUID.
`Map<String,Object>`	`getApplicationEnvironment(String appName)` Get application environment variables for the app with the specified name.
`Map<String,Object>`	`getApplicationEnvironment(UUID appGuid)` Get application environment variables for the app with the specified GUID.
`List<CloudEvent>`	`getApplicationEvents(String appName)` Get application events.
`InstancesInfo`	`getApplicationInstances(CloudApplication app)` Get application instances info for application.
`InstancesInfo`	`getApplicationInstances(String appName)` Get application instances info for application.
`List<CloudApplication>`	`getApplications()` Get all cloud applications.
`ApplicationStats`	`getApplicationStats(String appName)` Get application stats for the app with the specified name.
`URL`	`getCloudControllerUrl()` Get the URL used for the cloud controller.
`CloudInfo`	`getCloudInfo()` Get CloudInfo for the current cloud.
`CrashesInfo`	`getCrashes(String appName)` Get crashes info for application.
`Map<String,String>`	`getCrashLogs(String appName)` 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>`	`getDomainsForOrg()` Get list of all domain registered for the current organization.
`List<CloudEvent>`	`getEvents()` Get system events.
`String`	`getFile(String appName, int instanceIndex, String filePath)` Get file from the deployed application.
`String`	`getFile(String appName, 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 appName, int instanceIndex, String filePath, int startPosition, int endPosition)` Get a range of content of a file from the deployed application.
`String`	`getFileTail(String appName, 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 appName)` Deprecated. use `streamLogs(String, ApplicationLogListener)` or `getRecentLogs(String)`
`List<CloudOrganization>`	`getOrganizations()` Get list of CloudOrganizations for the current cloud.
`CloudOrganization`	`getOrgByName(String orgName, boolean required)` Get the organization with the specified name.
`List<CloudDomain>`	`getPrivateDomains()` Get list of all private domains.
`CloudQuota`	`getQuotaByName(String quotaName, boolean required)` Get quota by name
`List<CloudQuota>`	`getQuotas()` Get quota definitions
`List<ApplicationLog>`	`getRecentLogs(String appName)` Stream 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.
`List<CloudSecurityGroup>`	`getSecurityGroups()` Get a List of all application security groups.
`CloudService`	`getService(String service)` Get cloud service.
`CloudServiceBroker`	`getServiceBroker(String name)` Get a service broker.
`List<CloudServiceBroker>`	`getServiceBrokers()` Get all service brokers.
`CloudServiceInstance`	`getServiceInstance(String service)` Get a service instance.
`List<CloudServiceOffering>`	`getServiceOfferings()` Get all service offerings.
`List<CloudService>`	`getServices()` Get list of cloud services.
`List<CloudDomain>`	`getSharedDomains()` Get list of all shared domains.
`CloudSpace`	`getSpace(String spaceName)` Get space name with the specified name.
`List<UUID>`	`getSpaceAuditors(String spaceName)` Get list of space auditor UUID for the space.
`List<UUID>`	`getSpaceAuditors(String orgName, String spaceName)` Get list of space auditor UUID for the space.
`List<UUID>`	`getSpaceDevelopers(String spaceName)` Get list of space developer UUID for the space.
`List<UUID>`	`getSpaceDevelopers(String orgName, String spaceName)` Get list of space developer UUID for the space.
`List<UUID>`	`getSpaceManagers(String spaceName)` Get list of space manager UUID for the space.
`List<UUID>`	`getSpaceManagers(String orgName, String spaceName)` Get list of space manager UUID for the space.
`List<CloudSpace>`	`getSpaces()` Get list of CloudSpaces for the current cloud.
`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.
`List<CloudStack>`	`getStacks()` Get the list of stacks available for staging applications.
`String`	`getStagingLogs(StartingInfo info, int offset)` Get the staging log while an application is starting.
`List<CloudSecurityGroup>`	`getStagingSecurityGroups()` Lists security groups in the staging set for applications.
`org.springframework.security.oauth2.common.OAuth2AccessToken`	`login()` Login using the credentials already set for the client.
`void`	`logout()` Logout closing the current session.
`void`	`openFile(String appName, int instanceIndex, String filePath, ClientHttpResponseCallback callback)` Provide the content of a file from the deployed application via callbacks.
`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)` Delete a private domain in the current organization.
`void`	`rename(String appName, String newName)` Rename an application.
`StartingInfo`	`restartApplication(String appName)` Restart application.
`void`	`setQuotaToOrg(String orgName, 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 appName)` Start application.
`void`	`stopApplication(String appName)` Stop application.
`StreamingLogToken`	`streamLogs(String appName, ApplicationLogListener listener)` Stream application logs produced after this method is called.
`void`	`unbindRunningSecurityGroup(String securityGroupName)` Unbind a security group from the set of security groups for running applications.
`void`	`unbindSecurityGroup(String orgName, String spaceName, String securityGroupName)` Unbind a security group from a space.
`void`	`unbindService(String appName, String serviceName)` 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 appName, int disk)` Update application disk quota.
`void`	`updateApplicationEnv(String appName, List<String> env)` Update application env using a list of strings each with one environment setting.
`void`	`updateApplicationEnv(String appName, 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 appName, int instances)` Update application instances.
`void`	`updateApplicationMemory(String appName, int memory)` Update application memory.
`void`	`updateApplicationServices(String appName, List<String> services)` Update application services.
`void`	`updateApplicationStaging(String appName, Staging staging)` Update application staging information.
`void`	`updateApplicationUris(String appName, 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`	`updateServicePlanVisibilityForBroker(String name, boolean visibility)` Service plans are private by default when a service broker's catalog is fetched/updated.
`void`	`uploadApplication(String appName, ApplicationArchive archive)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, ApplicationArchive archive, UploadStatusCallback callback)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, File file)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, File file, UploadStatusCallback callback)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, String file)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, String fileName, InputStream inputStream)` Upload an application to Cloud Foundry.
`void`	`uploadApplication(String appName, String fileName, InputStream inputStream, UploadStatusCallback callback)` Upload an application to Cloud Foundry.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CloudFoundryClient
```
public CloudFoundryClient(URL cloudControllerUrl)
```
    Construct client for anonymous user. Useful only to get to the '/info' endpoint.
  - CloudFoundryClient
```
public CloudFoundryClient(URL cloudControllerUrl,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(URL cloudControllerUrl,
                  HttpProxyConfiguration httpProxyConfiguration)
```
  - CloudFoundryClient
```
public CloudFoundryClient(URL cloudControllerUrl,
                  HttpProxyConfiguration httpProxyConfiguration,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl)
```
    Construct client without a default org and space.
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  HttpProxyConfiguration httpProxyConfiguration)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  HttpProxyConfiguration httpProxyConfiguration,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  CloudSpace sessionSpace)
```
    Construct a client with a default CloudSpace.
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  CloudSpace sessionSpace,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  CloudSpace sessionSpace,
                  HttpProxyConfiguration httpProxyConfiguration)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  CloudSpace sessionSpace,
                  HttpProxyConfiguration httpProxyConfiguration,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  String orgName,
                  String spaceName)
```
    Construct a client with a default space name and org name.
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  String orgName,
                  String spaceName,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  String orgName,
                  String spaceName,
                  HttpProxyConfiguration httpProxyConfiguration)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudCredentials credentials,
                  URL cloudControllerUrl,
                  String orgName,
                  String spaceName,
                  HttpProxyConfiguration httpProxyConfiguration,
                  boolean trustSelfSignedCerts)
```
  - CloudFoundryClient
```
public CloudFoundryClient(CloudControllerClient cc)
```
    Construct a client with a pre-configured CloudControllerClient
- Method Detail
  - setResponseErrorHandler
```
public void setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)
```
    Description copied from interface: CloudFoundryOperations
    
    Override the default REST response error handler with a custom error handler.
    
    Specified by:
    
    setResponseErrorHandler in interface CloudFoundryOperations
  - getCloudControllerUrl
```
public URL getCloudControllerUrl()
```
    Description copied from interface: CloudFoundryOperations
    
    Get the URL used for the cloud controller.
    
    Specified by:
    
    getCloudControllerUrl in interface CloudFoundryOperations
    
    Returns:
    the cloud controller URL
  - getCloudInfo
```
public CloudInfo getCloudInfo()
```
    Description copied from interface: CloudFoundryOperations
    
    Get CloudInfo for the current cloud.
    
    Specified by:
    
    getCloudInfo in interface CloudFoundryOperations
    
    Returns:
    CloudInfo object containing the cloud info
  - getSpaces
```
public List<CloudSpace> getSpaces()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of CloudSpaces for the current cloud.
    
    Specified by:
    
    getSpaces in interface CloudFoundryOperations
    
    Returns:
    List of CloudSpace objects containing the space info
  - getOrganizations
```
public List<CloudOrganization> getOrganizations()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of CloudOrganizations for the current cloud.
    
    Specified by:
    
    getOrganizations in interface CloudFoundryOperations
    
    Returns:
    List of CloudOrganizations objects containing the organization info
  - register
```
public void register(String email,
            String password)
```
    Description copied from interface: CloudFoundryOperations
    
    Register new user account with the provided credentials.
    
    Specified by:
    
    register in interface CloudFoundryOperations
    
    Parameters:
    email - the email account
    password - the password
  - updatePassword
```
public void updatePassword(String newPassword)
```
    Description copied from interface: CloudFoundryOperations
    
    Update the password for the logged in user.
    
    Specified by:
    
    updatePassword in interface CloudFoundryOperations
    
    Parameters:
    newPassword - the new password
  - updatePassword
```
public void updatePassword(CloudCredentials credentials,
                  String newPassword)
```
    Description copied from interface: CloudFoundryOperations
    
    Update the password for the logged in user using the username/old_password provided in the credentials.
    
    Specified by:
    
    updatePassword in interface CloudFoundryOperations
    
    Parameters:
    credentials - current credentials
    newPassword - the new password
  - unregister
```
public void unregister()
```
    Description copied from interface: CloudFoundryOperations
    
    Unregister and log out the currently logged in user
    
    Specified by:
    
    unregister in interface CloudFoundryOperations
  - login
```
public org.springframework.security.oauth2.common.OAuth2AccessToken login()
```
    Description copied from interface: CloudFoundryOperations
    
    Login using the credentials already set for the client.
    
    Specified by:
    
    login in interface CloudFoundryOperations
    
    Returns:
    authentication token
  - logout
```
public void logout()
```
    Description copied from interface: CloudFoundryOperations
    
    Logout closing the current session.
    
    Specified by:
    
    logout in interface CloudFoundryOperations
  - getApplications
```
public List<CloudApplication> getApplications()
```
    Description copied from interface: CloudFoundryOperations
    
    Get all cloud applications.
    
    Specified by:
    
    getApplications in interface CloudFoundryOperations
    
    Returns:
    list of cloud applications
  - getApplication
```
public CloudApplication getApplication(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get cloud application with the specified name.
    
    Specified by:
    
    getApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - name of the app
    
    Returns:
    the cloud application
  - getApplication
```
public CloudApplication getApplication(UUID appGuid)
```
    Description copied from interface: CloudFoundryOperations
    
    Get cloud application with the specified GUID.
    
    Specified by:
    
    getApplication in interface CloudFoundryOperations
    
    Parameters:
    appGuid - GUID of the app
    
    Returns:
    the cloud application
  - getApplicationEnvironment
```
public Map<String,Object> getApplicationEnvironment(UUID appGuid)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application environment variables for the app with the specified GUID.
    
    Specified by:
    
    getApplicationEnvironment in interface CloudFoundryOperations
    
    Parameters:
    appGuid - GUID of the app
    
    Returns:
    the cloud application environment variables
  - getApplicationEnvironment
```
public Map<String,Object> getApplicationEnvironment(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application environment variables for the app with the specified name.
    
    Specified by:
    
    getApplicationEnvironment in interface CloudFoundryOperations
    
    Parameters:
    appName - name of the app
    
    Returns:
    the cloud application environment variables
  - getApplicationStats
```
public ApplicationStats getApplicationStats(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application stats for the app with the specified name.
    
    Specified by:
    
    getApplicationStats in interface CloudFoundryOperations
    
    Parameters:
    appName - name of the app
    
    Returns:
    the cloud application stats
  - createApplication
```
public void createApplication(String appName,
                     Staging staging,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)
```
    Description copied from interface: CloudFoundryOperations
    
    Create application.
    
    Specified by:
    
    createApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - 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
```
public void createApplication(String appName,
                     Staging staging,
                     Integer disk,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)
```
    Description copied from interface: CloudFoundryOperations
    
    Create application.
    
    Specified by:
    
    createApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - 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
  - createService
```
public void createService(CloudService service)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a service.
    
    Specified by:
    
    createService in interface CloudFoundryOperations
    
    Parameters:
    service - cloud service info
  - createUserProvidedService
```
public void createUserProvidedService(CloudService service,
                             Map<String,Object> credentials)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a user-provided service.
    
    Specified by:
    
    createUserProvidedService in interface CloudFoundryOperations
    
    Parameters:
    service - cloud service info
    credentials - the user-provided service credentials
  - createUserProvidedService
```
public void createUserProvidedService(CloudService service,
                             Map<String,Object> credentials,
                             String syslogDrainUrl)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a user-provided service for logging.
    
    Specified by:
    
    createUserProvidedService in interface CloudFoundryOperations
    
    Parameters:
    service - cloud service info
    credentials - the user-provided service credentials
    syslogDrainUrl - for a logging service
  - deleteOrphanedRoutes
```
public List<CloudRoute> deleteOrphanedRoutes()
```
    Description copied from interface: CloudFoundryOperations
    
    Delete routes that do not have any application which is assigned to them.
    
    Specified by:
    
    deleteOrphanedRoutes in interface CloudFoundryOperations
  - uploadApplication
```
public void uploadApplication(String appName,
                     String file)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - application name
    file - path to the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     File file)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    file - the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     File file,
                     UploadStatusCallback callback)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    file - the application archive
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     String fileName,
                     InputStream inputStream)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry. This form of uploadApplication will read the passed InputStream and copy the contents to a temporary file for upload.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    fileName - the logical name of the application file
    inputStream - the InputStream to read from
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     String fileName,
                     InputStream inputStream,
                     UploadStatusCallback callback)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry. This form of uploadApplication will read the passed InputStream and copy the contents to a temporary file for upload.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    fileName - the logical name of the application file
    inputStream - the InputStream to read from
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     ApplicationArchive archive)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    archive - the application archive
    
    Throws:
    
    IOException
  - uploadApplication
```
public void uploadApplication(String appName,
                     ApplicationArchive archive,
                     UploadStatusCallback callback)
                       throws IOException
```
    Description copied from interface: CloudFoundryOperations
    
    Upload an application to Cloud Foundry.
    
    Specified by:
    
    uploadApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    archive - the application archive
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - startApplication
```
public StartingInfo startApplication(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    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 CloudFoundryOperations
    
    Parameters:
    appName - name of application
    
    Returns:
    Starting info containing response headers, if headers are present in the response. If there are no headers, return null.
  - debugApplication
```
public void debugApplication(String appName,
                    CloudApplication.DebugMode mode)
```
    Description copied from interface: CloudFoundryOperations
    
    Debug application.
    
    Specified by:
    
    debugApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    mode - debug mode info
  - stopApplication
```
public void stopApplication(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Stop application.
    
    Specified by:
    
    stopApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
  - restartApplication
```
public StartingInfo restartApplication(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Restart application.
    
    Specified by:
    
    restartApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
  - deleteApplication
```
public void deleteApplication(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete application.
    
    Specified by:
    
    deleteApplication in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
  - deleteAllApplications
```
public void deleteAllApplications()
```
    Description copied from interface: CloudFoundryOperations
    
    Delete all applications.
    
    Specified by:
    
    deleteAllApplications in interface CloudFoundryOperations
  - deleteAllServices
```
public void deleteAllServices()
```
    Description copied from interface: CloudFoundryOperations
    
    Delete all services.
    
    Specified by:
    
    deleteAllServices in interface CloudFoundryOperations
  - updateApplicationDiskQuota
```
public void updateApplicationDiskQuota(String appName,
                              int disk)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application disk quota.
    
    Specified by:
    
    updateApplicationDiskQuota in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    disk - new disk setting in MB
  - updateApplicationMemory
```
public void updateApplicationMemory(String appName,
                           int memory)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application memory.
    
    Specified by:
    
    updateApplicationMemory in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    memory - new memory setting in MB
  - updateApplicationInstances
```
public void updateApplicationInstances(String appName,
                              int instances)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application instances.
    
    Specified by:
    
    updateApplicationInstances in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    instances - number of instances to use
  - updateApplicationServices
```
public void updateApplicationServices(String appName,
                             List<String> services)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application services.
    
    Specified by:
    
    updateApplicationServices in interface CloudFoundryOperations
    
    Parameters:
    appName - name of appplication
    services - list of services that should be bound to app
  - updateApplicationStaging
```
public void updateApplicationStaging(String appName,
                            Staging staging)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application staging information.
    
    Specified by:
    
    updateApplicationStaging in interface CloudFoundryOperations
    
    Parameters:
    appName - name of appplication
    staging - staging information for the app
  - updateApplicationUris
```
public void updateApplicationUris(String appName,
                         List<String> uris)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application URIs.
    
    Specified by:
    
    updateApplicationUris in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    uris - list of URIs the app should use
  - updateApplicationEnv
```
public void updateApplicationEnv(String appName,
                        Map<String,String> env)
```
    Description copied from interface: CloudFoundryOperations
    
    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 CloudFoundryOperations
    
    Parameters:
    appName - name of application
    env - map of environment settings
  - updateApplicationEnv
```
public void updateApplicationEnv(String appName,
                        List<String> env)
```
    Description copied from interface: CloudFoundryOperations
    
    Update application env using a list of strings each with one environment setting.
    
    Specified by:
    
    updateApplicationEnv in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    env - list of environment settings
  - getEvents
```
public List<CloudEvent> getEvents()
```
    Description copied from interface: CloudFoundryOperations
    
    Get system events.
    
    Specified by:
    
    getEvents in interface CloudFoundryOperations
    
    Returns:
    all system events
  - getApplicationEvents
```
public List<CloudEvent> getApplicationEvents(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application events.
    
    Specified by:
    
    getApplicationEvents in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    
    Returns:
    application events
  - getLogs
```
public Map<String,String> getLogs(String appName)
```
    Deprecated. use streamLogs(String, ApplicationLogListener) or getRecentLogs(String)
    
    Description copied from interface: CloudFoundryOperations
    
    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).
    
    Specified by:
    
    getLogs in interface CloudFoundryOperations
    
    Parameters:
    appName - 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.
  - streamLogs
```
public StreamingLogToken streamLogs(String appName,
                           ApplicationLogListener listener)
```
    Description copied from interface: CloudFoundryOperations
    
    Stream application logs produced after this method is called. This method has 'tail'-like behavior. Every time there is a new log entry, it notifies the listener.
    
    Specified by:
    
    streamLogs in interface CloudFoundryOperations
    
    Parameters:
    appName - the name of the application
    listener - listener object to be notified
    
    Returns:
    token than can be used to cancel listening for logs
  - getRecentLogs
```
public List<ApplicationLog> getRecentLogs(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Stream recent log entries. Stream logs that were recently produced for an app.
    
    Specified by:
    
    getRecentLogs in interface CloudFoundryOperations
    
    Parameters:
    appName - the name of the application
    
    Returns:
    the list of recent log entries
  - getCrashLogs
```
public Map<String,String> getCrashLogs(String appName)
```
    Deprecated. use streamLogs(String, ApplicationLogListener) or getRecentLogs(String)
    
    Description copied from interface: CloudFoundryOperations
    
    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).
    
    Specified by:
    
    getCrashLogs in interface CloudFoundryOperations
    
    Parameters:
    appName - 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.
  - getStagingLogs
```
public String getStagingLogs(StartingInfo info,
                    int offset)
```
    Description copied from interface: CloudFoundryOperations
    
    Get the staging log while an application is starting. A null value indicates that no further checks for staging logs should occur as staging logs are no longer available.
    
    Specified by:
    
    getStagingLogs in interface CloudFoundryOperations
    
    Parameters:
    info - starting information containing staging log file URL. Obtained after starting an application.
    offset - starting position from where content should be retrieved.
    
    Returns:
    portion of the staging log content starting from the offset. It may contain multiple lines. Returns null if no further content is available.
  - getFile
```
public String getFile(String appName,
             int instanceIndex,
             String filePath)
```
    Description copied from interface: CloudFoundryOperations
    
    Get file from the deployed application.
    
    Specified by:
    
    getFile in interface CloudFoundryOperations
    
    Parameters:
    appName - name of the application
    instanceIndex - instance index
    filePath - path to the file
    
    Returns:
    the contents of the file
  - getFile
```
public String getFile(String appName,
             int instanceIndex,
             String filePath,
             int startPosition)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a the content, starting at a specific position, of a file from the deployed application.
    
    Specified by:
    
    getFile in interface CloudFoundryOperations
    
    Parameters:
    appName - 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
```
public String getFile(String appName,
             int instanceIndex,
             String filePath,
             int startPosition,
             int endPosition)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    getFile in interface CloudFoundryOperations
    
    Parameters:
    appName - 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
  - openFile
```
public void openFile(String appName,
            int instanceIndex,
            String filePath,
            ClientHttpResponseCallback callback)
```
    Description copied from interface: CloudFoundryOperations
    
    Provide the content of a file from the deployed application via callbacks.
    
    Specified by:
    
    openFile in interface CloudFoundryOperations
    
    Parameters:
    appName - name of the application
    instanceIndex - instance index
    filePath - path to the file
    callback - callback object to receive file contents
  - getFileTail
```
public String getFileTail(String appName,
                 int instanceIndex,
                 String filePath,
                 int length)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a the last bytes, with length as specified, of content of a file from the deployed application.
    
    Specified by:
    
    getFileTail in interface CloudFoundryOperations
    
    Parameters:
    appName - 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
  - getServices
```
public List<CloudService> getServices()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of cloud services.
    
    Specified by:
    
    getServices in interface CloudFoundryOperations
    
    Returns:
    list of cloud services
  - getServiceBrokers
```
public List<CloudServiceBroker> getServiceBrokers()
```
    Description copied from interface: CloudFoundryOperations
    
    Get all service brokers.
    
    Specified by:
    
    getServiceBrokers in interface CloudFoundryOperations
    
    Returns:
  - getServiceBroker
```
public CloudServiceBroker getServiceBroker(String name)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a service broker.
    
    Specified by:
    
    getServiceBroker in interface CloudFoundryOperations
    
    Parameters:
    name - the service broker name
    
    Returns:
    the service broker
  - createServiceBroker
```
public void createServiceBroker(CloudServiceBroker serviceBroker)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a service broker.
    
    Specified by:
    
    createServiceBroker in interface CloudFoundryOperations
    
    Parameters:
    serviceBroker - cloud service broker info
  - updateServiceBroker
```
public void updateServiceBroker(CloudServiceBroker serviceBroker)
```
    Description copied from interface: CloudFoundryOperations
    
    Update a service broker (unchanged forces catalog refresh).
    
    Specified by:
    
    updateServiceBroker in interface CloudFoundryOperations
    
    Parameters:
    serviceBroker - cloud service broker info
  - deleteServiceBroker
```
public void deleteServiceBroker(String name)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete a service broker.
    
    Specified by:
    
    deleteServiceBroker in interface CloudFoundryOperations
    
    Parameters:
    name - the service broker name
  - updateServicePlanVisibilityForBroker
```
public void updateServicePlanVisibilityForBroker(String name,
                                        boolean visibility)
```
    Description copied from interface: CloudFoundryOperations
    
    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 CloudFoundryOperations
    
    Parameters:
    name - the service broker name
    visibility - true for public, false for private
  - getService
```
public CloudService getService(String service)
```
    Description copied from interface: CloudFoundryOperations
    
    Get cloud service.
    
    Specified by:
    
    getService in interface CloudFoundryOperations
    
    Parameters:
    service - name of service
    
    Returns:
    the cloud service info
  - getServiceInstance
```
public CloudServiceInstance getServiceInstance(String service)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a service instance.
    
    Specified by:
    
    getServiceInstance in interface CloudFoundryOperations
    
    Parameters:
    service - name of the service instance
    
    Returns:
    the service instance info
  - deleteService
```
public void deleteService(String service)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete cloud service.
    
    Specified by:
    
    deleteService in interface CloudFoundryOperations
    
    Parameters:
    service - name of service
  - getServiceOfferings
```
public List<CloudServiceOffering> getServiceOfferings()
```
    Description copied from interface: CloudFoundryOperations
    
    Get all service offerings.
    
    Specified by:
    
    getServiceOfferings in interface CloudFoundryOperations
    
    Returns:
    list of service offerings
  - bindService
```
public void bindService(String appName,
               String serviceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate (provision) a service with an application.
    
    Specified by:
    
    bindService in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    serviceName - the service name
  - unbindService
```
public void unbindService(String appName,
                 String serviceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Un-associate (unprovision) a service from an application.
    
    Specified by:
    
    unbindService in interface CloudFoundryOperations
    
    Parameters:
    appName - the application name
    serviceName - the service name
  - getApplicationInstances
```
public InstancesInfo getApplicationInstances(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application instances info for application.
    
    Specified by:
    
    getApplicationInstances in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application.
    
    Returns:
    instances info
  - getApplicationInstances
```
public InstancesInfo getApplicationInstances(CloudApplication app)
```
    Description copied from interface: CloudFoundryOperations
    
    Get application instances info for application.
    
    Specified by:
    
    getApplicationInstances in interface CloudFoundryOperations
    
    Parameters:
    app - the application.
    
    Returns:
    instances info
  - getCrashes
```
public CrashesInfo getCrashes(String appName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get crashes info for application.
    
    Specified by:
    
    getCrashes in interface CloudFoundryOperations
    
    Parameters:
    appName - name of application
    
    Returns:
    crashes info
  - getStacks
```
public List<CloudStack> getStacks()
```
    Description copied from interface: CloudFoundryOperations
    
    Get the list of stacks available for staging applications.
    
    Specified by:
    
    getStacks in interface CloudFoundryOperations
    
    Returns:
    the list of available stacks
  - getStack
```
public CloudStack getStack(String name)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a stack by name.
    
    Specified by:
    
    getStack in interface CloudFoundryOperations
    
    Parameters:
    name - the name of the stack to get
    
    Returns:
    the stack, or null if not found
  - rename
```
public void rename(String appName,
          String newName)
```
    Description copied from interface: CloudFoundryOperations
    
    Rename an application.
    
    Specified by:
    
    rename in interface CloudFoundryOperations
    
    Parameters:
    appName - the current name
    newName - the new name
  - getDomainsForOrg
```
public List<CloudDomain> getDomainsForOrg()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of all domain registered for the current organization.
    
    Specified by:
    
    getDomainsForOrg in interface CloudFoundryOperations
    
    Returns:
    list of domains
  - getPrivateDomains
```
public List<CloudDomain> getPrivateDomains()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of all private domains.
    
    Specified by:
    
    getPrivateDomains in interface CloudFoundryOperations
    
    Returns:
    list of private domains
  - getSharedDomains
```
public List<CloudDomain> getSharedDomains()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of all shared domains.
    
    Specified by:
    
    getSharedDomains in interface CloudFoundryOperations
    
    Returns:
    list of shared domains
  - getDomains
```
public List<CloudDomain> getDomains()
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of all domain shared and private domains.
    
    Specified by:
    
    getDomains in interface CloudFoundryOperations
    
    Returns:
    list of domains
  - getDefaultDomain
```
public CloudDomain getDefaultDomain()
```
    Description copied from interface: CloudFoundryOperations
    
    Gets the default domain for the current org, which is the first shared domain.
    
    Specified by:
    
    getDefaultDomain in interface CloudFoundryOperations
    
    Returns:
    the default domain
  - addDomain
```
public void addDomain(String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Add a private domain in the current organization.
    
    Specified by:
    
    addDomain in interface CloudFoundryOperations
    
    Parameters:
    domainName - the domain to add
  - deleteDomain
```
public void deleteDomain(String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete a private domain in the current organization.
    
    Specified by:
    
    deleteDomain in interface CloudFoundryOperations
    
    Parameters:
    domainName - the domain to delete
  - removeDomain
```
public void removeDomain(String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete a private domain in the current organization.
    
    Specified by:
    
    removeDomain in interface CloudFoundryOperations
    
    Parameters:
    domainName - the domain to remove
  - getRoutes
```
public List<CloudRoute> getRoutes(String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get the info for all routes for a domain.
    
    Specified by:
    
    getRoutes in interface CloudFoundryOperations
    
    Parameters:
    domainName - the domain the routes belong to
    
    Returns:
    list of routes
  - addRoute
```
public void addRoute(String host,
            String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Register a new route to the a domain.
    
    Specified by:
    
    addRoute in interface CloudFoundryOperations
    
    Parameters:
    host - the host of the route to register
    domainName - the domain of the route to register
  - deleteRoute
```
public void deleteRoute(String host,
               String domainName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete a registered route from the space of the current session.
    
    Specified by:
    
    deleteRoute in interface CloudFoundryOperations
    
    Parameters:
    host - the host of the route to delete
    domainName - the domain of the route to delete
  - registerRestLogListener
```
public void registerRestLogListener(RestLogCallback callBack)
```
    Description copied from interface: CloudFoundryOperations
    
    Register a new RestLogCallback
    
    Specified by:
    
    registerRestLogListener in interface CloudFoundryOperations
    
    Parameters:
    callBack - the callback to be registered
  - unRegisterRestLogListener
```
public void unRegisterRestLogListener(RestLogCallback callBack)
```
    Description copied from interface: CloudFoundryOperations
    
    Un-register a RestLogCallback
    
    Specified by:
    
    unRegisterRestLogListener in interface CloudFoundryOperations
    
    Parameters:
    callBack - the callback to be un-registered
  - getOrgByName
```
public CloudOrganization getOrgByName(String orgName,
                             boolean required)
```
    Description copied from interface: CloudFoundryOperations
    
    Get the organization with the specified name.
    
    Specified by:
    
    getOrgByName in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of organization
    required - if true, and organization is not found, throw an exception
    
    Returns:
  - getQuotas
```
public List<CloudQuota> getQuotas()
```
    Description copied from interface: CloudFoundryOperations
    
    Get quota definitions
    
    Specified by:
    
    getQuotas in interface CloudFoundryOperations
    
    Returns:
    List
  - getQuotaByName
```
public CloudQuota getQuotaByName(String quotaName,
                        boolean required)
```
    Description copied from interface: CloudFoundryOperations
    
    Get quota by name
    
    Specified by:
    
    getQuotaByName in interface CloudFoundryOperations
    
    Returns:
    CloudQuota instance
  - setQuotaToOrg
```
public void setQuotaToOrg(String orgName,
                 String quotaName)
```
    Description copied from interface: CloudFoundryOperations
    
    Set quota to organization
    
    Specified by:
    
    setQuotaToOrg in interface CloudFoundryOperations
  - createQuota
```
public void createQuota(CloudQuota quota)
```
    Description copied from interface: CloudFoundryOperations
    
    Create quota
    
    Specified by:
    
    createQuota in interface CloudFoundryOperations
  - deleteQuota
```
public void deleteQuota(String quotaName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete quota by name
    
    Specified by:
    
    deleteQuota in interface CloudFoundryOperations
  - updateQuota
```
public void updateQuota(CloudQuota quota,
               String name)
```
    Description copied from interface: CloudFoundryOperations
    
    Update Quota definition
    
    Specified by:
    
    updateQuota in interface CloudFoundryOperations
  - createSpace
```
public void createSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a space with the specified name
    
    Specified by:
    
    createSpace in interface CloudFoundryOperations
  - deleteSpace
```
public void deleteSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Delete a space with the specified name
    
    Specified by:
    
    deleteSpace in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
  - getSpace
```
public CloudSpace getSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get space name with the specified name.
    
    Specified by:
    
    getSpace in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
    
    Returns:
    the cloud space
  - getSpaceManagers
```
public List<UUID> getSpaceManagers(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space manager UUID for the space.
    
    Specified by:
    
    getSpaceManagers in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
    
    Returns:
    List of space manager UUID
  - getSpaceDevelopers
```
public List<UUID> getSpaceDevelopers(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space developer UUID for the space.
    
    Specified by:
    
    getSpaceDevelopers in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
    
    Returns:
    List of space developer UUID
  - getSpaceAuditors
```
public List<UUID> getSpaceAuditors(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space auditor UUID for the space.
    
    Specified by:
    
    getSpaceAuditors in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
    
    Returns:
    List of space auditor UUID
  - getSpaceManagers
```
public List<UUID> getSpaceManagers(String orgName,
                          String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space manager UUID for the space.
    
    Specified by:
    
    getSpaceManagers in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space manager UUID
  - getSpaceDevelopers
```
public List<UUID> getSpaceDevelopers(String orgName,
                            String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space developer UUID for the space.
    
    Specified by:
    
    getSpaceDevelopers in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space developer UUID
  - getSpaceAuditors
```
public List<UUID> getSpaceAuditors(String orgName,
                          String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get list of space auditor UUID for the space.
    
    Specified by:
    
    getSpaceAuditors in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space auditor UUID
  - associateManagerWithSpace
```
public void associateManagerWithSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space managers role
    
    Specified by:
    
    associateManagerWithSpace in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
  - associateDeveloperWithSpace
```
public void associateDeveloperWithSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space developer role
    
    Specified by:
    
    associateDeveloperWithSpace in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
  - associateAuditorWithSpace
```
public void associateAuditorWithSpace(String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space auditors role
    
    Specified by:
    
    associateAuditorWithSpace in interface CloudFoundryOperations
    
    Parameters:
    spaceName - name of the space
  - associateManagerWithSpace
```
public void associateManagerWithSpace(String orgName,
                             String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space managers role
    
    Specified by:
    
    associateManagerWithSpace in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - associateDeveloperWithSpace
```
public void associateDeveloperWithSpace(String orgName,
                               String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space developer role
    
    Specified by:
    
    associateDeveloperWithSpace in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - associateAuditorWithSpace
```
public void associateAuditorWithSpace(String orgName,
                             String spaceName)
```
    Description copied from interface: CloudFoundryOperations
    
    Associate current user to the space auditors role
    
    Specified by:
    
    associateAuditorWithSpace in interface CloudFoundryOperations
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - getSecurityGroups
```
public List<CloudSecurityGroup> getSecurityGroups()
```
    Description copied from interface: CloudFoundryOperations
    
    Get a List of all application security groups.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    getSecurityGroups in interface CloudFoundryOperations
    
    Returns:
    a list of all the CloudSecurityGroups in the system
  - getSecurityGroup
```
public CloudSecurityGroup getSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    Get a specific security group by name.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    getSecurityGroup in interface CloudFoundryOperations
    
    Parameters:
    securityGroupName - The name of the security group
    
    Returns:
    the CloudSecurityGroup or null if no security groups exist with the given name
  - createSecurityGroup
```
public void createSecurityGroup(CloudSecurityGroup securityGroup)
```
    Description copied from interface: CloudFoundryOperations
    
    Create a new CloudSecurityGroup.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    createSecurityGroup in interface CloudFoundryOperations
  - createSecurityGroup
```
public void createSecurityGroup(String name,
                       InputStream jsonRulesFile)
```
    Description copied from interface: CloudFoundryOperations
    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.
    Specified by:
    
    createSecurityGroup in interface CloudFoundryOperations
    
    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
  - updateSecurityGroup
```
public void updateSecurityGroup(CloudSecurityGroup securityGroup)
```
    Description copied from interface: CloudFoundryOperations
    
    Update an existing security group.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    updateSecurityGroup in interface CloudFoundryOperations
  - updateSecurityGroup
```
public void updateSecurityGroup(String name,
                       InputStream jsonRulesFile)
```
    Description copied from interface: CloudFoundryOperations
    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.
    Specified by:
    
    updateSecurityGroup in interface CloudFoundryOperations
    
    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
  - deleteSecurityGroup
```
public void deleteSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    Deletes the security group with the given name.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    deleteSecurityGroup in interface CloudFoundryOperations
  - getStagingSecurityGroups
```
public List<CloudSecurityGroup> getStagingSecurityGroups()
```
    Description copied from interface: CloudFoundryOperations
    
    Lists security groups in the staging set for applications.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    getStagingSecurityGroups in interface CloudFoundryOperations
  - bindStagingSecurityGroup
```
public void bindStagingSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    bindStagingSecurityGroup in interface CloudFoundryOperations
  - unbindStagingSecurityGroup
```
public void unbindStagingSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    unbindStagingSecurityGroup in interface CloudFoundryOperations
  - getRunningSecurityGroups
```
public List<CloudSecurityGroup> getRunningSecurityGroups()
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    getRunningSecurityGroups in interface CloudFoundryOperations
  - bindRunningSecurityGroup
```
public void bindRunningSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    bindRunningSecurityGroup in interface CloudFoundryOperations
  - unbindRunningSecurityGroup
```
public void unbindRunningSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    unbindRunningSecurityGroup in interface CloudFoundryOperations
  - bindSecurityGroup
```
public void bindSecurityGroup(String orgName,
                     String spaceName,
                     String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    Bind a security group to a space.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    bindSecurityGroup in interface CloudFoundryOperations
    
    Parameters:
    orgName - 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
  - unbindSecurityGroup
```
public void unbindSecurityGroup(String orgName,
                       String spaceName,
                       String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    Unbind a security group from a space.
    This method requires the logged in user to have admin permissions in the cloud controller.
    
    Specified by:
    
    unbindSecurityGroup in interface CloudFoundryOperations
    
    Parameters:
    orgName - 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
  - getSpacesBoundToSecurityGroup
```
public List<CloudSpace> getSpacesBoundToSecurityGroup(String securityGroupName)
```
    Description copied from interface: CloudFoundryOperations
    
    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.
    
    Specified by:
    
    getSpacesBoundToSecurityGroup in interface CloudFoundryOperations

Class CloudFoundryClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

CloudFoundryClient

Method Detail

setResponseErrorHandler

getCloudControllerUrl

getCloudInfo

getSpaces

getOrganizations

register

updatePassword

updatePassword

unregister

login

logout

getApplications

getApplication

getApplication

getApplicationEnvironment

getApplicationEnvironment

getApplicationStats

createApplication

createApplication

createService

createUserProvidedService

createUserProvidedService

deleteOrphanedRoutes

uploadApplication

uploadApplication

uploadApplication

uploadApplication

uploadApplication

uploadApplication

uploadApplication

startApplication

debugApplication

stopApplication

restartApplication

deleteApplication

deleteAllApplications

deleteAllServices

updateApplicationDiskQuota

updateApplicationMemory

updateApplicationInstances

updateApplicationServices

updateApplicationStaging

updateApplicationUris

updateApplicationEnv

updateApplicationEnv

getEvents

getApplicationEvents

getLogs

streamLogs

getRecentLogs

getCrashLogs

getStagingLogs

getFile

getFile

getFile

openFile

getFileTail