org.apache.camel.runtimecatalog

Interface RuntimeCamelCatalog

All Superinterfaces:

Service, StaticService

public interface RuntimeCamelCatalog
extends StaticService

Runtime based CamelCatalog which are included in camel-core that can provided limit CamelCatalog capabilities

Method Summary

Modifier and Type	Method and Description
String	asEndpointUri(String scheme, Map<String,String> properties, boolean encode) Creates an endpoint uri in Java style from the information from the properties
String	asEndpointUriXml(String scheme, Map<String,String> properties, boolean encode) Creates an endpoint uri in XML style (eg escape & as &l;) from the information from the properties
String	componentJSonSchema(String name) Returns the component information as JSon format.
String	dataFormatJSonSchema(String name) Returns the data format information as JSon format.
String	endpointComponentName(String uri) Returns the component name from the given endpoint uri
Map<String,String>	endpointLenientProperties(String uri) Parses the endpoint uri and constructs a key/value properties of only the lenient properties (eg custom options) For example using the HTTP components to provide query parameters in the endpoint uri.
Map<String,String>	endpointProperties(String uri) Parses the endpoint uri and constructs a key/value properties of each option
JSonSchemaResolver	getJSonSchemaResolver() Gets the JSonSchemaResolver.
String	languageJSonSchema(String name) Returns the language information as JSon format.
String	modelJSonSchema(String name) Returns the model information as JSon format.
void	setJSonSchemaResolver(JSonSchemaResolver resolver) To use a custom JSonSchemaResolver
EndpointValidationResult	validateEndpointProperties(String uri) Parses and validates the endpoint uri and constructs a key/value properties of each option.
EndpointValidationResult	validateEndpointProperties(String uri, boolean ignoreLenientProperties) Parses and validates the endpoint uri and constructs a key/value properties of each option.
EndpointValidationResult	validateEndpointProperties(String uri, boolean ignoreLenientProperties, boolean consumerOnly, boolean producerOnly) Parses and validates the endpoint uri and constructs a key/value properties of each option.
LanguageValidationResult	validateLanguageExpression(ClassLoader classLoader, String language, String text) Parses and validates the language as an expression Important: This requires having camel-core and the language dependencies on the classpath
LanguageValidationResult	validateLanguagePredicate(ClassLoader classLoader, String language, String text) Parses and validates the language as a predicate Important: This requires having camel-core and the language dependencies on the classpath
EndpointValidationResult	validateProperties(String scheme, Map<String,String> properties) Validates the properties for the given scheme against component and endpoint
boolean	validateTimePattern(String pattern) Validates the pattern whether its a valid time pattern.

Methods inherited from interface org.apache.camel.Service

init, start, stop

Method Detail

getJSonSchemaResolver

JSonSchemaResolver getJSonSchemaResolver()

Gets the JSonSchemaResolver.

setJSonSchemaResolver

void setJSonSchemaResolver(JSonSchemaResolver resolver)

To use a custom JSonSchemaResolver

componentJSonSchema

String componentJSonSchema(String name)

Returns the component information as JSon format.

Parameters:

name - the component name

Returns:

component details in JSon

dataFormatJSonSchema

String dataFormatJSonSchema(String name)

Returns the data format information as JSon format.

Parameters:

name - the data format name

Returns:

data format details in JSon

languageJSonSchema

String languageJSonSchema(String name)

Returns the language information as JSon format.

Parameters:

name - the language name

Returns:

language details in JSon

modelJSonSchema

String modelJSonSchema(String name)

Returns the model information as JSon format.

Parameters:

name - the model name

Returns:

model details in JSon

endpointProperties

Map<String,String> endpointProperties(String uri)
                               throws URISyntaxException

Parses the endpoint uri and constructs a key/value properties of each option

Parameters:

uri - the endpoint uri

Returns:

properties as key value pairs of each endpoint option

Throws:

URISyntaxException

endpointLenientProperties

Map<String,String> endpointLenientProperties(String uri)
                                      throws URISyntaxException

Parses the endpoint uri and constructs a key/value properties of only the lenient properties (eg custom options)

For example using the HTTP components to provide query parameters in the endpoint uri.

