com.sap.cloud.security.config

Interface OAuth2ServiceConfiguration

public interface OAuth2ServiceConfiguration

Provides information of the identity Service.

Method Summary

Modifier and Type	Method and Description
default URI	getCertUrl() Cert URL of the OAuth2 identity service instance.
String	getClientId() Client id of identity service instance.
default ClientIdentity	getClientIdentity() Client Identity of xsuaa instance
String	getClientSecret() Client secret of identity service instance.
default CredentialType	getCredentialType() Credential type as defined in "oauth2-configuration" of the xsuaa service instance security descriptor.
default List<String>	getDomains() Domains of the OAuth2 identity service instance.
Map<String,String>	getProperties() Returns all properties of the configuration as a map.
String	getProperty(String name) Returns the value of the given property as string.
Service	getService() Returns the identity Service of this configuration.
URI	getUrl() Base URL of the OAuth2 identity service instance.
boolean	hasProperty(String name) Returns true if the configuration contains the given property.
boolean	isLegacyMode() Returns true, in case of XSUAA service runs in legacy mode.

Method Detail

getClientId

String getClientId()

Client id of identity service instance.

Returns:

client identifier

getClientSecret

String getClientSecret()

Client secret of identity service instance.

Returns:

client secret

getClientIdentity

default ClientIdentity getClientIdentity()

Client Identity of xsuaa instance

Returns:

ClientIdentity object

getCredentialType

@Nullable
default CredentialType getCredentialType()

Credential type as defined in "oauth2-configuration" of the xsuaa service instance security descriptor.

Returns:

value of credential-type field

getUrl

URI getUrl()

Base URL of the OAuth2 identity service instance. In multi tenancy scenarios this is the url where the service instance was created.

Returns:

base url, e.g. https://paastenant.idservice.com

getCertUrl

@Nullable
default URI getCertUrl()

Cert URL of the OAuth2 identity service instance.

Returns:

cert url, e.g. https://paastenant.cert.idservice.com

getDomains

default List<String> getDomains()

Domains of the OAuth2 identity service instance.

Returns:

list of domain, e.g."idservice.com".

getProperty

@Nullable
String getProperty(String name)

Returns the value of the given property as string.

Parameters:

name - the name of the property. You can find constants in CFConstants

Returns:

the string value of the given property or null if the property does not exist.

getProperties

Map<String,String> getProperties()

Returns all properties of the configuration as a map.

Returns:

all properties as map.

hasProperty

boolean hasProperty(String name)

Returns true if the configuration contains the given property.

Parameters:

name - the name of the property. You can find constants in CFConstants

Returns:

true if the property does not exist.

getService

Service getService()

Returns the identity Service of this configuration.

Returns:

the service.

isLegacyMode

boolean isLegacyMode()

Returns true, in case of XSUAA service runs in legacy mode.

Returns:

true in case it runs in legacy mode.