Class JwtPipe

All Implemented Interfaces:
HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@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
      Specified by:
      configure in interface IPipe
      Overrides:
      configure in class FixedForwardPipe
      Throws:
      ConfigurationException
    • 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. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.
      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