org.finos.tracdap.common.config.IConfigLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracdap-lib-common Show documentation

TRAC D.A.P. common library, interfaces and utilities used across all TRAC components

There is a newer version: 0.6.3

/*
 * Licensed to the Fintech Open Source Foundation (FINOS) under one or
 * more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * FINOS 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.finos.tracdap.common.config;

import org.finos.tracdap.common.config.local.LocalConfigLoader;
import org.finos.tracdap.common.exception.EStartup;
import org.finos.tracdap.common.plugin.TracPlugin;

import java.net.URI;


/**
 * Tech stack abstraction interface for loading config files.
 *
 *  Config plugins can supply an IConfigLoader implementation to
 * handle physical loading of config files. The loader can advertise
 * the protocols it supports using the protocols() method and then provide
 * a load method to load files using those protocols. ConfigManager will only
 * call the loader for protocols it supports and will always pass an
 * absolute URL (relative URLs are resolved in ConfigManager). If there
 * are any problems loading a config file, throw an EStartup exception.
 *
 * For an example of a config loader, see LocalConfigLoader.
 *
 * @see ConfigManager
 * @see LocalConfigLoader ;
 * @see TracPlugin
 */
public interface IConfigLoader {

    /**
     * Use the loader to load a text file.
     *
     * The supplied configUrl will always be an absolute URL.
     * Only protocols registered when the plugin was loaded will be requested.
     *
     * @param configUrl URL of the file to load
     * @return The content of the file as text
     * @throws EStartup There was a problem loading the file
     */
    String loadTextFile(URI configUrl);

    /**
     * Use the loader to load a binary file.
     *
     * The supplied configUrl will always be an absolute URL.
     * Only protocols registered when the plugin was loaded will be requested.
     *
     * @param configUrl URL of the file to load
     * @return The content of the file as text
     * @throws EStartup There was a problem loading the file
     */
    byte[] loadBinaryFile(URI configUrl);
}