java.lang.Object
- org.oa4mp.server.loader.oauth2.claims.AbstractPayloadHandler
- - org.oa4mp.server.loader.oauth2.claims.AbstractAccessTokenHandler

All Implemented Interfaces:

Serializable, org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface, org.oa4mp.delegation.server.jwt.IDTokenHandlerInterface, org.oa4mp.delegation.server.jwt.PayloadHandler, org.oa4mp.delegation.server.OA2Scopes

Direct Known Subclasses:

DefaultAccessTokenHandler, RFC9068ATHandler, ScitokenHandler, WLCGTokenHandler
```
public class AbstractAccessTokenHandler
extends AbstractPayloadHandler
implements org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface, org.oa4mp.delegation.server.jwt.IDTokenHandlerInterface
```
Only create an access token handler if you need some special handling, otherwise the default simple token will be used.
Created by Jeff Gaynor
on 7/21/20 at 2:50 PM

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.oa4mp.delegation.server.OA2Scopes
  org.oa4mp.delegation.server.OA2Scopes.ScopeUtil

Field Summary

Fields
Modifier and Type Field Description

static String AT_BASIC_HANDLER_TYPE

static String AT_DEFAULT_HANDLER_TYPE
- Fields inherited from class org.oa4mp.server.loader.oauth2.claims.AbstractPayloadHandler
  client, oa2se, payload, request, transaction
- Fields inherited from interface org.oa4mp.delegation.server.OA2Scopes
  basicScopes, EDU_PERSON_ORC_ID, nonPublicScopes, SCOPE_ADDRESS, SCOPE_CILOGON_INFO, SCOPE_EMAIL, SCOPE_MYPROXY, SCOPE_OFFLINE_ACCESS, SCOPE_OPENID, SCOPE_PHONE, SCOPE_PROFILE, SCOPE_TOKEN_MANAGER, SCOPE_USER_INFO

Constructor Summary

Constructors
Constructor Description

AbstractAccessTokenHandler(PayloadHandlerConfigImpl payloadHandlerConfig)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addRequestState(edu.uiuc.ncsa.security.util.scripting.ScriptRunRequest req)`
`void`	`checkClaims()`
`void`	`finish(boolean doTemplates, boolean isQuery)`
`void`	`finish(String execPhase)`
`AccessToken`	`getAccessToken()`
`protected AccessTokenConfig`	`getATConfig()`	Convenience to peel off the `AccessTokenConfig` from the handler config and return it.
`net.sf.json.JSONObject`	`getPayload()`	The underlying `JSONObject` that contains the claims that go in to this access token.
`AccessTokenImpl`	`getSignedPayload(edu.uiuc.ncsa.security.util.jwk.JSONWebKey key)`
`AccessTokenImpl`	`getSignedPayload(edu.uiuc.ncsa.security.util.jwk.JSONWebKey key, String headerType)`
`List<org.oa4mp.delegation.server.server.claims.ClaimSource>`	`getSources()`
`net.sf.json.JSONObject`	`getUserMetaData()`	generally for this class you will need to inject the user meta data.
`void`	`handleResponse(edu.uiuc.ncsa.security.util.scripting.ScriptRunResponse resp)`
`void`	`init()`
`void`	`refreshAccountingInformation()`
`String`	`resolveTemplates(boolean isQuery)`	Templates are of the format
`void`	`saveState(String execPhase)`
`void`	`setAccessToken(AccessToken accessToken)`
`void`	`setAccountingInformation()`
`void`	`setUserMetaData(net.sf.json.JSONObject userMetaData)`

Methods inherited from class org.oa4mp.server.loader.oauth2.claims.AbstractPayloadHandler
doServerVariables, doSubstitution, execute, getExtendedAttributes, getPhCfg, getResponseCode, getTXRecord, hasScript, hasTXRecord, isEmpty, listToString, refresh, setExtendedAttributes, setPayload, setPhCfg, setResponseCode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.oa4mp.delegation.server.jwt.PayloadHandler
execute, getExtendedAttributes, getPhCfg, getResponseCode, hasScript, refresh, setPayload, setPhCfg, setResponseCode

- Field Detail
  - AT_DEFAULT_HANDLER_TYPE
```
public static final String AT_DEFAULT_HANDLER_TYPE
```
    See Also:
    
    Constant Field Values
  - AT_BASIC_HANDLER_TYPE
```
public static final String AT_BASIC_HANDLER_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractAccessTokenHandler
```
public AbstractAccessTokenHandler(PayloadHandlerConfigImpl payloadHandlerConfig)
```
- Method Detail
  - getPayload
```
public net.sf.json.JSONObject getPayload()
```
    The underlying JSONObject that contains the claims that go in to this access token. Note that the getUserMetaData() call will retrieve the user metadata and is not the same as the access token contents!
    
    Specified by:
    
    getPayload in interface org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface
    
    Specified by:
    
    getPayload in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Returns:
  - getUserMetaData
