com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpCfService

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.ScpCfService

@Beta
public class ScpCfService
extends Object

A facilitation of access to the SCP services with OAuth auth listed in VCAP_SERVICES.

Be aware that this class is in Beta (as indicated by the annotation) and therefore subject to breaking changes.

Constructor Summary

Constructors

Constructor and Description
ScpCfService(ScpCfServiceInfo serviceInfo, URI authUri, BasicCredentials clientCredentials, String serviceLocationInfo) Constructor open for extension.
ScpCfService(ScpCfServiceInfo serviceInfo, URI authUri, BasicCredentials clientCredentials, String serviceLocationInfo, boolean useProviderTenant) Constructor open for extension.

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpRequest	addBearerTokenHeader(org.apache.http.HttpRequest request) Configures a provided request to the service to bear required authentication token.
URI	getAuthUri() The oauth server url from the service config.
BasicCredentials	getClientCredentials()
ScpCfServiceInfo	getServiceInfo() Provides access to the rest of the service info.
String	getServiceLocationInfo() Service access.
static ScpCfService	of(ScpCfServiceDesignator designator, String authUrlJsonPath, String clientIdJsonPath, String clientSecretJsonPath, String serviceLocationJsonPath) Factory method reading information about service from VCAP_SERVICES.
static ScpCfService	of(String serviceType, String servicePlan, String authUrlJsonPath, String clientIdJsonPath, String clientSecretJsonPath, String serviceLocationJsonPath) Factory method reading information about service from VCAP_SERVICES.
static ScpCfService	ofMultiTenant(ScpCfServiceDesignator designator, String authUrlJsonPath, String clientIdJsonPath, String clientSecretJsonPath, String serviceLocationJsonPath, boolean useProviderTenant) Factory method reading information about service from VCAP_SERVICES.
static ScpCfService	ofMultiTenant(String serviceType, String servicePlan, String authUrlJsonPath, String clientIdJsonPath, String clientSecretJsonPath, String serviceLocationJsonPath, boolean useProviderTenant) Factory method reading information about service from VCAP_SERVICES.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCfService

public ScpCfService(@Nonnull
                    ScpCfServiceInfo serviceInfo,
                    @Nonnull
                    URI authUri,
                    @Nonnull
                    BasicCredentials clientCredentials,
                    @Nonnull
                    String serviceLocationInfo)

Constructor open for extension.

Parameters:

serviceInfo - json from the VCAP_SERVICES

authUri - OAuth authentication service

clientCredentials - credentials for authentications to OAuth service

serviceLocationInfo - url or host of the service represented by this object

ScpCfService

public ScpCfService(@Nonnull
                    ScpCfServiceInfo serviceInfo,
                    @Nonnull
                    URI authUri,
                    @Nonnull
                    BasicCredentials clientCredentials,
                    @Nonnull
                    String serviceLocationInfo,
                    boolean useProviderTenant)

Constructor open for extension.

Parameters:

serviceInfo - json from the VCAP_SERVICES

authUri - OAuth authentication service

clientCredentials - credentials for authentications to OAuth service

serviceLocationInfo - url or host of the service represented by this object

useProviderTenant - for applications that other tenants can subscribe to, this flag controls whether to always use the service with the credentials of the provider tenant.

Method Detail

of

@Nonnull
public static ScpCfService of(@Nonnull
                                       ScpCfServiceDesignator designator,
                                       @Nonnull
                                       String authUrlJsonPath,
                                       @Nonnull
                                       String clientIdJsonPath,
                                       @Nonnull
                                       String clientSecretJsonPath,
                                       @Nonnull
                                       String serviceLocationJsonPath)
                                throws CloudPlatformException,
                                       ScpCfServiceCreationFailedException

Factory method reading information about service from VCAP_SERVICES. Takes paths in the form of 'credentials/clientId' to make information extraction generic. Doesn't validate the connection to the auth server or service itself yet.

Parameters:

designator - service designator indicatig the service information to use

authUrlJsonPath - path to the OAuth server URL.

clientIdJsonPath - path to client id

clientSecretJsonPath - path to client secret

serviceLocationJsonPath - path to the service's url or host information or similar

Returns:

the created service.

Throws:

CloudPlatformException - On problems like the service type not being present in VCAP_SERVICES.

ScpCfServiceCreationFailedException - If the service creation is otherwise incomplete or incorrect.

of

@Nonnull
public static ScpCfService of(@Nonnull
                                       String serviceType,
                                       @Nullable
                                       String servicePlan,
                                       @Nonnull
                                       String authUrlJsonPath,
                                       @Nonnull
                                       String clientIdJsonPath,
                                       @Nonnull
                                       String clientSecretJsonPath,
                                       @Nonnull
                                       String serviceLocationJsonPath)
                                throws CloudPlatformException,
                                       ScpCfServiceCreationFailedException

