Package org.citrusframework.variable.dictionary

Class AbstractDataDictionary<T>

java.lang.Object
org.citrusframework.message.AbstractMessageProcessor
org.citrusframework.variable.dictionary.AbstractDataDictionary<T>
All Implemented Interfaces:
org.citrusframework.common.InitializingPhase, org.citrusframework.message.MessageDirectionAware, org.citrusframework.message.MessageProcessor, org.citrusframework.message.MessageTransformer, org.citrusframework.message.MessageTypeSelector, org.citrusframework.Scoped, org.citrusframework.variable.dictionary.DataDictionary<T>
public abstract class AbstractDataDictionary<T> extends org.citrusframework.message.AbstractMessageProcessor implements org.citrusframework.variable.dictionary.DataDictionary<T>
Abstract data dictionary implementation provides global scope handling.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.citrusframework.variable.dictionary.DataDictionary

    org.citrusframework.variable.dictionary.DataDictionary.PathMappingStrategy

    Nested classes/interfaces inherited from interface org.citrusframework.message.MessageProcessor

    org.citrusframework.message.MessageProcessor.Builder<T extends org.citrusframework.message.MessageProcessor,B extends org.citrusframework.message.MessageProcessor.Builder<T,B>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.citrusframework.spi.Resource
    mappingFile
    mapping file resource
    protected Map<String,String>
    mappings
    Known mappings to this dictionary

    Fields inherited from interface org.citrusframework.message.MessageProcessor

    RESOURCE_PATH, TYPE_RESOLVER

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractDataDictionary()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected <V> V
    convertIfNecessary(String value, V originalValue, org.citrusframework.context.TestContext context)
    Convert to original value type if necessary.
    org.citrusframework.spi.Resource
    getMappingFile()
    Gets the mapping file resource.
    Map<String,String>
    getMappings()
    Gets the mappings.
    String
    getName()
     
    org.citrusframework.variable.dictionary.DataDictionary.PathMappingStrategy
    getPathMappingStrategy()
     
    void
    initialize()
     
    boolean
    isGlobalScope()
     
    void
    setGlobalScope(boolean scope)
    Sets the global scope property.
    void
    setMappingFile(org.citrusframework.spi.Resource mappingFile)
    Sets the mapping file resource.
    void
    setMappings(Map<String,String> mappings)
    Sets the mappings.
    void
    setName(String name)
    Sets the data dictionary name.
    void
    setPathMappingStrategy(org.citrusframework.variable.dictionary.DataDictionary.PathMappingStrategy pathMappingStrategy)
    Sets the path mapping strategy.

    Methods inherited from class org.citrusframework.message.AbstractMessageProcessor

    getDirection, process, processMessage, setDirection, supportsMessageType

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.citrusframework.variable.dictionary.DataDictionary

    translate

    Methods inherited from interface org.citrusframework.message.MessageDirectionAware

    getDirection

    Methods inherited from interface org.citrusframework.message.MessageProcessor

    process, transform

  • Field Details

    • mappings

      protected Map<String,String> mappings
      Known mappings to this dictionary

    • mappingFile

      protected org.citrusframework.spi.Resource mappingFile
      mapping file resource

  • Constructor Details

    • AbstractDataDictionary

      public AbstractDataDictionary()

  • Method Details

    • convertIfNecessary

      protected <V> V convertIfNecessary(String value, V originalValue, org.citrusframework.context.TestContext context)
      Convert to original value type if necessary.
      Type Parameters:
      V -
      Parameters:
      value -
      originalValue -
      context -
      Returns:

    • initialize

      public void initialize()
      Specified by:
      initialize in interface org.citrusframework.common.InitializingPhase

    • getName

      public String getName()
      Specified by:
      getName in interface org.citrusframework.variable.dictionary.DataDictionary<T>
      Overrides:
      getName in class org.citrusframework.message.AbstractMessageProcessor

    • setName

      public void setName(String name)
      Sets the data dictionary name.
      Parameters:
      name -

    • isGlobalScope

      public boolean isGlobalScope()
      Specified by:
      isGlobalScope in interface org.citrusframework.Scoped

    • setGlobalScope

      public void setGlobalScope(boolean scope)
      Sets the global scope property.
      Parameters:
      scope -

    • setMappings

      public void setMappings(Map<String,String> mappings)
      Sets the mappings.
      Parameters:
      mappings -

    • getMappings

      public Map<String,String> getMappings()
      Gets the mappings.
      Returns:

    • getMappingFile

      public org.citrusframework.spi.Resource getMappingFile()
      Gets the mapping file resource.
      Returns:

    • setMappingFile

      public void setMappingFile(org.citrusframework.spi.Resource mappingFile)
      Sets the mapping file resource.
      Parameters:
      mappingFile -

    • getPathMappingStrategy

      public org.citrusframework.variable.dictionary.DataDictionary.PathMappingStrategy getPathMappingStrategy()
      Specified by:
      getPathMappingStrategy in interface org.citrusframework.variable.dictionary.DataDictionary<T>

    • setPathMappingStrategy

      public void setPathMappingStrategy(org.citrusframework.variable.dictionary.DataDictionary.PathMappingStrategy pathMappingStrategy)
      Sets the path mapping strategy.
      Parameters:
      pathMappingStrategy -