io.telicent.smart.cache.server.jaxrs.init.ServerConfigInit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-base-server Show documentation

There is a newer version: 0.24.1

/**
 * Copyright (C) Telicent Ltd
 *
 * 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 io.telicent.smart.cache.server.jaxrs.init;

import jakarta.servlet.ServletContextListener;

import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;

/**
 * A {@code ServletContextListener} that will be auto-discovered via {@link ServiceLoader#load(Class)} and whose
 * initialisation order is controlled via its declared {@link #priority()} value
 */
public interface ServerConfigInit extends ServletContextListener {

    /**
     * Gets the configuration initialisers that are detected via {@link ServiceLoader#load(Class)}
     *
     * @return Detected initialisers
     */
    static List getConfigInitialisers() {
        ServiceLoader loader = ServiceLoader.load(ServerConfigInit.class);

        List loadedInits = new ArrayList<>();
        for (ServerConfigInit serverConfigInit : loader) {
            loadedInits.add(serverConfigInit);
        }

        loadedInits.sort(InitPriorityComparator.INSTANCE);

        return loadedInits;
    }

    /**
     * Gets the name for the initialiser
     *
     * @return Name
     */
    String getName();

    /**
     * Gets the priority for the initialiser
     *
     * @return Priority, higher values indicate higher priority i.e. the initialiser should run sooner
     */
    int priority();
}