/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */
package org.apache.hc.client5.http.impl.auth;

import org.apache.hc.client5.http.auth.AuthenticationException;
import org.apache.hc.core5.http.protocol.HttpContext;

/**
 * Extension hook for optional SCRAM attributes.
 *
 * @since 5.6
 */
public interface ScramExtension {

    /**
     * Process an extension attribute.
     *
     * @param name    attribute name
     * @param value   attribute value or {@code null}
     * @param context HTTP context
     * @return true if processed, false to ignore
     * @throws AuthenticationException on processing error
     * @since 5.6
     */
    boolean process(String name, String value, HttpContext context) throws AuthenticationException;

    /**
     * Whether this extension supports the given attribute name.
     *
     * @param name attribute name
     * @return true if supported
     * @since 5.6
     */
    boolean supports(String name);
}
