Interface CatalogCamelContext

All Superinterfaces:

AutoCloseable, CamelContext, CamelContextLifecycle, RuntimeConfiguration

public interface CatalogCamelContext
extends CamelContext

Catalog-level extension of CamelContext that exposes the JSON schema metadata Camel publishes for the Components, DataFormats, Languages and EIPs available at runtime.

The catalog data is the same information surfaced by the Camel Catalog tooling and is used by Camel CLI, IDE plugins, Karaf shell commands and the management/console layer to inspect what is loaded in a running application.

Since:

3.0

See Also:

• CamelContext

Method Summary

Modifier and Type	Method	Description
@Nullable String	getComponentParameterJsonSchema(String componentName)	Returns the JSON schema representation of the component and endpoint parameters for the given component name.
@Nullable String	getDataFormatParameterJsonSchema(String dataFormatName)	Returns the JSON schema representation of the DataFormat parameters for the given data format name.
@Nullable String	getDevConsoleParameterJsonSchema(String devConsoleName)	Returns the JSON schema representation of the DevConsole parameters for the given dev-console name.
@Nullable String	getEipParameterJsonSchema(String eipName)	Returns the JSON schema representation of the EIP parameters for the given EIP name.
@Nullable String	getLanguageParameterJsonSchema(String languageName)	Returns the JSON schema representation of the Language parameters for the given language name.
@Nullable String	getPojoBeanParameterJsonSchema(String name)	Returns the JSON schema representation of the pojo bean parameters for the given bean name.
@Nullable String	getTransformerParameterJsonSchema(String transformerName)	Returns the JSON schema representation of the DataTypeTransformer parameters for the given transformer name.

Methods inherited from interface CamelContext

addComponent, addEndpoint, addLifecycleStrategy, addPrototypeService, addRouteFromKamelet, addRouteFromKamelet, addRouteFromTemplate, addRouteFromTemplate, addRouteFromTemplate, addRouteFromTemplate, addRouteFromTemplate, addRoutePolicyFactory, addRoutes, addRoutesConfigurations, addService, addService, addService, addStartupListener, addTemplatedRoutes, createConsumerTemplate, createConsumerTemplate, createDataFormat, createFluentProducerTemplate, createFluentProducerTemplate, createProducerTemplate, createProducerTemplate, deferStartService, disableJMX, getApplicationContextClassLoader, getAutoStartupExcludePattern, getCamelContextExtension, getClassResolver, getClock, getComponent, getComponent, getComponent, getComponent, getComponentNames, getDataFormatNames, getDebugger, getDescription, getDumpRoutes, getEndpoint, getEndpoint, getEndpoint, getEndpointRegistry, getEndpoints, getErrorRegistry, getExecutorServiceManager, getGlobalEndpointConfiguration, getGlobalOption, getGlobalOptions, getInflightRepository, getInjector, getLanguageNames, getLifecycleStrategies, getManagementName, getManagementNameStrategy, getManagementStrategy, getMDCLoggingKeysPattern, getMessageHistoryFactory, getMessageSizeStrategy, getName, getNamedRouteDefinitions, getNameStrategy, getProcessor, getProcessor, getPropertiesComponent, getRegistry, getRegistry, getRestConfiguration, getRestRegistry, getRoute, getRouteController, getRouteGroupIds, getRouteIds, getRoutePolicyFactories, getRoutes, getRoutes, getRoutesByGroup, getRoutesSize, getRuntimeEndpointRegistry, getShutdownStrategy, getSSLContextParameters, getStartupSummaryLevel, getStreamCachingStrategy, getTracer, getTracingLoggingFormat, getTransformerRegistry, getTypeConverter, getTypeConverterRegistry, getUptime, getUuidGenerator, getValidatorRegistry, getVariable, getVariable, getVaultConfiguration, getVersion, hasComponent, hasEndpoint, hasService, hasService, hasService, hasServices, isBacklogTracingRests, isBacklogTracingStandby, isBacklogTracingTemplates, isDebugStandby, isDevConsole, isLoadHealthChecks, isLoadTypeConverters, isModeline, isSourceLocationEnabled, isTracingRests, isTracingStandby, isTracingTemplates, isTypeConverterStatisticsEnabled, isUseBreadcrumb, isUseDataType, isUseMDCLogging, isVetoStarted, removeComponent, removeEndpoint, removeEndpoints, removeRoute, removeRouteTemplates, removeService, resolveDataFormat, resolveLanguage, resolvePropertyPlaceholders, resolveTransformer, resolveTransformer, resolveValidator, setApplicationContextClassLoader, setAutoStartupExcludePattern, setBacklogTracingRests, setBacklogTracingStandby, setBacklogTracingTemplates, setClassResolver, setDebugger, setDebugStandby, setDevConsole, setDumpRoutes, setErrorRegistry, setExecutorServiceManager, setGlobalOptions, setInflightRepository, setInjector, setLoadHealthChecks, setLoadTypeConverters, setManagementName, setManagementNameStrategy, setManagementStrategy, setMDCLoggingKeysPattern, setMessageHistoryFactory, setMessageSizeStrategy, setModeline, setNameStrategy, setPropertiesComponent, setRestConfiguration, setRestRegistry, setRouteController, setRuntimeEndpointRegistry, setShutdownStrategy, setSourceLocationEnabled, setSSLContextParameters, setStartupSummaryLevel, setStreamCachingStrategy, setTracer, setTracingLoggingFormat, setTracingRests, setTracingStandby, setTracingTemplates, setTypeConverterRegistry, setTypeConverterStatisticsEnabled, setUseBreadcrumb, setUseDataType, setUseMDCLogging, setUuidGenerator, setVariable, setVaultConfiguration

Methods inherited from interface CamelContextLifecycle

build, close, getStatus, init, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, resume, shutdown, start, stop, suspend

Methods inherited from interface RuntimeConfiguration

getDelayer, getShutdownRoute, getShutdownRunningTask, getTracingPattern, isAllowUseOriginalMessage, isAutoStartup, isAutowiredEnabled, isBacklogTracing, isCaseInsensitiveHeaders, isDebugging, isLogExhaustedMessageBody, isLogMask, isMessageHistory, isMessageSize, isStreamCaching, isTracing, setAllowUseOriginalMessage, setAutoStartup, setAutowiredEnabled, setBacklogTracing, setCaseInsensitiveHeaders, setDebugging, setDelayer, setLogExhaustedMessageBody, setLogMask, setMessageHistory, setMessageSize, setShutdownRoute, setShutdownRunningTask, setStreamCaching, setTracing, setTracingPattern

Method Details

getComponentParameterJsonSchema

@Nullable 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

@Nullable 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

@Nullable 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

getTransformerParameterJsonSchema

@Nullable String getTransformerParameterJsonSchema(String transformerName)
                                            throws IOException

Returns the JSON schema representation of the DataTypeTransformer parameters for the given transformer name.

Returns:

the JSON or null if the transformer does not exist

Throws:

IOException

getDevConsoleParameterJsonSchema

@Nullable String getDevConsoleParameterJsonSchema(String devConsoleName)
                                           throws IOException

Returns the JSON schema representation of the DevConsole parameters for the given dev-console name.

Returns:

the JSON or null if the dev-console does not exist

Throws:

IOException

getEipParameterJsonSchema

@Nullable 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

getPojoBeanParameterJsonSchema

@Nullable String getPojoBeanParameterJsonSchema(String name)
                                         throws IOException

Returns the JSON schema representation of the pojo bean parameters for the given bean name.

Returns:

the JSON or null if the pojo bean does not exist

Throws:

IOException