CloudFoundryOperations (Cloud Foundry Java Client Library 1.1.3 API)

All Known Implementing Classes:

CloudFoundryClient
```
public interface CloudFoundryOperations
```
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

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`	`associateAuditorWithSpace(String orgName, 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 orgName, String spaceName)` Associate current user to the space developer role
`void`	`associateDeveloperWithSpace(String orgName, 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 orgName, String spaceName)` Associate current user to the space managers role
`void`	`associateManagerWithSpace(String orgName, String spaceName, String userGuid)` Associate a 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 guid)` 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.
`Map<String,CloudUser>`	`getOrganizationUsers(String orgName)` Get all users in the specified organization
`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 clientHttpResponseCallback)` 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)` Deprecated. alias for `deleteDomain(java.lang.String)`
`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.

- Method Detail
  - setResponseErrorHandler
```
void setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)
```
    Override the default REST response error handler with a custom error handler.
    
    Parameters:
    errorHandler -
  - 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
  - getSpaces
```
List<CloudSpace> getSpaces()
```
    Get list of CloudSpaces for the current cloud.
    
    Returns:
    List of CloudSpace objects containing the space info
  - 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
  - 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
  - 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
  - getSpaceManagers
```
List<UUID> getSpaceManagers(String orgName,
                          String spaceName)
```
    Get list of space manager UUID for the space.
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space manager UUID
  - getSpaceDevelopers
```
List<UUID> getSpaceDevelopers(String orgName,
                            String spaceName)
```
    Get list of space developer UUID for the space.
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space developer UUID
  - getSpaceAuditors
```
List<UUID> getSpaceAuditors(String orgName,
                          String spaceName)
```
    Get list of space auditor UUID for the space.
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
    
    Returns:
    List of space auditor UUID
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String spaceName)
```
    Associate current user to the space auditors role
    
    Parameters:
    spaceName - name of the space
  - associateDeveloperWithSpace
```
void associateDeveloperWithSpace(String spaceName)
```
    Associate current user to the space developer role
    
    Parameters:
    spaceName - name of the space
  - associateManagerWithSpace
```
void associateManagerWithSpace(String spaceName)
```
    Associate current user to the space managers role
    
    Parameters:
    spaceName - name of the space
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String orgName,
                             String spaceName)
```
    Associate current user to the space auditors role
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - associateDeveloperWithSpace
```
void associateDeveloperWithSpace(String orgName,
                               String spaceName)
```
    Associate current user to the space developer role
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - associateManagerWithSpace
```
void associateManagerWithSpace(String orgName,
                             String spaceName)
```
    Associate current user to the space managers role
    
    Parameters:
    orgName - name of the organization containing the space
    spaceName - name of the space
  - associateAuditorWithSpace
```
void associateAuditorWithSpace(String orgName,
                             String spaceName,
                             String userGuid)
```
    Associate a user to the space auditors role
    
    Parameters:
    orgName - 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 orgName,
                               String spaceName,
                               String userGuid)
```
    Associate a user to the space developer role
    
    Parameters:
    orgName - 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 orgName,
                             String spaceName,
                             String userGuid)
```
    Associate a user to the space managers role
    
    Parameters:
    orgName - 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
  - createSpace
```
void createSpace(String spaceName)
```
    Create a space with the specified name
    
    Parameters:
    spaceName -
  - getSpace
```
CloudSpace getSpace(String spaceName)
```
    Get space name with the specified name.
    
    Parameters:
    spaceName - name of the space
    
    Returns:
    the cloud space
  - deleteSpace
```
void deleteSpace(String spaceName)
```
    Delete a space with the specified name
    
    Parameters:
    spaceName - name of the space
  - getOrganizations
```
List<CloudOrganization> getOrganizations()
```
    Get list of CloudOrganizations for the current cloud.
    
    Returns:
    List of CloudOrganizations objects containing the organization info
  - getOrgByName
```
CloudOrganization getOrgByName(String orgName,
                             boolean required)
```
    Get the organization with the specified name.
    
    Parameters:
    orgName - name of organization
    required - if true, and organization is not found, throw an exception
    
    Returns:
  - register
```
void register(String email,
            String password)
```
    Register new user account with the provided credentials.
    
    Parameters:
    email - the email account
    password - the password
  - 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
  - unregister
```
void unregister()
```
    Unregister and log out the currently logged in user
  - 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.
  - getApplications
```
List<CloudApplication> getApplications()
```
    Get all cloud applications.
    
    Returns:
    list of cloud applications
  - getApplication
```
CloudApplication getApplication(String appName)
```
    Get cloud application with the specified name.
    
    Parameters:
    appName - name of the app
    
    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
  - getApplicationStats
