platforms/commands/commands-core/src/main/java/org/apache/camel/commands/CamelCommand.java

/*
 * 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.commands;

import java.io.PrintStream;

/**
 * A Camel command.
 */
public interface CamelCommand {

    /**
     * Executes the given command.
     *
     * @param camelController the Camel controller to access Camel information
     * @param out             the output printer stream
     * @param err             the error print stream
     * @return response from command, or <tt>null</tt> if nothing to return
     * @throws Exception is thrown if error executing command
     */
    Object execute(CamelController camelController, PrintStream out, PrintStream err) throws Exception;

}