Interface ComponentVerifierExtension
- All Superinterfaces:
ComponentExtension
Defines the interface used for validating component/endpoint parameters. The central method of this interface is
verify(ComponentVerifierExtension.Scope, Map)
which takes a scope and a set of parameters which should be
verified.
The return value is a ComponentVerifierExtension.Result
of the verification-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The result of a verificationstatic enum
The scope defines how the parameters should be verified.static interface
This interface represents a detailed error in case when the verification fails. -
Method Summary
Modifier and TypeMethodDescriptionverify
(ComponentVerifierExtension.Scope scope, Map<String, Object> parameters) Verify the given parameters against a provided scope.Methods inherited from interface org.apache.camel.component.extension.ComponentExtension
unwrap
-
Method Details
-
verify
ComponentVerifierExtension.Result verify(ComponentVerifierExtension.Scope scope, Map<String, Object> parameters) Verify the given parameters against a provided scope.The supported scopes are:
ComponentVerifierExtension.Scope.PARAMETERS
: to validate that all the mandatory options are provided and syntactically correct.ComponentVerifierExtension.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 verificationparameters
- the parameters to verify which are interpreted individually by each component verifier- Returns:
- the verification result
-