All Classes

Class	Description
AbstractEndpointConfiguration	Abstract endpoint configuration provides basic properties such as message listeners.
AbstractMessageConsumer
AbstractMessageProcessor	Abstract message processor is message direction aware and automatically applies message type selector.
AbstractMessageValidator<T extends ValidationContext>	Base abstract implementation for message validators.
AbstractSelectiveMessageConsumer
ActionTimeoutException	Throw this exception in case you did not receive a message on a destination in time.
AfterSuite
AfterTest
AnnotationConfigParser<A extends Annotation,T extends Endpoint>
BeforeSuite
BeforeTest
BindToRegistry	Used to bind an object to the Citrus context reference registry for dependency injection reasons.
CitrusConfiguration
CitrusEndpoint	Marks field or parameter for endpoint injection.
CitrusEndpointAnnotations	Dependency injection support for CitrusEndpoint endpoint annotations.
CitrusEndpointConfig
CitrusEndpointProperty
CitrusFramework	Citrus test framework annotation marking a field or method parameter for object injection.
CitrusInstanceStrategy	Instance creation strategy.
CitrusResource
CitrusRuntimeException	Basic custom runtime exception for all errors in Citrus
CitrusSettings
CitrusTest	Citrus test case annotation used in Java DSL test cases to execute several tests within one single test builder class.
CitrusTestSource	Citrus test case annotation used for Groovy test case definition inside a unit test class.
CitrusVersion
CitrusXmlTest	Deprecated. in favor of using generic CitrusTestSource annotation
Completable	Interface indicates that test action is aware of its completed state.
Condition	Tests whether a condition is satisfied.
Consumer
ControlExpressionParser	Control expression parser for extracting the individual control values from a control expression.
CorrelationManager<T>	Correlation manager stores objects with a correlation key.
DataDictionary<T>	Data dictionary interface describes a mechanism to modify message content (payload) with global dictionary elements.
DataDictionary.PathMappingStrategy	Possible mapping strategies for identifying matching dictionary items with path comparison.
DefaultControlExpressionParser	Default implementation of control expression parser.
DefaultEmptyMessageValidator	Basic message validator is able to verify empty message payloads.
DefaultEndpointFactory	Default endpoint factory implementation uses registered endpoint components in Spring application context to create endpoint from given endpoint uri.
DefaultMessageStore
DefaultMessageValidator	Basic control message validator for all message types.
DefaultTypeConverter
DefaultValidationContext
Described
Endpoint	Endpoint interface defines basic send and receive operations on a message endpoint.
EndpointAdapter	Endpoint adapter represents a special message handler that delegates incoming request messages to some message endpoint.
EndpointAdapterMappingStrategy	Strategy finds proper endpoint adapter instance for given mapping key.
EndpointBuilder<T extends Endpoint>	Endpoint builder interface.
EndpointComponent	Endpoint component registers with bean name in Spring application context and is then responsible to create proper endpoints dynamically from endpoint uri values.
EndpointConfiguration
EndpointFactory	Endpoint factory tries to get endpoint instance by parsing an endpoint uri.
EndpointUriBuilder
EndpointUriResolver	Resolves endpoint uri so we can send messages to dynamic endpoints.
ErrorHandlingStrategy	Enumeration representing the different error handling strategies in synchronous communication with client server interaction where the client receives an error message as response.
FailureStackElement	Failure stack element provides access to the detailed failure stack message and the location in the test case XML where error happened.
Function	General function interface.
FunctionLibrary	Library holding a set of functions.
FunctionParameterHelper	Helper class parsing a parameter string and converting the tokens to a parameter list.
FunctionRegistry	Function registry holding all available function libraries.
FunctionUtils	Utility class for functions.
GenericValidationProcessor<T>
GherkinTestActionRunner	Runner adds default alias methods using Gherkin behavior driven development style (GIVEN, WHEN, THEN).
GlobalVariables	Global variables valid in each test case.
GlobalVariables.Builder	Fluent builder.
GroovyScriptExecutor	Executes a validation-script
HeaderValidationContext
HeaderValidator
InitializingPhase
InvalidFunctionUsageException	Use this exception in case a function is called with invalid parameters.
IsJsonPredicate	Tests if a string represents a Json.
IsXmlPredicate	Tests if a string represents a XML.
LogMessageModifier	Special modifier adds message related modifications on log output on headers and body.
LogModifier	Modifier masks output that gets printed to an output stream.
MappingKeyExtractor	Interface describes mapping extraction along message dispatching endpoint adapter processing steps.
Marshaller
Message
MessageBuilder	Interface for classes being able to build control messages for validation.
MessageConstructionInterceptor	Deprecated. since 3.0 in favor of using MessageTransformer
MessageConverter<I,O,C extends EndpointConfiguration>	Message converter interface describes methods for converting a external message type T to the internal message representation and vice versa.
MessageCorrelator	Message correlator interface for synchronous reply messages.
MessageDirection	Indicates message direction inbound, outbound or unbounded.
MessageDirectionAware
MessageHeaderBuilder
MessageHeaderDataBuilder
MessageHeaders	Citrus specific message headers.
MessageHeaderType	Enumeration for supported message header types.
MessageHeaderUtils
MessageListener
MessageListenerAware
MessageListeners
MessagePayloadBuilder
MessagePayloadBuilder.Builder<T extends MessagePayloadBuilder,B extends MessagePayloadBuilder.Builder<T,B>>	Fluent builder
MessagePayloadUtils
MessageProcessor	Processor performs operations on the given message.
MessageProcessor.Builder<T extends MessageProcessor,B extends MessageProcessor.Builder<T,B>>	Fluent builder
MessageProcessorAdapter	Adapter interface marks that a class is able to act as a message processor.
MessageProcessors	List of global message construction processors that modify message payload and message headers.
MessageQueue
MessageSelector
MessageSelector.AllAcceptingMessageSelector	Special message selector accepts all messages on queue.
MessageSelector.MessageSelectorFactory	Factory capable of creating a message selector from key value pairs.
MessageStore
MessageTimeoutException
MessageTransformer	Transformer is able to completely change a given message.
MessageTransformer.Builder<T extends MessageTransformer,B extends MessageTransformer.Builder<T,B>>	Fluent builder
MessageType	Enumeration for message protocol types used in test cases.
MessageTypeAware
MessageTypeSelector
MessageValidator<T extends ValidationContext>	Message validator interface.
MessageValidatorRegistry	Simple registry holding all available message validator implementations.
MissingExpectedMessageException	This exception is thrown when a message receiving action does not specify any expected content.
Named
NamespaceContextBuilder	Builds a namespace context for XPath expression evaluations.
NoSuchFunctionException	Unknown functions cause this exception.
NoSuchFunctionLibraryException	In case no function library exists for a given prefix this exception is thrown.
NoSuchMessageValidatorException	In case no message validator exists for a given prefix this exception is thrown.
NoSuchValidationMatcherException	Unknown validation matchers cause this exception.
NoSuchValidationMatcherLibraryException	In case no function library exists for a given prefix this exception is thrown.
NoSuchVariableException	Throw this exception in case an unknown variable is read from test context.
ObjectStore<T>	Interface defines add and remove object methods for storing data.
ParallelContainerException	Special exception thrown in case several actions in a parallel container have failed.
PathExpressionAdapter
PollableEndpointConfiguration	Extends endpoint configuration by adding polling interval settings.
Producer
ReferenceRegistry	Bind objects to registry for later reference.
ReferenceResolver
ReferenceResolverAware
ReplyConsumer	Consumer that explicitly receives reply messages synchronously.
ReplyMessageTimeoutException
ReplyProducer
ResourcePathTypeResolver	Type resolver resolves references via resource path lookup.
SchemaValidationContext	This context holds the basic information for the validation of messages against schemas
SchemaValidationContext.Builder<B>	Fluent builder
SchemaValidator<T extends SchemaValidationContext>
Scoped
ScriptPayloadBuilder
ScriptTypes	Script type constants representing possible script languages used in test cases.
SegmentVariableExtractor	Class extracting values of segments of VariableExpressions.
SegmentVariableExtractorRegistry	Simple registry holding all available segment variable extractor implementations.
SegmentVariableExtractorRegistry.AbstractSegmentVariableExtractor	Base class for segment variable extractors that ensures that an exception is thrown upon no match.
SegmentVariableExtractorRegistry.IndexedSegmentVariableExtractor	Base class for extractors that can operate on indexed values.
SegmentVariableExtractorRegistry.MapVariableExtractor	SegmentVariableExtractor that accesses the segment value from a Map.
SegmentVariableExtractorRegistry.ObjectFieldValueExtractor	SegmentVariableExtractor that accesses the segment value by a Field of the parentObject
SelectiveConsumer	Consumer implementation able to select messages available on a message destination.
Server	Server representation in Citrus is a runnable instance accepting client connections.
ShutdownPhase
SimpleReferenceResolver	Simple object registry holding in memory key value store to bind and obtain object references by name.
SqlResultSetScriptExecutor	Executes the sql validation script providing the result set representation.
StopTimer	Interface for stopping a timer.
StringResult	Helper representing a stream result that is written to a String writer.
StringSource	A simple JAXB stream source representation of a static String content.
TestAction	Interface for all test actions.
TestActionBuilder<T extends TestAction>	Test action builder.
TestActionBuilder.DelegatingTestActionBuilder<T extends TestAction>
TestActionContainer	Container interface describing all test action containers that hold several embedded test actions to execute.
TestActionContainerBuilder<T extends TestActionContainer,S extends TestActionContainerBuilder<T,S>>
TestActionListener	Listener invoked on test action execution with success and failure.
TestActionListenerAware
TestActionListeners	Class broadcasting test action events to all available test action listeners injected by Spring's IoC container.
TestActionListenersAware
TestActionRunner
TestActor	Actor performs send/receive message actions.
TestActorAware
TestBehavior	Behavior applies logic to given test action runner.
TestCase	Test case executing a list of TestAction in sequence.
TestCaseBuilder
TestCaseFailedException	Base exception marking failure of test case.
TestCaseMetaInfo	Test case meta information.
TestCaseMetaInfo.Status	Status of testcase
TestCaseRunner
TestClass
TestContext	Class holding and managing test variables.
TestEngine
TestEngineFailedException	Custom RuntimeException thrown if test run failed, because some tests were not successful.
TestGroupAware	Interface marks test case to support group bindings.
TestListener	Test listener interface.
TestListenerAware
TestListeners	Class that spreads test events to all available test listeners injected by Spring's IoC container.
TestLoader	Test loader interface.
TestParameterAware	Interface marks test case to support test parameters.
TestReporter	Interface for test reporters.
TestReporterAware
TestReporters
TestReporterSettings
TestResult	Class representing test results (failed, successful, skipped)
TestResults	Multiple TestResult instances combined to a TestResults.
TestResults.ResultCallback	Callback interface for synchronized access to test results in iteration.
TestRunConfiguration
TestScanner
TestSourceAware
TestSuiteListener	Listener for events regarding a test suite (start, finish, failure, success)
TestSuiteListenerAware
TestSuiteListeners	Class managing a list of injected test suite listeners.
TypeAliasResolver<S,A>	Type resolver able to adapt an alias type to a given source type.
TypeConversionUtils
TypeConverter
TypeResolver	Resolves types by searching for classpath resource mapping files in order to resolve class references at runtime.
UnknownElementException	Thrown in case an element is not found.
Unmarshaller
ValidationContext	Basic validation context holding validation specific information.
ValidationContext.Builder<T extends ValidationContext,B extends ValidationContext.Builder<T,B>>	Fluent builder
ValidationContextAdapter	Adapter interface marks that a class is able to act as a validation context.
ValidationException	This exception marks errors during validation in Citrus.
ValidationMatcher	General validation matcher interface.
ValidationMatcherLibrary	Library holding a set of validation matchers.
ValidationMatcherRegistry	ValidationMatcher registry holding all available validation matcher libraries.
ValidationMatcherUtils	Utility class for validation matchers.
ValidationProcessor	Callback called by receive message action for validation purpose.
ValueMatcher
VariableExpressionIterator	This Iterator uses a regular expression pattern to match individual segments of a variableExpression.
VariableExpressionIterator.VariableSegment
VariableExpressionSegmentMatcher	Matcher that matches segments of variable expressions.
VariableExtractor	Class extracting variables form messages.
VariableExtractor.Builder<T extends VariableExtractor,B extends VariableExtractor.Builder<T,B>>	Fluent builder
VariableExtractorAdapter	Adapter interface marks that a class is able to act as a variable extractor.
VariableNullValueException	Variable value evaluates to null.
VariableUtils	Utility class manipulating test variables.
WithExpressions<B>
WithHeaderBuilder
WithPayloadBuilder
XmlNamespaceAware