org.apache.camel.catalog.CamelCatalog Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.catalog;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.camel.tooling.model.ArtifactModel;
import org.apache.camel.tooling.model.BaseModel;
import org.apache.camel.tooling.model.ComponentModel;
import org.apache.camel.tooling.model.DataFormatModel;
import org.apache.camel.tooling.model.EipModel;
import org.apache.camel.tooling.model.LanguageModel;
import org.apache.camel.tooling.model.MainModel;
import org.apache.camel.tooling.model.OtherModel;
import org.apache.camel.tooling.model.ReleaseModel;
/**
* Catalog of components, data formats, models (EIPs), languages, and more from this Apache Camel release.
*/
public interface CamelCatalog {
/**
* Returns the {@link JSonSchemaResolver} used by this catalog.
*
* @return the resolver
*/
JSonSchemaResolver getJSonSchemaResolver();
/**
* To use a custom {@link JSonSchemaResolver} with this catalog.
*
* @param resolver the custom resolver
*/
void setJSonSchemaResolver(JSonSchemaResolver resolver);
/**
* To plugin a custom {@link RuntimeProvider} that amends the catalog to only include information that is supported
* on the runtime.
*/
void setRuntimeProvider(RuntimeProvider provider);
/**
* Gets the {@link RuntimeProvider} in use.
*/
RuntimeProvider getRuntimeProvider();
/**
* Enables caching of the resources which makes the catalog faster, but keeps data in memory during caching.
*
* The catalog does not cache by default.
*/
void enableCache();
/**
* Whether caching has been enabled.
*/
boolean isCaching();
/**
* To plugin a custom {@link SuggestionStrategy} to provide suggestion for unknown options
*/
void setSuggestionStrategy(SuggestionStrategy suggestionStrategy);
/**
* Gets the {@link SuggestionStrategy} in use
*/
SuggestionStrategy getSuggestionStrategy();
/**
* To plugin a custom {@link VersionManager} to load other versions of Camel the catalog should use.
*/
void setVersionManager(VersionManager versionManager);
/**
* Gets the {@link VersionManager} in use
*/
VersionManager getVersionManager();
/**
* Adds a 3rd party component to this catalog.
*
* @param name the component name
* @param className the fully qualified class name for the component class
*/
void addComponent(String name, String className);
/**
* Adds a 3rd party component to this catalog.
*
* @param name the component name
* @param className the fully qualified class name for the component class
* @param jsonSchema the component JSON schema
*/
void addComponent(String name, String className, String jsonSchema);
/**
* Adds a 3rd party data format to this catalog.
*
* @param name the data format name
* @param className the fully qualified class name for the data format class
*/
void addDataFormat(String name, String className);
/**
* Adds a 3rd party data format to this catalog.
*
* @param name the data format name
* @param className the fully qualified class name for the data format class
* @param jsonSchema the data format JSON schema
*/
void addDataFormat(String name, String className, String jsonSchema);
/**
* The version of this Camel Catalog
*/
String getCatalogVersion();
/**
* 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 {@link #loadVersion(String)}.
*
* @param version the Camel version such as 2.17.1
* @return true if the version was loaded, false if not.
*/
boolean loadVersion(String version);
/**
* Gets the current loaded Camel version used by the catalog.
*/
String getLoadedVersion();
/**
* Gets the current loaded runtime provider version used by the catalog.
*/
String getRuntimeProviderLoadedVersion();
/**
* 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 {@link #loadVersion(String)}.
*
* @param groupId the runtime provider Maven groupId
* @param artifactId the runtime provider Maven artifactId
* @param version the runtime provider Maven version
* @return true if the version was loaded, false if not.
*/
boolean loadRuntimeProviderVersion(String groupId, String artifactId, String version);
/**
* Find all the component names from the Camel catalog
*/
List findComponentNames();
/**
* Find all the data format names from the Camel catalog
*/
List findDataFormatNames();
/**
* Find all the language names from the Camel catalog
*/
List findLanguageNames();
/**
* Find all the model names from the Camel catalog
*/
List findModelNames();
/**
* Find all the other (miscellaneous) names from the Camel catalog
*/
List findOtherNames();
/**
* @param kind the kind to look for
* @return the list of part names of the given {@link Kind} available in this {@link CamelCatalog}
*/
default List findNames(Kind kind) {
switch (kind) {
case component:
return findComponentNames();
case dataformat:
return findDataFormatNames();
case language:
return findLanguageNames();
case other:
return findOtherNames();
case eip:
return findModelNames();
default:
throw new IllegalArgumentException("Unexpected kind " + kind);
}
}
/**
* Find all the component names from the Camel catalog that matches the label
*/
List findComponentNames(String filter);
/**
* Find all the data format names from the Camel catalog that matches the label
*/
List findDataFormatNames(String filter);
/**
* Find all the language names from the Camel catalog that matches the label
*/
List findLanguageNames(String filter);
/**
* Find all the model names from the Camel catalog that matches the label
*/
List findModelNames(String filter);
/**
* Find all the other (miscellaneous) names from the Camel catalog that matches the label
*/
List findOtherNames(String filter);
/**
* Returns the component information as JSON format.
*
* @param name the component name
* @return component details in JSon
*/
String componentJSonSchema(String name);
/**
* Returns the data format information as JSON format.
*
* @param name the data format name
* @return data format details in JSon
*/
String dataFormatJSonSchema(String name);
/**
* Returns the language information as JSON format.
*
* @param name the language name
* @return language details in JSon
*/
String languageJSonSchema(String name);
/**
* Returns the other (miscellaneous) information as JSON format.
*
* @param name the other (miscellaneous) name
* @return other (miscellaneous) details in JSon
*/
String otherJSonSchema(String name);
/**
* Returns the model information as JSON format.
*
* @param name the model name
* @return model details in JSon
*/
String modelJSonSchema(String name);
/**
* Find all the unique label names all the components are using.
*
* @return a set of all the labels.
*/
Set findComponentLabels();
/**
* Find all the unique label names all the data formats are using.
*
* @return a set of all the labels.
*/
Set findDataFormatLabels();
/**
* Find all the unique label names all the languages are using.
*
* @return a set of all the labels.
*/
Set findLanguageLabels();
/**
* Find all the unique label names all the models are using.
*
* @return a set of all the labels.
*/
Set findModelLabels();
/**
* Find all the unique label names all the other (miscellaneous) are using.
*
* @return a set of all the labels.
*/
Set findOtherLabels();
/**
* Returns the Camel Spring XML schema
*
* @return the spring XML schema
*/
String springSchemaAsXml();
/**
* Returns the camel-main json schema
*
* @return the camel-main json schema
*/
String mainJsonSchema();
/**
* Parses the endpoint uri and constructs a key/value properties of each option
*
* @param uri the endpoint uri
* @return properties as key value pairs of each endpoint option
*/
Map endpointProperties(String uri) throws URISyntaxException;
/**
* 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.
*
* @param uri the endpoint uri
* @return properties as key value pairs of each lenient properties
*/
Map endpointLenientProperties(String uri) throws URISyntaxException;
/**
* Validates the pattern whether its a valid time pattern.
*
* @param pattern the pattern such as 5000, 5s, 5sec, 4min, 4m30s, 1h, etc.
* @return true if valid, false if invalid
*/
boolean validateTimePattern(String pattern);
/**
* Parses and validates the endpoint uri and constructs a key/value properties of each option.
*
* @param uri the endpoint uri
* @return validation result
*/
EndpointValidationResult validateEndpointProperties(String uri);
/**
* Parses and validates the endpoint uri and constructs a key/value properties of each option.
*
* The option ignoreLenientProperties can be used to ignore components that uses lenient properties. When this is
* true, then the uri validation is stricter but would fail on properties that are not part of the component but in
* the uri because of using lenient properties. For example using the HTTP components to provide query parameters in
* the endpoint uri.
*
* @param uri the endpoint uri
* @param ignoreLenientProperties whether to ignore components that uses lenient properties.
* @return validation result
*/
EndpointValidationResult validateEndpointProperties(String uri, boolean ignoreLenientProperties);
/**
* Parses and validates the endpoint uri and constructs a key/value properties of each option.
*
* The option ignoreLenientProperties can be used to ignore components that uses lenient properties. When this is
* true, then the uri validation is stricter but would fail on properties that are not part of the component but in
* the uri because of using lenient properties. For example using the HTTP components to provide query parameters in
* the endpoint uri.
*
* @param uri the endpoint uri
* @param ignoreLenientProperties whether to ignore components that uses lenient properties.
* @param consumerOnly whether the endpoint is only used as a consumer
* @param producerOnly whether the endpoint is only used as a producer
* @return validation result
*/
EndpointValidationResult validateEndpointProperties(
String uri, boolean ignoreLenientProperties, boolean consumerOnly, boolean producerOnly);
/**
* Parses and validates the language as a predicate
*
* It is possible to specify language options as query parameters in the language parameter, such as
* jsonpath?unpackArray=true&allowEasyPredicate=false
*
* Important: This requires having camel-core and the language dependencies on the classpath
*
* @param classLoader a custom classloader to use for loading the language from the classpath, or null for
* using default classloader
* @param language the name of the language
* @param text the predicate text
* @return validation result
*/
LanguageValidationResult validateLanguagePredicate(ClassLoader classLoader, String language, String text);
/**
* Parses and validates the language as an expression
*
* It is possible to specify language options as query parameters in the language parameter, such as
* jsonpath?unpackArray=true&allowEasyPredicate=false
*
* Important: This requires having camel-core and the language dependencies on the classpath
*
* @param classLoader a custom classloader to use for loading the language from the classpath, or null for
* using default classloader
* @param language the name of the language
* @param text the expression text
* @return validation result
*/
LanguageValidationResult validateLanguageExpression(ClassLoader classLoader, String language, String text);
/**
* Parses and validates the configuration property
*
* @param text the configuration text
* @return validation result
*/
ConfigurationPropertiesValidationResult validateConfigurationProperty(String text);
/**
* Returns the component name from the given endpoint uri
*
* @param uri the endpoint uri
* @return the component name (aka scheme), or null if not possible to determine
*/
String endpointComponentName(String uri);
/**
* Creates an endpoint uri in Java style from the information from the properties
*
* @param scheme the endpoint schema
* @param properties the properties as key value pairs
* @param encode whether to URL encode the returned uri or not
* @return the constructed endpoint uri
* @throws java.net.URISyntaxException is thrown if there is encoding error
*/
String asEndpointUri(String scheme, Map properties, boolean encode) throws URISyntaxException;
/**
* Creates an endpoint uri in XML style from the information from the properties
*
* @param scheme the endpoint schema
* @param properties the properties as key value pairs
* @param encode whether to URL encode the returned uri or not
* @return the constructed endpoint uri
* @throws java.net.URISyntaxException is thrown if there is encoding error
*/
String asEndpointUriXml(String scheme, Map properties, boolean encode) throws URISyntaxException;
/**
* Lists all the components summary details in JSon
*/
String listComponentsAsJson();
/**
* Lists all the data formats summary details in JSon
*/
String listDataFormatsAsJson();
/**
* Lists all the languages summary details in JSon
*/
String listLanguagesAsJson();
/**
* Lists all the models (EIPs) summary details in JSon
*/
String listModelsAsJson();
/**
* Lists all the others (miscellaneous) summary details in JSon
*/
String listOthersAsJson();
/**
* Reports a summary what the catalog contains in JSon
*/
String summaryAsJson();
/**
* @param name the component name to look up
* @return the requested component or {@code null} in case it is not available in this {@link CamelCatalog}
*/
ComponentModel componentModel(String name);
/**
* @param name the data format name to look up
* @return the requested data format or {@code null} in case it is not available in this {@link CamelCatalog}
*/
DataFormatModel dataFormatModel(String name);
/**
* @param name the language name to look up
* @return the requested language or {@code null} in case it is not available in this {@link CamelCatalog}
*/
LanguageModel languageModel(String name);
/**
* @param name the other name to look up
* @return the requested other or {@code null} in case it is not available in this {@link CamelCatalog}
*/
OtherModel otherModel(String name);
/**
* @param name the EIP model name to look up
* @return the requested EIP model or {@code null} in case it is not available in this {@link CamelCatalog}
*/
EipModel eipModel(String name);
/**
* @return the requested main model or {@code null} in case it is not available in this {@link CamelCatalog}
*/
MainModel mainModel();
/**
* Lookup the model for the given kind and name
*
* @param kind the requested kind
* @param name the name to look up
* @return the requested model or {@code null} in case it is not available in this {@link CamelCatalog}
*/
default BaseModel model(Kind kind, String name) {
switch (kind) {
case component:
return componentModel(name);
case dataformat:
return dataFormatModel(name);
case language:
return languageModel(name);
case other:
return otherModel(name);
case eip:
return eipModel(name);
default:
throw new IllegalArgumentException("Unexpected kind " + kind);
}
}
/**
* Lookup the model for the given Maven GAV
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version (optional)
* @return the requested model or {@code null} in case it is not available in this {@link CamelCatalog}
*/
ArtifactModel modelFromMavenGAV(String groupId, String artifactId, String version);
/**
* Load resource from catalog classpath
*
* @param kind The resource kind, ex. camel-jbang
* @param name The resource name
* @return An input stream for reading the resource; null if the resource could not be found
*/
InputStream loadResource(String kind, String name);
/**
* Load all Camel releases (core and spring-boot) from catalog
*/
List camelReleases();
/**
* Load all Camel Quarkus releases from catalog
*/
List camelQuarkusReleases();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy