blob: 80c9fae54745c86d4da462973bfade84572ff0ab [file] [log] [blame]
/**
* 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.connector;
import java.net.URISyntaxException;
import java.util.List;
import java.util.Map;
import javax.management.MXBean;
/**
* Catalog of connectors.
*/
@MXBean
public interface CamelConnectorCatalog {
/**
* To configure which {@link ConnectorDataStore} to use
*/
void setConnectorDataStore(ConnectorDataStore dataStore);
/**
* Is the connector already registered in the catalog
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
* @return whether the catalog has the connector or not
*/
boolean hasConnector(String groupId, String artifactId, String version);
/**
* Adds or updates the connector to the catalog
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
* @param name name of connector
* @param scheme scheme of connector
* @param javaType fully qualified class name of the connector
* @param description description of connector
* @param labels labels (separated by comma) of connector
* @param connectorJson the <tt>camel-connector</tt> json file
* @param connectorSchemaJson the <tt>camel-connector-schema</tt> json file
* @param componentSchemaJson the <tt>camel-component-schema</tt> json file
*/
void addConnector(String groupId, String artifactId, String version, String name, String scheme, String javaType,
String description, String labels, String connectorJson, String connectorSchemaJson, String componentSchemaJson);
/**
* Removes the connector from the catalog
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
*/
void removeConnector(String groupId, String artifactId, String version);
/**
* Finds all the connectors from the catalog
*
* @param latestVersionOnly whether to include only latest version of the connectors
*/
List<ConnectorDto> findConnector(boolean latestVersionOnly);
/**
* Find all the connectors that matches the maven coordinate, name, label or description from the catalog
*
* @param filter filter text
* @param latestVersionOnly whether to include only latest version of the connectors
*/
List<ConnectorDto> findConnector(String filter, boolean latestVersionOnly);
/**
* Returns the <tt>camel-connector</tt> json file for the given connector with the Maven coordinate
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
*/
String connectorJSon(String groupId, String artifactId, String version);
/**
* Returns the <tt>camel-connector-schema</tt> json file for the given connector with the Maven coordinate
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
*/
String connectorSchemaJSon(String groupId, String artifactId, String version);
/**
* Returns the <tt>camel-component-schema</tt> json file for the given connector with the Maven coordinate
*
* @param groupId maven group id
* @param artifactId maven artifact id
* @param version maven version
*/
String componentSchemaJSon(String groupId, String artifactId, String version);
/**
* 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<String, String> properties, boolean encode) throws URISyntaxException;
/**
* Creates an endpoint uri in XML style (eg escape & as &ampl;) 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<String, String> properties, boolean encode) throws URISyntaxException;
}