/**
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 * Copyright 2017 SmartBear Software
 * <p>
 * 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.eclipse.microprofile.openapi.models.security;

import java.util.List;
import java.util.Map;

import org.eclipse.microprofile.openapi.models.Constructible;

/**
 * SecurityRequirement
 *
 * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement Object</a>
 */
public interface SecurityRequirement extends Constructible, Map<String, List<String>> {

    /**
     * Adds a security scheme to the SecurityRequirement instance based on the scheme name and 
     * required scope (optional) provided.
     * 
     * @param securitySchemeName the name of security scheme declared in the Components section of the OpenAPI document
     * @param scope a required scope - only valid when the defined scheme's type is 'oauth2' or 'openIdConnect'. passing null will
     *              result in an empty list of scopes
     * @return Updated SecurityRequirement instance
     */
    SecurityRequirement addScheme(String securitySchemeName, String scope);

    /**
     * Adds a security scheme to the SecurityRequirement instance based on the scheme name and 
     * required scopes (optional) provided.
     * 
     * @param securitySchemeName the name of security scheme declared in the Components section of the OpenAPI document
     * @param scopes the scopes required - only valid when the defined scheme is 'oauth2' or 'openIdConnect'. passing null
     *               will result in an empty list of scopes
     * @return Updated SecurityRequirement instance
     */
    SecurityRequirement addScheme(String securitySchemeName, List<String> scopes);

    /**
     * Adds a security scheme to the SecurityRequirement instance based on the scheme name.  No 
     * scopes are included, resulting in an empty list of scopes for the security scheme.  This
     * is valid when the defined security scheme is not 'oauth2' or 'openIdConnect'.
     * 
     * @param securitySchemeName the name of security scheme declared in the Components section of the OpenAPI document
     * @return Updated SecurityRequirement instance
     */
    SecurityRequirement addScheme(String securitySchemeName);

    /**
     * Removes a security scheme to the SecurityRequirement instance based on the scheme name.
     * 
     * @param securitySchemeName the name of security scheme
     */
    void removeScheme(String securitySchemeName);

    /**
     * Returns a copy map (potentially immutable) of the schemes.
     * 
     * @return all items
     */
    Map<String, List<String>> getSchemes();

    /**
     * Set all security schemes to the SecurityRequirement instance. Keys are the name of security scheme declared in the Components 
     * section of the OpenAPI document, values are a list of required scope - only valid when the defined scheme is 'oauth2' or 'openIdConnect'
     * 
     * @param items a map containing the security schemes.
     */
    void setSchemes(Map<String, List<String>> items);

    /**
     * Check whether a scheme is present in the map. This is a convenience method for <code>getSchemes().containsKey(name)</code>
     * 
     * @param securitySchemeName the name of security scheme
     * @return a boolean to indicate if the scheme is present or not.
     */
    default boolean hasScheme(String securitySchemeName) {
        Map<String, List<String>> map = getSchemes();
        if (map == null) {
            return false;
        }
        return map.containsKey(securitySchemeName);
    }

    /**
     * Returns a list of scopes for a given scheme name. This is a convenience method for <code>getSchemes().get(name)</code>
     * 
     * @param securitySchemeName the name of security scheme
     * @return a list of scopes or null.
     */
    default List<String> getScheme(String securitySchemeName) {
        Map<String, List<String>> map = getSchemes();
        if (map == null) {
            return null;
        }
        return map.get(securitySchemeName);
    }

    /**
     * In the next version, {@link SecurityRequirement} will no longer extends {@link Map}, this method will no longer be present.
     * Use {@link #getScheme(String)} instead.
     * @deprecated since 1.1
     */
    @Deprecated
    @Override
    List<String> get(Object key);

    /**
     * In the next version, {@link SecurityRequirement} will no longer extends {@link Map}, this method will no longer be present.
     * Use {@link #hasScheme(String)} instead.
     * @deprecated since 1.1
     */
    @Deprecated
    @Override
    boolean containsKey(Object key);
    
    /**
     * In the next version, {@link SecurityRequirement} will no longer extends {@link Map}, this method will no longer be present.
     * Use {@link #addScheme(String, List)} instead.
     * @deprecated since 1.1
     */
    @Deprecated
    @Override
    List<String> put(String key, List<String> value);

    /**
     * In the next version, {@link SecurityRequirement} will no longer extends {@link Map}, this method will no longer be present.
     * Use {@link #setSchemes(Map)} instead.
     * @deprecated since 1.1
     */
    @Deprecated
    @Override
    void putAll(Map<? extends String, ? extends List<String>> m);

    /**
     * In the next version, {@link SecurityRequirement} will no longer extends {@link Map}, this method will no longer be present.
     * Use {@link #removeScheme(String)} instead.
     * @deprecated since 1.1
     */
    @Deprecated
    @Override
    List<String> remove(Object key);

}