com.sap.cloud.security.json

Class DefaultJsonObject

java.lang.Object

com.sap.cloud.security.json.DefaultJsonObject

All Implemented Interfaces:

JsonObject

public class DefaultJsonObject
extends Object
implements JsonObject

Use this class to parse a Json String. This might be relevant in case the OAuth2ServiceConfiguration does not provide all required properties.

Constructor Summary

Constructors

Constructor and Description
DefaultJsonObject(String jsonString) Create an instance

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key)
java.time.Instant	getAsInstant(String name) Returns an Instant identified by the given property name.
<T> List<T>	getAsList(String name, Class<T> type) Parses the json object for the given property name and returns a list of type T.
String	getAsString(String name) Returns the string identified by the given property name.
JsonObject	getJsonObject(String name) Returns a nested JSON object as @{link JsonObject} instance.
List<JsonObject>	getJsonObjects(String name) Returns a nested array of JSON objects as list of JsonObject instances.
Map<String,String>	getKeyValueMap() Returns a key-value map of the JSON properties.
boolean	isEmpty() Method to check if the underlying json object is empty.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJsonObject

public DefaultJsonObject(String jsonString)

Create an instance

Parameters:

jsonString - the content in json format that should be parsed.

Method Detail

contains

public boolean contains(String key)

Specified by:

contains in interface JsonObject

Parameters:

key - the name of the property.

Returns:

true if the json object contains the given property.

isEmpty

public boolean isEmpty()

Description copied from interface: JsonObject

Method to check if the underlying json object is empty.

Specified by:

isEmpty in interface JsonObject

Returns:

true if the jsonObject is empty.

getAsList

public <T> List<T> getAsList(String name,
                             Class<T> type)

Description copied from interface: JsonObject

Parses the json object for the given property name and returns a list of type T. If the property with the given name is not found, an empty list is returned.

Specified by:

getAsList in interface JsonObject

Type Parameters:

T - the type of the list elements.

Parameters:

name - the property inside this json object which contains a list as values of type T.

type - type parameter for generic type T.

Returns:

the list of type T.

getAsString

@Nullable
public String getAsString(String name)

Description copied from interface: JsonObject

Returns the string identified by the given property name. If the property with the given name is not found, null is returned.

Specified by:

getAsString in interface JsonObject

Parameters:

name - the name of the property.

Returns:

the json string object.

getAsInstant

@Nullable
public java.time.Instant getAsInstant(String name)

Description copied from interface: JsonObject

Returns an Instant identified by the given property name. If the property with the given name is not found, null is returned.

Specified by:

getAsInstant in interface JsonObject

Parameters:

name - the name of the property.

Returns:

the Instant object.

getJsonObject

@Nullable
public JsonObject getJsonObject(String name)

Description copied from interface: JsonObject

Returns a nested JSON object as @{link JsonObject} instance.

Specified by:

getJsonObject in interface JsonObject

Parameters:

name - the name of property.

Returns:

the JsonObject.

getJsonObjects

public List<JsonObject> getJsonObjects(String name)

Description copied from interface: JsonObject

Returns a nested array of JSON objects as list of JsonObject instances. If the property with the given name is not found, an empty list is returned.

Specified by:

getJsonObjects in interface JsonObject

Parameters:

name - the name of property.

Returns:

a list of JsonObject instances.

getKeyValueMap

public Map<String,String> getKeyValueMap()

Description copied from interface: JsonObject

Returns a key-value map of the JSON properties. Example:

 
 	String vcapServices = System.getenv(CFConstants.VCAP_SERVICES);
 	JsonObject serviceJsonObject = new DefaultJsonObject(vcapServices).getJsonObjects(Service.XSUAA.getCFName())
 			.get(0);
 	Map<String, String> xsuaaConfigMap = serviceJsonObject.getKeyValueMap();
 	Map<String, String> credentialsMap = serviceJsonObject.getJsonObject(CFConstants.CREDENTIALS)
 			.getKeyValueMap();
 
 

Specified by:

getKeyValueMap in interface JsonObject

Returns:

the json properties as key-value map