```
ApplicationStats getApplicationStats(String appName)
```
    Get application stats for the app with the specified name.
    
    Parameters:
    appName - name of the app
    
    Returns:
    the cloud application stats
  - getApplicationEnvironment
```
Map<String,Object> getApplicationEnvironment(String appName)
```
    Get application environment variables for the app with the specified name.
    
    Parameters:
    appName - name of the app
    
    Returns:
    the cloud application environment variables
  - getApplicationEnvironment
```
Map<String,Object> getApplicationEnvironment(UUID appGuid)
```
    Get application environment variables for the app with the specified GUID.
    
    Parameters:
    appGuid - GUID of the app
    
    Returns:
    the cloud application environment variables
  - createApplication
```
void createApplication(String appName,
                     Staging staging,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)
```
    Create application.
    
    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
```
void createApplication(String appName,
                     Staging staging,
                     Integer disk,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)
```
    Create application.
    
    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
```
void createService(CloudService service)
```
    Create a service.
    
    Parameters:
    service - cloud service info
  - 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
  - deleteOrphanedRoutes
```
List<CloudRoute> deleteOrphanedRoutes()
```
    Delete routes that do not have any application which is assigned to them.
  - uploadApplication
```
void uploadApplication(String appName,
                     String file)
                       throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    appName - application name
    file - path to the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String appName,
                     File file)
                       throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    appName - the application name
    file - the application archive or folder
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String appName,
                     File file,
                     UploadStatusCallback callback)
                       throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    appName - the application name
    file - the application archive
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String appName,
                     String fileName,
                     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:
    appName - the application name
    fileName - the logical name of the application file
    inputStream - the InputStream to read from
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String appName,
                     String fileName,
                     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:
    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
```
void uploadApplication(String appName,
                     ApplicationArchive archive)
                       throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    appName - the application name
    archive - the application archive
    
    Throws:
    
    IOException
  - uploadApplication
```
void uploadApplication(String appName,
                     ApplicationArchive archive,
                     UploadStatusCallback callback)
                       throws IOException
```
    Upload an application to Cloud Foundry.
    
    Parameters:
    appName - the application name
    archive - the application archive
    callback - a callback interface used to provide progress information or null
    
    Throws:
    
    IOException
  - startApplication
```
StartingInfo startApplication(String appName)
```
    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:
    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
```
void debugApplication(String appName,
                    CloudApplication.DebugMode mode)
```
    Debug application.
    
    Parameters:
    appName - name of application
    mode - debug mode info
  - stopApplication
```
void stopApplication(String appName)
```
    Stop application.
    
    Parameters:
    appName - name of application
  - restartApplication
```
StartingInfo restartApplication(String appName)
```
    Restart application.
    
    Parameters:
    appName - name of application
  - deleteApplication
```
void deleteApplication(String appName)
```
    Delete application.
    
    Parameters:
    appName - name of application
  - deleteAllApplications
```
void deleteAllApplications()
```
    Delete all applications.
  - deleteAllServices
```
void deleteAllServices()
```
    Delete all services.
  - updateApplicationDiskQuota
```
void updateApplicationDiskQuota(String appName,
                              int disk)
```
    Update application disk quota.
    
    Parameters:
    appName - name of application
    disk - new disk setting in MB
  - updateApplicationMemory
```
void updateApplicationMemory(String appName,
                           int memory)
```
    Update application memory.
    
    Parameters:
    appName - name of application
    memory - new memory setting in MB
  - updateApplicationInstances
```
void updateApplicationInstances(String appName,
                              int instances)
```
    Update application instances.
    
    Parameters:
    appName - name of application
    instances - number of instances to use
  - updateApplicationServices
```
void updateApplicationServices(String appName,
                             List<String> services)
```
    Update application services.
    
    Parameters:
    appName - name of appplication
    services - list of services that should be bound to app
  - updateApplicationStaging
```
void updateApplicationStaging(String appName,
                            Staging staging)
```
    Update application staging information.
    
    Parameters:
    appName - name of appplication
    staging - staging information for the app
  - updateApplicationUris
```
void updateApplicationUris(String appName,
                         List<String> uris)
```
    Update application URIs.
    
    Parameters:
    appName - name of application
    uris - list of URIs the app should use
  - updateApplicationEnv
```
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..
    
    Parameters:
    appName - name of application
    env - map of environment settings
  - updateApplicationEnv
```
void updateApplicationEnv(String appName,
                        List<String> env)
