Package com.adaptris.core.jwt

Class JWTCreator

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.jwt.JWTCreator

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Create a JSON Web Token",
                  tag="jwt,create,json,web,token",
                  since="3.11.1")
public class JWTCreator
extends ServiceImp

This service provides a way to create a JSON Web Token from the given data.

    <jwt-creator>
      <unique-id>jwt-create</unique-id>
      <issuer>ashley</issuer>
      <subject>test</subject>
      <audience>everyone</audience>
      <expiration>2040-12-31 00:00:00.0 UTC</expiration>
      <not-before>2020-01-01 00:00:00.0 UTC</not-before>
      <secret class="base64-encoded-secret">
        <secret>c64975ba3cf3f9cd58459710b0a42369f34b0759c9967fb5a47eea488e8bea79</secret>
      </secret>
      <custom-claims>
        <key-value-pair>
          <key>payload</key>
          <value>%message{%payload}</value>
        </key-value-pair>
      </custom-claims>
    </jwt-creator>
 

In the adapter configuration file this class is aliased as jwt-create which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
JWTCreator()

Method Summary

Modifier and Type	Method	Description
protected void	closeService()	.
void	doService(AdaptrisMessage message)	Apply the service to the message.
java.lang.String	getAudience()
KeyValuePairSet	getCustomClaims()
java.util.Date	getExpiration()
java.lang.String	getId()
java.util.Date	getIssuedAt()
java.lang.String	getIssuer()
java.util.Date	getNotBefore()
SecretConfigurator	getSecret()
java.lang.String	getSubject()
protected void	initService()	.
void	prepare()	Prepare for initialisation.
void	setAudience(java.lang.String audience)
void	setCustomClaims(KeyValuePairSet customClaims)
void	setExpiration(java.util.Date expiration)
void	setId(java.lang.String id)
void	setIssuedAt(java.util.Date issuedAt)
void	setIssuer(java.lang.String issuer)
void	setNotBefore(java.util.Date notBefore)
void	setSecret(SecretConfigurator secret)
void	setSubject(java.lang.String subject)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JWTCreator

public JWTCreator()

Method Detail

doService

public void doService(AdaptrisMessage message)
               throws ServiceException

Apply the service to the message.

Parameters:

message - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

initService

protected void initService()

.

Specified by:

initService in class ServiceImp

closeService

protected void closeService()

.

Specified by:

closeService in class ServiceImp

prepare

public void prepare()

Prepare for initialisation.

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getIssuer

public java.lang.String getIssuer()

setIssuer

public void setIssuer(java.lang.String issuer)

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

getAudience

public java.lang.String getAudience()

setAudience

public void setAudience(java.lang.String audience)

getIssuedAt

public java.util.Date getIssuedAt()

setIssuedAt

public void setIssuedAt(java.util.Date issuedAt)

getExpiration

public java.util.Date getExpiration()

setExpiration

public void setExpiration(java.util.Date expiration)

getNotBefore

public java.util.Date getNotBefore()

setNotBefore

public void setNotBefore(java.util.Date notBefore)

getSecret

public SecretConfigurator getSecret()

setSecret

public void setSecret(SecretConfigurator secret)

getCustomClaims

public KeyValuePairSet getCustomClaims()

setCustomClaims

public void setCustomClaims(KeyValuePairSet customClaims)