common/rya.api/src/main/java/org/apache/rya/api/client/ListInstances.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.rya.api.client;

import java.util.List;

import edu.umd.cs.findbugs.annotations.DefaultAnnotation;
import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * List the names of the installed Rya instances.
 */
@DefaultAnnotation(NonNull.class)
public interface ListInstances {

    /**
     * List the names of the installed Rya instances.
     *
     * @return The names of the installed Rya Instances.
     * @throws RyaClientException Something caused the command to fail.
     */
    public List<String> listInstances() throws RyaClientException;
}