Class RemoveCacheKeyPipe

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

@ElementType(SESSION) public class RemoveCacheKeyPipe extends FixedForwardPipe
Remove specified cache key from cache with specified name.
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
      Specified by:
      configure in interface IPipe
      configure in class FixedForwardPipe
    • 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.
    • 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
    • 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()