recipe/src/main/java/org/jclouds/karaf/recipe/RecipeProvider.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.jclouds.karaf.recipe;

import org.jclouds.scriptbuilder.domain.Statement;

import java.util.Set;

/**
 * A RecipeProvider is a generic way to provide recipes to compute commands and services.
 * Implementations of the RecipeProvider can be used to create {@link Statement} objects, which can be used when
 * creating compute nodes.
 */
public interface RecipeProvider {

    /**
     * Returns the id of the {@link RecipeProvider}.
     * @return
     */
    String getId();

    /**
     * Creates a {@link Statement} for a give recipe.
     * @param recipe
     * @return
     */
    Statement createStatement(String recipe, String group);

    /**
     * Lists all the supported recipes.
     * @return
     */
    Set<String> listProvidedRecipes();
}