Class UserAuthorizer.Builder (1.27.0)

public static class UserAuthorizer.Builder

Inheritance

java.lang.Object > UserAuthorizer.Builder

Constructors

Builder()

protected Builder()

Builder(UserAuthorizer authorizer)

protected Builder(UserAuthorizer authorizer)
Parameter
Name Description
authorizer UserAuthorizer

Methods

build()

public UserAuthorizer build()
Returns
Type Description
UserAuthorizer

getCallbackUri()

public URI getCallbackUri()
Returns
Type Description
URI

getClientAuthenticationType()

public UserAuthorizer.ClientAuthenticationType getClientAuthenticationType()
Returns
Type Description
UserAuthorizer.ClientAuthenticationType

getClientId()

public ClientId getClientId()
Returns
Type Description
ClientId

getHttpTransportFactory()

public HttpTransportFactory getHttpTransportFactory()
Returns
Type Description
HttpTransportFactory

getPKCEProvider()

public PKCEProvider getPKCEProvider()
Returns
Type Description
PKCEProvider

getScopes()

public Collection<String> getScopes()
Returns
Type Description
Collection<String>

getTokenServerUri()

public URI getTokenServerUri()
Returns
Type Description
URI

getTokenStore()

public TokenStore getTokenStore()
Returns
Type Description
TokenStore

getUserAuthUri()

public URI getUserAuthUri()
Returns
Type Description
URI

setCallbackUri(URI callbackUri)

public UserAuthorizer.Builder setCallbackUri(URI callbackUri)

Sets the redirect URI registered with your OAuth provider. This is where the user's browser will be redirected after granting or denying authorization.

Parameter
Name Description
callbackUri URI

the redirect URI

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setClientAuthenticationType(UserAuthorizer.ClientAuthenticationType clientAuthentication)

public UserAuthorizer.Builder setClientAuthenticationType(UserAuthorizer.ClientAuthenticationType clientAuthentication)

Sets the optional ClientAuthenticationType, one of the client authentication methods defined in RFC 7591. This specifies how your application authenticates itself to the authorization server.

Parameter
Name Description
clientAuthentication UserAuthorizer.ClientAuthenticationType

the ClientAuthenticationType to set

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setClientId(ClientId clientId)

public UserAuthorizer.Builder setClientId(ClientId clientId)

Sets the OAuth 2.0 client ID.

Parameter
Name Description
clientId ClientId

the client ID

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setHttpTransportFactory(HttpTransportFactory transportFactory)

public UserAuthorizer.Builder setHttpTransportFactory(HttpTransportFactory transportFactory)

Sets the HTTP transport factory.

Parameter
Name Description
transportFactory HttpTransportFactory

the HttpTransportFactory to set

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setPKCEProvider(PKCEProvider pkce)

public UserAuthorizer.Builder setPKCEProvider(PKCEProvider pkce)

Sets the optional PKCEProvider to enable Proof Key for Code Exchange to be used. This enhances security by using a code challenge and verifier to prevent authorization code interception attacks.

Parameter
Name Description
pkce PKCEProvider

the PKCEProvider to set

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setScopes(Collection<String> scopes)

public UserAuthorizer.Builder setScopes(Collection<String> scopes)

Sets the OAuth 2.0 scopes to request.

Parameter
Name Description
scopes Collection<String>

the scopes to request

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setTokenServerUri(URI tokenServerUri)

public UserAuthorizer.Builder setTokenServerUri(URI tokenServerUri)

Sets the token exchange endpoint.

Parameter
Name Description
tokenServerUri URI

the token exchange endpoint to use

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setTokenStore(TokenStore tokenStore)

public UserAuthorizer.Builder setTokenStore(TokenStore tokenStore)

Sets the TokenStore to use for long term token storage.

Parameter
Name Description
tokenStore TokenStore

the token store

Returns
Type Description
UserAuthorizer.Builder

this Builder object

setUserAuthUri(URI userAuthUri)

public UserAuthorizer.Builder setUserAuthUri(URI userAuthUri)

Sets the authorization URI where the user is directed to log in and grant authorization.

Parameter
Name Description
userAuthUri URI

the authorization URI

Returns
Type Description
UserAuthorizer.Builder

this Builder object