org.trustedanalytics.cloud.cc

Class FeignClient

java.lang.Object

org.trustedanalytics.cloud.cc.FeignClient

All Implemented Interfaces:

CcOperations, CcOperationsApps, CcOperationsCommon, CcOperationsOrgsSpaces, CcOperationsServices, CcOperationsUsers

public class FeignClient
extends Object
implements CcOperations

Constructor Summary

Constructors

Constructor and Description
FeignClient(String url) Creates client applying default configuration
FeignClient(String url, Function<feign.Feign.Builder,feign.Feign.Builder> customizations) Creates client applying default configuration and then customizations.

Method Summary

Modifier and Type	Method and Description
void	assignOrgRole(UUID userGuid, UUID orgGuid, Role role) Assigns organization role to user identified by given GUID.
void	assignSpaceRole(UUID userGuid, UUID orgGuid, Role role) Assigns space role to user identified by given GUID.
void	assignUserToOrganization(UUID userGuid, UUID orgGuid) Assigns user identified by given GUID to organization identified by given GUID.
void	assignUserToSpace(UUID userGuid, UUID spaceGuid) Assigns user identified by given GUID to space identified by given GUID.
UUID	createOrganization(String orgName) Creates organization with given name.
CcServiceBinding	createServiceBinding(CcNewServiceBinding ccNewServiceBinding) Creates service binding for application.
rx.Observable<CcExtendedServiceInstance>	createServiceInstance(CcNewServiceInstance serviceInstance) Creates new service instance using provided configuration.
rx.Observable<CcServiceKey>	createServiceKey(CcNewServiceKey serviceKey) Creates a new service key
UUID	createSpace(UUID orgGuid, String name) Creates space within given organization.
void	createUser(UUID userGuid) Creates new user with given GUID.
void	deleteApp(UUID app) Deletes application identified by given GUID.
void	deleteOrg(UUID orgGuid) Deletes organization identified by given GUID.
void	deleteServiceBinding(UUID bindingGuid) Deletes service binding for application identified by given GUID.
void	deleteServiceInstance(UUID instanceGuid) Deletes service instance identified by given GUID.
void	deleteServiceKey(UUID keyGuid) Deletes given service key
void	deleteSpace(UUID spaceGuid) Deletes space identified by given GUID.
void	deleteUser(UUID guid) Deletes user identified by given GUID.
CcServiceBindingList	getAppBindings(UUID app) Returns all bindings belonging to application identified by given GUID.
CcServiceBindingList	getAppBindings(UUID app, FilterQuery query) Returns all bindings belonging to application identified by given GUID and filtering by given filter.
rx.Observable<CcAppEnv>	getAppEnv(UUID appUUID) Returns environment variables for application identified by given GUID.
CcAppSummary	getAppSummary(UUID app) Returns summary for application identified by given GUID.
Collection<CcOrg>	getAuditedOrganizations(UUID user) Returns organizations audited by user identified by given GUID.
Collection<CcOrg>	getBillingManagedOrganizations(UUID user) Returns organizations billed by user identified by given GUID.
rx.Observable<CcBuildpack>	getBuildpacks() Returns buildpacks
rx.Observable<CcExtendedServiceInstance>	getExtendedServiceInstances()
rx.Observable<CcExtendedServiceInstance>	getExtendedServiceInstances(FilterQuery filterQuery)
rx.Observable<CcExtendedServiceInstance>	getExtendedServiceInstances(FilterQuery filterQuery, int depth)
rx.Observable<CcExtendedServiceInstance>	getExtendedServiceInstances(int depth)
rx.Observable<CcExtendedServicePlan>	getExtendedServicePlans(UUID serviceGuid) Returns service plans within service identified by given GUID
rx.Observable<CcExtendedService>	getExtendedServices() Returns services
Collection<CcOrg>	getManagedOrganizations(UUID user) Returns organizations managed by user identified by given GUID.
rx.Observable<CcMemoryUsage>	getMemoryUsage(UUID orgGuid) Get memory usage from organization identified by given GUID.
rx.Observable<CcOrg>	getOrg(UUID orgUUID) Returns organization identified by given GUID.
rx.Observable<CcOrg>	getOrgs() Returns all organizations.
rx.Observable<CcOrgSummary>	getOrgSummary(UUID orgGuid) Get organization summary from organization identified by given GUID.
Collection<User>	getOrgUsers(UUID orgGuid, Role role) Returns all users with given role within organization identified by given GUID.
rx.Observable<CcQuota>	getQuota() Get quota
rx.Observable<CcExtendedService>	getService(UUID serviceGuid) Returns service identified by given GUID.
CcServiceBindingList	getServiceBindings(FilterQuery filterQuery) Returns list of service bindings matching provided filter
rx.Observable<CcServiceKey>	getServiceKeys() Returns a list of all service keys acessible to user
rx.Observable<CcExtendedService>	getServices(UUID spaceGuid) Returns services within space identified by given GUID.
rx.Observable<CcSpace>	getSpace(UUID spaceId) Returns space identified by given GUID.
rx.Observable<CcSpace>	getSpaces() Returns all spaces.
rx.Observable<CcSpace>	getSpaces(UUID org) Returns all spaces withing organization identified by given GUID.
CcSummary	getSpaceSummary(UUID spaceGuid) Returns summary for space identified by given UUID
Collection<User>	getSpaceUsers(UUID spaceGuid, Role role) Returns all users with given role within space identified by given GUID.
Collection<CcOrg>	getUserOrgs(UUID userGuid) Returns organizations assigned to user identified by given GUID.
Collection<CcOrgPermission>	getUserPermissions(UUID user, Collection<UUID> orgsFilter) Returns users permissions for given organizations.
Collection<CcSpace>	getUsersSpaces(UUID userGuid, Role role, UUID orgGuid) Get spaces that user has access to in given role.
void	renameOrg(UUID orgId, String name) Renames organization identified by given GUID.
void	restageApp(UUID appGuid) Restages application identified by given GUID.
void	revokeOrgRole(UUID userGuid, UUID orgId, Role role) Removes organization role from user identified by given GUID
void	revokeSpaceRole(UUID userGuid, UUID spaceId, Role role) Removes space role from user identified by given GUID
void	switchApp(UUID app, CcAppStatus appStatus) Switches off application identified by given GUID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeignClient

