Class JwtPipe

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Category(BASIC) public class JwtPipe extends FixedForwardPipe
Creates a JWT with a shared secret using the HmacSHA256 algorithm.
Since:
7.9
Author:
Niels Meijer
Specific parameters
"sharedSecret" overrides attribute sharedSecret. This parameter has worse performance, compared to this pipes attribute.
  • Constructor Details

    • JwtPipe

      public JwtPipe()
  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class FixedForwardPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException
    • setAuthAlias

      public void setAuthAlias(String alias)
      Auth Alias for the SharedSecret to be used when signing the JWT (using the HmacSHA256 algorithm)
    • setSharedSecret

      public void setSharedSecret(String sharedSecret)
      Shared secret to be used when signing the JWT (using the HmacSHA256 algorithm)
    • setExpirationTime

      public void setExpirationTime(int expirationTime)
      JWT expirationTime in seconds, 0 to disable
      Default value
      600