Package org.keycloak.protocol.oidc.encode

Interface TokenContextEncoderProvider

All Superinterfaces:

org.keycloak.provider.Provider

All Known Implementing Classes:

DefaultTokenContextEncoderProvider

public interface TokenContextEncoderProvider
extends org.keycloak.provider.Provider

Provides ability to encode some context into access token ID, so this information can be later retrieved from the token without the need to use some proprietary/non-standard claims. For example token context can contain info whether it is lightweight access token or regular token, whether it is coming from online session or offline session etc.

Author:

Marek Posolda

Method Summary

Modifier and Type	Method	Description
String	encodeTokenId(AccessTokenContext tokenContext)
AccessTokenContext	getTokenContextFromClientSessionContext(org.keycloak.models.ClientSessionContext clientSessionContext, String rawTokenId, boolean isOffline)
AccessTokenContext	getTokenContextFromTokenId(String encodedTokenId)

Methods inherited from interface org.keycloak.provider.Provider

close

Method Details

getTokenContextFromClientSessionContext

AccessTokenContext getTokenContextFromClientSessionContext(org.keycloak.models.ClientSessionContext clientSessionContext,
 String rawTokenId,
 boolean isOffline)

getTokenContextFromTokenId

AccessTokenContext getTokenContextFromTokenId(String encodedTokenId)

encodeTokenId

String encodeTokenId(AccessTokenContext tokenContext)