org.apache.camel

Interface CatalogCamelContext

All Superinterfaces:

CamelContext, RuntimeConfiguration, Service, SuspendableService

public interface CatalogCamelContext
extends CamelContext

Catalog level interface for the CamelContext

Method Summary

Modifier and Type	Method and Description
String	createRouteStaticEndpointJson(String routeId) Creates a JSON representation of all the static and dynamic configured endpoints defined in the given route(s).
String	createRouteStaticEndpointJson(String routeId, boolean includeDynamic) Creates a JSON representation of all the static (and possible dynamic) configured endpoints defined in the given route(s).
String	explainComponentJson(String componentName, boolean includeAllOptions) Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.
String	explainDataFormatJson(String dataFormatName, DataFormat dataFormat, boolean includeAllOptions) Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.
String	explainEipJson(String nameOrId, boolean includeAllOptions) Returns a JSON schema representation of the EIP parameters for the given EIP by its id.
String	explainEndpointJson(String uri, boolean includeAllOptions) Returns a JSON schema representation of the endpoint parameters for the given endpoint uri.
Map<String,Properties>	findComponents() Find information about all the Camel components available in the classpath and Registry.
Map<String,Properties>	findEips() Find information about all the EIPs from camel-core.
String	getComponentParameterJsonSchema(String componentName) Returns the JSON schema representation of the component and endpoint parameters for the given component name.
String	getDataFormatParameterJsonSchema(String dataFormatName) Returns the JSON schema representation of the DataFormat parameters for the given data format name.
String	getEipParameterJsonSchema(String eipName) Returns the JSON schema representation of the EIP parameters for the given EIP name.
String	getLanguageParameterJsonSchema(String languageName) Returns the JSON schema representation of the Language parameters for the given language name.
String	resolveComponentDefaultName(String javaType) Resolves a component's default name from its java type.

Methods inherited from interface org.apache.camel.CamelContext

adapt, addComponent, addEndpoint, addInterceptStrategy, addLifecycleStrategy, addLogListener, addRegisterEndpointCallback, addRestConfiguration, addRoutePolicyFactory, addRoutes, addService, addService, addService, addStartupListener, createConsumerTemplate, createConsumerTemplate, createDataFormat, createFluentProducerTemplate, createFluentProducerTemplate, createMulticast, createProducerTemplate, createProducerTemplate, deferStartService, disableJMX, getApplicationContextClassLoader, getAsyncProcessorAwaitManager, getBeanPostProcessor, getClassResolver, getComponent, getComponent, getComponent, getComponent, getComponentNames, getDataFormatResolver, getDebugger, getDefaultFactoryFinder, getEndpoint, getEndpoint, getEndpointMap, getEndpointRegistry, getEndpoints, getErrorHandlerExecutorService, getErrorHandlerFactory, getExecutorServiceManager, getExtension, getFactoryFinder, getGlobalOption, getGlobalOptions, getHeadersMapFactory, getInflightRepository, getInjector, getInterceptStrategies, getLanguageNames, getLifecycleStrategies, getLogListeners, getManagementMBeanAssembler, getManagementName, getManagementNameStrategy, getManagementStrategy, getMessageHistoryFactory, getModelJAXBContextFactory, getName, getNameStrategy, getNodeIdFactory, getPackageScanClassResolver, getProcessor, getProcessor, getProcessorFactory, getPropertiesComponent, getPropertiesComponent, getPropertyPrefixToken, getPropertySuffixToken, getRegistry, getRegistry, getReloadStrategy, getRestConfiguration, getRestConfiguration, getRestConfigurations, getRestRegistry, getRoute, getRouteController, getRoutePolicyFactories, getRoutes, getRouteStartupOrder, getRuntimeEndpointRegistry, getShutdownStrategy, getSSLContextParameters, getStatus, getStreamCachingStrategy, getTransformerRegistry, getTypeConverter, getTypeConverterRegistry, getUnitOfWorkFactory, getUptime, getUptimeMillis, getUuidGenerator, getValidatorRegistry, getVersion, hasComponent, hasEndpoint, hasService, hasService, hasServices, isLoadTypeConverters, isSetupRoutes, isTypeConverterStatisticsEnabled, isUseBreadcrumb, isUseDataType, isUseMDCLogging, isVetoStarted, removeComponent, removeEndpoint, removeEndpoints, removeRoute, removeService, resolveDataFormat, resolveLanguage, resolvePropertyPlaceholders, resolveTransformer, resolveTransformer, resolveValidator, setApplicationContextClassLoader, setAsyncProcessorAwaitManager, setClassResolver, setDataFormatResolver, setDebugger, setErrorHandlerFactory, setExecutorServiceManager, setExtension, setFactoryFinderResolver, setGlobalOptions, setHeadersMapFactory, setInflightRepository, setLoadTypeConverters, setManagementName, setManagementNameStrategy, setManagementStrategy, setMessageHistoryFactory, setModelJAXBContextFactory, setNameStrategy, setNodeIdFactory, setPackageScanClassResolver, setProcessorFactory, setReloadStrategy, setRestConfiguration, setRestRegistry, setRouteController, setRuntimeEndpointRegistry, setShutdownStrategy, setSSLContextParameters, setStreamCachingStrategy, setTypeConverterRegistry, setTypeConverterStatisticsEnabled, setUnitOfWorkFactory, setupManagement, setupRoutes, setUseBreadcrumb, setUseDataType, setUseMDCLogging, setUuidGenerator, start, stop

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.Service

