Package com.aquima.web.boot.security.openid

Interface OpenIdConnectSettings

public interface OpenIdConnectSettings

OpenID Connect Settings that also include OpenID Connect Provider Metadata according to OpenID Connect Discovery 1.0.

Since:

11.5

Author:

Voicu Moldovan

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationEndpoint()
Map<String,String>	getAuthorizationEndpointParameters()
String	getClientId()
String	getClientSecret()
String	getEndSessionEndpoint()
PublicKey	getKeyById(String keyId)	The signing key the Relying Partie uses to validate signatures from the OpenID Connect Provider.
List<String>	getScopes()
String	getTokenEndpoint()
Map<String,String>	getTokenEndpointParameters()
String	getTokenIssuer()
String	getUserInfoEndpoint()
Map<String,String>	getUserInfoEndpointParameters()
boolean	isCheckAudience()
boolean	isSsoLogout()

Method Details

getAuthorizationEndpoint

String getAuthorizationEndpoint()
                         throws InvalidOpenIdConfigurationException

Returns:

the URL of the OpenID Connect Provider's OAuth 2.0 Authorization Endpoint.

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getAuthorizationEndpointParameters

Map<String,String> getAuthorizationEndpointParameters()
                                               throws InvalidOpenIdConfigurationException

Returns:

the additional parameters to use when calling the authorization endpoint

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getClientId

String getClientId()

Returns:

the runtime client id. MUST be defined in the property file.

getClientSecret

String getClientSecret()

Returns:

the runtime client secret. MUST be defined in the property file.

getEndSessionEndpoint

String getEndSessionEndpoint()
                      throws InvalidOpenIdConfigurationException

Returns:

the URL of the OpenID Connect Provider's End Session Endpoint.

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getKeyById

PublicKey getKeyById(String keyId)
              throws InvalidOpenIdConfigurationException

The signing key the Relying Partie uses to validate signatures from the OpenID Connect Provider.

Parameters:

keyId - The id of the key.

Returns:

the key for the specified id.

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getScopes

List<String> getScopes()

Returns:

the scopes defined in property file.

getTokenEndpoint

String getTokenEndpoint()
                 throws InvalidOpenIdConfigurationException

Returns:

the URL of the OpenID Connect Provider's OAuth 2.0 Token Endpoint.

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getTokenEndpointParameters

Map<String,String> getTokenEndpointParameters()
                                       throws InvalidOpenIdConfigurationException

Returns:

the additional parameters to use when calling the token endpoint

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getTokenIssuer

String getTokenIssuer()

Returns:

the URL using the https scheme with no query or fragment component that the OpenID Connect Provider asserts as its Issuer Identifier.

isCheckAudience

boolean isCheckAudience()

Returns:

the boolean indicating whether the audience claim should be checked.

isSsoLogout

boolean isSsoLogout()

Returns:

the indicating whether when logging out of Blueriq the user should be logged out of the Single-Sign-On session as well.

getUserInfoEndpoint

String getUserInfoEndpoint()
                    throws InvalidOpenIdConfigurationException

Returns:

the URL of the OpenID Connect Provider's UserInfo Endpoint

Throws:

InvalidOpenIdConfigurationException - when config is invalid

getUserInfoEndpointParameters

Map<String,String> getUserInfoEndpointParameters()
                                          throws InvalidOpenIdConfigurationException

Returns:

the additional parameters to use when calling the UserInfo Endpoint

Throws:

InvalidOpenIdConfigurationException - when config is invalid