001/*
002 * (C) Copyright 2020 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Kevin Leturc <kleturc@nuxeo.com>
018 */
019
020package org.nuxeo.runtime.capabilities;
021
022import java.util.Map;
023import java.util.function.Supplier;
024
025/**
026 * Service holding the server capabilities.
027 *
028 * @since 11.5
029 */
030public interface CapabilitiesService {
031
032    /**
033     * Registers capabilities under the given {@code name}.
034     *
035     * @see #registerCapabilities(String, Supplier)
036     */
037    void registerCapabilities(String name, Map<String, Object> map);
038
039    /**
040     * Registers capabilities under the given {@code name}.
041     * <p>
042     * The given {@link Supplier} is called each time {@link #getCapabilities()} is called.
043     * <p>
044     * Capabilities might be registered during the Component start step.
045     */
046    void registerCapabilities(String name, Supplier<Map<String, Object>> supplier);
047
048    /**
049     * Returns the capabilities.
050     */
051    Capabilities getCapabilities();
052
053}