org.cloudfoundry.client.lib.rest

Interface CloudControllerClient

All Known Implementing Classes:

CloudControllerClientImpl

public interface CloudControllerClient

Interface defining operations available for the cloud controller REST client implementations

Author:

Thomas Risberg

Method Summary

Methods

Modifier and Type	Method and Description
void	addDomain(String domainName)
void	addRoute(String host, String domainName)
void	associateAuditorWithSpace(String orgName, String spaceName)
void	associateDeveloperWithSpace(String orgName, String spaceName)
void	associateManagerWithSpace(String orgName, String spaceName)
void	bindRunningSecurityGroup(String securityGroupName)
void	bindSecurityGroup(String orgName, String spaceName, String securityGroupName)
void	bindService(String appName, String serviceName)
void	bindStagingSecurityGroup(String securityGroupName)
void	createApplication(String appName, Staging staging, Integer disk, Integer memory, List<String> uris, List<String> serviceNames)
void	createApplication(String appName, Staging staging, Integer memory, List<String> uris, List<String> serviceNames)
void	createQuota(CloudQuota quota)
void	createSecurityGroup(CloudSecurityGroup securityGroup)
void	createSecurityGroup(String name, InputStream jsonRulesFile)
void	createService(CloudService service)
void	createServiceBroker(CloudServiceBroker serviceBroker)
void	createSpace(String spaceName)
void	createUserProvidedService(CloudService service, Map<String,Object> credentials)
void	createUserProvidedService(CloudService service, Map<String,Object> credentials, String syslogDrainUrl)
void	debugApplication(String appName, CloudApplication.DebugMode mode)
void	deleteAllApplications()
void	deleteAllServices()
void	deleteApplication(String appName)
void	deleteDomain(String domainName)
List<CloudRoute>	deleteOrphanedRoutes()
void	deleteQuota(String quotaName)
void	deleteRoute(String host, String domainName)
void	deleteSecurityGroup(String securityGroupName)
void	deleteService(String service)
void	deleteServiceBroker(String name)
void	deleteSpace(String spaceName)
CloudApplication	getApplication(String appName)
CloudApplication	getApplication(UUID appGuid)
Map<String,Object>	getApplicationEnvironment(String appName)
Map<String,Object>	getApplicationEnvironment(UUID appGuid)
List<CloudEvent>	getApplicationEvents(String appName)
InstancesInfo	getApplicationInstances(CloudApplication app)
InstancesInfo	getApplicationInstances(String appName)
List<CloudApplication>	getApplications()
ApplicationStats	getApplicationStats(String appName)
URL	getCloudControllerUrl()
CrashesInfo	getCrashes(String appName)
Map<String,String>	getCrashLogs(String appName)
CloudDomain	getDefaultDomain()
List<CloudDomain>	getDomains()
List<CloudDomain>	getDomainsForOrg()
List<CloudEvent>	getEvents()
String	getFile(String appName, int instanceIndex, String filePath, int startPosition, int endPosition)
CloudInfo	getInfo()
Map<String,String>	getLogs(String appName)
List<CloudOrganization>	getOrganizations()
CloudOrganization	getOrgByName(String orgName, boolean required)
List<CloudDomain>	getPrivateDomains()
CloudQuota	getQuotaByName(String quotaName, boolean required)
List<CloudQuota>	getQuotas()
List<ApplicationLog>	getRecentLogs(String appName)
List<CloudRoute>	getRoutes(String domainName)
List<CloudSecurityGroup>	getRunningSecurityGroups()
CloudSecurityGroup	getSecurityGroup(String securityGroupName)
List<CloudSecurityGroup>	getSecurityGroups()
CloudService	getService(String service)
CloudServiceBroker	getServiceBroker(String name)
List<CloudServiceBroker>	getServiceBrokers()
CloudServiceInstance	getServiceInstance(String serviceName)
List<CloudServiceOffering>	getServiceOfferings()
List<CloudService>	getServices()
List<CloudDomain>	getSharedDomains()
CloudSpace	getSpace(String spaceName)
List<UUID>	getSpaceAuditors(String orgName, String spaceName)
List<UUID>	getSpaceDevelopers(String orgName, String spaceName)
List<UUID>	getSpaceManagers(String orgName, String spaceName)
List<CloudSpace>	getSpaces()
List<CloudSpace>	getSpacesBoundToSecurityGroup(String securityGroupName)
CloudStack	getStack(String name)
List<CloudStack>	getStacks()
String	getStagingLogs(StartingInfo info, int offset)
List<CloudSecurityGroup>	getStagingSecurityGroups()
org.springframework.security.oauth2.common.OAuth2AccessToken	login()
void	logout()
void	openFile(String appName, int instanceIndex, String filePath, ClientHttpResponseCallback callback)
void	register(String email, String password)
void	registerRestLogListener(RestLogCallback callBack)
void	removeDomain(String domainName)
void	rename(String appName, String newName)
StartingInfo	restartApplication(String appName)
void	setQuotaToOrg(String orgName, String quotaName)
void	setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)
StartingInfo	startApplication(String appName)
void	stopApplication(String appName)
StreamingLogToken	streamLogs(String appName, ApplicationLogListener listener)
void	unbindRunningSecurityGroup(String securityGroupName)
void	unbindSecurityGroup(String orgName, String spaceName, String securityGroupName)
void	unbindService(String appName, String serviceName)
void	unbindStagingSecurityGroup(String securityGroupName)
void	unregister()
void	unRegisterRestLogListener(RestLogCallback callBack)
void	updateApplicationDiskQuota(String appName, int disk)
void	updateApplicationEnv(String appName, List<String> env)
void	updateApplicationEnv(String appName, Map<String,String> env)
void	updateApplicationInstances(String appName, int instances)
void	updateApplicationMemory(String appName, int memory)
void	updateApplicationServices(String appName, List<String> services)
void	updateApplicationStaging(String appName, Staging staging)
void	updateApplicationUris(String appName, List<String> uris)
void	updatePassword(CloudCredentials credentials, String newPassword)
void	updatePassword(String newPassword)
void	updateQuota(CloudQuota quota, String name)
void	updateSecurityGroup(CloudSecurityGroup securityGroup)
void	updateSecurityGroup(String name, InputStream jsonRulesFile)
void	updateServiceBroker(CloudServiceBroker serviceBroker)
void	updateServicePlanVisibilityForBroker(String name, boolean visibility)
void	uploadApplication(String appName, ApplicationArchive archive, UploadStatusCallback callback)
void	uploadApplication(String appName, File file, UploadStatusCallback callback)
void	uploadApplication(String appName, String fileName, InputStream inputStream, UploadStatusCallback callback)