public FeignClient(String url)

Creates client applying default configuration

Parameters:

url - endpoint url

FeignClient

public FeignClient(String url,
                   Function<feign.Feign.Builder,feign.Feign.Builder> customizations)

Creates client applying default configuration and then customizations. Example:

 
 new FeignClient(apiUrl, builder -> builder.requestInterceptor(template ->
 template.header("Authorization", "bearer " + token)));
 
 

Parameters:

url - endpoint url

customizations - custom configuration that should be applied after defaults

Method Detail

getAppSummary

public CcAppSummary getAppSummary(UUID app)

Description copied from interface: CcOperationsApps

Returns summary for application identified by given GUID.

Specified by:

getAppSummary in interface CcOperationsApps

Parameters:

app - application GUID

Returns:

application summary

restageApp

public void restageApp(UUID appGuid)

Description copied from interface: CcOperationsApps

Restages application identified by given GUID.

Specified by:

restageApp in interface CcOperationsApps

Parameters:

appGuid - application GUID

getAppBindings

public CcServiceBindingList getAppBindings(UUID app)

Description copied from interface: CcOperationsApps

Returns all bindings belonging to application identified by given GUID.

Specified by:

getAppBindings in interface CcOperationsApps

Parameters:

app - application GUID

Returns:

bindings for given application

getAppBindings

public CcServiceBindingList getAppBindings(UUID app,
                                           FilterQuery query)

Description copied from interface: CcOperationsApps

Returns all bindings belonging to application identified by given GUID and filtering by given filter.

Specified by:

getAppBindings in interface CcOperationsApps

Parameters:

app - application GUID

query - filter

Returns:

binding for given application matching filter

deleteApp

public void deleteApp(UUID app)

Description copied from interface: CcOperationsApps

Deletes application identified by given GUID. All services bindings belonging to this application will also be removed.

Specified by:

deleteApp in interface CcOperationsApps

Parameters:

app - application GUID

createServiceBinding

public CcServiceBinding createServiceBinding(CcNewServiceBinding ccNewServiceBinding)

Description copied from interface: CcOperationsApps

Creates service binding for application.

Specified by:

createServiceBinding in interface CcOperationsApps

Parameters:

ccNewServiceBinding - binding for application

Returns:

binding for application

deleteServiceBinding

public void deleteServiceBinding(UUID bindingGuid)

Description copied from interface: CcOperationsApps

Deletes service binding for application identified by given GUID.

Specified by:

deleteServiceBinding in interface CcOperationsApps

Parameters:

bindingGuid - binding GUID

createUser

public void createUser(UUID userGuid)

Description copied from interface: CcOperationsOrgsSpaces

Creates new user with given GUID.

Specified by:

createUser in interface CcOperationsOrgsSpaces

Parameters:

userGuid - user GUID

createOrganization

public UUID createOrganization(String orgName)

Description copied from interface: CcOperationsOrgsSpaces

