com.sap.cloud.sdk.cloudplatform

Class ScpCfCloudPlatform

java.lang.Object

com.sap.cloud.sdk.cloudplatform.ScpCfCloudPlatform

All Implemented Interfaces:

CloudPlatform

public class ScpCfCloudPlatform
extends Object
implements CloudPlatform

Implementation for the SAP Cloud Platform Cloud Foundry variant.

Constructor Summary

Constructors

Constructor and Description
ScpCfCloudPlatform()

Method Summary

Modifier and Type	Method and Description
String	getApplicationName()
com.google.gson.JsonObject	getConnectivityServiceCredentials() Retrieves the connectivity service credentials.
List<com.google.gson.JsonObject>	getConnectivityServiceCredentialsList() Retrieves the service credentials for all bound connectivity service instances.
com.google.gson.JsonObject	getDestinationServiceCredentials() Retrieves the destination service credentials.
List<com.google.gson.JsonObject>	getDestinationServiceCredentialsList() Retrieves the service credentials for all bound destination service instances.
Optional<String>	getEnvironmentVariable(String name)
static ScpCfCloudPlatform	getInstanceOrThrow() Be aware that this method is Beta (as indicated by the annotation) and therefore subject to breaking changes.
com.google.gson.JsonObject	getServiceCredentials(String serviceName) Retrieves the credentials of a service.
com.google.gson.JsonObject	getServiceCredentials(String serviceName, String servicePlan) Retrieves the credentials of a service.
Map<String,com.google.gson.JsonElement>	getVcapApplication() Provides access to the "VCAP_APPLICATION" environment variable.
Map<String,com.google.gson.JsonArray>	getVcapServices() Provides access to the "VCAP_SERVICES" environment variable.
String	getXsAppName() Retrieves the "xsappname" from the XSUAA service instance credentials.
com.google.gson.JsonObject	getXsuaaServiceCredentials() Retrieves the XSUAA service credentials.
com.google.gson.JsonObject	getXsuaaServiceCredentials(com.auth0.jwt.interfaces.DecodedJWT jwt) Retrieves the service credentials for all bound XSUAA service instances based on the given JSON Web Token.
com.google.gson.JsonObject	getXsuaaServiceCredentials(String servicePlan) Retrieves the XSUAA service credentials.
List<com.google.gson.JsonObject>	getXsuaaServiceCredentialsList() Retrieves the service credentials for all bound XSUAA service instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCfCloudPlatform

public ScpCfCloudPlatform()

Method Detail

getInstanceOrThrow

@Beta
 @Nonnull
public static ScpCfCloudPlatform getInstanceOrThrow()
                                                             throws CloudPlatformException

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

Returns:

The instance of this class if executed on the Cloud Foundry (CF) version of SAP Cloud Platform. Else throws.

Throws:

CloudPlatformException - If not executed on the Cloud Foundry (CF) version of SAP Cloud Platform.

getEnvironmentVariable

@Nonnull
public Optional<String> getEnvironmentVariable(@Nonnull
                                                        String name)

Returns:

The environment variable with the given name, if present.

getVcapApplication

@Nonnull
public Map<String,com.google.gson.JsonElement> getVcapApplication()
                                                                    throws CloudPlatformException

Provides access to the "VCAP_APPLICATION" environment variable.

Returns:

A map of the JsonElement entries in "VCAP_APPLICATION" by their names.

Throws:

CloudPlatformException - If there is an issue accessing the environment variable.

getVcapServices

@Nonnull
public Map<String,com.google.gson.JsonArray> getVcapServices()
                                                               throws CloudPlatformException

Provides access to the "VCAP_SERVICES" environment variable.

Returns:

A map of the JsonArray entries in "VCAP_SERVICES" by their names.

Throws:

CloudPlatformException - If there is an issue accessing the environment variable.

getApplicationName

@Nonnull
public String getApplicationName()
                                   throws CloudPlatformException

Specified by:

getApplicationName in interface CloudPlatform

Returns:

The name of the application.

Throws:

CloudPlatformException - If there is an error accessing the application name.

getXsAppName

@Nonnull
public String getXsAppName()
                             throws CloudPlatformException,
                                    NoServiceBindingException,
                                    MultipleServiceBindingsException

Retrieves the "xsappname" from the XSUAA service instance credentials. This method assumes that only one binding to an XSUAA service instance exists.

Returns:

The XS application name.

Throws:

CloudPlatformException - If there is an issue accessing XS application name.

NoServiceBindingException - If there is no binding to the XSUAA service.

MultipleServiceBindingsException - If there are multiple bindings to the XSUAA service.

getServiceCredentials

@Nonnull
public com.google.gson.JsonObject getServiceCredentials(@Nonnull
                                                                 String serviceName)
                                                          throws CloudPlatformException,
                                                                 NoServiceBindingException,
                                                                 MultipleServiceBindingsException

Retrieves the credentials of a service. This method assumes that only one binding to a service must exist.

Parameters:

serviceName - The name of the service.

Returns:

