/*
 * Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.

 * WSO2 Inc. 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.
 */

package org.apache.synapse.endpoints.auth;

import org.apache.synapse.MessageContext;

public interface AuthHandler {

    /**
     * Gets the auth handler type of the instance.
     */
    String getAuthType();

    /**
     * This method will set the Authorization header with the relevant auth token.
     *
     * @param messageContext Message context to which the token needs to be set
     * @throws AuthException In the event of errors when generating new token
     */
    void setAuthHeader(MessageContext messageContext) throws AuthException;
}