Creates organization with given name.

Specified by:

createOrganization in interface CcOperationsOrgsSpaces

Parameters:

orgName - name of organization

Returns:

UUID of created organization

createSpace

public UUID createSpace(UUID orgGuid,
                        String name)

Description copied from interface: CcOperationsOrgsSpaces

Creates space within given organization.

Specified by:

createSpace in interface CcOperationsOrgsSpaces

Parameters:

orgGuid - organization GUID

name - space name

Returns:

space GUID

assignUserToOrganization

public void assignUserToOrganization(UUID userGuid,
                                     UUID orgGuid)

Description copied from interface: CcOperationsOrgsSpaces

Assigns user identified by given GUID to organization identified by given GUID.

Specified by:

assignUserToOrganization in interface CcOperationsOrgsSpaces

Parameters:

userGuid - user GUID

orgGuid - organization GUID

assignUserToSpace

public void assignUserToSpace(UUID userGuid,
                              UUID spaceGuid)

Description copied from interface: CcOperationsOrgsSpaces

Assigns user identified by given GUID to space identified by given GUID.

Specified by:

assignUserToSpace in interface CcOperationsOrgsSpaces

Parameters:

userGuid - user GUID

spaceGuid - space GUID

getOrg

public rx.Observable<CcOrg> getOrg(UUID orgUUID)

Description copied from interface: CcOperationsOrgsSpaces

Returns organization identified by given GUID.

Specified by:

getOrg in interface CcOperationsOrgsSpaces

Parameters:

orgUUID - organization GUID

Returns:

organization

getOrgs

public rx.Observable<CcOrg> getOrgs()

Description copied from interface: CcOperationsOrgsSpaces

Returns all organizations.

Specified by:

getOrgs in interface CcOperationsOrgsSpaces

Returns:

organizations

getSpaces

public rx.Observable<CcSpace> getSpaces()

Description copied from interface: CcOperationsOrgsSpaces

Returns all spaces.

Specified by:

getSpaces in interface CcOperationsOrgsSpaces

Returns:

spaces

getSpace

public rx.Observable<CcSpace> getSpace(UUID spaceId)

Description copied from interface: CcOperationsOrgsSpaces

Returns space identified by given GUID.

Specified by:

getSpace in interface CcOperationsOrgsSpaces

Parameters:

spaceId - space GUID

Returns:

space

getSpaces

public rx.Observable<CcSpace> getSpaces(UUID org)

Description copied from interface: CcOperationsOrgsSpaces

Returns all spaces withing organization identified by given GUID.

Specified by:

getSpaces in interface CcOperationsOrgsSpaces

Parameters:

org - GUID

Returns:

spaces

getManagedOrganizations

public Collection<CcOrg> getManagedOrganizations(UUID user)

Description copied from interface: CcOperationsOrgsSpaces

Returns organizations managed by user identified by given GUID.

Specified by:

getManagedOrganizations in interface CcOperationsOrgsSpaces

Parameters:

user - GUID

Returns:

organizations

getAuditedOrganizations

public Collection<CcOrg> getAuditedOrganizations(UUID user)

Description copied from interface: CcOperationsOrgsSpaces

Returns organizations audited by user identified by given GUID.

Specified by:

getAuditedOrganizations in interface CcOperationsOrgsSpaces

Parameters:

user - GUID

Returns:

organizations

getBillingManagedOrganizations

public Collection<CcOrg> getBillingManagedOrganizations(UUID user)

Description copied from interface: CcOperationsOrgsSpaces

Returns organizations billed by user identified by given GUID.

Specified by:

getBillingManagedOrganizations in interface CcOperationsOrgsSpaces

Parameters:

user - GUID

Returns:

organizations

renameOrg

public void renameOrg(UUID orgId,
                      String name)

Description copied from interface: CcOperationsOrgsSpaces

Renames organization identified by given GUID.

Specified by:

renameOrg in interface CcOperationsOrgsSpaces

Parameters:

orgId - GUID

name - new name

deleteOrg

public void deleteOrg(UUID orgGuid)

Description copied from interface: CcOperationsOrgsSpaces

Deletes organization identified by given GUID.

Specified by:

deleteOrg in interface CcOperationsOrgsSpaces

Parameters:

orgGuid - GUID

deleteSpace

public void deleteSpace(UUID spaceGuid)

Description copied from interface: CcOperationsOrgsSpaces

Deletes space identified by given GUID.

Specified by:

deleteSpace in interface CcOperationsOrgsSpaces

Parameters:

spaceGuid - GUID

getUsersSpaces

public Collection<CcSpace> getUsersSpaces(UUID userGuid,
                                          Role role,
                                          UUID orgGuid)

