Interface Environment

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

  • Method Details

    • 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:

    • getServiceConfigurationsAsList

      Map<Service,List<OAuth2ServiceConfiguration>> getServiceConfigurationsAsList()
      Gives access to all service configurations parsed from the environment.
      Returns:
      the service configurations grouped by service

    • getServiceConfigurations

      Map<Service,Map<ServiceConstants.Plan,OAuth2ServiceConfiguration>> getServiceConfigurations()