org.apache.camel.catalog

Class DefaultCamelCatalog

java.lang.Object

org.apache.camel.catalog.AbstractCamelCatalog

org.apache.camel.catalog.DefaultCamelCatalog

All Implemented Interfaces:

CamelCatalog

public class DefaultCamelCatalog
extends AbstractCamelCatalog
implements CamelCatalog

Default CamelCatalog.

Constructor Summary

Constructors

Constructor and Description
DefaultCamelCatalog() Creates the CamelCatalog without caching enabled.
DefaultCamelCatalog(boolean caching) Creates the CamelCatalog

Method Summary

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	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.
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
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.
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	setRuntimeProvider(RuntimeProvider runtimeProvider) To plugin a custom RuntimeProvider that amends the catalog to only include information that is supported on the runtime.
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

Methods inherited from class org.apache.camel.catalog.AbstractCamelCatalog

asEndpointUri, asEndpointUri, asEndpointUriXml, asEndpointUriXml, endpointComponentName, endpointLenientProperties, endpointProperties, getJSonSchemaResolver, getSuggestionStrategy, setJSonSchemaResolver, setSuggestionStrategy, validateEndpointProperties, validateEndpointProperties, validateEndpointProperties, validateLanguageExpression, validateLanguagePredicate, validateProperties, validateSimpleExpression, validateSimpleExpression, validateSimplePredicate, validateSimplePredicate, validateTimePattern

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.catalog.CamelCatalog

asEndpointUri, asEndpointUri, asEndpointUriXml, asEndpointUriXml, endpointComponentName, endpointLenientProperties, endpointProperties, getJSonSchemaResolver, getSuggestionStrategy, setJSonSchemaResolver, setSuggestionStrategy, validateEndpointProperties, validateEndpointProperties, validateEndpointProperties, validateLanguageExpression, validateLanguagePredicate, validateSimpleExpression, validateSimpleExpression, validateSimplePredicate, validateSimplePredicate, validateTimePattern

Constructor Detail

DefaultCamelCatalog

public DefaultCamelCatalog()

Creates the CamelCatalog without caching enabled.

DefaultCamelCatalog

public DefaultCamelCatalog(boolean caching)

Creates the CamelCatalog

Parameters:

caching - whether to use cache

Method Detail

getRuntimeProvider

public RuntimeProvider getRuntimeProvider()

Description copied from interface: CamelCatalog

Gets the RuntimeProvider in use.

Specified by:

getRuntimeProvider in interface CamelCatalog

setRuntimeProvider

public void setRuntimeProvider(RuntimeProvider runtimeProvider)

Description copied from interface: CamelCatalog

To plugin a custom RuntimeProvider that amends the catalog to only include information that is supported on the runtime.

Specified by:

setRuntimeProvider in interface CamelCatalog

enableCache

public void enableCache()

Description copied from interface: CamelCatalog

Enables caching of the resources which makes the catalog faster, but keeps data in memory during caching.

The catalog does not cache by default.

Specified by:

enableCache in interface CamelCatalog

isCaching

public boolean isCaching()

Description copied from interface: CamelCatalog

Whether caching has been enabled.

Specified by:

isCaching in interface CamelCatalog

setVersionManager

public void setVersionManager(VersionManager versionManager)

Description copied from interface: CamelCatalog

To plugin a custom VersionManager to load other versions of Camel the catalog should use.

Specified by:

setVersionManager in interface CamelCatalog

getVersionManager

public VersionManager getVersionManager()

Description copied from interface: CamelCatalog

Gets the VersionManager in use

Specified by:

getVersionManager in interface CamelCatalog

addComponent

public void addComponent(String name,
                         String className)

Description copied from interface: CamelCatalog

Adds a 3rd party component to this catalog.

Specified by:

addComponent in interface CamelCatalog

Parameters:

name - the component name

className - the fully qualified class name for the component class

addComponent

public void addComponent(String name,
                         String className,
                         String jsonSchema)

Description copied from interface: CamelCatalog

Adds a 3rd party component to this catalog.

