org.apache.camel.component.extension.verifier

Class DefaultComponentVerifierExtension

java.lang.Object

org.apache.camel.component.extension.verifier.DefaultComponentVerifierExtension

All Implemented Interfaces:

CamelContextAware, ComponentExtension, ComponentVerifierExtension, ComponentAware, ComponentVerifier

Direct Known Subclasses:

RestComponentVerifierExtension

public class DefaultComponentVerifierExtension
extends Object
implements ComponentVerifierExtension, ComponentVerifier, CamelContextAware, ComponentAware

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.component.extension.ComponentVerifierExtension

ComponentVerifierExtension.Result, ComponentVerifierExtension.Scope, ComponentVerifierExtension.VerificationError

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultComponentVerifierExtension(String defaultScheme)
protected	DefaultComponentVerifierExtension(String defaultScheme, CamelContext camelContext)
protected	DefaultComponentVerifierExtension(String defaultScheme, CamelContext camelContext, Component component)

Method Summary

Modifier and Type	Method and Description
CamelContext	getCamelContext() Get the CamelContext
Component	getComponent() Get the Component
protected <T> T	getMandatoryOption(Map<String,Object> parameters, String key, Class<T> type)
protected <T> Optional<T>	getOption(Map<String,Object> parameters, String key, Class<T> type)
protected <T> T	getOption(Map<String,Object> parameters, String key, Class<T> type, Supplier<T> defaultSupplier)
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setComponent(Component component) Injects the Component
protected <T> T	setProperties(T instance, Map<String,Object> properties)
protected <T> T	setProperties(T instance, String prefix, Map<String,Object> properties)
ComponentVerifierExtension.Result	verify(ComponentVerifierExtension.Scope scope, Map<String,Object> parameters) Verify the given parameters against a provided scope.
protected ComponentVerifierExtension.Result	verifyConnectivity(Map<String,Object> parameters)
protected ComponentVerifierExtension.Result	verifyParameters(Map<String,Object> parameters)
protected void	verifyParametersAgainstCatalog(ResultBuilder builder, Map<String,Object> parameters)
protected void	verifyParametersAgainstCatalog(ResultBuilder builder, Map<String,Object> parameters, CatalogVerifierCustomizer customizer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.component.extension.ComponentExtension

unwrap

Methods inherited from interface org.apache.camel.ComponentAware

getComponent

Constructor Detail

DefaultComponentVerifierExtension

protected DefaultComponentVerifierExtension(String defaultScheme)

DefaultComponentVerifierExtension

protected DefaultComponentVerifierExtension(String defaultScheme,
                                            CamelContext camelContext)

DefaultComponentVerifierExtension

protected DefaultComponentVerifierExtension(String defaultScheme,
                                            CamelContext camelContext,
                                            Component component)

Method Detail

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

getComponent

public Component getComponent()

Description copied from interface: ComponentAware

Get the Component

Specified by:

getComponent in interface ComponentAware

Returns:

the component

setComponent

public void setComponent(Component component)

Description copied from interface: ComponentAware

Injects the Component

Specified by:

setComponent in interface ComponentAware

Parameters:

component - the component

verify

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

Description copied from interface: ComponentVerifierExtension

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.

Specified by:

verify in interface ComponentVerifierExtension

Parameters:

scope - the scope of the verification

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

Returns:

the verification result

verifyConnectivity

protected ComponentVerifierExtension.Result verifyConnectivity(Map<String,Object> parameters)

verifyParameters

protected ComponentVerifierExtension.Result verifyParameters(Map<String,Object> parameters)

verifyParametersAgainstCatalog

protected void verifyParametersAgainstCatalog(ResultBuilder builder,
                                              Map<String,Object> parameters)

verifyParametersAgainstCatalog

protected void verifyParametersAgainstCatalog(ResultBuilder builder,
                                              Map<String,Object> parameters,
                                              CatalogVerifierCustomizer customizer)

setProperties

protected <T> T setProperties(T instance,
                              Map<String,Object> properties)
                       throws Exception

Throws:

Exception

setProperties

protected <T> T setProperties(T instance,
                              String prefix,
                              Map<String,Object> properties)
                       throws Exception

Throws:

Exception

getOption

protected <T> Optional<T> getOption(Map<String,Object> parameters,
                                    String key,
                                    Class<T> type)

getOption

protected <T> T getOption(Map<String,Object> parameters,
                          String key,
                          Class<T> type,
                          Supplier<T> defaultSupplier)

getMandatoryOption

protected <T> T getMandatoryOption(Map<String,Object> parameters,
                                   String key,
                                   Class<T> type)
                            throws NoSuchOptionException

Throws:

NoSuchOptionException