chop/spi/src/main/java/org/apache/usergrid/chop/spi/ProjectManager.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.usergrid.chop.spi;


import java.io.IOException;
import java.util.Set;

import org.apache.usergrid.chop.api.Project;


/**
 * Manages projects.
 */
public interface ProjectManager {

    /**
     * Scans for projects with test information using key like:
     * </p>
     * "$TESTS_PATH/.*\/$PROJECT_FILE
     *
     * @return a set of projects
     */
    Set<Project> getProjects() throws IOException;

    /**
     * Deletes all the projects.
     */
    void deleteProjects();

    /**
     * Stores the project test information.
     *
     * @param project the Project object to be serialized and stored
     */
    void store( Project project );

    /**
     * Tries to load a Project file based on prepackaged runner metadata: the runner's
     * loadKey. If it cannot find it, null is returned.
     *
     * @param runnerWar the load key for the runner war
     * @return the Project object if it exists in the store or null if it does not
     */
    Project getProject( String runnerWar );

}