```
    Update application env using a list of strings each with one environment setting.
    
    Parameters:
    appName - name of application
    env - list of environment settings
  - getEvents
```
List<CloudEvent> getEvents()
```
    Get system events.
    
    Returns:
    all system events
  - getApplicationEvents
```
List<CloudEvent> getApplicationEvents(String appName)
```
    Get application events.
    
    Parameters:
    appName - name of application
    
    Returns:
    application events
  - getLogs
```
Map<String,String> getLogs(String appName)
```
    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:
    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
```
StreamingLogToken streamLogs(String appName,
                           ApplicationLogListener listener)
```
    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.
    
    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
```
List<ApplicationLog> getRecentLogs(String appName)
```
    Stream recent log entries. Stream logs that were recently produced for an app.
    
    Parameters:
    appName - the name of the application
    
    Returns:
    the list of recent log entries
  - getCrashLogs
```
Map<String,String> getCrashLogs(String appName)
```
    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:
    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
```
String getStagingLogs(StartingInfo info,
                    int offset)
```
    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.
    
    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.
  - getStacks
```
List<CloudStack> getStacks()
```
    Get the list of stacks available for staging applications.
    
    Returns:
    the list of available stacks
  - getStack
```
CloudStack getStack(String name)
```
    Get a stack by name.
    
    Parameters:
    name - the name of the stack to get
    
    Returns:
    the stack, or null if not found
  - getFile
```
String getFile(String appName,
             int instanceIndex,
             String filePath)
```
    Get file from the deployed application.
    
    Parameters:
    appName - name of the application
    instanceIndex - instance index
    filePath - path to the file
    
    Returns:
    the contents of the file
  - getFile
```
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.
    
    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
```
String getFile(String appName,
             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:
    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
  - getFileTail
```
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.
    
    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
  - openFile
```
void openFile(String appName,
            int instanceIndex,
            String filePath,
            ClientHttpResponseCallback clientHttpResponseCallback)
```
    Provide the content of a file from the deployed application via callbacks.
    
    Parameters:
    appName - name of the application
    instanceIndex - instance index
    filePath - path to the file
    clientHttpResponseCallback - callback object to receive file contents
  - getServices
```
List<CloudService> getServices()
```
    Get list of cloud services.
    
    Returns:
    list of cloud services
  - getService
```
CloudService getService(String service)
```
    Get cloud service.
    
    Parameters:
    service - name of service
    
    Returns:
    the cloud service info
  - getServiceInstance
```
CloudServiceInstance getServiceInstance(String service)
```
    Get a service instance.
    
    Parameters:
    service - name of the service instance
    
    Returns:
    the service instance info
  - deleteService
```
void deleteService(String service)
```
    Delete cloud service.
    
    Parameters:
    service - name of service
  - getServiceOfferings
```
List<CloudServiceOffering> getServiceOfferings()
```
    Get all service offerings.
    
    Returns:
    list of service offerings
  - getServiceBrokers
```
List<CloudServiceBroker> getServiceBrokers()
```
    Get all service brokers.
    
    Returns:
  - getServiceBroker
```
CloudServiceBroker getServiceBroker(String name)
```
    Get a service broker.
    
    Parameters:
    name - the service broker name
    
    Returns:
    the service broker
  - createServiceBroker
```
void createServiceBroker(CloudServiceBroker serviceBroker)
```
    Create a service broker.
    
    Parameters:
    serviceBroker - cloud service broker info
  - updateServiceBroker
```
void updateServiceBroker(CloudServiceBroker serviceBroker)
```
    Update a service broker (unchanged forces catalog refresh).
    
    Parameters:
    serviceBroker - cloud service broker info
  - deleteServiceBroker
```
void deleteServiceBroker(String name)
```
    Delete a service broker.
    
    Parameters:
    name - the service broker name
  - 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
  - bindService
```
void bindService(String appName,
               String serviceName)
```
    Associate (provision) a service with an application.
    
    Parameters:
    appName - the application name
    serviceName - the service name
  - unbindService
```
void unbindService(String appName,
                 String serviceName)
```
    Un-associate (unprovision) a service from an application.
    
    Parameters:
    appName - the application name
    serviceName - the service name
  - getApplicationInstances
```
InstancesInfo getApplicationInstances(String appName)
```
    Get application instances info for application.
    
    Parameters:
    appName - name of application.
    
    Returns:
    instances info
  - getApplicationInstances
```
InstancesInfo getApplicationInstances(CloudApplication app)
```
    Get application instances info for application.
    
    Parameters:
    app - the application.
    
    Returns:
    instances info
  - getCrashes
```
CrashesInfo getCrashes(String appName)
```
    Get crashes info for application.
    
    Parameters:
    appName - name of application
    
    Returns:
    crashes info
  - rename
