Class AuthExchange


  • public class AuthExchange
    extends java.lang.Object
    This class represents the actual state of authentication handshake including the current AuthScheme used for request authorization as well as a collection of backup authentication options if available.
    Since:
    4.5
    • Constructor Detail

      • AuthExchange

        public AuthExchange()
    • Method Detail

      • reset

        public void reset()
      • isConnectionBased

        public boolean isConnectionBased()
        Returns true if the actual authentication scheme is connection based.
      • getPathPrefix

        public java.lang.String getPathPrefix()
        Since:
        5.2
      • setPathPrefix

        public void setPathPrefix​(java.lang.String pathPrefix)
        Since:
        5.2
      • select

        public void select​(AuthScheme authScheme)
        Resets the auth state with AuthScheme and clears auth options.
        Parameters:
        authScheme - auth scheme. May not be null.
      • getAuthOptions

        public java.util.Queue<AuthScheme> getAuthOptions()
        Returns available auth options. May be null.
      • setOptions

        public void setOptions​(java.util.Queue<AuthScheme> authOptions)
        Updates the auth state with a queue of auth options.
        Parameters:
        authOptions - a queue of auth options. May not be null or empty.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object