Specified by:

addComponent in interface CamelCatalog

Parameters:

name - the component name

className - the fully qualified class name for the component class

jsonSchema - the component JSon schema

addDataFormat

public void addDataFormat(String name,
                          String className)

Description copied from interface: CamelCatalog

Adds a 3rd party data format to this catalog.

Specified by:

addDataFormat in interface CamelCatalog

Parameters:

name - the data format name

className - the fully qualified class name for the data format class

addDataFormat

public void addDataFormat(String name,
                          String className,
                          String jsonSchema)

Description copied from interface: CamelCatalog

Adds a 3rd party data format to this catalog.

Specified by:

addDataFormat in interface CamelCatalog

Parameters:

name - the data format name

className - the fully qualified class name for the data format class

jsonSchema - the data format JSon schema

getCatalogVersion

public String getCatalogVersion()

Description copied from interface: CamelCatalog

The version of this Camel Catalog

Specified by:

getCatalogVersion in interface CamelCatalog

loadVersion

public boolean loadVersion(String version)

Description copied from interface: CamelCatalog

Attempt to load the Camel version to be used by the catalog.

Loading the camel-catalog JAR of the given version of choice may require internet access to download the JAR from Maven central. You can pre download the JAR and install in a local Maven repository to avoid internet access for offline environments.

When loading a new version the cache will be invalidated.

Important: When loading a new runtime provider version, then its strongly advised to load the same/corresponding version first using CamelCatalog.loadVersion(String).

Specified by:

loadVersion in interface CamelCatalog

Parameters:

version - the Camel version such as 2.17.1

Returns:

true if the version was loaded, false if not.

getLoadedVersion

public String getLoadedVersion()

Description copied from interface: CamelCatalog

Gets the current loaded Camel version used by the catalog.

Specified by:

getLoadedVersion in interface CamelCatalog

getRuntimeProviderLoadedVersion

public String getRuntimeProviderLoadedVersion()

Description copied from interface: CamelCatalog

Gets the current loaded runtime provider version used by the catalog.

Specified by:

getRuntimeProviderLoadedVersion in interface CamelCatalog

loadRuntimeProviderVersion

public boolean loadRuntimeProviderVersion(String groupId,
                                          String artifactId,
                                          String version)

Description copied from interface: CamelCatalog

Attempt to load the runtime provider version to be used by the catalog.

Loading the runtime provider JAR of the given version of choice may require internet access to download the JAR from Maven central. You can pre download the JAR and install in a local Maven repository to avoid internet access for offline environments.

Important: When loading a new runtime provider version, then its strongly advised to load the same/corresponding version first using CamelCatalog.loadVersion(String).

Specified by:

loadRuntimeProviderVersion in interface CamelCatalog

Parameters:

groupId - the runtime provider Maven groupId

artifactId - the runtime provider Maven artifactId

version - the runtime provider Maven version

Returns:

true if the version was loaded, false if not.

findComponentNames

public List<String> findComponentNames()

Description copied from interface: CamelCatalog

Find all the component names from the Camel catalog

Specified by:

findComponentNames in interface CamelCatalog

findDataFormatNames

public List<String> findDataFormatNames()

Description copied from interface: CamelCatalog

Find all the data format names from the Camel catalog

Specified by:

findDataFormatNames in interface CamelCatalog

findLanguageNames

public List<String> findLanguageNames()

Description copied from interface: CamelCatalog

Find all the language names from the Camel catalog

Specified by:

findLanguageNames in interface CamelCatalog

findModelNames

public List<String> findModelNames()

Description copied from interface: CamelCatalog

Find all the model names from the Camel catalog

Specified by:

findModelNames in interface CamelCatalog

findOtherNames

public List<String> findOtherNames()

Description copied from interface: CamelCatalog

Find all the other (miscellaneous) names from the Camel catalog

Specified by:

findOtherNames in interface CamelCatalog

findModelNames

public List<String> findModelNames(String filter)

Description copied from interface: CamelCatalog

