Class OpenIdConfiguration

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.security.openid.OpenIdConfiguration

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

public class OpenIdConfiguration
extends ContainerLifeCycle

Holds the configuration for an OpenID Connect service. This uses the OpenID Provider URL with the path CONFIG_PATH to discover the required information about the OIDC service.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private String	authEndpoint
private final String	authMethod
private final String	clientId
private final String	clientSecret
private static final String	CONFIG_PATH
private final HttpClient	httpClient
private final String	issuer
private static final Logger	LOG
private final List<String>	scopes
private String	tokenEndpoint

Fields inherited from class AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
OpenIdConfiguration(String provider, String clientId, String clientSecret)	Create an OpenID configuration for a specific OIDC provider.
OpenIdConfiguration(String issuer, String authorizationEndpoint, String tokenEndpoint, String clientId, String clientSecret, String authMethod, HttpClient httpClient)	Create an OpenID configuration for a specific OIDC provider.
OpenIdConfiguration(String issuer, String authorizationEndpoint, String tokenEndpoint, String clientId, String clientSecret, HttpClient httpClient)	Create an OpenID configuration for a specific OIDC provider.

Method Summary

Modifier and Type	Method	Description
void	addScopes(String... scopes)
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
private static Map<String,Object>	fetchOpenIdConnectMetadata(String provider, HttpClient httpClient)
String	getAuthEndpoint()
String	getAuthMethod()
String	getClientId()
String	getClientSecret()
HttpClient	getHttpClient()
String	getIssuer()
List<String>	getScopes()
String	getTokenEndpoint()
private static HttpClient	newHttpClient()

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class Object

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

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Field Details

LOG

private static final Logger LOG

CONFIG_PATH

private static final String CONFIG_PATH

See Also:

• Constant Field Values

httpClient

private final HttpClient httpClient

issuer

private final String issuer

clientId

private final String clientId

clientSecret

private final String clientSecret

scopes

private final List<String> scopes

authMethod

private final String authMethod

authEndpoint

private String authEndpoint

tokenEndpoint

private String tokenEndpoint

Constructor Details

OpenIdConfiguration

public OpenIdConfiguration(String provider,
 String clientId,
 String clientSecret)

Create an OpenID configuration for a specific OIDC provider.

Parameters:

provider - The URL of the OpenID provider.

clientId - OAuth 2.0 Client Identifier valid at the Authorization Server.

clientSecret - The client secret known only by the Client and the Authorization Server.

OpenIdConfiguration

public OpenIdConfiguration(String issuer,
 String authorizationEndpoint,
 String tokenEndpoint,
 String clientId,
 String clientSecret,
 HttpClient httpClient)

Create an OpenID configuration for a specific OIDC provider.

Parameters:

issuer - The URL of the OpenID provider.

authorizationEndpoint - the URL of the OpenID provider's authorization endpoint if configured.

tokenEndpoint - the URL of the OpenID provider's token endpoint if configured.

clientId - OAuth 2.0 Client Identifier valid at the Authorization Server.

clientSecret - The client secret known only by the Client and the Authorization Server.

httpClient - The HttpClient instance to use.

OpenIdConfiguration

public OpenIdConfiguration(String issuer,
 String authorizationEndpoint,
 String tokenEndpoint,
 String clientId,
 String clientSecret,
 String authMethod,
 HttpClient httpClient)

Create an OpenID configuration for a specific OIDC provider.

Parameters:

issuer - The URL of the OpenID provider.

authorizationEndpoint - the URL of the OpenID provider's authorization endpoint if configured.

tokenEndpoint - the URL of the OpenID provider's token endpoint if configured.

clientId - OAuth 2.0 Client Identifier valid at the Authorization Server.

clientSecret - The client secret known only by the Client and the Authorization Server.

authMethod - Authentication method to use with the Token Endpoint.

httpClient - The HttpClient instance to use.

Method Details

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception

newHttpClient

private static HttpClient newHttpClient()

fetchOpenIdConnectMetadata

private static Map<String,Object> fetchOpenIdConnectMetadata(String provider,
 HttpClient httpClient)

getHttpClient

public HttpClient getHttpClient()

getAuthEndpoint

public String getAuthEndpoint()

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

getIssuer

public String getIssuer()

getTokenEndpoint

public String getTokenEndpoint()

getAuthMethod

public String getAuthMethod()

addScopes

public void addScopes(String... scopes)

getScopes

public List<String> getScopes()