org.apache.camel.catalog.connector

Interface CamelConnectorCatalog

All Known Implementing Classes:

DefaultCamelConnectorCatalog

@MXBean
public interface CamelConnectorCatalog

Catalog of connectors.

Method Summary

Modifier and Type	Method and Description
void	addConnector(String groupId, String artifactId, String version, String name, String scheme, String javaType, String description, String labels, String connectorJson, String connectorSchemaJson, String componentSchemaJson) Adds or updates the connector to the catalog
String	asEndpointUri(String scheme, Map<String,String> properties, boolean encode) Creates an endpoint uri in Java style from the information from the properties
String	asEndpointUriXml(String scheme, Map<String,String> properties, boolean encode) Creates an endpoint uri in XML style (eg escape & as &l;) from the information from the properties
String	componentSchemaJSon(String groupId, String artifactId, String version) Returns the camel-component-schema json file for the given connector with the Maven coordinate
String	connectorJSon(String groupId, String artifactId, String version) Returns the camel-connector json file for the given connector with the Maven coordinate
String	connectorSchemaJSon(String groupId, String artifactId, String version) Returns the camel-connector-schema json file for the given connector with the Maven coordinate
List<ConnectorDto>	findConnector(boolean latestVersionOnly) Finds all the connectors from the catalog
List<ConnectorDto>	findConnector(String filter, boolean latestVersionOnly) Find all the connectors that matches the maven coordinate, name, label or description from the catalog
boolean	hasConnector(String groupId, String artifactId, String version) Is the connector already registered in the catalog
void	removeConnector(String groupId, String artifactId, String version) Removes the connector from the catalog
void	setConnectorDataStore(ConnectorDataStore dataStore) To configure which ConnectorDataStore to use

Method Detail

setConnectorDataStore

void setConnectorDataStore(ConnectorDataStore dataStore)

To configure which ConnectorDataStore to use

hasConnector

boolean hasConnector(String groupId,
                     String artifactId,
                     String version)

Is the connector already registered in the catalog

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

Returns:

whether the catalog has the connector or not

addConnector

void addConnector(String groupId,
                  String artifactId,
                  String version,
                  String name,
                  String scheme,
                  String javaType,
                  String description,
                  String labels,
                  String connectorJson,
                  String connectorSchemaJson,
                  String componentSchemaJson)

Adds or updates the connector to the catalog

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

name - name of connector

scheme - scheme of connector

javaType - fully qualified class name of the connector

description - description of connector

labels - labels (separated by comma) of connector

connectorJson - the camel-connector json file

connectorSchemaJson - the camel-connector-schema json file

componentSchemaJson - the camel-component-schema json file

removeConnector

void removeConnector(String groupId,
                     String artifactId,
                     String version)

Removes the connector from the catalog

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

findConnector

List<ConnectorDto> findConnector(boolean latestVersionOnly)

Finds all the connectors from the catalog

Parameters:

latestVersionOnly - whether to include only latest version of the connectors

findConnector

List<ConnectorDto> findConnector(String filter,
                                 boolean latestVersionOnly)

Find all the connectors that matches the maven coordinate, name, label or description from the catalog

Parameters:

filter - filter text

latestVersionOnly - whether to include only latest version of the connectors

connectorJSon

String connectorJSon(String groupId,
                     String artifactId,
                     String version)

Returns the camel-connector json file for the given connector with the Maven coordinate

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

connectorSchemaJSon

String connectorSchemaJSon(String groupId,
                           String artifactId,
                           String version)

Returns the camel-connector-schema json file for the given connector with the Maven coordinate

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

componentSchemaJSon

String componentSchemaJSon(String groupId,
                           String artifactId,
                           String version)

Returns the camel-component-schema json file for the given connector with the Maven coordinate

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

asEndpointUri

String asEndpointUri(String scheme,
                     Map<String,String> properties,
                     boolean encode)
              throws URISyntaxException

Creates an endpoint uri in Java style from the information from the properties

Parameters:

scheme - the endpoint schema

properties - the properties as key value pairs

encode - whether to URL encode the returned uri or not

Returns:

the constructed endpoint uri

Throws:

URISyntaxException - is thrown if there is encoding error

asEndpointUriXml

String asEndpointUriXml(String scheme,
                        Map<String,String> properties,
                        boolean encode)
                 throws URISyntaxException

Creates an endpoint uri in XML style (eg escape & as &l;) from the information from the properties

Parameters:

scheme - the endpoint schema

properties - the properties as key value pairs

encode - whether to URL encode the returned uri or not

Returns:

the constructed endpoint uri

Throws:

URISyntaxException - is thrown if there is encoding error