Method Detail

setResponseErrorHandler

void setResponseErrorHandler(org.springframework.web.client.ResponseErrorHandler errorHandler)

getCloudControllerUrl

URL getCloudControllerUrl()

getInfo

CloudInfo getInfo()

getSpaces

List<CloudSpace> getSpaces()

getOrganizations

List<CloudOrganization> getOrganizations()

login

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

logout

void logout()

register

void register(String email,
            String password)

updatePassword

void updatePassword(String newPassword)

updatePassword

void updatePassword(CloudCredentials credentials,
                  String newPassword)

unregister

void unregister()

getServices

List<CloudService> getServices()

createService

void createService(CloudService service)

createUserProvidedService

void createUserProvidedService(CloudService service,
                             Map<String,Object> credentials)

createUserProvidedService

void createUserProvidedService(CloudService service,
                             Map<String,Object> credentials,
                             String syslogDrainUrl)

getService

CloudService getService(String service)

getServiceInstance

CloudServiceInstance getServiceInstance(String serviceName)

deleteService

void deleteService(String service)

deleteAllServices

void deleteAllServices()

getServiceOfferings

List<CloudServiceOffering> getServiceOfferings()

getServiceBrokers

List<CloudServiceBroker> getServiceBrokers()

getServiceBroker

CloudServiceBroker getServiceBroker(String name)

