@MXBean public interface CamelCatalog
Modifier and Type | Method and Description |
---|---|
void |
addComponent(String name,
String className)
Adds a 3rd party component to this catalog.
|
void |
addDataFormat(String name,
String className)
Adds a 3rd party data format to this catalog.
|
String |
archetypeCatalogAsXml()
Returns the Apache Camel Maven Archetype catalog in XML format.
|
String |
asEndpointUri(String scheme,
Map<String,String> properties,
boolean encode)
Creates an endpoint uri in Java style from the information from the properties
|
String |
asEndpointUri(String scheme,
String json,
boolean encode)
Creates an endpoint uri in Java style from the information in the json schema
|
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 |
asEndpointUriXml(String scheme,
String json,
boolean encode)
Creates an endpoint uri in XML style (eg escape & as &l;) from the information in the json schema
|
String |
blueprintSchemaAsXml()
Returns the Camel Blueprint XML schema
|
String |
componentJSonSchema(String name)
Returns the component information as JSon format.
|
String |
dataFormatJSonSchema(String name)
Returns the data format information as JSon format.
|
void |
enableCache()
Enables caching of the resources which makes the catalog faster, but keeps data in memory during caching.
|
String |
endpointComponentName(String uri)
Returns the component name from the given endpoint uri
|
Map<String,String> |
endpointProperties(String uri)
Parses the endpoint uri and constructs a key/value properties of each option
|
Set<String> |
findComponentLabels()
Find all the unique label names all the components are using.
|
List<String> |
findComponentNames()
Find all the component names from the Camel catalog
|
List<String> |
findComponentNames(String filter)
Find all the component names from the Camel catalog that matches the label
|
Set<String> |
findDataFormatLabels()
Find all the unique label names all the data formats are using.
|
List<String> |
findDataFormatNames()
Find all the data format names from the Camel catalog
|
List<String> |
findDataFormatNames(String filter)
Find all the data format names from the Camel catalog that matches the label
|
Set<String> |
findLanguageLabels()
Find all the unique label names all the data formats are using.
|
List<String> |
findLanguageNames()
Find all the language names from the Camel catalog
|
List<String> |
findLanguageNames(String filter)
Find all the language names from the Camel catalog that matches the label
|
Set<String> |
findModelLabels()
Find all the unique label names all the models are using.
|
List<String> |
findModelNames()
Find all the model names from the Camel catalog
|
List<String> |
findModelNames(String filter)
Find all the model names from the Camel catalog that matches the label
|
String |
getCatalogVersion()
The version of this Camel Catalog
|
String |
languageJSonSchema(String name)
Returns the language information as JSon format.
|
String |
listComponentsAsJson()
Lists all the components summary details in JSon
|
String |
listDataFormatsAsJson()
Lists all the data formats summary details in JSon
|
String |
listLanguagesAsJson()
Lists all the languages summary details in JSon
|
String |
listModelsAsJson()
Lists all the models (EIPs) summary details in JSon
|
String |
modelJSonSchema(String name)
Returns the model information as JSon format.
|
void |
setSuggestionStrategy(SuggestionStrategy suggestionStrategy)
To plugin a custom
SuggestionStrategy to provide suggestion for unknown options |
String |
springSchemaAsXml()
Returns the Camel Spring XML schema
|
String |
summaryAsJson()
Reports a summary what the catalog contains in JSon
|
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.
|
SimpleValidationResult |
validateSimpleExpression(String simple)
Parses and validates the simple expression.
|
SimpleValidationResult |
validateSimplePredicate(String simple)
Parses and validates the simple predicate
Important: This requires having camel-core on the classpath
|
boolean |
validateTimePattern(String pattern)
Validates the pattern whether its a valid time pattern.
|
void enableCache()
void setSuggestionStrategy(SuggestionStrategy suggestionStrategy)
SuggestionStrategy
to provide suggestion for unknown optionsvoid addComponent(String name, String className)
name
- the component nameclassName
- the fully qualified class name for the component classvoid addDataFormat(String name, String className)
name
- the data format nameclassName
- the fully qualified class name for the data format classString getCatalogVersion()
List<String> findComponentNames()
List<String> findDataFormatNames()
List<String> findLanguageNames()
List<String> findComponentNames(String filter)
List<String> findDataFormatNames(String filter)
List<String> findLanguageNames(String filter)
List<String> findModelNames(String filter)
String componentJSonSchema(String name)
name
- the component nameString dataFormatJSonSchema(String name)
name
- the data format nameString languageJSonSchema(String name)
name
- the language nameString modelJSonSchema(String name)
name
- the model nameSet<String> findComponentLabels()
Set<String> findDataFormatLabels()
Set<String> findLanguageLabels()
Set<String> findModelLabels()
String archetypeCatalogAsXml()
String springSchemaAsXml()
String blueprintSchemaAsXml()
Map<String,String> endpointProperties(String uri) throws URISyntaxException
uri
- the endpoint uriURISyntaxException
boolean validateTimePattern(String pattern)
pattern
- the pattern such as 5000, 5s, 5sec, 4min, 4m30s, 1h, etc.EndpointValidationResult validateEndpointProperties(String uri)
uri
- the endpoint uriEndpointValidationResult validateEndpointProperties(String uri, boolean ignoreLenientProperties)
uri
- the endpoint uriignoreLenientProperties
- whether to ignore components that uses lenient properties.SimpleValidationResult validateSimpleExpression(String simple)
simple
- the simple expressionSimpleValidationResult validateSimplePredicate(String simple)
simple
- the simple predicateString endpointComponentName(String uri)
uri
- the endpoint uriString asEndpointUri(String scheme, String json, boolean encode) throws URISyntaxException
scheme
- the endpoint schemajson
- the json schema with the endpoint propertiesencode
- whether to URL encode the returned uri or notURISyntaxException
- is thrown if there is encoding errorString asEndpointUriXml(String scheme, String json, boolean encode) throws URISyntaxException
scheme
- the endpoint schemajson
- the json schema with the endpoint propertiesencode
- whether to URL encode the returned uri or notURISyntaxException
- is thrown if there is encoding errorString asEndpointUri(String scheme, Map<String,String> properties, boolean encode) throws URISyntaxException
scheme
- the endpoint schemaproperties
- the properties as key value pairsencode
- whether to URL encode the returned uri or notURISyntaxException
- is thrown if there is encoding errorString asEndpointUriXml(String scheme, Map<String,String> properties, boolean encode) throws URISyntaxException
scheme
- the endpoint schemaproperties
- the properties as key value pairsencode
- whether to URL encode the returned uri or notURISyntaxException
- is thrown if there is encoding errorString listComponentsAsJson()
String listDataFormatsAsJson()
String listLanguagesAsJson()
String listModelsAsJson()
String summaryAsJson()
Apache Camel