com.pega.pegarules.pub.util

Interface JWTUtils

public interface JWTUtils

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateJSONWebKeySet(java.lang.String tokenInstanceName) API to generate JSON web key set as a json string
ClipboardPage	generateJSONWebToken(ClipboardPage aTokenProfilePage, ClipboardPage aContextPage, java.util.Map<java.lang.String,java.lang.String> options) Generates JSON web token instance from the given Clipboard Page of "Data-Admin-Security-Token"
ClipboardPage	generateJSONWebToken(java.lang.String aTokenInstanceName, ClipboardPage aContextPage, java.util.Map<java.lang.String,java.lang.String> options) Generates JSON web token instance from the given Clipboard Page of "Data-Admin-Security-Token"
void	processJSONWebToken(java.lang.String compactJWTString, ClipboardPage aTokenProfilePage) API for processing JSON web token in compact form X.Y.Z
void	processJSONWebToken(java.lang.String generatedJWT, java.lang.String processingTokenProfileName) API for processing generated json web token

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

generateJSONWebToken

ClipboardPage generateJSONWebToken(ClipboardPage aTokenProfilePage,
                                   ClipboardPage aContextPage,
                                   java.util.Map<java.lang.String,java.lang.String> options)

Generates JSON web token instance from the given Clipboard Page of "Data-Admin-Security-Token"

Parameters:

aTokenProfilePage - : a ClipboardPage of "Data-Admin-Security-Token"

aContextPage - : Based on options parameter, context page properties are included in JWT as a payload.

options - : options can be configured with following the keys 1) "honourCustomClaims", if true, context page is included in JWT as a payload 2) "propertiesToExclude" is a string of comma separated properties which are excluded from context page ex:"pzInzKey,pxObjClass" 3) "customClaimName" if specified, will be the JSON key for payload page properties, else will have default value "pyData"

Returns:

ClipboardPage of class Embed-Token-JsonWebToken with following meta data pyJWT : JSON web token in compact serialization format. pyTokenID : Unique ID generated for each JWT Token. pyTokenExp : Expiry of the generated token in GMT date format.

generateJSONWebToken

ClipboardPage generateJSONWebToken(java.lang.String aTokenInstanceName,
                                   ClipboardPage aContextPage,
                                   java.util.Map<java.lang.String,java.lang.String> options)

Generates JSON web token instance from the given Clipboard Page of "Data-Admin-Security-Token"

Parameters:

aTokenInstanceName - : Name of Token Profile instance

aContextPage - : Based on options parameter, context page properties are included in JWT as a payload.

options - : options can be configured with following keys 1) "honourCustomClaims", if true, context page is included in JWT as a payload 2) "propertiesToExclude" is a string of comma separated properties which are excluded from context page ex:"pzInzKey,pxObjClass" 3) "customClaimName" if specified, will be the JSON key for payload page properties, else will have default value "pyData"

Returns:

ClipboardPage of class Embed-Token-JsonWebToken with following meta data pyJWT : JSON web token in compact serialization format. pyTokenID : Unique ID generated for each JWT Token. pyTokenExp : Expiry of the generated token in GMT date format.

generateJSONWebKeySet

java.lang.String generateJSONWebKeySet(java.lang.String tokenInstanceName)

API to generate JSON web key set as a json string

Parameters:

tokenInstanceName - Token instance name

Returns:

JWKSetAsJSONString

processJSONWebToken

void processJSONWebToken(java.lang.String generatedJWT,
                         java.lang.String processingTokenProfileName)

API for processing generated json web token

Parameters:

generatedJWT - Generated JWT string

processingTokenProfileName - JWT profile instance name

processJSONWebToken

void processJSONWebToken(java.lang.String compactJWTString,
                         ClipboardPage aTokenProfilePage)

API for processing JSON web token in compact form X.Y.Z

Parameters:

compactJWTString - JWT string

aTokenProfilePage - JWT profile instance page * *