Router.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.openejb.resource.jdbc.router;

import org.apache.openejb.resource.jdbc.RoutedDataSource;

import javax.sql.DataSource;

/**
 * The Router interface is responsible for providing the target data source to the ${@link RoutedDataSource}}.
 * <p/>
 * $Rev:$
 */
public interface Router {

    /**
     * Used by ${@link RoutedDataSource} to get the active data source.
     *
     * @return the data source to delegate to
     */
    DataSource getDataSource();
}