Description copied from interface: CcOperationsOrgsSpaces

Get spaces that user has access to in given role.

Specified by:

getUsersSpaces in interface CcOperationsOrgsSpaces

Parameters:

userGuid - GUID

role - user role

orgGuid - GUID

Returns:

spaces

getExtendedServices

public rx.Observable<CcExtendedService> getExtendedServices()

Description copied from interface: CcOperationsServices

Returns services

Specified by:

getExtendedServices in interface CcOperationsServices

Returns:

services

getExtendedServiceInstances

public rx.Observable<CcExtendedServiceInstance> getExtendedServiceInstances()

Specified by:

getExtendedServiceInstances in interface CcOperationsServices

Returns:

all service instances

getExtendedServiceInstances

public rx.Observable<CcExtendedServiceInstance> getExtendedServiceInstances(FilterQuery filterQuery)

Specified by:

getExtendedServiceInstances in interface CcOperationsServices

Parameters:

filterQuery - filter to use when requesting service instances

Returns:

filtered service instances

getExtendedServiceInstances

public rx.Observable<CcExtendedServiceInstance> getExtendedServiceInstances(int depth)

Specified by:

getExtendedServiceInstances in interface CcOperationsServices

Parameters:

depth - how deep the relations should be resolved

Returns:

all service instances

getExtendedServiceInstances

public rx.Observable<CcExtendedServiceInstance> getExtendedServiceInstances(FilterQuery filterQuery,
                                                                            int depth)

Specified by:

getExtendedServiceInstances in interface CcOperationsServices

Parameters:

filterQuery - filter to use when requesting service instances

depth - how deep the relations should be resolved

Returns:

filtered service instances

getExtendedServicePlans

public rx.Observable<CcExtendedServicePlan> getExtendedServicePlans(UUID serviceGuid)

Description copied from interface: CcOperationsServices

Returns service plans within service identified by given GUID

Specified by:

getExtendedServicePlans in interface CcOperationsServices

Returns:

services plans

getServices

public rx.Observable<CcExtendedService> getServices(UUID spaceGuid)

Description copied from interface: CcOperationsServices

Returns services within space identified by given GUID.

Specified by:

getServices in interface CcOperationsServices

Parameters:

spaceGuid - GUID

Returns:

services

getService

public rx.Observable<CcExtendedService> getService(UUID serviceGuid)

Description copied from interface: CcOperationsServices

Returns service identified by given GUID.

Specified by:

getService in interface CcOperationsServices

Parameters:

serviceGuid - GUID

Returns:

service

getServiceBindings

public CcServiceBindingList getServiceBindings(FilterQuery filterQuery)

Description copied from interface: CcOperationsServices

Returns list of service bindings matching provided filter

Specified by:

getServiceBindings in interface CcOperationsServices

Parameters:

filterQuery - filter

Returns:

matching service bindings

getServiceKeys

public rx.Observable<CcServiceKey> getServiceKeys()

Description copied from interface: CcOperationsServices

Returns a list of all service keys acessible to user

Specified by:

getServiceKeys in interface CcOperationsServices

Returns:

list of service keys

createServiceKey

public rx.Observable<CcServiceKey> createServiceKey(CcNewServiceKey serviceKey)

Description copied from interface: CcOperationsServices

Creates a new service key

Specified by:

createServiceKey in interface CcOperationsServices

Returns:

Created service key

deleteServiceKey

public void deleteServiceKey(UUID keyGuid)

Description copied from interface: CcOperationsServices

Deletes given service key

Specified by:

deleteServiceKey in interface CcOperationsServices

createServiceInstance

public rx.Observable<CcExtendedServiceInstance> createServiceInstance(CcNewServiceInstance serviceInstance)

Description copied from interface: CcOperationsServices

Creates new service instance using provided configuration.

Specified by:

createServiceInstance in interface CcOperationsServices

Parameters:

serviceInstance - service instance

Returns:

new service instance

deleteServiceInstance

public void deleteServiceInstance(UUID instanceGuid)

Description copied from interface: CcOperationsServices

Deletes service instance identified by given GUID.

Specified by:

deleteServiceInstance in interface CcOperationsServices

Parameters:

instanceGuid - GUID

getSpaceSummary

public CcSummary getSpaceSummary(UUID spaceGuid)

Description copied from interface: CcOperationsCommon

Returns summary for space identified by given UUID

Specified by:

getSpaceSummary in interface CcOperationsCommon

Parameters:

spaceGuid - space UUID

Returns:

space summary

getUserOrgs

public Collection<CcOrg> getUserOrgs(UUID userGuid)

