001/*
002 * PermissionsEx
003 * Copyright (C) zml and PermissionsEx contributors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package ca.stellardrift.permissionsex.impl.config;
018
019import ca.stellardrift.permissionsex.datastore.ProtoDataStore;
020import ca.stellardrift.permissionsex.exception.PEBKACException;
021import org.checkerframework.checker.nullness.qual.Nullable;
022
023import java.io.IOException;
024import java.util.List;
025
026/**
027 * Configuration for PermissionsEx
028 */
029public interface PermissionsExConfiguration<PlatformType> {
030    @Nullable ProtoDataStore<?> getDataStore(String name);
031
032    ProtoDataStore<?> getDefaultDataStore();
033
034    boolean isDebugEnabled();
035
036    List<String> getServerTags();
037
038    void validate() throws PEBKACException;
039
040    /**
041     * Get a configuration containing options only applicable to one implementation of PermissionsEx
042     *
043     * @return The configuration object
044     */
045    PlatformType getPlatformConfig();
046
047    PermissionsExConfiguration<PlatformType> reload() throws IOException;
048
049    default void save() throws IOException {}
050}