Package org.citrusframework

Class CitrusSettings

java.lang.Object
org.citrusframework.CitrusSettings
public final class CitrusSettings extends Object

  • Field Details

    • OUTBOUND_SCHEMA_VALIDATION_ENABLED_PROPERTY

      public static final String OUTBOUND_SCHEMA_VALIDATION_ENABLED_PROPERTY
      See Also:

    • OUTBOUND_SCHEMA_VALIDATION_ENABLED_ENV

      public static final String OUTBOUND_SCHEMA_VALIDATION_ENABLED_ENV
      See Also:

    • OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_PROPERTY

      public static final String OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_PROPERTY
      See Also:

    • OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_ENV

      public static final String OUTBOUND_JSON_SCHEMA_VALIDATION_ENABLED_ENV
      See Also:

    • OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_PROPERTY

      public static final String OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_PROPERTY
      See Also:

    • OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_ENV

      public static final String OUTBOUND_XML_SCHEMA_VALIDATION_ENABLED_ENV
      See Also:

    • TEST_NAME_VARIABLE_PROPERTY

      public static final String TEST_NAME_VARIABLE_PROPERTY
      Default variable names
      See Also:

    • TEST_NAME_VARIABLE_ENV

      public static final String TEST_NAME_VARIABLE_ENV
      See Also:

    • TEST_NAME_VARIABLE

      public static final String TEST_NAME_VARIABLE

    • TEST_PACKAGE_VARIABLE_PROPERTY

      public static final String TEST_PACKAGE_VARIABLE_PROPERTY
      See Also:

    • TEST_PACKAGE_VARIABLE_ENV

      public static final String TEST_PACKAGE_VARIABLE_ENV
      See Also:

    • TEST_PACKAGE_VARIABLE

      public static final String TEST_PACKAGE_VARIABLE

    • CITRUS_FILE_ENCODING_PROPERTY

      public static final String CITRUS_FILE_ENCODING_PROPERTY
      File encoding system property
      See Also:

    • CITRUS_FILE_ENCODING_ENV

      public static final String CITRUS_FILE_ENCODING_ENV
      See Also:

    • CITRUS_FILE_ENCODING

      public static final String CITRUS_FILE_ENCODING

    • VARIABLE_PREFIX

      public static final String VARIABLE_PREFIX
      Prefix/sufix used to identify variable expressions
      See Also:

    • VARIABLE_SUFFIX

      public static final String VARIABLE_SUFFIX
      See Also:

    • VARIABLE_ESCAPE

      public static final String VARIABLE_ESCAPE
      See Also:

    • DEFAULT_CONFIG_CLASS_PROPERTY

      public static final String DEFAULT_CONFIG_CLASS_PROPERTY
      Default application context class
      See Also:

    • DEFAULT_CONFIG_CLASS_ENV

      public static final String DEFAULT_CONFIG_CLASS_ENV
      See Also:

    • DEFAULT_CONFIG_CLASS

      public static final String DEFAULT_CONFIG_CLASS

    • DEFAULT_TEST_SRC_DIRECTORY_PROPERTY

      public static final String DEFAULT_TEST_SRC_DIRECTORY_PROPERTY
      Default test directories
      See Also:

    • DEFAULT_TEST_SRC_DIRECTORY_ENV

      public static final String DEFAULT_TEST_SRC_DIRECTORY_ENV
      See Also:

    • DEFAULT_TEST_SRC_DIRECTORY

      public static final String DEFAULT_TEST_SRC_DIRECTORY

    • IGNORE_PLACEHOLDER

      public static final String IGNORE_PLACEHOLDER
      Placeholder used in messages to ignore elements
      See Also:

    • VALIDATION_MATCHER_PREFIX

      public static final String VALIDATION_MATCHER_PREFIX
      Prefix/suffix used to identify validation matchers
      See Also:

    • VALIDATION_MATCHER_SUFFIX

      public static final String VALIDATION_MATCHER_SUFFIX
      See Also:

    • GROOVY_TEST_FILE_NAME_PATTERN_PROPERTY

      public static final String GROOVY_TEST_FILE_NAME_PATTERN_PROPERTY
      See Also:

    • GROOVY_TEST_FILE_NAME_PATTERN_ENV

      public static final String GROOVY_TEST_FILE_NAME_PATTERN_ENV
      See Also:

    • GROOVY_TEST_FILE_NAME_PATTERN

      public static final String GROOVY_TEST_FILE_NAME_PATTERN

    • YAML_TEST_FILE_NAME_PATTERN_PROPERTY

      public static final String YAML_TEST_FILE_NAME_PATTERN_PROPERTY
      See Also:

    • YAML_TEST_FILE_NAME_PATTERN_ENV

      public static final String YAML_TEST_FILE_NAME_PATTERN_ENV
      See Also:

    • YAML_TEST_FILE_NAME_PATTERN

      public static final String YAML_TEST_FILE_NAME_PATTERN

    • XML_TEST_FILE_NAME_PATTERN_PROPERTY

      public static final String XML_TEST_FILE_NAME_PATTERN_PROPERTY
      See Also:

    • XML_TEST_FILE_NAME_PATTERN_ENV

      public static final String XML_TEST_FILE_NAME_PATTERN_ENV
      See Also:

    • XML_TEST_FILE_NAME_PATTERN

      public static final String XML_TEST_FILE_NAME_PATTERN

    • JAVA_TEST_FILE_NAME_PATTERN_PROPERTY

      public static final String JAVA_TEST_FILE_NAME_PATTERN_PROPERTY
      See Also:

    • JAVA_TEST_FILE_NAME_PATTERN_ENV

      public static final String JAVA_TEST_FILE_NAME_PATTERN_ENV
      See Also:

    • JAVA_TEST_FILE_NAME_PATTERN

      public static final String JAVA_TEST_FILE_NAME_PATTERN

    • DEFAULT_MESSAGE_TYPE_PROPERTY

      public static final String DEFAULT_MESSAGE_TYPE_PROPERTY
      Default message type used in message validation mechanism
      See Also:

    • DEFAULT_MESSAGE_TYPE_ENV

      public static final String DEFAULT_MESSAGE_TYPE_ENV
      See Also:

    • DEFAULT_MESSAGE_TYPE

      public static final String DEFAULT_MESSAGE_TYPE

    • HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_PROPERTY

      public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_PROPERTY
      Flag to allow deactivation of the http message builder citrus header update. See ISSUE-1143 for details.
      See Also:

    • HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_ENV

      public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_ENV
      See Also:

    • HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_DEFAULT

      public static final String HTTP_MESSAGE_BUILDER_FORCE_CITRUS_HEADER_UPDATE_ENABLED_DEFAULT

    • ENV_VAR_PROPERTY_BINDING_ENABLED_PROPERTY

      public static final String ENV_VAR_PROPERTY_BINDING_ENABLED_PROPERTY
      Flag to enable/disable environment variable based endpoint and component configuration.
      See Also:

    • ENV_VAR_PROPERTY_BINDING_ENABLED_ENV

      public static final String ENV_VAR_PROPERTY_BINDING_ENABLED_ENV
      See Also:

    • ENV_VAR_PROPERTY_BINDING_ENABLED_DEFAULT

      public static final String ENV_VAR_PROPERTY_BINDING_ENABLED_DEFAULT

    • COMPONENT_PROPERTY_BINDING_ENABLED_PROPERTY

      public static final String COMPONENT_PROPERTY_BINDING_ENABLED_PROPERTY
      Flag to enable/disable environment variable based endpoint and component configuration.
      See Also:

    • COMPONENT_PROPERTY_BINDING_ENABLED_ENV

      public static final String COMPONENT_PROPERTY_BINDING_ENABLED_ENV
      See Also:

    • COMPONENT_PROPERTY_BINDING_ENABLED_DEFAULT

      public static final String COMPONENT_PROPERTY_BINDING_ENABLED_DEFAULT

    • ENDPOINT_PROPERTY_BINDING_ENABLED_PROPERTY

      public static final String ENDPOINT_PROPERTY_BINDING_ENABLED_PROPERTY
      Flag to enable/disable environment variable based endpoint and component configuration.
      See Also:

    • ENDPOINT_PROPERTY_BINDING_ENABLED_ENV

      public static final String ENDPOINT_PROPERTY_BINDING_ENABLED_ENV
      See Also:

    • ENDPOINT_PROPERTY_BINDING_ENABLED_DEFAULT

      public static final String ENDPOINT_PROPERTY_BINDING_ENABLED_DEFAULT

    • MESSAGE_TRACE_DIRECTORY_PROPERTY

      public static final String MESSAGE_TRACE_DIRECTORY_PROPERTY
      Default message trace output directory
      See Also:

    • MESSAGE_TRACE_DIRECTORY_ENV

      public static final String MESSAGE_TRACE_DIRECTORY_ENV
      See Also:

    • MESSAGE_TRACE_DIRECTORY_DEFAULT

      public static final String MESSAGE_TRACE_DIRECTORY_DEFAULT
      See Also:

    • TYPE_CONVERTER_PROPERTY

      public static final String TYPE_CONVERTER_PROPERTY
      Default type converter
      See Also:

    • TYPE_CONVERTER_ENV

      public static final String TYPE_CONVERTER_ENV
      See Also:

    • TYPE_CONVERTER_DEFAULT

      public static final String TYPE_CONVERTER_DEFAULT
      See Also:

    • PERFORM_DEFAULT_VALIDATION_PROPERTY

      public static final String PERFORM_DEFAULT_VALIDATION_PROPERTY
      Flag to enable/disable fallback to default text equals validation
      See Also:

    • PERFORM_DEFAULT_VALIDATION_ENV

      public static final String PERFORM_DEFAULT_VALIDATION_ENV
      See Also:

    • PERFORM_DEFAULT_VALIDATION_DEFAULT

      public static final String PERFORM_DEFAULT_VALIDATION_DEFAULT

    • CACHE_INPUT_STREAM_PROPERTY

      public static final String CACHE_INPUT_STREAM_PROPERTY
      Flag to enable/disable input stream caching
      See Also:

    • CACHE_INPUT_STREAM_ENV

      public static final String CACHE_INPUT_STREAM_ENV
      See Also:

    • CACHE_INPUT_STREAM_DEFAULT

      public static final String CACHE_INPUT_STREAM_DEFAULT

    • PRETTY_PRINT_PROPERTY

      public static final String PRETTY_PRINT_PROPERTY
      Flag to enable/disable message pretty print
      See Also:

    • PRETTY_PRINT_ENV

      public static final String PRETTY_PRINT_ENV
      See Also:

    • PRETTY_PRINT_DEFAULT

      public static final String PRETTY_PRINT_DEFAULT

    • FILE_PATH_CHARSET_PARAMETER_PROPERTY

      public static final String FILE_PATH_CHARSET_PARAMETER_PROPERTY
      File path charset parameter
      See Also:

    • FILE_PATH_CHARSET_PARAMETER_ENV

      public static final String FILE_PATH_CHARSET_PARAMETER_ENV
      See Also:

    • FILE_PATH_CHARSET_PARAMETER_DEFAULT

      public static final String FILE_PATH_CHARSET_PARAMETER_DEFAULT
      See Also:

    • GROOVY_STATIC_IMPORTS_PROPERTY

      public static final String GROOVY_STATIC_IMPORTS_PROPERTY
      List of static imports for Groovy test action scripts.
      See Also:

    • GROOVY_STATIC_IMPORTS_ENV

      public static final String GROOVY_STATIC_IMPORTS_ENV
      See Also:

    • GROOVY_STATIC_IMPORTS_DEFAULT

      public static final String GROOVY_STATIC_IMPORTS_DEFAULT
      See Also:

    • DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_PROPERTY

      public static final String DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_PROPERTY
      Flag to enable/disable stack trace output in default logging reporter.
      See Also:

    • DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_ENV

      public static final String DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_ENV
      See Also:

    • DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_DEFAULT

      public static final String DEFAULT_LOGGING_REPORTER_PRINT_STACK_TRACES_DEFAULT

    • AUTO_CLOSE_DYNAMIC_ENDPOINTS_PROPERTY

      public static final String AUTO_CLOSE_DYNAMIC_ENDPOINTS_PROPERTY
      Flag to enable/disable auto close of dynamic endpoints.
      See Also:

    • AUTO_CLOSE_DYNAMIC_ENDPOINTS_ENV

      public static final String AUTO_CLOSE_DYNAMIC_ENDPOINTS_ENV
      See Also:

    • AUTO_CLOSE_DYNAMIC_ENDPOINTS_DEFAULT

      public static final String AUTO_CLOSE_DYNAMIC_ENDPOINTS_DEFAULT

    • AUTO_REMOVE_DYNAMIC_ENDPOINTS_PROPERTY

      public static final String AUTO_REMOVE_DYNAMIC_ENDPOINTS_PROPERTY
      Flag to enable/disable auto removal of dynamic endpoints.
      See Also:

    • AUTO_REMOVE_DYNAMIC_ENDPOINTS_ENV

      public static final String AUTO_REMOVE_DYNAMIC_ENDPOINTS_ENV
      See Also:

    • AUTO_REMOVE_DYNAMIC_ENDPOINTS_DEFAULT

      public static final String AUTO_REMOVE_DYNAMIC_ENDPOINTS_DEFAULT

  • Method Details

    • getGroovyTestFileNamePattern

      public static Set<String> getGroovyTestFileNamePattern()
      Gets set of file name patterns for Groovy test files.

    • getYamlTestFileNamePattern

      public static Set<String> getYamlTestFileNamePattern()
      Gets set of file name patterns for YAML test files.

    • getXmlTestFileNamePattern

      public static Set<String> getXmlTestFileNamePattern()
      Gets set of file name patterns for XML test files.

    • getJavaTestFileNamePattern

      public static Set<String> getJavaTestFileNamePattern()
      Gets set of file name patterns for Java test files.

    • getMessageTraceDirectory

      public static String getMessageTraceDirectory()
      Gets the directory where to put message trace files.

    • getTypeConverter

      public static String getTypeConverter()
      Gets the type converter to use by default.

    • isPerformDefaultValidation

      public static boolean isPerformDefaultValidation()
      Gets the setting whether fallback default message validation is enabled/disabled.

    • isCacheInputStream

      public static boolean isCacheInputStream()
      Gets the setting whether caching of input stream is enabled/disabled.

    • isPrettyPrintEnabled

      public static boolean isPrettyPrintEnabled()
      Gets the message payload pretty print enabled/disabled setting.

    • getFilePathCharsetParameter

      public static String getFilePathCharsetParameter()
      Get the file path charset parameter.

    • isHttpMessageBuilderForceCitrusHeaderUpdateEnabled

      public static boolean isHttpMessageBuilderForceCitrusHeaderUpdateEnabled()
      Gets the http message builder force citrus header update enabled/disabled setting, which controls whether the citrus message builder always creates messages with unique ids.

    • getTestFileNamePattern

      public static Set<String> getTestFileNamePattern(String type)
      Gets the test file name pattern for given type or empty patterns for unknown type.

    • getPropertyEnvOrDefault

      public static String getPropertyEnvOrDefault(String prop, String env, String def)
      Gets in the respective order, a system property, an environment variable or the default
      Parameters:
      prop - the name of the system property to get
      env - the name of the environment variable to get
      def - the default value
      Returns:
      first value encountered, which is not null. May return null, if default value is null.

    • isEnvVarPropertyBindingEnabled

      public static boolean isEnvVarPropertyBindingEnabled()
      Gets the setting that marks environment variable property binding enabled/disabled. If enabled endpoints and components are configured using system properties and environment variables.

    • isComponentPropertyBindingEnabled

      public static boolean isComponentPropertyBindingEnabled()
      Gets the setting that marks environment variable property binding enabled/disabled for all components. If enabled components are configured using system properties and environment variables.

    • isEndpointPropertyBindingEnabled

      public static boolean isEndpointPropertyBindingEnabled()
      Gets the setting that marks environment variable property binding enabled/disabled for all endpoints. If enabled endpoints are configured using system properties and environment variables.

    • getGroovyStaticImports

      public static String getGroovyStaticImports()
      Gets the static imports used in Groovy test action scripts.

    • isStackTraceOutputEnabled

      public static boolean isStackTraceOutputEnabled()
      Whether stack traces should be printed in the default logging reporter or not.

    • isAutoCloseDynamicEndpoints

      public static boolean isAutoCloseDynamicEndpoints()
      Setting marks auto close for dynamic endpoints. If set to true all dynamic endpoints will be closed automatically after the test.

    • isAutoRemoveDynamicEndpoints

      public static boolean isAutoRemoveDynamicEndpoints()
      Setting marks auto removal for dynamic endpoints. If set to true all dynamic endpoints will be closed and removed automatically after the test.