Package org.restlet.data

Class AuthenticationInfo

  • public class AuthenticationInfo
extends java.lang.Object
    Preemptive authentication information. Sent by an origin server to a client after a successful digest authentication attempt.

    Note that when used with HTTP connectors, this class maps to the "Authentication-Info" header.
    See Also:
    HTTP Authentication - The Authentication-Info Header

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String clientNonce
      The client nonce.
      private java.lang.String nextServerNonce
      The next nonce value.
      private int nonceCount
      The nonce-count value.
      private java.lang.String quality
      The quality of protection.
      private java.lang.String responseDigest
      The optional response digest for mutual authentication.

    • Constructor Summary

      Constructors 
      Constructor Description
      AuthenticationInfo​(java.lang.String nextNonce, int nonceCount, java.lang.String cnonce, java.lang.String quality, java.lang.String responseDigest)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      java.lang.String getClientNonce()
      Returns the client nonce.
      java.lang.String getNextServerNonce()
      Returns the next server nonce.
      int getNonceCount()
      Returns the nonce-count value.
      java.lang.String getQuality()
      Returns the quality of protection.
      java.lang.String getResponseDigest()
      Returns the optional response digest for mutual authentication.
      int hashCode()
      void setClientNonce​(java.lang.String clientNonce)
      Sets the client nonce.
      void setNextServerNonce​(java.lang.String nextNonce)
      Sets the next server nonce.
      void setNonceCount​(int nonceCount)
      Sets the nonce-count value.
      void setQuality​(java.lang.String qop)
      Sets the quality of protection.
      void setResponseDigest​(java.lang.String responseDigest)
      Sets the optional response digest for mutual authentication.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • nextServerNonce

        private volatile java.lang.String nextServerNonce
        The next nonce value.

      • nonceCount

        private volatile int nonceCount
        The nonce-count value.

      • clientNonce

        private volatile java.lang.String clientNonce
        The client nonce.

      • quality

        private volatile java.lang.String quality
        The quality of protection.

      • responseDigest

        private volatile java.lang.String responseDigest
        The optional response digest for mutual authentication.

    • Constructor Detail

      • AuthenticationInfo

        public AuthenticationInfo​(java.lang.String nextNonce,
                          int nonceCount,
                          java.lang.String cnonce,
                          java.lang.String quality,
                          java.lang.String responseDigest)
        Constructor.
        Parameters:
        nextNonce - The next nonce value.
        nonceCount - The nonce-count value.
        cnonce - The cnonce value.
        quality - The quality of protection.
        responseDigest - The optional response digest for mutual authentication.

    • Method Detail

      • equals

        public final boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getClientNonce

        public java.lang.String getClientNonce()
        Returns the client nonce.
        Returns:
        The client nonce.

      • getNextServerNonce

        public java.lang.String getNextServerNonce()
        Returns the next server nonce. This is the nonce the server wishes the client to use for a future authentication response
        Returns:
        The next nonce value.

      • getNonceCount

        public int getNonceCount()
        Returns the nonce-count value.
        Returns:
        The nonce-count value.

      • getResponseDigest

        public java.lang.String getResponseDigest()
        Returns the optional response digest for mutual authentication. Note that when used with HTTP connectors, this property maps to the "response-digest" value in the "response-auth" directive of the "Authentication-Info" header.
        Returns:
        The optional response digest for mutual authentication.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • setClientNonce

        public void setClientNonce​(java.lang.String clientNonce)
        Sets the client nonce.
        Parameters:
        clientNonce - The client nonce.

      • setNextServerNonce

        public void setNextServerNonce​(java.lang.String nextNonce)
        Sets the next server nonce. This is the nonce the server wishes the client to use for a future authentication response
        Parameters:
        nextNonce - The next nonce.

      • setNonceCount

        public void setNonceCount​(int nonceCount)
        Sets the nonce-count value.
        Parameters:
        nonceCount - The nonceCount value.

      • setResponseDigest

        public void setResponseDigest​(java.lang.String responseDigest)
        Sets the optional response digest for mutual authentication. Note that when used with HTTP connectors, this property maps to the "response-digest" value in the "response-auth" directive of the "Authentication-Info" header.
        Parameters:
        responseDigest - The response digest.