Find all the model names from the Camel catalog that matches the label

Specified by:

findModelNames in interface CamelCatalog

findComponentNames

public List<String> findComponentNames(String filter)

Description copied from interface: CamelCatalog

Find all the component names from the Camel catalog that matches the label

Specified by:

findComponentNames in interface CamelCatalog

findDataFormatNames

public List<String> findDataFormatNames(String filter)

Description copied from interface: CamelCatalog

Find all the data format names from the Camel catalog that matches the label

Specified by:

findDataFormatNames in interface CamelCatalog

findLanguageNames

public List<String> findLanguageNames(String filter)

Description copied from interface: CamelCatalog

Find all the language names from the Camel catalog that matches the label

Specified by:

findLanguageNames in interface CamelCatalog

findOtherNames

public List<String> findOtherNames(String filter)

Description copied from interface: CamelCatalog

Find all the other (miscellaneous) names from the Camel catalog that matches the label

Specified by:

findOtherNames in interface CamelCatalog

modelJSonSchema

public String modelJSonSchema(String name)

Description copied from interface: CamelCatalog

Returns the model information as JSon format.

Specified by:

modelJSonSchema in interface CamelCatalog

Parameters:

name - the model name

Returns:

model details in JSon

componentJSonSchema

public String componentJSonSchema(String name)

Description copied from interface: CamelCatalog

Returns the component information as JSon format.

Specified by:

componentJSonSchema in interface CamelCatalog

Parameters:

name - the component name

Returns:

component details in JSon

dataFormatJSonSchema

public String dataFormatJSonSchema(String name)

Description copied from interface: CamelCatalog

Returns the data format information as JSon format.

Specified by:

dataFormatJSonSchema in interface CamelCatalog

Parameters:

name - the data format name

Returns:

data format details in JSon

languageJSonSchema

public String languageJSonSchema(String name)

Description copied from interface: CamelCatalog

Returns the language information as JSon format.

Specified by:

languageJSonSchema in interface CamelCatalog

Parameters:

name - the language name

Returns:

language details in JSon

otherJSonSchema

public String otherJSonSchema(String name)

Description copied from interface: CamelCatalog

Returns the other (miscellaneous) information as JSon format.

Specified by:

otherJSonSchema in interface CamelCatalog

Parameters:

name - the other (miscellaneous) name

Returns:

other (miscellaneous) details in JSon

componentAsciiDoc

public String componentAsciiDoc(String name)

Description copied from interface: CamelCatalog

Returns the component documentation as Ascii doc format.

Specified by:

componentAsciiDoc in interface CamelCatalog

Parameters:

name - the component name

Returns:

component documentation in ascii doc format.

componentHtmlDoc

public String componentHtmlDoc(String name)

Description copied from interface: CamelCatalog

Returns the component documentation as HTML format.

Specified by:

componentHtmlDoc in interface CamelCatalog

Parameters:

name - the component name

Returns:

component documentation in html format.

dataFormatAsciiDoc

public String dataFormatAsciiDoc(String name)

Description copied from interface: CamelCatalog

Returns the data format documentation as Ascii doc format.

Specified by:

dataFormatAsciiDoc in interface CamelCatalog

Parameters:

name - the data format name

Returns:

data format documentation in ascii doc format.

dataFormatHtmlDoc

public String dataFormatHtmlDoc(String name)

Description copied from interface: CamelCatalog

Returns the data format documentation as HTML format.

Specified by:

dataFormatHtmlDoc in interface CamelCatalog

Parameters:

name - the data format name

Returns:

data format documentation in HTML format.

languageAsciiDoc

public String languageAsciiDoc(String name)

Description copied from interface: CamelCatalog

Returns the language documentation as Ascii doc format.

Specified by:

languageAsciiDoc in interface CamelCatalog

Parameters:

name - the language name

Returns:

language documentation in ascii doc format.

languageHtmlDoc

public String languageHtmlDoc(String name)

Description copied from interface: CamelCatalog

Returns the language documentation as HTML format.

Specified by:

