com.homeaway.streamingplatform.db.dao.RegionDao Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stream-registry Show documentation

The newest version!

/* Copyright (c) 2018 Expedia Group.
 * All rights reserved.  http://www.homeaway.com

 * Licensed 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 com.homeaway.streamingplatform.db.dao;

import java.util.Collection;
import java.util.Set;

import com.homeaway.streamingplatform.model.Hint;

// TODO consider splitting this interface into a ClusterDao and NamespaceDao
/**
 * The interface for the Region dao.
 */
public interface RegionDao {
    // TODO hint name needs to become clustername or stream-binding
    // TODO this method needs to move to a ClusterDao
    /**
     * Returns a Collection of {@link Hint}s
     *
     * @return Collection of hints
     */
    Collection getHints();

    // TODO regions need to become namespaces
    // TODO there needs to be knowledge of a parent namespace
    // TODO there needs to be knowledge of the current namespace
    /**
     * Get supported regions for a specific {@link Hint} and environment.
     *
     * @param hint {@link Hint}
     * @return supported regions
     */
    Set getSupportedRegions(String hint);
}