Package org.apache.catalina.authenticator.jaspic

Class MessageInfoImpl

  • All Implemented Interfaces:
    MessageInfo
    public class MessageInfoImpl
extends java.lang.Object
implements MessageInfo
    Implementation of MessageInfo for JASPIC authentication.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String IS_MANDATORY
      Key for the mandatory flag.
      protected static StringManager sm
      The string manager for this class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> getMap()
      Returns a map of additional context information associated with this authentication exchange.
      java.lang.Object getRequestMessage()
      Returns the request message object associated with this authentication exchange.
      java.lang.Object getResponseMessage()
      Returns the response message object associated with this authentication exchange.
      void setRequestMessage​(java.lang.Object request)
      Sets the request message object for this authentication exchange.
      void setResponseMessage​(java.lang.Object response)
      Sets the response message object for this authentication exchange.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • sm

        protected static final StringManager sm
        The string manager for this class.

      • IS_MANDATORY

        public static final java.lang.String IS_MANDATORY
        Key for the mandatory flag.
        See Also:
        Constant Field Values

    • Constructor Detail

      • MessageInfoImpl

        public MessageInfoImpl()
        Default constructor.

      • MessageInfoImpl

        public MessageInfoImpl​(HttpServletRequest request,
                       HttpServletResponse response,
                       boolean authMandatory)
        Constructor.
        Parameters:
        request - the request
        response - the response
        authMandatory - whether auth is mandatory

    • Method Detail

      • getMap

        public java.util.Map<java.lang.String,​java.lang.Object> getMap()
        Description copied from interface: jakarta.security.auth.message.MessageInfo
        Returns a map of additional context information associated with this authentication exchange. The map may contain protocol-specific attributes such as message headers.
        Specified by:
        getMap in interface MessageInfo
        Returns:
        a Map of context information, or null if not available

      • getRequestMessage

        public java.lang.Object getRequestMessage()
        Description copied from interface: jakarta.security.auth.message.MessageInfo
        Returns the request message object associated with this authentication exchange. The type of the returned object is protocol-specific.
        Specified by:
        getRequestMessage in interface MessageInfo
        Returns:
        the request message object, or null if not available

      • getResponseMessage

        public java.lang.Object getResponseMessage()
        Description copied from interface: jakarta.security.auth.message.MessageInfo
        Returns the response message object associated with this authentication exchange. The type of the returned object is protocol-specific.
        Specified by:
        getResponseMessage in interface MessageInfo
        Returns:
        the response message object, or null if not available