Parameters:

uri - the endpoint uri

Returns:

properties as key value pairs of each lenient properties

Throws:

URISyntaxException

validateTimePattern

boolean validateTimePattern(String pattern)

Validates the pattern whether its a valid time pattern.

Parameters:

pattern - the pattern such as 5000, 5s, 5sec, 4min, 4m30s, 1h, etc.

Returns:

true if valid, false if invalid

validateProperties

EndpointValidationResult validateProperties(String scheme,
                                            Map<String,String> properties)

Validates the properties for the given scheme against component and endpoint

Parameters:

scheme - the endpoint scheme

properties - the endpoint properties

Returns:

validation result

validateEndpointProperties

EndpointValidationResult validateEndpointProperties(String uri)

Parses and validates the endpoint uri and constructs a key/value properties of each option.

Parameters:

uri - the endpoint uri

Returns:

validation result

validateEndpointProperties

EndpointValidationResult validateEndpointProperties(String uri,
                                                    boolean ignoreLenientProperties)

Parses and validates the endpoint uri and constructs a key/value properties of each option.

The option ignoreLenientProperties can be used to ignore components that uses lenient properties. When this is true, then the uri validation is stricter but would fail on properties that are not part of the component but in the uri because of using lenient properties. For example using the HTTP components to provide query parameters in the endpoint uri.

Parameters:

uri - the endpoint uri

ignoreLenientProperties - whether to ignore components that uses lenient properties.

Returns:

validation result

validateEndpointProperties

EndpointValidationResult validateEndpointProperties(String uri,
                                                    boolean ignoreLenientProperties,
                                                    boolean consumerOnly,
                                                    boolean producerOnly)

Parses and validates the endpoint uri and constructs a key/value properties of each option.

The option ignoreLenientProperties can be used to ignore components that uses lenient properties. When this is true, then the uri validation is stricter but would fail on properties that are not part of the component but in the uri because of using lenient properties. For example using the HTTP components to provide query parameters in the endpoint uri.

Parameters:

uri - the endpoint uri

ignoreLenientProperties - whether to ignore components that uses lenient properties.

consumerOnly - whether the endpoint is only used as a consumer

producerOnly - whether the endpoint is only used as a producer

Returns:

validation result

validateLanguagePredicate

LanguageValidationResult validateLanguagePredicate(ClassLoader classLoader,
                                                   String language,
                                                   String text)

Parses and validates the language as a predicate

Important: This requires having camel-core and the language dependencies on the classpath

Parameters:

classLoader - a custom classloader to use for loading the language from the classpath, or null for using default classloader

language - the name of the language

text - the predicate text

Returns:

validation result

validateLanguageExpression

LanguageValidationResult validateLanguageExpression(ClassLoader classLoader,
                                                    String language,
                                                    String text)

Parses and validates the language as an expression

Important: This requires having camel-core and the language dependencies on the classpath

Parameters:

classLoader - a custom classloader to use for loading the language from the classpath, or null for using default classloader

language - the name of the language

text - the expression text

Returns:

validation result

endpointComponentName

String endpointComponentName(String uri)

Returns the component name from the given endpoint uri

Parameters:

uri - the endpoint uri

Returns:

the component name (aka scheme), or null if not possible to determine

asEndpointUri

String asEndpointUri(String scheme,
                     Map<String,String> properties,
                     boolean encode)
              throws URISyntaxException

Creates an endpoint uri in Java style from the information from the properties

Parameters:

scheme - the endpoint schema

properties - the properties as key value pairs

encode - whether to URL encode the returned uri or not

Returns:

the constructed endpoint uri

Throws:

URISyntaxException - is thrown if there is encoding error

asEndpointUriXml

String asEndpointUriXml(String scheme,
                        Map<String,String> properties,
                        boolean encode)
                 throws URISyntaxException

Creates an endpoint uri in XML style (eg escape & as &l;) from the information from the properties

Parameters:

scheme - the endpoint schema

properties - the properties as key value pairs

encode - whether to URL encode the returned uri or not

Returns:

the constructed endpoint uri

Throws:

URISyntaxException - is thrown if there is encoding error