com.okta.commons.http.authc.RequestAuthenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-http-api Show documentation

Provides a common HTTP Interface for Okta's Java libraries

There is a newer version: 2.0.1

/*
 * Copyright 2014 Stormpath, Inc.
 * Modifications Copyright 2018 Okta, Inc.
 *
 * 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 com.okta.commons.http.authc;

import com.okta.commons.http.Request;

/**
 * Interface to be implemented by HTTP authentication schemes. Such scheme defines the way the communication with
 * the Okta API server will be authenticated.
 *
 * @since 0.5.0
 */
public interface RequestAuthenticator {
    String AUTHORIZATION_HEADER = "Authorization";

    /**
     * Implementations of this operation will prepare the authentication information as expected by the Okta API server.
     *
     * @param request the request that will be sent to Okta API server, it shall be modified by the implementating classes
     *                in order to insert here the authentication information
     * @throws RequestAuthenticationException when the authentication request cannot be created
     */
    void authenticate(Request request) throws RequestAuthenticationException;

}