init

Methods inherited from interface org.apache.camel.RuntimeConfiguration

getDelayer, getShutdownRoute, getShutdownRunningTask, isAllowUseOriginalMessage, isAutoStartup, isHandleFault, isLogExhaustedMessageBody, isLogMask, isMessageHistory, isStreamCaching, isTracing, setAllowUseOriginalMessage, setAutoStartup, setDelayer, setHandleFault, setLogExhaustedMessageBody, setLogMask, setMessageHistory, setShutdownRoute, setShutdownRunningTask, setStreamCaching, setTracing

Method Detail

resolveComponentDefaultName

String resolveComponentDefaultName(String javaType)

Resolves a component's default name from its java type.

A component may be used with a non default name such as activemq, wmq for the JMS component. This method can resolve the default component name by its java type.

Parameters:

javaType - the FQN name of the java type

Returns:

the default component name.

findComponents

Map<String,Properties> findComponents()
                               throws LoadPropertiesException,
                                      IOException

Find information about all the Camel components available in the classpath and Registry.

Returns:

a map with the component name, and value with component details.

Throws:

LoadPropertiesException - is thrown if error during classpath discovery of the components

IOException - is thrown if error during classpath discovery of the components

findEips

Map<String,Properties> findEips()
                         throws LoadPropertiesException,
                                IOException

Find information about all the EIPs from camel-core.

Returns:

a map with node id, and value with EIP details.

Throws:

LoadPropertiesException - is thrown if error during classpath discovery of the EIPs

IOException - is thrown if error during classpath discovery of the EIPs

getComponentParameterJsonSchema

String getComponentParameterJsonSchema(String componentName)
                                throws IOException

Returns the JSON schema representation of the component and endpoint parameters for the given component name.

Returns:

the json or null if the component is not built with JSon schema support

Throws:

IOException

getDataFormatParameterJsonSchema

String getDataFormatParameterJsonSchema(String dataFormatName)
                                 throws IOException

Returns the JSON schema representation of the DataFormat parameters for the given data format name.

Returns:

the json or null if the data format does not exist

Throws:

IOException

getLanguageParameterJsonSchema

String getLanguageParameterJsonSchema(String languageName)
                               throws IOException

Returns the JSON schema representation of the Language parameters for the given language name.

Returns:

the json or null if the language does not exist

Throws:

IOException

getEipParameterJsonSchema

String getEipParameterJsonSchema(String eipName)
                          throws IOException

Returns the JSON schema representation of the EIP parameters for the given EIP name.

Returns:

the json or null if the EIP does not exist

Throws:

IOException

explainEipJson

String explainEipJson(String nameOrId,
                      boolean includeAllOptions)

Returns a JSON schema representation of the EIP parameters for the given EIP by its id.

Parameters:

nameOrId - the name of the EIP (NamedNode.getShortName() or a node id to refer to a specific node from the routes.

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if the eipName or the id was not found

explainComponentJson

String explainComponentJson(String componentName,
                            boolean includeAllOptions)

Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.

Parameters:

componentName - the name of the component.

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if the component was not found

explainDataFormatJson

String explainDataFormatJson(String dataFormatName,
                             DataFormat dataFormat,
                             boolean includeAllOptions)

Returns a JSON schema representation of the component parameters (not endpoint parameters) for the given component by its id.

Parameters:

dataFormat - the data format instance.

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json

explainEndpointJson

String explainEndpointJson(String uri,
                           boolean includeAllOptions)

Returns a JSON schema representation of the endpoint parameters for the given endpoint uri.

Parameters:

uri - the endpoint uri

includeAllOptions - whether to include non configured options also (eg default options)

Returns:

the json or null if uri parameters is invalid, or the component is not built with JSon schema support

createRouteStaticEndpointJson

String createRouteStaticEndpointJson(String routeId)

Creates a JSON representation of all the static and dynamic configured endpoints defined in the given route(s).

Parameters:

routeId - for a particular route, or null for all routes

Returns:

a JSON string

createRouteStaticEndpointJson

String createRouteStaticEndpointJson(String routeId,
                                     boolean includeDynamic)

Creates a JSON representation of all the static (and possible dynamic) configured endpoints defined in the given route(s).

Parameters:

routeId - for a particular route, or null for all routes

includeDynamic - whether to include dynamic endpoints

Returns:

a JSON string