/*
 * 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.jackrabbit.vault.fs.api;

import java.io.InputStream;
import java.util.List;

/**
 * {@code VaultFsConfig}...
 */
public interface VaultFsConfig {

    /**
     * Name of the property that configures whether to use binary references instead of actual binary
     */
    String NAME_USE_BINARY_REFERENCES = "useBinaryReferences";

    /**
     * Returns an input stream that contains the source xml that constructs this config
     * @return the source config
     */
    InputStream getSource();

    /**
     * Returns the source xml that constructs this config
     * @return the source xml
     */
    String getSourceAsString();

    /**
     * Returns a list of configured aggregators.
     * @return the configured aggregators.
     */
    List<Aggregator> getAggregators();

    /**
     * Returns a list of configured artifact handlers.
     * @return the configured artifact handlers.
     */
    List<ArtifactHandler> getHandlers();

    /**
     * Returns the configuration property with the given name or {@code null} if it is not defined.
     * @param name the name of the property
     * @return the value or null
     */
    String getProperty(String name);
}