```
public net.sf.json.JSONObject getUserMetaData()
```
    generally for this class you will need to inject the user meta data.
    
    Specified by:
    
    getUserMetaData in interface org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface
    
    Specified by:
    
    getUserMetaData in interface org.oa4mp.delegation.server.jwt.IDTokenHandlerInterface
    
    Returns:
  - setUserMetaData
```
public void setUserMetaData(net.sf.json.JSONObject userMetaData)
```
    Specified by:
    
    setUserMetaData in interface org.oa4mp.delegation.server.jwt.IDTokenHandlerInterface
  - init
```
public void init()
          throws Throwable
```
    Specified by:
    
    init in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Throws:
    
    Throwable
  - addRequestState
```
public void addRequestState(edu.uiuc.ncsa.security.util.scripting.ScriptRunRequest req)
                     throws Throwable
```
    Specified by:
    
    addRequestState in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Throws:
    
    Throwable
  - handleResponse
```
public void handleResponse(edu.uiuc.ncsa.security.util.scripting.ScriptRunResponse resp)
                    throws Throwable
```
    Specified by:
    
    handleResponse in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Overrides:
    
    handleResponse in class AbstractPayloadHandler
    
    Throws:
    
    Throwable
  - checkClaims
```
public void checkClaims()
                 throws Throwable
```
    Specified by:
    
    checkClaims in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Throws:
    
    Throwable
  - resolveTemplates
```
public String resolveTemplates(boolean isQuery)
```
    Templates are of the format
    [{"aud":audience, [{"op":X0, "path":P0}, {"op":X1, "path":P1},...}] ]
  - getATConfig
```
protected AccessTokenConfig getATConfig()
```
    Convenience to peel off the AccessTokenConfig from the handler config and return it.
    
    Returns:
  - getSources
```
public List<org.oa4mp.delegation.server.server.claims.ClaimSource> getSources()
                                                                       throws Throwable
```
    Specified by:
    
    getSources in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Throws:
    
    Throwable
  - finish
```
public void finish(boolean doTemplates,
                   boolean isQuery)
            throws Throwable
```
    Throws:
    
    Throwable
  - finish
```
public void finish(String execPhase)
            throws Throwable
```
    Specified by:
    
    finish in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Throws:
    
    Throwable
  - getSignedPayload
```
public AccessTokenImpl getSignedPayload(edu.uiuc.ncsa.security.util.jwk.JSONWebKey key)
```
    Specified by:
    
    getSignedPayload in interface org.oa4mp.delegation.server.jwt.PayloadHandler
  - getSignedPayload
```
public AccessTokenImpl getSignedPayload(edu.uiuc.ncsa.security.util.jwk.JSONWebKey key,
                                        String headerType)
```
    Specified by:
    
    getSignedPayload in interface org.oa4mp.delegation.server.jwt.PayloadHandler
  - saveState
```
public void saveState(String execPhase)
               throws Throwable
```
    Specified by:
    
    saveState in interface org.oa4mp.delegation.server.jwt.PayloadHandler
    
    Overrides:
    
    saveState in class AbstractPayloadHandler
    
    Throws:
    
    Throwable
  - setAccountingInformation
```
public void setAccountingInformation()
```
    Specified by:
    
    setAccountingInformation in interface org.oa4mp.delegation.server.jwt.PayloadHandler
  - refreshAccountingInformation
```
public void refreshAccountingInformation()
```
    Specified by:
    
    refreshAccountingInformation in interface org.oa4mp.delegation.server.jwt.PayloadHandler
  - getAccessToken
```
public AccessToken getAccessToken()
```
    Specified by:
    
    getAccessToken in interface org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface
  - setAccessToken
```
public void setAccessToken(AccessToken accessToken)
```
    Specified by:
    
    setAccessToken in interface org.oa4mp.delegation.server.jwt.AccessTokenHandlerInterface

Modifier and Type	Field	Description
`static String`	`AT_BASIC_HANDLER_TYPE`
`static String`	`AT_DEFAULT_HANDLER_TYPE`

Class AbstractAccessTokenHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.oa4mp.delegation.server.OA2Scopes

Field Summary

Fields inherited from class org.oa4mp.server.loader.oauth2.claims.AbstractPayloadHandler

Fields inherited from interface org.oa4mp.delegation.server.OA2Scopes

Constructor Summary

Method Summary

Methods inherited from class org.oa4mp.server.loader.oauth2.claims.AbstractPayloadHandler

Methods inherited from class java.lang.Object

Methods inherited from interface org.oa4mp.delegation.server.jwt.PayloadHandler

Field Detail

AT_DEFAULT_HANDLER_TYPE

AT_BASIC_HANDLER_TYPE

Constructor Detail

AbstractAccessTokenHandler

Method Detail

getPayload

getUserMetaData

setUserMetaData

init

addRequestState

handleResponse

checkClaims

resolveTemplates

getATConfig

getSources

finish

finish

getSignedPayload

getSignedPayload

saveState

setAccountingInformation

refreshAccountingInformation

getAccessToken

setAccessToken