Class OpenIdConfiguration.Builder

java.lang.Object

org.eclipse.jetty.security.openid.OpenIdConfiguration.Builder

Enclosing class:

OpenIdConfiguration

public static class OpenIdConfiguration.Builder
extends Object

Builder for OpenIdConfiguration.

The only required parameters are issuer, clientId and clientSecret.

The authorizationEndpoint, tokenEndpoint and endSessionEndpoint will be retrieved from the OpenID metadata at .well-known/openid-configuration if they are not explicitly specified.

Constructor Summary

Constructors

Constructor	Description
Builder()	Create a Builder for an OpenID Configuration.
Builder(String issuer, String clientId, String clientSecret)	Create a Builder for an OpenID Configuration.

Method Summary

Modifier and Type	Method	Description
OpenIdConfiguration.Builder	authenticateNewUsers(boolean authenticateNewUsers)
OpenIdConfiguration.Builder	authenticationMethod(String authenticationMethod)
OpenIdConfiguration.Builder	authorizationEndpoint(String authorizationEndpoint)
OpenIdConfiguration	build()
OpenIdConfiguration.Builder	clientId(String clientId)
OpenIdConfiguration.Builder	clientSecret(String clientSecret)
OpenIdConfiguration.Builder	endSessionEndpoint(String endSessionEndpoint)
OpenIdConfiguration.Builder	httpClient(HttpClient httpClient)
OpenIdConfiguration.Builder	issuer(String issuer)
OpenIdConfiguration.Builder	logoutWhenIdTokenIsExpired(boolean logoutWhenIdTokenIsExpired)
OpenIdConfiguration.Builder	scopes(String... scopes)
OpenIdConfiguration.Builder	tokenEndpoint(String tokenEndpoint)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Create a Builder for an OpenID Configuration.

Builder

public Builder(@Name("issuer")
 String issuer,
 @Name("clientId")
 String clientId,
 @Name("clientSecret")
 String clientSecret)

Create a Builder for an OpenID Configuration.

Parameters:

issuer - The URL of the OpenID provider.

clientId - OAuth 2.0 Client Identifier valid at the OpenID provider.

clientSecret - The client secret known only by the Client and the OpenID provider.

Method Details

issuer

public OpenIdConfiguration.Builder issuer(String issuer)

Parameters:

issuer - The URL of the OpenID provider.

clientId

public OpenIdConfiguration.Builder clientId(String clientId)

Parameters:

clientId - OAuth 2.0 Client Identifier valid at the OpenID provider.

clientSecret

public OpenIdConfiguration.Builder clientSecret(String clientSecret)

Parameters:

clientSecret - The client secret known only by the Client and the OpenID provider.

authorizationEndpoint

public OpenIdConfiguration.Builder authorizationEndpoint(String authorizationEndpoint)

Parameters:

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

tokenEndpoint

public OpenIdConfiguration.Builder tokenEndpoint(String tokenEndpoint)

Parameters:

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

endSessionEndpoint

public OpenIdConfiguration.Builder endSessionEndpoint(String endSessionEndpoint)

Parameters:

endSessionEndpoint - the URL of the OpenID provider's end session endpoint if configured.

authenticationMethod

public OpenIdConfiguration.Builder authenticationMethod(String authenticationMethod)

Parameters:

authenticationMethod - Authentication method to use with the Token Endpoint.

httpClient

public OpenIdConfiguration.Builder httpClient(HttpClient httpClient)

Parameters:

httpClient - The HttpClient instance to use.

authenticateNewUsers

public OpenIdConfiguration.Builder authenticateNewUsers(boolean authenticateNewUsers)

Parameters:

authenticateNewUsers - Whether to authenticate new users.

scopes

public OpenIdConfiguration.Builder scopes(String... scopes)

Parameters:

scopes - The scopes to request.

logoutWhenIdTokenIsExpired

public OpenIdConfiguration.Builder logoutWhenIdTokenIsExpired(boolean logoutWhenIdTokenIsExpired)

Parameters:

logoutWhenIdTokenIsExpired - Whether to logout when the ID token is expired.

build

public OpenIdConfiguration build()

Returns:

a new OpenIdConfiguration instance.