Class RemoveCacheKeyPipe

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

@EnterpriseIntegrationPattern(SESSION) public class RemoveCacheKeyPipe extends FixedForwardPipe
Remove specified cache key from cache with specified name.
Author:
Jaco de Groot
  • Constructor Details

    • RemoveCacheKeyPipe

      public RemoveCacheKeyPipe()
  • 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
    • setCacheName

      public void setCacheName(String cacheName)
      Name of the cache from which items are to be removed
    • getCacheName

      public String getCacheName()
    • setKeyXPath

      public void setKeyXPath(String keyXPath)
      XPath expression to extract cache key from request message
    • getKeyXPath

      public String getKeyXPath()
    • setKeyXPathOutputType

      public void setKeyXPathOutputType(TransformerPool.OutputType keyXPathOutputType)
      Output type of xpath expression to extract cache key from request message, must be 'xml' or 'text'
      Default value
      text
    • getKeyXPathOutputType

      public TransformerPool.OutputType getKeyXPathOutputType()
    • setKeyNamespaceDefs

      public void setKeyNamespaceDefs(String keyNamespaceDefs)
      Namespace defintions for keyXPath. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions
    • getKeyNamespaceDefs

      public String getKeyNamespaceDefs()
    • setKeyStyleSheet

      public void setKeyStyleSheet(String keyStyleSheet)
      Stylesheet to extract cache key from request message. Use in combination with cacheEmptyKeys to inhibit caching for certain groups of request messages
    • getKeyStyleSheet

      public String getKeyStyleSheet()
    • setKeyInputSessionKey

      public void setKeyInputSessionKey(String keyInputSessionKey)
      Session key to use as input for transformation of request message to key by keyXPath or keyStyleSheet
    • getKeyInputSessionKey

      public String getKeyInputSessionKey()