Namespace: Consultingwerk.Framework
Class 
JsonWebTokenPayload Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.ParameterObject
Consultingwerk.Framework.JsonWebTokenPayload

Inherits: Consultingwerk.ParameterObject
Implements: Consultingwerk.IJsonSerializable
SERIALIZABLE

File:JsonWebTokenPayload
Purpose:Represents the payload (claims) of a JSON Web Token (JWT)
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:17.04.2021 12:24:50
Notes:https://tools.ietf.org/html/rfc7519#section-4

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# CHARACTER AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.Framework.JsonWebTokenPayload Audience (character) Property Setter for the Audience property
+ Deserialize (longchar) Deserializes a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.JsonSerializable
# DeserializeProperty (JsonObject, character, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL Equals (Object) Compares this object to the passed in object by value
Inherited from Consultingwerk.ParameterObject
+ Consultingwerk.Framework.JsonWebTokenPayload ExpirationTime (datetime-tz) Property Setter for the ExpirationTime property
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ RAW GetHashCode () Returns an 64bit RAW Hash Value representing the object instance
Inherited from Consultingwerk.ParameterObject
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.Framework.JsonWebTokenPayload IssuedAt (datetime-tz) Property Setter for the IssuedAt property
+ Consultingwerk.Framework.JsonWebTokenPayload Issuer (character) Property Setter for the Issuer property
+ Consultingwerk.Framework.JsonWebTokenPayload JwtId (character) Property Setter for the JwtId property
+ Consultingwerk.Framework.JsonWebTokenPayload NotBefore (datetime-tz) Property Setter for the NotBefore property
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.Framework.JsonWebTokenPayload Subject (character) Property Setter for the Subject property
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a string representation of the object
Inherited from Consultingwerk.ParameterObject
+ LONGCHAR WriteJson () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR WriteXml () Returns an XML LONGCHAR representation of the object instance
Inherited from Consultingwerk.JsonSerializable
+ HANDLE XmlSerialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.JsonSerializable
+ XmlSerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.JsonSerializable
# XmlSerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary
Options Name Purpose
+ JsonWebTokenPayload () Constructor for the JsonWebTokenPayload class
+ JsonWebTokenPayload (character, character, character, datetime-tz, datetime-tz, datetime-tz, character) Constructor for the JsonWebTokenPayload class

Top Property Summary
Options Name Purpose
+ CHARACTER Audience
+ DATETIME-TZ ExpirationTime
+ DATETIME-TZ IssuedAt
+ CHARACTER Issuer
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER JwtId
+ DATETIME-TZ NotBefore
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER Subject
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED CHARACTER AddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
Top

PROTECTED AddSerializableProperties (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Add a list of Serializable Properties to the SerializableProperties property
Notes: Required as a workaround to full reflection only. We *may* remove this
method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties CHARACTER
A comma delimited list of serializable properties
Top

PROTECTED CHARACTER AddSerializableProperties (Class)
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload Audience (character)
Purpose: Property Setter for the Audience property
Notes:

Parameters:
pAudience CHARACTER
The value for the Audience property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedRepresentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)
Inherited from Consultingwerk.JsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PROTECTED DeserializeProperty (JsonObject, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization
Notes:

Parameters:
poJsonObject JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC LOGICAL Equals (Object)
Inherited from Consultingwerk.ParameterObject
Purpose: Compares this object to the passed in object by value
Notes:

Parameters:
poObject Progress.Lang.Object
The reference to the object to compare to
Returns LOGICAL
Logical value indicating if the two objects are identical by value
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload ExpirationTime (datetime-tz)
Purpose: Property Setter for the ExpirationTime property
Notes:

Parameters:
pExpirationTime DATETIME-TZ
The value for the ExpirationTime property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PROTECTED IEnumerable GetEnumerableInstance (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a value list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
Top

PUBLIC RAW GetHashCode ()
Inherited from Consultingwerk.ParameterObject
Purpose: Returns an 64bit RAW Hash Value representing the object instance
Notes: Based on the ABL SHA-512 implementation

Returns RAW
The RAW Hash Value representing the object instance
Top

PUBLIC CHARACTER GetSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload IssuedAt (datetime-tz)
Purpose: Property Setter for the IssuedAt property
Notes:

Parameters:
pIssuedAt DATETIME-TZ
The value for the IssuedAt property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload Issuer (character)
Purpose: Property Setter for the Issuer property
Notes:

Parameters:
pIssuer CHARACTER
The value for the Issuer property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload JwtId (character)
Purpose: Property Setter for the JwtId property
Notes:

Parameters:
pJwtId CHARACTER
The value for the JwtId property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload NotBefore (datetime-tz)
Purpose: Property Setter for the NotBefore property
Notes:

Parameters:
pNotBefore DATETIME-TZ
The value for the NotBefore property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PROTECTED SerializeProperty (JsonObject, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization

Parameters:
poJsonObject JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC Consultingwerk.Framework.JsonWebTokenPayload Subject (character)
Purpose: Property Setter for the Subject property
Notes:

Parameters:
pSubject CHARACTER
The value for the Subject property
Returns Consultingwerk.Framework.JsonWebTokenPayload
The reference to the object instance
Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data
Top

PUBLIC CHARACTER ToString ()
Inherited from Consultingwerk.ParameterObject
Purpose: Returns a string representation of the object
Notes:

Returns CHARACTER
The string representation of the object
Top

PUBLIC LONGCHAR WriteJson ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization
This method is a facade to the JsonSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC LONGCHAR WriteXml ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an XML LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE XmlSerialize (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of the current object instance to
an existing X-NODEREF object
Notes:

Parameters:
phParent HANDLE
The reference to the parent XML Node or Document
Returns HANDLE
The X-NODEREF with the properties of the serialized object
Top

PUBLIC XmlSerializeProperties (handle)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of this object instance as child nodes of
the given node
Notes:

Parameters:
phObjectNode HANDLE
The reference to the X-NODEREF object that represents the node for the current instance
Top

PROTECTED XmlSerializeProperty (handle, character, character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current parent XmlNode
Notes: Allows to override the handling of individual properties during the
XmlSerialization

Parameters:
phParentNode HANDLE
The reference to the parent XML Node
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

PUBLIC JsonWebTokenPayload ()
Purpose: Constructor for the JsonWebTokenPayload class
Notes:

Top

PUBLIC JsonWebTokenPayload (character, character, character, datetime-tz, datetime-tz, datetime-tz, character)
Purpose: Constructor for the JsonWebTokenPayload class
Notes:

Parameters:
pIssuer CHARACTER
The value for the Issuer property
pSubject CHARACTER
The value for the Subject property
pAudience CHARACTER
The value for the Audience property
pExpirationTime DATETIME-TZ
The value for the ExpirationTime property
pNotBefore DATETIME-TZ
The value for the NotBefore property
pIssuedAt DATETIME-TZ
The value for the IssuedAt property
pJwtId CHARACTER
The value for the JwtId property


Property Detail
Top

PUBLIC CHARACTER Audience

Returns CHARACTER
Top

PUBLIC DATETIME-TZ ExpirationTime

Returns DATETIME-TZ
Top

PUBLIC DATETIME-TZ IssuedAt

Returns DATETIME-TZ
Top

PUBLIC CHARACTER Issuer

Returns CHARACTER
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC CHARACTER JwtId

Returns CHARACTER
Top

PUBLIC DATETIME-TZ NotBefore

Returns DATETIME-TZ
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC CHARACTER Subject

Returns CHARACTER
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:51:39