languageHtmlDoc in interface CamelCatalog

Parameters:

name - the language name

Returns:

language documentation in HTML format.

otherAsciiDoc

public String otherAsciiDoc(String name)

Description copied from interface: CamelCatalog

Returns the other (miscellaneous) documentation as Ascii doc format.

Specified by:

otherAsciiDoc in interface CamelCatalog

Parameters:

name - the other (miscellaneous) name

Returns:

other (miscellaneous) documentation in ascii doc format.

otherHtmlDoc

public String otherHtmlDoc(String name)

Description copied from interface: CamelCatalog

Returns the other (miscellaneous) documentation as HTML format.

Specified by:

otherHtmlDoc in interface CamelCatalog

Parameters:

name - the other (miscellaneous) name

Returns:

other (miscellaneous) documentation in HTML format.

findModelLabels

public Set<String> findModelLabels()

Description copied from interface: CamelCatalog

Find all the unique label names all the models are using.

Specified by:

findModelLabels in interface CamelCatalog

Returns:

a set of all the labels.

findComponentLabels

public Set<String> findComponentLabels()

Description copied from interface: CamelCatalog

Find all the unique label names all the components are using.

Specified by:

findComponentLabels in interface CamelCatalog

Returns:

a set of all the labels.

findDataFormatLabels

public Set<String> findDataFormatLabels()

Description copied from interface: CamelCatalog

Find all the unique label names all the data formats are using.

Specified by:

findDataFormatLabels in interface CamelCatalog

Returns:

a set of all the labels.

findLanguageLabels

public Set<String> findLanguageLabels()

Description copied from interface: CamelCatalog

Find all the unique label names all the languages are using.

Specified by:

findLanguageLabels in interface CamelCatalog

Returns:

a set of all the labels.

findOtherLabels

public Set<String> findOtherLabels()

Description copied from interface: CamelCatalog

Find all the unique label names all the other (miscellaneous) are using.

Specified by:

findOtherLabels in interface CamelCatalog

Returns:

a set of all the labels.

archetypeCatalogAsXml

public String archetypeCatalogAsXml()

Description copied from interface: CamelCatalog

Returns the Apache Camel Maven Archetype catalog in XML format.

Specified by:

archetypeCatalogAsXml in interface CamelCatalog

Returns:

the catalog in XML

springSchemaAsXml

public String springSchemaAsXml()

Description copied from interface: CamelCatalog

Returns the Camel Spring XML schema

Specified by:

springSchemaAsXml in interface CamelCatalog

Returns:

the spring XML schema

blueprintSchemaAsXml

public String blueprintSchemaAsXml()

Description copied from interface: CamelCatalog

Returns the Camel Blueprint XML schema

Specified by:

blueprintSchemaAsXml in interface CamelCatalog

Returns:

the blueprint XML schema

listComponentsAsJson

public String listComponentsAsJson()

Description copied from interface: CamelCatalog

Lists all the components summary details in JSon

Specified by:

listComponentsAsJson in interface CamelCatalog

listDataFormatsAsJson

public String listDataFormatsAsJson()

Description copied from interface: CamelCatalog

Lists all the data formats summary details in JSon

Specified by:

listDataFormatsAsJson in interface CamelCatalog

listLanguagesAsJson

public String listLanguagesAsJson()

Description copied from interface: CamelCatalog

Lists all the languages summary details in JSon

Specified by:

listLanguagesAsJson in interface CamelCatalog

listModelsAsJson

public String listModelsAsJson()

Description copied from interface: CamelCatalog

Lists all the models (EIPs) summary details in JSon

Specified by:

listModelsAsJson in interface CamelCatalog

listOthersAsJson

public String listOthersAsJson()

Description copied from interface: CamelCatalog

Lists all the others (miscellaneous) summary details in JSon

Specified by:

listOthersAsJson in interface CamelCatalog

summaryAsJson

public String summaryAsJson()

Description copied from interface: CamelCatalog

Reports a summary what the catalog contains in JSon

Specified by:

summaryAsJson in interface CamelCatalog