001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel;
018
019import java.io.IOException;
020
021import org.apache.camel.spi.DataFormat;
022import org.apache.camel.spi.Language;
023
024/**
025 * Catalog level interface for the {@link CamelContext}
026 */
027public interface CatalogCamelContext extends CamelContext {
028
029    /**
030     * Returns the JSON schema representation of the component and endpoint parameters for the given component name.
031     *
032     * @return the json or <tt>null</tt> if the component is <b>not</b> built with JSon schema support
033     */
034    String getComponentParameterJsonSchema(String componentName) throws IOException;
035
036    /**
037     * Returns the JSON schema representation of the {@link DataFormat} parameters for the given data format name.
038     *
039     * @return the json or <tt>null</tt> if the data format does not exist
040     */
041    String getDataFormatParameterJsonSchema(String dataFormatName) throws IOException;
042
043    /**
044     * Returns the JSON schema representation of the {@link Language} parameters for the given language name.
045     *
046     * @return the json or <tt>null</tt> if the language does not exist
047     */
048    String getLanguageParameterJsonSchema(String languageName) throws IOException;
049
050    /**
051     * Returns the JSON schema representation of the EIP parameters for the given EIP name.
052     *
053     * @return the json or <tt>null</tt> if the EIP does not exist
054     */
055    String getEipParameterJsonSchema(String eipName) throws IOException;
056
057}