Package com.ibm.websphere.security.jwt
Class JwtConsumer
java.lang.Object
com.ibm.websphere.security.jwt.JwtConsumer
This is a class that facilitates validating and parsing JSON Web Tokens.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe ID used for the defaultjwtConsumerserver configuration element that it implicitly included with thejwt-1.0feature. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic JwtConsumercreate()Creates a newJwtConsumerobject using the default configuration ID "defaultJwtConsumer".static JwtConsumerCreates a newJwtConsumerobject using the configuration ID provided.Creates a newJwtTokenobject based on the provided encoded token string.
-
Field Details
-
DEFAULT_ID
The ID used for the defaultjwtConsumerserver configuration element that it implicitly included with thejwt-1.0feature.- See Also:
-
-
Constructor Details
-
JwtConsumer
public JwtConsumer()End OSGi-related fields and methods -
JwtConsumer
- Throws:
InvalidConsumerException
-
-
Method Details
-
create
Creates a newJwtConsumerobject using the default configuration ID "defaultJwtConsumer".- Returns:
- A new
JwtConsumerobject tied to thejwtConsumerserver configuration element with the default ID "defaultJwtConsumer". - Throws:
InvalidConsumerException- Thrown if the JWT consumer service is not available.
-
create
Creates a newJwtConsumerobject using the configuration ID provided.- Parameters:
consumerConfigId- ID of a correspondingjwtConsumerelement inserver.xml. Ifnull, the default configuration ID "defaultJwtConsumer" will be used.- Returns:
- A new
JwtConsumerobject tied to thejwtConsumerserver configuration element whoseidattribute matches the ID provided. - Throws:
InvalidConsumerException- Thrown if the JWT consumer service is not available.
-
createJwt
public JwtToken createJwt(String encodedTokenString) throws InvalidTokenException, InvalidConsumerException Creates a newJwtTokenobject based on the provided encoded token string. The token string is processed based on the configuration for thejwtConsumerelement that is specified inserver.xmlthat matches the ID used to instantiate thisJwtConsumerobject.- Parameters:
encodedTokenString- JWT string to be used to create and validate a newJwtTokenobject. The string should adhere to the format described in {@link https://tools.ietf.org/html/rfc7519#section-3}, where the string is a sequence of base64url-encoded URL-safe parts separated by period ('.') characters.- Returns:
- A new
JwtTokenobject based on the data contained in the provided token string. - Throws:
InvalidConsumerException- Thrown if ajwtConsumerelement with the ID used to instantiate thisJwtConsumerobject cannot be found in the server configuration.InvalidTokenException- Thrown if the provided token string isnullor empty, or if there is an error while processing the token string.
-