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.
@NotNull java.lang.String	getAudience()
KeyValuePairSet	getCustomClaims()
@NotNull java.util.Date	getExpiration()
java.lang.String	getId()
java.util.Date	getIssuedAt()
@NotNull java.lang.String	getIssuer()
@NotNull java.util.Date	getNotBefore()
@NotNull SecretConfigurator	getSecret()
@NotNull java.lang.String	getSubject()
protected void	initService()	.
void	prepare()	Prepare for initialisation.
void	setAudience(@NotNull java.lang.String audience)
void	setCustomClaims(KeyValuePairSet customClaims)
void	setExpiration(@NotNull java.util.Date expiration)
void	setId(java.lang.String id)
void	setIssuedAt(java.util.Date issuedAt)
void	setIssuer(@NotNull java.lang.String issuer)
void	setNotBefore(@NotNull java.util.Date notBefore)
void	setSecret(@NotNull SecretConfigurator secret)
void	setSubject(@NotNull 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

@NotNull
public @NotNull java.lang.String getIssuer()

setIssuer

public void setIssuer(@NotNull
                      @NotNull java.lang.String issuer)

getSubject

@NotNull
public @NotNull java.lang.String getSubject()

setSubject

public void setSubject(@NotNull
                       @NotNull java.lang.String subject)

getAudience

@NotNull
public @NotNull java.lang.String getAudience()

setAudience

public void setAudience(@NotNull
                        @NotNull java.lang.String audience)

getIssuedAt

public java.util.Date getIssuedAt()

setIssuedAt

public void setIssuedAt(java.util.Date issuedAt)

getExpiration

@NotNull
public @NotNull java.util.Date getExpiration()

setExpiration

public void setExpiration(@NotNull
                          @NotNull java.util.Date expiration)

getNotBefore

@NotNull
public @NotNull java.util.Date getNotBefore()

setNotBefore

public void setNotBefore(@NotNull
                         @NotNull java.util.Date notBefore)

getSecret

@NotNull
public @NotNull SecretConfigurator getSecret()

setSecret

public void setSecret(@NotNull
                      @NotNull SecretConfigurator secret)

getCustomClaims

public KeyValuePairSet getCustomClaims()

setCustomClaims

public void setCustomClaims(KeyValuePairSet customClaims)