Description copied from interface: CcOperationsOrgsSpaces

Returns organizations assigned to user identified by given GUID.

Specified by:

getUserOrgs in interface CcOperationsOrgsSpaces

Parameters:

userGuid - GUID

Returns:

organizations

getUserPermissions

public Collection<CcOrgPermission> getUserPermissions(UUID user,
                                                      Collection<UUID> orgsFilter)

Description copied from interface: CcOperationsOrgsSpaces

Returns users permissions for given organizations.

Specified by:

getUserPermissions in interface CcOperationsOrgsSpaces

Parameters:

user - GUID

orgsFilter - organizations UUIDs

Returns:

permissions in organizations

getOrgUsers

public Collection<User> getOrgUsers(UUID orgGuid,
                                    Role role)

Description copied from interface: CcOperationsUsers

Returns all users with given role within organization identified by given GUID.

Specified by:

getOrgUsers in interface CcOperationsUsers

Parameters:

orgGuid - organization GUID

role - user role

Returns:

users within organization with specified role

getSpaceUsers

public Collection<User> getSpaceUsers(UUID spaceGuid,
                                      Role role)

Description copied from interface: CcOperationsUsers

Returns all users with given role within space identified by given GUID.

Specified by:

getSpaceUsers in interface CcOperationsUsers

Parameters:

spaceGuid - space GUID

role - user role

Returns:

users within space with specified role

assignOrgRole

public void assignOrgRole(UUID userGuid,
                          UUID orgGuid,
                          Role role)

Description copied from interface: CcOperationsUsers

Assigns organization role to user identified by given GUID.

Specified by:

assignOrgRole in interface CcOperationsUsers

Parameters:

userGuid - user GUID

orgGuid - organization GUID

role - organization role

assignSpaceRole

public void assignSpaceRole(UUID userGuid,
                            UUID orgGuid,
                            Role role)

Description copied from interface: CcOperationsUsers

Assigns space role to user identified by given GUID.

Specified by:

assignSpaceRole in interface CcOperationsUsers

Parameters:

userGuid - user GUID

orgGuid - organization GUID

role - space role

deleteUser

public void deleteUser(UUID guid)

Description copied from interface: CcOperationsUsers

Deletes user identified by given GUID.

Specified by:

deleteUser in interface CcOperationsUsers

Parameters:

guid - user GUID

revokeOrgRole

public void revokeOrgRole(UUID userGuid,
                          UUID orgId,
                          Role role)

Description copied from interface: CcOperationsUsers

Removes organization role from user identified by given GUID

Specified by:

revokeOrgRole in interface CcOperationsUsers

Parameters:

userGuid - user GUID

orgId - organization GUID

role - organization role

revokeSpaceRole

public void revokeSpaceRole(UUID userGuid,
                            UUID spaceId,
                            Role role)

Description copied from interface: CcOperationsUsers

Removes space role from user identified by given GUID

Specified by:

revokeSpaceRole in interface CcOperationsUsers

Parameters:

userGuid - user GUID

spaceId - space GUID

role - role

switchApp

public void switchApp(UUID app,
                      CcAppStatus appStatus)

Description copied from interface: CcOperationsApps

Switches off application identified by given GUID.

Specified by:

switchApp in interface CcOperationsApps

Parameters:

app - application GUID

getAppEnv

public rx.Observable<CcAppEnv> getAppEnv(UUID appUUID)

Description copied from interface: CcOperationsApps

Returns environment variables for application identified by given GUID.

Specified by:

getAppEnv in interface CcOperationsApps

Parameters:

appUUID - application GUID

getMemoryUsage

public rx.Observable<CcMemoryUsage> getMemoryUsage(UUID orgGuid)

Description copied from interface: CcOperationsOrgsSpaces

Get memory usage from organization identified by given GUID.

Specified by:

getMemoryUsage in interface CcOperationsOrgsSpaces

Parameters:

orgGuid - GUID

getQuota

public rx.Observable<CcQuota> getQuota()

Description copied from interface: CcOperationsCommon

Get quota

Specified by:

getQuota in interface CcOperationsCommon

getBuildpacks

public rx.Observable<CcBuildpack> getBuildpacks()

Description copied from interface: CcOperationsCommon

Returns buildpacks

Specified by:

getBuildpacks in interface CcOperationsCommon

getOrgSummary

public rx.Observable<CcOrgSummary> getOrgSummary(UUID orgGuid)

Description copied from interface: CcOperationsOrgsSpaces

Get organization summary from organization identified by given GUID.

Specified by:

getOrgSummary in interface CcOperationsOrgsSpaces

Parameters:

orgGuid - GUID