javax.security.auth.message.config

Interface ClientAuthConfig

  • All Superinterfaces:
    AuthConfig

    public interface ClientAuthConfig
    extends AuthConfig
    This interface encapsulates the configuration of ClientAuthContext objects for a message layer and application context (for example, the messaging context of a specific application, or set of applications).

    Implementations of this interface are returned by an AuthConfigProvider.

    Callers interact with a ClientAuthConfig to obtain ClientAuthContext objects suitable for processing a given message exchange at the layer and within the application context of the ClientAuthConfig. Each ClientAuthContext object is responsible for instantiating, initializing, and invoking the one or more ClientAuthModules encapsulated in the ClientAuthContext.

    After having acquired a ClientAuthContext, a caller operates on the context to cause it to invoke the encapsulated ClientAuthModules to secure client requests and to validate server responses.

    See Also:
    AuthConfigProvider
    • Method Detail

      • getAuthContext

        ClientAuthContext getAuthContext(String authContextID,
                                         Subject clientSubject,
                                         Map properties)
                                  throws AuthException
        Get a ClientAuthContext instance from this ClientAuthConfig.

        The implementation of this method returns a ClientAuthContext instance that encapsulates the ClientAuthModules used to secure and validate requests/responses associated with the given authContextID.

        Specifically, this method accesses this ClientAuthConfig object with the argument authContextID to determine the ClientAuthModules that are to be encapsulated in the returned ClientAuthContext instance.

        The ClientAuthConfig object establishes the request and response MessagePolicy objects that are passed to the encapsulated modules when they are initialized by the returned ClientAuthContext instance. It is the modules' responsibility to enforce these policies when invoked.

        Parameters:
        authContextID - An String identifier used to index the provided config, or null. This value must be identical to the value returned by the getAuthContextID method for all MessageInfo objects passed to the secureRequest method of the returned ClientAuthContext.
        clientSubject - A Subject that represents the source of the service request to be secured by the acquired authentication context. The principals and credentials of the Subject may be used to select or acquire the authentication context. If the Subject is not null, additional Principals or credentials (pertaining to the source of the request) may be added to the Subject. A null value may be passed for this parameter.
        properties - A Map object that may be used by the caller to augment the properties that will be passed to the encapsulated modules at module initialization. The null value may be passed for this parameter.
        Returns:
        A ClientAuthContext instance that encapsulates the ClientAuthModules used to secure and validate requests/responses associated with the given authContextID, or null (indicating that no modules are configured).
        Throws:
        AuthException - If this method fails.

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

21/08/2025 19:10:04 Cette version de la page est en cache (à la date du 21/08/2025 19:10:04) afin d'accélérer le traitement.
Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.

Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/security/auth/message/config/clientauthconfig.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.