createServiceBroker

void createServiceBroker(CloudServiceBroker serviceBroker)

updateServiceBroker

void updateServiceBroker(CloudServiceBroker serviceBroker)

deleteServiceBroker

void deleteServiceBroker(String name)

updateServicePlanVisibilityForBroker

void updateServicePlanVisibilityForBroker(String name,
                                        boolean visibility)

getApplications

List<CloudApplication> getApplications()

getApplication

CloudApplication getApplication(String appName)

getApplication

CloudApplication getApplication(UUID appGuid)

getApplicationStats

ApplicationStats getApplicationStats(String appName)

getApplicationEnvironment

Map<String,Object> getApplicationEnvironment(UUID appGuid)

getApplicationEnvironment

Map<String,Object> getApplicationEnvironment(String appName)

createApplication

void createApplication(String appName,
                     Staging staging,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)

createApplication

void createApplication(String appName,
                     Staging staging,
                     Integer disk,
                     Integer memory,
                     List<String> uris,
                     List<String> serviceNames)

uploadApplication

void uploadApplication(String appName,
                     File file,
                     UploadStatusCallback callback)
                       throws IOException

Throws:

IOException

uploadApplication

void uploadApplication(String appName,
                     String fileName,
                     InputStream inputStream,
                     UploadStatusCallback callback)
                       throws IOException

Throws:

IOException

uploadApplication

void uploadApplication(String appName,
                     ApplicationArchive archive,
                     UploadStatusCallback callback)
                       throws IOException

Throws:

IOException

startApplication

StartingInfo startApplication(String appName)

debugApplication

void debugApplication(String appName,
                    CloudApplication.DebugMode mode)

stopApplication

void stopApplication(String appName)

restartApplication

StartingInfo restartApplication(String appName)

deleteApplication

void deleteApplication(String appName)

deleteAllApplications

void deleteAllApplications()

updateApplicationDiskQuota

void updateApplicationDiskQuota(String appName,
                              int disk)

updateApplicationMemory

void updateApplicationMemory(String appName,
                           int memory)

updateApplicationInstances

void updateApplicationInstances(String appName,
                              int instances)

updateApplicationServices

void updateApplicationServices(String appName,
                             List<String> services)

updateApplicationStaging

void updateApplicationStaging(String appName,
                            Staging staging)

updateApplicationUris

void updateApplicationUris(String appName,
                         List<String> uris)

updateApplicationEnv

void updateApplicationEnv(String appName,
                        Map<String,String> env)

updateApplicationEnv

void updateApplicationEnv(String appName,
                        List<String> env)

getEvents

List<CloudEvent> getEvents()

getApplicationEvents

List<CloudEvent> getApplicationEvents(String appName)

getLogs

Map<String,String> getLogs(String appName)

streamLogs

StreamingLogToken streamLogs(String appName,
                           ApplicationLogListener listener)

getRecentLogs

List<ApplicationLog> getRecentLogs(String appName)

getCrashLogs

Map<String,String> getCrashLogs(String appName)

getFile

String getFile(String appName,
             int instanceIndex,
             String filePath,
             int startPosition,
             int endPosition)

openFile

void openFile(String appName,
            int instanceIndex,
            String filePath,
            ClientHttpResponseCallback callback)

bindService

void bindService(String appName,
               String serviceName)

unbindService

void unbindService(String appName,
                 String serviceName)

getApplicationInstances

InstancesInfo getApplicationInstances(String appName)

getApplicationInstances

InstancesInfo getApplicationInstances(CloudApplication app)

getCrashes

CrashesInfo getCrashes(String appName)

rename

void rename(String appName,
          String newName)

getStagingLogs

