DirectDataSourceProvider.java

/**
 * Copyright 2011-2017 Asakusa Framework Team.
 *
 * 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.asakusafw.runtime.directio;

import java.io.IOException;

/**
 * Provides {@link DirectDataSource}.
 * @since 0.2.5
 */
public interface DirectDataSourceProvider {

    /**
     * Returns the data source ID.
     * @return ID
     */
    String getId();

    /**
     * Returns the container path of this data source.
     * @return the container path
     */
    String getPath();

    /**
     * Creates a new instance.
     * @return created instance
     * @throws IOException if failed to create an instance
     * @throws InterruptedException if interrupted
     */
    DirectDataSource newInstance() throws IOException, InterruptedException;
}