javax.security.auth.message.callback

Class CallerPrincipalCallback

Contents
  • All Implemented Interfaces:
    Callback

    public class CallerPrincipalCallback
extends Object
implements Callback
    Callback for setting the container's caller (or Remote user) principal. This callback is intended to be called by a serverAuthModule during its validateRequest processing.

    • Constructor Detail

      • CallerPrincipalCallback

        public CallerPrincipalCallback(Subject s,
                               Principal p)
        Create a CallerPrincipalCallback to set the container's representation of the caller principal
        Parameters:
        s - The Subject in which the container will distinguish the caller identity.
        p - The Principal that will be distinguished as the caller principal. This value may be null.

        The CallbackHandler must use the argument Principal to establish the caller principal associated with the invocation being processed by the container. When the argument Principal is null, the handler must establish the container's representation of the unauthenticated caller principal. The handler may perform principal mapping of non-null argument Principal values, but it must be possible to configure the handler such that it establishes the non-null argument Principal as the caller principal.

      • CallerPrincipalCallback

        public CallerPrincipalCallback(Subject s,
                               String n)
        Create a CallerPrincipalCallback to set the container's representation of the caller principal.
        Parameters:
        s - The Subject in which the container will distinguish the caller identity.
        n - The String value that will be returned when getName() is called on the principal established as the caller principal or null.

        The CallbackHandler must use the n argument to establish the caller principal associated with the invocation being processed by the container. When the n argument is null, the handler must establish the container's representation of the unauthenticated caller principal (which may or may not be equal to null, depending on the requirements of the container type ). The handler may perform principal mapping of non-null values of n, but it must be possible to configure the handler such that it establishes the non-null argument value as the value returned when getName is called on the established principal.

    • Method Detail

      • getSubject

        public Subject getSubject()
        Get the Subject in which the handler will distinguish the caller principal
        Returns:
        The subject.

      • getPrincipal

        public Principal getPrincipal()
        Get the caller principal.
        Returns:
        The principal or null.

        When the values returned by this method and the getName methods are null, the handler must establish the container's representation of the unauthenticated caller principal within the Subject.

      • getName

        public String getName()
        Get the caller principal name.
        Returns:
        The principal name or null.

        When the values returned by this method and the getPrincipal methods are null, the handler must establish the container's representation of the unauthenticated caller principal within the Subject.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/security/auth/message/callback/CallerPrincipalCallback.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, CallerPrincipalCallback (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.