ConfigManager.java

/* Copyright 2012 Google, Inc.
 *
 * 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 org.arbeitspferde.groningen.config;

import org.arbeitspferde.groningen.exceptions.InvalidConfigurationException;

import java.io.IOException;

/**
 * Use {@code ConfigManager} to get obtain an instance of {@link GroningenConfig}.
 */
public interface ConfigManager {

  /**
   * Initialize the configuration manager.
   */
  public void initialize() throws IOException, InvalidConfigurationException;

  /**
   * Shutdown the configuration manager.
   */
  public void shutdown() throws IOException;

  /**
   * Query the Groningen configuration data from its repository.
   * @return An instance of {@link GroningenConfig}
   */
  public GroningenConfig queryConfig();
}