The JsonObject for the service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the requested service.

MultipleServiceBindingsException - If there are multiple bindings to the requested service.

getServiceCredentials

@Nonnull
public com.google.gson.JsonObject getServiceCredentials(@Nonnull
                                                                 String serviceName,
                                                                 @Nullable
                                                                 String servicePlan)
                                                          throws CloudPlatformException,
                                                                 NoServiceBindingException,
                                                                 MultipleServiceBindingsException

Retrieves the credentials of a service. This method assumes that there may be multiple bindings to a service, however, only one must exist for the requested service plan.

Parameters:

serviceName - The name of the service.

servicePlan - The plan of the service (optional). If null, the service plan is ignored when retrieving the service credentials, i.e., only one binding must exist to the service.

Returns:

The JsonObject for the service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the requested service.

MultipleServiceBindingsException - If there are multiple bindings to the requested service.

getXsuaaServiceCredentials

@Nonnull
public com.google.gson.JsonObject getXsuaaServiceCredentials()
                                                               throws CloudPlatformException,
                                                                      NoServiceBindingException,
                                                                      MultipleServiceBindingsException

Retrieves the XSUAA service credentials. This method assumes that only one binding to an XSUAA service instance exists.

Returns:

The JsonObject for the XSUAA service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the XSUAA service.

MultipleServiceBindingsException - If there are multiple bindings to the XSUAA service.

getXsuaaServiceCredentials

@Nonnull
public com.google.gson.JsonObject getXsuaaServiceCredentials(@Nonnull
                                                                      String servicePlan)
                                                               throws CloudPlatformException,
                                                                      NoServiceBindingException,
                                                                      MultipleServiceBindingsException

Retrieves the XSUAA service credentials. This method assumes that there may be multiple bindings to the XSUAA service, however, only one must exist for the requested service plan.

Parameters:

servicePlan - The plan of the service (optional). If null, the service plan is ignored when retrieving the service credentials, i.e., only one binding must exist to the service.

Returns:

The JsonObject for the XSUAA credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the XSUAA service.

MultipleServiceBindingsException - If there are multiple bindings to the XSUAA service.

getXsuaaServiceCredentialsList

@Nonnull
public List<com.google.gson.JsonObject> getXsuaaServiceCredentialsList()
                                                                         throws CloudPlatformException

Retrieves the service credentials for all bound XSUAA service instances. This method does not make assumptions about the number of bound service instances.

Returns:

A list of JsonObject containing the credentials for all bound XSUAA service instances.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

getXsuaaServiceCredentials

@Nonnull
public com.google.gson.JsonObject getXsuaaServiceCredentials(@Nonnull
                                                                      com.auth0.jwt.interfaces.DecodedJWT jwt)
                                                               throws CloudPlatformException,
                                                                      NoServiceBindingException,
                                                                      MultipleServiceBindingsException

Retrieves the service credentials for all bound XSUAA service instances based on the given JSON Web Token. This method does not make assumptions about the number of bound service instances.

Parameters:

jwt - The JWT for which to return the matching XSUAA service instance credentials.

Returns:

The JsonObject for the XSUAA service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no matching binding to a XSUAA service instance.

MultipleServiceBindingsException - If there are multiple bindings to matching XSUAA service instances.

getDestinationServiceCredentials

@Nonnull
public com.google.gson.JsonObject getDestinationServiceCredentials()
                                                                     throws CloudPlatformException,
                                                                            NoServiceBindingException,
                                                                            MultipleServiceBindingsException

Retrieves the destination service credentials. This method assumes that only one binding must exist to the destination service.

Returns:

The JsonObject for the destination service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the destination service.

MultipleServiceBindingsException - If there are multiple bindings to the destination service.

getDestinationServiceCredentialsList

@Nonnull
public List<com.google.gson.JsonObject> getDestinationServiceCredentialsList()
                                                                               throws CloudPlatformException

Retrieves the service credentials for all bound destination service instances. This method does not make assumptions about the number of bound service instances.

Returns:

A list of JsonObject containing the credentials for all bound destination service instances.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

getConnectivityServiceCredentials

@Nonnull
public com.google.gson.JsonObject getConnectivityServiceCredentials()
                                                                      throws CloudPlatformException,
                                                                             NoServiceBindingException,
                                                                             MultipleServiceBindingsException

Retrieves the connectivity service credentials. This method assumes that only one binding must exist to the connectivity service.

Returns:

The JsonObject for the connectivity service credentials.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.

NoServiceBindingException - If there is no binding to the connectivity service.

MultipleServiceBindingsException - If there are multiple bindings to the connectivity service.

getConnectivityServiceCredentialsList

@Nonnull
public List<com.google.gson.JsonObject> getConnectivityServiceCredentialsList()
                                                                                throws CloudPlatformException

Retrieves the service credentials for all bound connectivity service instances. This method does not make assumptions about the number of bound service instances.

Returns:

A list of JsonObject containing the credentials for all bound connectivity service instances.

Throws:

CloudPlatformException - If there is an issue accessing the service credentials.