org.apache.camel

Interface ComponentVerifier

All Known Implementing Classes:

DefaultComponentVerifier, RestComponentVerifier

public interface ComponentVerifier

Defines the interface used for validating component/endpoint parameters. The central method of this interface is verify(Scope, Map) which takes a scope and a set of parameters which should be verified.

The return value is a ComponentVerifier.Result of the verification

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ComponentVerifier.Result The result of a verification
static class	ComponentVerifier.Scope The scope defines how the parameters should be verified.
static interface	ComponentVerifier.VerificationError This interface represents a detailed error in case when the verification fails.

Method Summary

Modifier and Type	Method and Description
ComponentVerifier.Result	verify(ComponentVerifier.Scope scope, Map<String,Object> parameters) Verify the given parameters against a provided scope.

Method Detail

verify

ComponentVerifier.Result verify(ComponentVerifier.Scope scope,
                                Map<String,Object> parameters)

Verify the given parameters against a provided scope.

The supported scopes are:

• ComponentVerifier.Scope.PARAMETERS: to validate that all the mandatory options are provided and syntactically correct.
• ComponentVerifier.Scope.CONNECTIVITY: to validate that the given options (i.e. credentials, addresses) are correct. Verifying with this scope typically implies reaching out to the backend via some sort of network connection.

Parameters:

scope - the scope of the verification

parameters - the parameters to verify which are interpreted individually by each component verifier

Returns:

the verification result