```
void rename(String appName,
          String newName)
```
    Rename an application.
    
    Parameters:
    appName - the current name
    newName - the new name
  - getDomainsForOrg
```
List<CloudDomain> getDomainsForOrg()
```
    Get list of all domain registered for the current organization.
    
    Returns:
    list of domains
  - getPrivateDomains
```
List<CloudDomain> getPrivateDomains()
```
    Get list of all private domains.
    
    Returns:
    list of private domains
  - getSharedDomains
```
List<CloudDomain> getSharedDomains()
```
    Get list of all shared domains.
    
    Returns:
    list of shared domains
  - getDomains
```
List<CloudDomain> getDomains()
```
    Get list of all domain shared and private domains.
    
    Returns:
    list of domains
  - getDefaultDomain
```
CloudDomain getDefaultDomain()
```
    Gets the default domain for the current org, which is the first shared domain.
    
    Returns:
    the default domain
  - addDomain
```
void addDomain(String domainName)
```
    Add a private domain in the current organization.
    
    Parameters:
    domainName - the domain to add
  - removeDomain
```
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
  - deleteDomain
```
void deleteDomain(String domainName)
```
    Delete a private domain in the current organization.
    
    Parameters:
    domainName - the domain to delete
  - 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
  - addRoute
```
void addRoute(String host,
            String domainName)
```
    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
  - deleteRoute
```
void deleteRoute(String host,
               String domainName)
```
    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
  - registerRestLogListener
```
void registerRestLogListener(RestLogCallback callBack)
```
    Register a new RestLogCallback
    
    Parameters:
    callBack - the callback to be registered
  - unRegisterRestLogListener
```
void unRegisterRestLogListener(RestLogCallback callBack)
```
    Un-register a RestLogCallback
    
    Parameters:
    callBack - the callback to be un-registered
  - getQuotaByName
```
CloudQuota getQuotaByName(String quotaName,
                        boolean required)
```
    Get quota by name
    
    Parameters:
    quotaName -
    required -
    
    Returns:
    CloudQuota instance
  - setQuotaToOrg
```
void setQuotaToOrg(String orgName,
                 String quotaName)
```
    Set quota to organization
    
    Parameters:
    orgName -
    quotaName -
  - createQuota
```
void createQuota(CloudQuota quota)
```
    Create quota
    
    Parameters:
    quota -
  - deleteQuota
```
void deleteQuota(String quotaName)
```
    Delete quota by name
    
    Parameters:
    quotaName -
  - getQuotas
```
List<CloudQuota> getQuotas()
```
    Get quota definitions
    
    Returns:
    List
  - updateQuota
```
void updateQuota(CloudQuota quota,
               String name)
```
    Update Quota definition
    
    Parameters:
    quota -
    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
  - 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 or null if no security groups exist with the given name
  - 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
  - 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:
    
    IllegalArgumentException - 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:
    
    IllegalArgumentException - if a security group does not exist with the given name
    See Also:
    http://docs.cloudfoundry.org/adminguide/app-sec-groups.html
  - 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:
    
    IllegalArgumentException - if a security group does not exist with the given name
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - bindSecurityGroup
```
void bindSecurityGroup(String orgName,
                     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:
    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
    
    Throws:
    
    IllegalArgumentException - if the org, space, or security group do not exist
  - unbindSecurityGroup
```
void unbindSecurityGroup(String orgName,
                       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:
    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
    
    Throws:
    
    IllegalArgumentException - if the org, space, or security group do not exist
  - getOrganizationUsers
```
Map<String,CloudUser> getOrganizationUsers(String orgName)
```
    Get all users in the specified organization
    
    Parameters:
    orgName - organization name
    
    Returns:
    a Map CloudUser with username as key
    
    Throws:
    
    IllegalArgumentException - if the org do not exist

Interface CloudFoundryOperations

Method Summary

Method Detail

setResponseErrorHandler

getCloudControllerUrl

getCloudInfo

getSpaces

getSpaceManagers

getSpaceDevelopers

getSpaceAuditors

getSpaceManagers

getSpaceDevelopers

getSpaceAuditors

associateAuditorWithSpace

associateDeveloperWithSpace

associateManagerWithSpace

associateAuditorWithSpace

associateDeveloperWithSpace

associateManagerWithSpace

associateAuditorWithSpace

associateDeveloperWithSpace

associateManagerWithSpace

createSpace

getSpace

deleteSpace

getOrganizations

getOrgByName

register

updatePassword

updatePassword

unregister

login

logout

getApplications

getApplication

getApplication

getApplicationStats

getApplicationEnvironment

getApplicationEnvironment

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

getStacks

getStack

getFile

getFile

getFile

getFileTail