Factory method reading information about service from VCAP_SERVICES. Takes paths in the form of 'credentials/clientId' to make information extraction generic. Doesn't validate the connection to the auth server or service itself yet.

Parameters:

serviceType - classification of services

servicePlan - optional service plan identifier to distinguish different instances of the same service type.

authUrlJsonPath - path to the OAuth server URL.

clientIdJsonPath - path to client id

clientSecretJsonPath - path to client secret

serviceLocationJsonPath - path to the service's url or host information or similar

Returns:

the created service.

Throws:

CloudPlatformException - On problems like the service type not being present in VCAP_SERVICES.

ScpCfServiceCreationFailedException - If the service creation is otherwise incomplete or incorrect.

ofMultiTenant

@Nonnull
public static ScpCfService ofMultiTenant(@Nonnull
                                                  String serviceType,
                                                  @Nullable
                                                  String servicePlan,
                                                  @Nonnull
                                                  String authUrlJsonPath,
                                                  @Nonnull
                                                  String clientIdJsonPath,
                                                  @Nonnull
                                                  String clientSecretJsonPath,
                                                  @Nonnull
                                                  String serviceLocationJsonPath,
                                                  boolean useProviderTenant)
                                           throws CloudPlatformException,
                                                  ScpCfServiceCreationFailedException

Factory method reading information about service from VCAP_SERVICES. Takes paths in the form of 'credentials/clientId' to make information extraction generic. Doesn't validate the connection to the auth server or service itself yet. This one takes into account multi-tenant subscription environments and allows for always using the provider tenant when accessing the service.

Parameters:

serviceType - classification of services

servicePlan - optional service plan identifier to distinguish different instances of the same service type.

authUrlJsonPath - path to the OAuth server URL.

clientIdJsonPath - path to client id

clientSecretJsonPath - path to client secret

serviceLocationJsonPath - path to the service's url or host information or similar

useProviderTenant - for applications that other tenants can subscribe to, this flag controls whether to always use the service with the credentials ofMultiTenant the provider tenant.

Returns:

the created service.

Throws:

CloudPlatformException - On problems like the service type not being present in VCAP_SERVICES.

ScpCfServiceCreationFailedException - If the service creation is otherwise incomplete or incorrect.

ofMultiTenant

@Nonnull
public static ScpCfService ofMultiTenant(@Nonnull
                                                  ScpCfServiceDesignator designator,
                                                  @Nonnull
                                                  String authUrlJsonPath,
                                                  @Nonnull
                                                  String clientIdJsonPath,
                                                  @Nonnull
                                                  String clientSecretJsonPath,
                                                  @Nonnull
                                                  String serviceLocationJsonPath,
                                                  boolean useProviderTenant)
                                           throws CloudPlatformException

Factory method reading information about service from VCAP_SERVICES. Takes paths in the form of 'credentials/clientId' to make information extraction generic. Doesn't validate the connection to the auth server or service itself yet. This one takes into account multi-tenant subscription environments and allows for always using the provider tenant when accessing the service.

Parameters:

designator - service designator indicatig the service information to use

authUrlJsonPath - path to the OAuth server URL.

clientIdJsonPath - path to client id

clientSecretJsonPath - path to client secret

serviceLocationJsonPath - path to the service's url or host information or similar

useProviderTenant - for applications that other tenants can subscribe to, this flag controls whether to always use the service with the credentials ofMultiTenant the provider tenant.

Returns:

the created service.

Throws:

CloudPlatformException - On problems like the service type not being present in VCAP_SERVICES and if the service information is otherwise incomplete or incorrect.

getServiceInfo

@Nonnull
public ScpCfServiceInfo getServiceInfo()

Provides access to the rest of the service info.

Returns:

an nice wrapper for the json.

getServiceLocationInfo

@Nullable
public String getServiceLocationInfo()

Service access.

Returns:

the URL or host name or similar - if present

getAuthUri

@Nonnull
public URI getAuthUri()

The oauth server url from the service config.

Returns:

the url

getClientCredentials

@Nonnull
public BasicCredentials getClientCredentials()

Returns:

the client credentials from the service info

addBearerTokenHeader

@Nonnull
public org.apache.http.HttpRequest addBearerTokenHeader(@Nonnull
                                                                 org.apache.http.HttpRequest request)
                                                          throws ScpCfServiceAuthorizationFailedException

Configures a provided request to the service to bear required authentication token. Requests authentication from the oauth server or uses a cached token.

Parameters:

request - to add authentication token to.

Returns:

the request for chaining.

Throws:

ScpCfServiceAuthorizationFailedException - if the request was forbidden or failed

toString

@Nonnull
public String toString()

Overrides:

toString in class Object