IRISLIB database
JWT Class Reference

The OAuth2.Server.JWT is the GenerateTokenClass which creates a JWT which is included with the server. More...

Inheritance diagram for JWT:
Collaboration diagram for JWT:

Static Public Member Functions

 AddClaims (_.Library.ArrayOfObjects claims, _.OAuth2.Server.Properties properties, _.Library.DynamicObject json)
 The OAuth2.Server.JWT is the GenerateTokenClass which creates a JWT which is included with the server. More...
 
_.Library.String GenerateAccessToken (_.OAuth2.Server.Properties properties, _.Library.Status sc)
 The GenerateAccessToken method returns an optionally signed and/or encryypted JWT to be used. More...
 
_.Library.Boolean IsJWT ()
 The IsJWT method returns true if the GenerateAccessToken method returns a JWT. More...
 
- Static Public Member Functions inherited from Generate
_.Library.Status OnRefreshAccessToken (_.OAuth2.Server.Properties properties)
 The OnRefreshAccessToken method will be called when a new access token is granted. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

The OAuth2.Server.JWT is the GenerateTokenClass which creates a JWT which is included with the server.

The GenerateTokenClass is specified in the Authorization Server Configuration. It must contain a GenerateAccessToken method will be used to generate an access token based on the array of properties that is returned by the ValidateUser method.

Member Function Documentation

◆ AddClaims()

AddClaims ( _.Library.ArrayOfObjects  claims,
_.OAuth2.Server.Properties  properties,
_.Library.DynamicObject  json 
)
static

The OAuth2.Server.JWT is the GenerateTokenClass which creates a JWT which is included with the server.

The GenerateTokenClass is specified in the Authorization Server Configuration. It must contain a GenerateAccessToken method will be used to generate an access token based on the array of properties that is returned by the ValidateUser method.

Add requested claims to the JWT

◆ GenerateAccessToken()

_.Library.String GenerateAccessToken ( _.OAuth2.Server.Properties  properties,
_.Library.Status  sc 
)
static

The GenerateAccessToken method returns an optionally signed and/or encryypted JWT to be used.

as an access token. The access token may be based on the properties argument. In addition values for claims to be added to the JSON response object may be returned in the properties.ResponseProperties array.
However the method in this default class just returns a JWT which is optionally signed and/or encrypted.

Reimplemented from Generate.

◆ IsJWT()

_.Library.Boolean IsJWT ( )
static

The IsJWT method returns true if the GenerateAccessToken method returns a JWT.

IsJWT is used to determine inclusion of algorithms for access token in server metadata.

Reimplemented from Generate.