com.sap.cloud.security.config

Interface Environment

public interface Environment

Central entry point to access the OAuth configuration (OAuth2ServiceConfiguration) of a supported identity Service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Environment.Type Represents a supported SAP CP environment.

Method Summary

Modifier and Type	Method and Description
OAuth2ServiceConfiguration	getIasConfiguration() Return OAuth service configuration of IAS identity service instance.
int	getNumberOfXsuaaConfigurations() Returns the number of Xsuaa identity service instances.
Map<Service,List<OAuth2ServiceConfiguration>>	getServiceConfigurationsAsList() Gives access to all service configurations parsed from the environment.
Environment.Type	getType()
OAuth2ServiceConfiguration	getXsuaaConfiguration() Return the primary OAuth service configuration of Xsuaa identity service instance.
OAuth2ServiceConfiguration	getXsuaaConfigurationForTokenExchange() In case there is only one Xsuaa identity service instance, this one gets returned.

Method Detail

getType

@Nonnull
Environment.Type getType()

getXsuaaConfiguration

@Nullable
OAuth2ServiceConfiguration getXsuaaConfiguration()

Return the primary OAuth service configuration of Xsuaa identity service instance.

Returns:

the OAuth service configuration or null, in case there is no instance

getIasConfiguration

@Nullable
OAuth2ServiceConfiguration getIasConfiguration()

Return OAuth service configuration of IAS identity service instance.

Returns:

the OAuth service configuration or null, in case there is no instance

getNumberOfXsuaaConfigurations

int getNumberOfXsuaaConfigurations()

Returns the number of Xsuaa identity service instances.

Returns:

the number Xsuaa identity service instances.

getXsuaaConfigurationForTokenExchange

@Nullable
OAuth2ServiceConfiguration getXsuaaConfigurationForTokenExchange()

In case there is only one Xsuaa identity service instance, this one gets returned. In case there are multiple bindings the primary one of plan "broker" gets returned.

Returns:

the service configuration to be used for token exchange

See Also:

com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows

getServiceConfigurationsAsList

@Nullable
Map<Service,List<OAuth2ServiceConfiguration>> getServiceConfigurationsAsList()

Gives access to all service configurations parsed from the environment.

Returns:

the service configurations grouped by service