com.sap.cloud.sdk.cloudplatform

Class ScpCfServiceInfo

java.lang.Object

com.sap.cloud.sdk.cloudplatform.ScpCfServiceInfo

@Beta
public class ScpCfServiceInfo
extends Object

Helper providing easy access to Cloud Foundry service information.

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
ScpCfServiceInfo(com.google.gson.JsonElement serviceInfoElem, String serviceType) Also parses the name from serviceInfoElem.

Method Summary

Modifier and Type	Method and Description
static List<ScpCfServiceInfo>	createFor(ScpCfServiceDesignator designator) Creates the list of services from the VCAP_SERVICES environment variable.
static List<ScpCfServiceInfo>	createFor(String serviceType) Creates the list of services from the VCAP_SERVICES environment variable.
static List<ScpCfServiceInfo>	createFor(String serviceType, String servicePlan) Creates the list of services from the VCAP_SERVICES environment variable.
com.google.gson.JsonElement	getServiceInfoElem()
static com.google.gson.JsonElement	getServiceInfoPath(com.google.gson.JsonElement subElem, Iterator<String> pathElems) Descend nicely.
static com.google.gson.JsonElement	getServiceInfoPath(com.google.gson.JsonElement subElem, String path) Descend nicely.
com.google.gson.JsonElement	getServiceInfoPath(String path) Descend nicely into the service info element.
String	getServiceInfoPathNonEmptyStringOrThrow(String path, String humanReadableElemReference) Descend nicely into the service info and throw if anything but a non-empty string at the final destination of the path.
String	getServiceName()
String	getServicePlan()
String	getServiceType()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpCfServiceInfo

public ScpCfServiceInfo(@Nonnull
                        com.google.gson.JsonElement serviceInfoElem,
                        @Nonnull
                        String serviceType)

Also parses the name from serviceInfoElem.

Parameters:

serviceInfoElem - info to parse

serviceType - the type of this service (from VCAP_SERVICES)

Method Detail

createFor

@Nonnull
public static List<ScpCfServiceInfo> createFor(@Nonnull
                                                        String serviceType)

Creates the list of services from the VCAP_SERVICES environment variable.

Parameters:

serviceType - to get the services for

Returns:

possibly empty list.

Throws:

CloudPlatformException - if not executed on the Cloud Foundry type SAP Cloud Platform

createFor

@Nonnull
public static List<ScpCfServiceInfo> createFor(@Nonnull
                                                        String serviceType,
                                                        @Nullable
                                                        String servicePlan)

Creates the list of services from the VCAP_SERVICES environment variable.

Parameters:

serviceType - to get the services for

servicePlan - to optionally filter by. if specified, only service bindings are returned that exactly match this plan

Returns:

possibly empty list.

Throws:

CloudPlatformException - if not executed on the Cloud Foundry type SAP Cloud Platform

createFor

@Nonnull
public static List<ScpCfServiceInfo> createFor(@Nonnull
                                                        ScpCfServiceDesignator designator)

Creates the list of services from the VCAP_SERVICES environment variable.

Parameters:

designator - to get the services for

Returns:

possibly empty list.

Throws:

CloudPlatformException - if not executed on the Cloud Foundry type SAP Cloud Platform

getServiceInfoPathNonEmptyStringOrThrow

@Nonnull
public String getServiceInfoPathNonEmptyStringOrThrow(@Nonnull
                                                               String path,
                                                               @Nonnull
                                                               String humanReadableElemReference)

Descend nicely into the service info and throw if anything but a non-empty string at the final destination of the path.

Parameters:

path - the path, split at /

humanReadableElemReference - to use in the exception's message as the name of the element.

Returns:

null if the final element is null, else the json element (e.g. json null, primitive...)

Throws:

ServiceBindingDataException - if anything happens instead of finding a non-empty string at the leaf.

See Also:

getServiceInfoElem()

getServiceInfoPath

@Nullable
public com.google.gson.JsonElement getServiceInfoPath(String path)

Descend nicely into the service info element.

Parameters:

path - the path, split at /

Returns:

null if the final element is null, else the json element (e.g. json null, primitive...)

Throws:

NoSuchElementException - if the path cannot be followed because a path element is missing.

See Also:

getServiceInfoElem()

getServiceInfoPath

@Nullable
public static com.google.gson.JsonElement getServiceInfoPath(@Nullable
                                                                       com.google.gson.JsonElement subElem,
                                                                       @Nonnull
                                                                       String path)

Descend nicely.

Parameters:

subElem - to descend into

path - the path, split at /

Returns:

null if the final element is null, else the json element (e.g. json null, primitive...)

Throws:

NoSuchElementException - if the path cannot be followed because a path element is missing.

getServiceInfoPath

@Nullable
public static com.google.gson.JsonElement getServiceInfoPath(@Nullable
                                                                       com.google.gson.JsonElement subElem,
                                                                       @Nonnull
                                                                       Iterator<String> pathElems)

Descend nicely.

Parameters:

subElem - to descend into

pathElems - the path

Returns:

null if the final element is null, else the json element (e.g. json null, primitive...)

Throws:

NoSuchElementException - if the path cannot be followed because a path element is missing.

IllegalArgumentException - if the iterator is returning null or subElem is not a JSON object.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getServiceInfoElem

public com.google.gson.JsonElement getServiceInfoElem()

getServiceType

public String getServiceType()

getServiceName

public String getServiceName()

getServicePlan

@Nullable
public String getServicePlan()