jakarta.security.auth.message.config.AuthConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.authentication-api Show documentation

Jakarta Authentication defines a general low-level SPI for authentication mechanisms, which are controllers that interact with a caller and a container's environment to obtain the caller's credentials, validate these, and pass an authenticated identity (such as name and groups) to the container. Jakarta Authentication consists of several profiles, with each profile telling how a specific container (such as Jakarta Servlet) can integrate with- and adapt to this SPI.

There is a newer version: 3.1.0

Show newest version

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates and others.
 * All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.security.auth.message.config;

import jakarta.security.auth.message.MessageInfo;

/**
 * This interface defines the common functionality implemented by Authentication context configuration objects.
 *
 * @see ClientAuthContext
 * @see ServerAuthContext
 */
public interface AuthConfig {
    
    /**
     * Get the message layer name of this authentication context configuration object.
     *
     * @return The message layer name of this configuration object, or null if the configuration object pertains to an
     * unspecified message layer.
     */
    String getMessageLayer();

    /**
     * Get the application context identifier of this authentication context configuration object.
     *
     * @return The String identifying the application context of this configuration object, or null if the configuration
     * object pertains to an unspecified application context.
     */
    String getAppContext();

    /**
     * Get the authentication context identifier corresponding to the request and response objects encapsulated in
     * messageInfo.
     *
     * @param messageInfo A contextual Object that encapsulates the client request and server response objects.
     *
     * @return The authentication context identifier corresponding to the encapsulated request and response objects, or
     * null.
     *
     * @throws IllegalArgumentException If the type of the message objects incorporated in messageInfo are not compatible
     * with the message types supported by this authentication context configuration object.
     */
    String getAuthContextID(MessageInfo messageInfo);

    /**
     * Causes a dynamic authentication context configuration object to update the internal state that it uses to process
     * calls to its getAuthContext method.
     *
     * @exception SecurityException If the caller does not have permission to refresh the configuration object, or if an
     * error occurred during the update.
     */
    void refresh();

    /**
     * Used to determine whether the authentication context configuration object encapsulates any protected authentication
     * contexts.
     *
     * @return True if the configuration object encapsulates at least one protected authentication context. Otherwise, this
     * method returns false.
     */
    boolean isProtected();
}