@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 |
addComponent(String name,
String className,
String jsonSchema)
Adds a 3rd party component to this catalog.
|
void |
addDataFormat(String name,
String className)
Adds a 3rd party data format to this catalog.
|
void |
addDataFormat(String name,
String className,
String jsonSchema)
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)
Deprecated.
|
String |
asEndpointUriXml(String scheme,
Map<String,String> properties,
boolean encode)
Creates an endpoint uri in XML style from the information from the properties
|
String |
asEndpointUriXml(String scheme,
String json,
boolean encode)
Deprecated.
|
String |
blueprintSchemaAsXml()
Returns the Camel Blueprint XML schema
|
String |
componentAsciiDoc(String name)
Returns the component documentation as Ascii doc format.
|
String |
componentHtmlDoc(String name)
Returns the component documentation as HTML format.
|
String |
componentJSonSchema(String name)
Returns the component information as JSon format.
|
String |
dataFormatAsciiDoc(String name)
Returns the data format documentation as Ascii doc format.
|
String |
dataFormatHtmlDoc(String name)
Returns the data format documentation as HTML 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> |
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
|
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 languages 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
|
Set<String> |
findOtherLabels()
Find all the unique label names all the other (miscellaneous) are using.
|
List<String> |
findOtherNames()
Find all the other (miscellaneous) names from the Camel catalog
|
List<String> |
findOtherNames(String filter)
Find all the other (miscellaneous) names from the Camel catalog that matches the label
|
String |
getCatalogVersion()
The version of this Camel Catalog
|
JSonSchemaResolver |
getJSonSchemaResolver()
Returns the
JSonSchemaResolver used by this catalog. |
String |
getLoadedVersion()
Gets the current loaded Camel version used by the catalog.
|
RuntimeProvider |
getRuntimeProvider()
Gets the
RuntimeProvider in use. |
String |
getRuntimeProviderLoadedVersion()
Gets the current loaded runtime provider version used by the catalog.
|
SuggestionStrategy |
getSuggestionStrategy()
Gets the
SuggestionStrategy in use |
VersionManager |
getVersionManager()
Gets the
VersionManager in use |
boolean |
isCaching()
Whether caching has been enabled.
|
String |
languageAsciiDoc(String name)
Returns the language documentation as Ascii doc format.
|
String |
languageHtmlDoc(String name)
Returns the language documentation as HTML format.
|
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 |
listOthersAsJson()
Lists all the others (miscellaneous) summary details in JSon
|
boolean |
loadRuntimeProviderVersion(String groupId,
String artifactId,
String version)
Attempt to load the runtime provider version to be used by the catalog.
|
boolean |
loadVersion(String version)
Attempt to load the Camel version to be used by the catalog.
|
String |
modelJSonSchema(String name)
Returns the model information as JSon format.
|
String |
otherAsciiDoc(String name)
Returns the other (miscellaneous) documentation as Ascii doc format.
|
String |
otherHtmlDoc(String name)
Returns the other (miscellaneous) documentation as HTML format.
|
String |
otherJSonSchema(String name)
Returns the other (miscellaneous) information as JSon format.
|
void |
setJSonSchemaResolver(JSonSchemaResolver resolver)
To use a custom
JSonSchemaResolver with this catalog. |
void |
setRuntimeProvider(RuntimeProvider provider)
To plugin a custom
RuntimeProvider that amends the catalog to only include information that is supported on the runtime. |
void |
setSuggestionStrategy(SuggestionStrategy suggestionStrategy)
To plugin a custom
SuggestionStrategy to provide suggestion for unknown options |
void |
setVersionManager(VersionManager versionManager)
To plugin a custom
VersionManager to load other versions of Camel the catalog should use. |
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.
|
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
|
SimpleValidationResult |
validateSimpleExpression(ClassLoader classLoader,
String simple)
Parses and validates the simple expression.
|
SimpleValidationResult |
validateSimpleExpression(String simple)
Deprecated.
|
SimpleValidationResult |
validateSimplePredicate(ClassLoader classLoader,
String simple)
Parses and validates the simple predicate
Important: This requires having camel-core on the classpath
|
SimpleValidationResult |
validateSimplePredicate(String simple)
Deprecated.
|
boolean |
validateTimePattern(String pattern)
Validates the pattern whether its a valid time pattern.
|
JSonSchemaResolver getJSonSchemaResolver()
JSonSchemaResolver
used by this catalog.void setJSonSchemaResolver(JSonSchemaResolver resolver)
JSonSchemaResolver
with this catalog.resolver
- the custom resolvervoid setRuntimeProvider(RuntimeProvider provider)
RuntimeProvider
that amends the catalog to only include information that is supported on the runtime.RuntimeProvider getRuntimeProvider()
RuntimeProvider
in use.void enableCache()
boolean isCaching()
void setSuggestionStrategy(SuggestionStrategy suggestionStrategy)
SuggestionStrategy
to provide suggestion for unknown optionsSuggestionStrategy getSuggestionStrategy()
SuggestionStrategy
in usevoid setVersionManager(VersionManager versionManager)
VersionManager
to load other versions of Camel the catalog should use.VersionManager getVersionManager()
VersionManager
in usevoid addComponent(String name, String className)
name
- the component nameclassName
- the fully qualified class name for the component classvoid addComponent(String name, String className, String jsonSchema)
name
- the component nameclassName
- the fully qualified class name for the component classjsonSchema
- the component JSon schemavoid addDataFormat(String name, String className)
name
- the data format nameclassName
- the fully qualified class name for the data format classvoid addDataFormat(String name, String className, String jsonSchema)
name
- the data format nameclassName
- the fully qualified class name for the data format classjsonSchema
- the data format JSon schemaString getCatalogVersion()
boolean loadVersion(String version)
loadVersion(String)
.version
- the Camel version such as 2.17.1String getLoadedVersion()
String getRuntimeProviderLoadedVersion()
boolean loadRuntimeProviderVersion(String groupId, String artifactId, String version)
loadVersion(String)
.groupId
- the runtime provider Maven groupIdartifactId
- the runtime provider Maven artifactIdversion
- the runtime provider Maven versionList<String> findComponentNames()
List<String> findDataFormatNames()
List<String> findLanguageNames()
List<String> findOtherNames()
List<String> findComponentNames(String filter)
List<String> findDataFormatNames(String filter)
List<String> findLanguageNames(String filter)
List<String> findModelNames(String filter)
List<String> findOtherNames(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 otherJSonSchema(String name)
name
- the other (miscellaneous) nameString modelJSonSchema(String name)
name
- the model nameString componentAsciiDoc(String name)
name
- the component nameString componentHtmlDoc(String name)
name
- the component nameString dataFormatAsciiDoc(String name)
name
- the data format nameString dataFormatHtmlDoc(String name)
name
- the data format nameString languageAsciiDoc(String name)
name
- the language nameString languageHtmlDoc(String name)
name
- the language nameString otherAsciiDoc(String name)
name
- the other (miscellaneous) nameString otherHtmlDoc(String name)
name
- the other (miscellaneous) nameSet<String> findComponentLabels()
Set<String> findDataFormatLabels()
Set<String> findLanguageLabels()
Set<String> findModelLabels()
Set<String> findOtherLabels()
String archetypeCatalogAsXml()
String springSchemaAsXml()
String blueprintSchemaAsXml()
Map<String,String> endpointProperties(String uri) throws URISyntaxException
uri
- the endpoint uriURISyntaxException
Map<String,String> endpointLenientProperties(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.EndpointValidationResult validateEndpointProperties(String uri, boolean ignoreLenientProperties, boolean consumerOnly, boolean producerOnly)
uri
- the endpoint uriignoreLenientProperties
- whether to ignore components that uses lenient properties.consumerOnly
- whether the endpoint is only used as a consumerproducerOnly
- whether the endpoint is only used as a producer@Deprecated SimpleValidationResult validateSimpleExpression(String simple)
validateSimpleExpression(ClassLoader, String)
simple
- the simple expressionSimpleValidationResult validateSimpleExpression(ClassLoader classLoader, String simple)
classLoader
- a custom classloader to use for loading the language from the classpath, or null for using default classloadersimple
- the simple expression@Deprecated SimpleValidationResult validateSimplePredicate(String simple)
validateSimplePredicate(ClassLoader, String)
simple
- the simple predicateSimpleValidationResult validateSimplePredicate(ClassLoader classLoader, String simple)
classLoader
- a custom classloader to use for loading the language from the classpath, or null for using default classloadersimple
- the simple predicateLanguageValidationResult validateLanguagePredicate(ClassLoader classLoader, String language, String text)
classLoader
- a custom classloader to use for loading the language from the classpath, or null for using default classloaderlanguage
- the name of the languagetext
- the predicate textLanguageValidationResult validateLanguageExpression(ClassLoader classLoader, String language, String text)
classLoader
- a custom classloader to use for loading the language from the classpath, or null for using default classloaderlanguage
- the name of the languagetext
- the expression textString endpointComponentName(String uri)
uri
- the endpoint uri@Deprecated String 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 error@Deprecated String 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 listOthersAsJson()
String summaryAsJson()
Apache Camel