String getStagingLogs(StartingInfo info,
                    int offset)

getStacks

List<CloudStack> getStacks()

getStack

CloudStack getStack(String name)

createSpace

void createSpace(String spaceName)

getSpace

CloudSpace getSpace(String spaceName)

deleteSpace

void deleteSpace(String spaceName)

getDomainsForOrg

List<CloudDomain> getDomainsForOrg()

getDomains

List<CloudDomain> getDomains()

getPrivateDomains

List<CloudDomain> getPrivateDomains()

getSharedDomains

List<CloudDomain> getSharedDomains()

getDefaultDomain

CloudDomain getDefaultDomain()

addDomain

void addDomain(String domainName)

deleteDomain

void deleteDomain(String domainName)

removeDomain

void removeDomain(String domainName)

getRoutes

List<CloudRoute> getRoutes(String domainName)

addRoute

void addRoute(String host,
            String domainName)

deleteRoute

void deleteRoute(String host,
               String domainName)

deleteOrphanedRoutes

List<CloudRoute> deleteOrphanedRoutes()

registerRestLogListener

void registerRestLogListener(RestLogCallback callBack)

unRegisterRestLogListener

void unRegisterRestLogListener(RestLogCallback callBack)

getOrgByName

CloudOrganization getOrgByName(String orgName,
                             boolean required)

getQuotas

List<CloudQuota> getQuotas()

getQuotaByName

CloudQuota getQuotaByName(String quotaName,
                        boolean required)

createQuota

void createQuota(CloudQuota quota)

updateQuota

void updateQuota(CloudQuota quota,
               String name)

deleteQuota

void deleteQuota(String quotaName)

setQuotaToOrg

void setQuotaToOrg(String orgName,
                 String quotaName)

getSpaceManagers

List<UUID> getSpaceManagers(String orgName,
                          String spaceName)

getSpaceDevelopers

List<UUID> getSpaceDevelopers(String orgName,
                            String spaceName)

getSpaceAuditors

List<UUID> getSpaceAuditors(String orgName,
                          String spaceName)

associateManagerWithSpace

void associateManagerWithSpace(String orgName,
                             String spaceName)

associateDeveloperWithSpace

void associateDeveloperWithSpace(String orgName,
                               String spaceName)

associateAuditorWithSpace

void associateAuditorWithSpace(String orgName,
                             String spaceName)

getSecurityGroups

List<CloudSecurityGroup> getSecurityGroups()

getSecurityGroup

CloudSecurityGroup getSecurityGroup(String securityGroupName)

createSecurityGroup

void createSecurityGroup(CloudSecurityGroup securityGroup)

createSecurityGroup

void createSecurityGroup(String name,
                       InputStream jsonRulesFile)

updateSecurityGroup

void updateSecurityGroup(CloudSecurityGroup securityGroup)

updateSecurityGroup

void updateSecurityGroup(String name,
                       InputStream jsonRulesFile)

deleteSecurityGroup

void deleteSecurityGroup(String securityGroupName)

getStagingSecurityGroups

List<CloudSecurityGroup> getStagingSecurityGroups()

bindStagingSecurityGroup

void bindStagingSecurityGroup(String securityGroupName)

unbindStagingSecurityGroup

void unbindStagingSecurityGroup(String securityGroupName)

getRunningSecurityGroups

List<CloudSecurityGroup> getRunningSecurityGroups()

bindRunningSecurityGroup

void bindRunningSecurityGroup(String securityGroupName)

unbindRunningSecurityGroup

void unbindRunningSecurityGroup(String securityGroupName)

getSpacesBoundToSecurityGroup

List<CloudSpace> getSpacesBoundToSecurityGroup(String securityGroupName)

bindSecurityGroup

void bindSecurityGroup(String orgName,
                     String spaceName,
                     String securityGroupName)

unbindSecurityGroup

void unbindSecurityGroup(String orgName,
                       String spaceName,
                       String securityGroupName)