TokenService (ala-ws-plugin 6.2.0 API)

au.org.ala.ws.tokens.TokenService

@groovy.util.logging.Slf4j
class TokenService
extends java.lang.Object

Component for getting access tokens for using on web service requests.

Properties Summary

Properties
Type	Name and description
`boolean`	`cacheTokens`
`java.lang.String`	`clientId`
`java.lang.String`	`clientSecret`
`org.pac4j.core.config.Config`	`config`
`java.util.List<java.lang.String>`	`finalScopes`
`java.lang.String`	`jwtScopes`
`java.lang.Object`	`lock`

Constructor Summary

Constructors
Constructor and description
`TokenService (org.pac4j.core.config.Config config, org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, au.org.ala.web.Pac4jContextProvider pac4jContextProvider, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)`
`TokenService (org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, au.org.ala.web.Pac4jContextProvider pac4jContextProvider, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)`
`TokenService (org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`com.nimbusds.oauth2.sdk.token.AccessToken`	`getAuthToken(boolean requireUser)` Get an access token.
	`org.pac4j.core.profile.ProfileManager`	`getProfileManager()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final boolean cacheTokens
  - final java.lang.String clientId
  - final java.lang.String clientSecret
  - org.pac4j.core.config.Config config
  - final java.util.List<java.lang.String> finalScopes
  - final java.lang.String jwtScopes
  - @com.google.common.annotations.VisibleForTesting final java.lang.Object lock
- Constructor Detail
  - TokenService(org.pac4j.core.config.Config config, org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, au.org.ala.web.Pac4jContextProvider pac4jContextProvider, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)
  - TokenService(org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, au.org.ala.web.Pac4jContextProvider pac4jContextProvider, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)
  - TokenService(org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)
- Method Detail
  - com.nimbusds.oauth2.sdk.token.AccessToken getAuthToken(boolean requireUser)
    
    Get an access token. Will return the current user's access token or if there is no current user, will request a client credentials grant based access token for this app.
    Parameters:
    requireUser - Whether the auth token must belong to an individual user (setting this to true will disable requesting a client credentials based app JWT)
    Returns:
    The access token
  - org.pac4j.core.profile.ProfileManager getProfileManager()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class TokenService

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final boolean cacheTokens

final java.lang.String clientId

final java.lang.String clientSecret

org.pac4j.core.config.Config config

final java.util.List<java.lang.String> finalScopes

final java.lang.String jwtScopes

@com.google.common.annotations.VisibleForTesting final java.lang.Object lock

Constructor Detail

TokenService(org.pac4j.oidc.config.OidcConfiguration oidcConfiguration, org.pac4j.core.context.session.SessionStore sessionStore, TokenClient tokenClient, java.lang.String clientId, java.lang.String clientSecret, java.lang.String jwtScopes, boolean cacheTokens)

Method Detail

com.nimbusds.oauth2.sdk.token.AccessToken getAuthToken(boolean requireUser)

org.pac4j.core.profile.ProfileManager getProfileManager()