public static class OidcConfig.Builder extends Object implements Builder<OidcConfig>
Builder to build instances of OidcConfig.| Constructor and Description |
|---|
Builder() |
| Modifier and Type | Method and Description |
|---|---|
OidcConfig.Builder |
audience(String audience)
Audience of issued tokens.
|
OidcConfig.Builder |
authorizationEndpointUri(URI uri)
URI of an authorization endpoint used to redirect users to for logging-in.
|
OidcConfig.Builder |
baseScopes(String scopes)
Configure base scopes.
|
OidcConfig |
build()
Build the instance from this builder.
|
OidcConfig.Builder |
clientId(String clientId)
Client ID as generated by OIDC server.
|
OidcConfig.Builder |
clientSecret(String clientSecret)
Client secret as generated by OIDC server.
|
OidcConfig.Builder |
config(Config config)
Update this builder with values from configuration.
|
OidcConfig.Builder |
cookieName(String cookieName)
Name of the cookie to use.
|
OidcConfig.Builder |
frontendUri(String uri)
Full URI of this application that is visible from user browser.
|
OidcConfig.Builder |
headerTokenHandler(TokenHandler tokenHandler)
A
TokenHandler to
process header containing a JWT. |
OidcConfig.Builder |
identityUri(URI uri)
URI of the identity server, base used to retrieve OIDC metadata.
|
OidcConfig.Builder |
introspectEndpointUri(URI uri)
Endpoint to use to validate JWT.
|
OidcConfig.Builder |
issuer(String issuer)
Issuer of issued tokens.
|
OidcConfig.Builder |
oidcMetadata(JsonObject metadata)
JsonObject with the OIDC Metadata.
|
OidcConfig.Builder |
oidcMetadata(Resource resource)
Resource configuration for OIDC Metadata
containing endpoints to various identity services, as well as information about the identity server.
|
OidcConfig.Builder |
oidcMetadataWellKnown(Boolean useWellKnown)
If set to true, metadata will be loaded from default (well known)
location, unless it is explicitly defined using oidc-metadata-resource.
|
OidcConfig.Builder |
paramName(String paramName)
Name of a query parameter that contains the JWT token when parameter is used.
|
OidcConfig.Builder |
proxyHost(String proxyHost)
Proxy host to use.
|
OidcConfig.Builder |
proxyPort(int proxyPort)
Proxy port.
|
OidcConfig.Builder |
realm(String realm)
Realm to return when not redirecting and an error occurs that sends back WWW-Authenticate header.
|
OidcConfig.Builder |
redirect(boolean redirect)
By default the client should redirect to the identity server for the user to log in.
|
OidcConfig.Builder |
redirectUri(String redirectUri)
URI to register web server component on, used by the OIDC server to
redirect authorization requests to after a user logs in or approves
scopes.
|
OidcConfig.Builder |
scopeAudience(String audience)
Audience of the scope required by this application.
|
OidcConfig.Builder |
signJwk(JwkKeys jwk)
Set
JwkKeys to use for JWT validation. |
OidcConfig.Builder |
signJwk(Resource resource)
A resource pointing to JWK with public keys of signing certificates used
to validate JWT.
|
OidcConfig.Builder |
tokenEndpointUri(URI uri)
URI of a token endpoint used to obtain a JWT based on the authentication
code.
|
OidcConfig.Builder |
useCookie(Boolean useCookie)
Whether to use cookie to store JWT between requests.
|
OidcConfig.Builder |
useHeader(Boolean useHeader)
Whether to expect JWT in a header field.
|
OidcConfig.Builder |
useParam(Boolean useParam)
Whether to use a query parameter to send JWT token from application to this
server.
|
OidcConfig.Builder |
validateJwtWithJwk(Boolean useJwk)
Use JWK (a set of keys to validate signatures of JWT) to validate tokens.
|
public OidcConfig build()
Builderbuild in interface Builder<OidcConfig>public OidcConfig.Builder config(Config config)
config - configuration located on node with OIDC configuration keys (e.g. client-id)public OidcConfig.Builder redirect(boolean redirect)
redirect - Whether to redirect to OIDC server in case the request does not contain sufficient information to
authenticate the user, defaults to truepublic OidcConfig.Builder realm(String realm)
realm - realm namepublic OidcConfig.Builder audience(String audience)
audience - audience to validatepublic OidcConfig.Builder issuer(String issuer)
issuer - expected issuer to validatepublic OidcConfig.Builder validateJwtWithJwk(Boolean useJwk)
useJwk - when set to true, jwk is used, when set to false, introspect endpoint is usedpublic OidcConfig.Builder introspectEndpointUri(URI uri)
signJwk(JwkKeys) or signJwk(Resource).uri - URI of introspection endpointpublic OidcConfig.Builder baseScopes(String scopes)
scopes - Space separated scopes to be required by default from OIDC serverpublic OidcConfig.Builder oidcMetadataWellKnown(Boolean useWellKnown)
useWellKnown - whether to use well known location for OIDC metadatapublic OidcConfig.Builder signJwk(Resource resource)
resource - Resource pointing to the JWKpublic OidcConfig.Builder signJwk(JwkKeys jwk)
JwkKeys to use for JWT validation.jwk - JwkKeys instance to get public keys used to sign JWTpublic OidcConfig.Builder oidcMetadata(Resource resource)
resource - resource pointing to the JSON structurepublic OidcConfig.Builder oidcMetadata(JsonObject metadata)
metadata - metadata JSONoidcMetadata(Resource)public OidcConfig.Builder headerTokenHandler(TokenHandler tokenHandler)
TokenHandler to
process header containing a JWT.
Default is "Authorization" header with a prefix "bearer ".tokenHandler - token handler to usepublic OidcConfig.Builder useHeader(Boolean useHeader)
useHeader - set to true to use a header extracted with headerTokenHandler(TokenHandler)public OidcConfig.Builder scopeAudience(String audience)
audience - audience, if provided, end with "/" to append the scope correctlypublic OidcConfig.Builder frontendUri(String uri)
uri - the frontend URI, such as "http://my.server.com/myApppublic OidcConfig.Builder tokenEndpointUri(URI uri)
oidcMetadata(Resource), if that is not defined
an attempt is made to use identityUri(URI)/oauth2/v1/token.uri - URI to use for token endpointpublic OidcConfig.Builder authorizationEndpointUri(URI uri)
oidcMetadata(Resource), if that is not defined
an attempt is made to use identityUri(URI)/oauth2/v1/authorize.uri - URI to use for token endpointpublic OidcConfig.Builder cookieName(String cookieName)
cookieName - name of a cookiepublic OidcConfig.Builder useCookie(Boolean useCookie)
useCookie - whether to use cookie to store JWT (true) or not (false))public OidcConfig.Builder paramName(String paramName)
paramName - name of the query parameter to expectpublic OidcConfig.Builder useParam(Boolean useParam)
useParam - whether to use a query parameter (true) or not (false)paramName(String)public OidcConfig.Builder identityUri(URI uri)
uri - full URI of an identity server (such as "http://tenantid.identity.oraclecloud.com")public OidcConfig.Builder proxyHost(String proxyHost)
proxyHost - host of the proxyproxyProtocol(String),
proxyPort(int)public OidcConfig.Builder proxyPort(int proxyPort)
proxyPort - port of the proxy server to usepublic OidcConfig.Builder clientId(String clientId)
clientId - the client id of this application.public OidcConfig.Builder clientSecret(String clientSecret)
clientSecret - secret to usepublic OidcConfig.Builder redirectUri(String redirectUri)
Defaults to
redirectUri - the URI (path without protocol, host and port) used to redirect requests back to usCopyright © 2018–2019 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms.