org.restlet.data
Class AuthenticationInfo

java.lang.Object
  extended by org.restlet.data.AuthenticationInfo

public class AuthenticationInfo
extends 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.

Author:
Kelly McLaughlin, Jerome Louvel
See Also:
HTTP Authentication - The Authentication-Info Header

Constructor Summary
AuthenticationInfo(String nextNonce, int nonceCount, String cnonce, String quality, String responseDigest)
          Constructor.
 
Method Summary
 boolean equals(Object obj)
          
 String getClientNonce()
          Returns the client nonce.
 String getNextServerNonce()
          Returns the next server nonce.
 int getNonceCount()
          Returns the nonce-count value.
 String getQuality()
          Returns the quality of protection.
 String getResponseDigest()
          Returns the optional response digest for mutual authentication.
 int hashCode()
          
 void setClientNonce(String clientNonce)
          Sets the client nonce.
 void setNextServerNonce(String nextNonce)
          Sets the next server nonce.
 void setNonceCount(int nonceCount)
          Sets the nonce-count value.
 void setQuality(String qop)
          Sets the quality of protection.
 void setResponseDigest(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
 

Constructor Detail

AuthenticationInfo

public AuthenticationInfo(String nextNonce,
                          int nonceCount,
                          String cnonce,
                          String quality,
                          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(Object obj)

Overrides:
equals in class Object

getClientNonce

public String getClientNonce()
Returns the client nonce.

Returns:
The client nonce.

getNextServerNonce

public 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.

getQuality

public String getQuality()
Returns the quality of protection. The value can be ChallengeMessage.QUALITY_AUTHENTICATION for authentication or ChallengeMessage.QUALITY_AUTHENTICATION_INTEGRITY for authentication with integrity protection.

Returns:
The quality of protection.

getResponseDigest

public 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 Object

setClientNonce

public void setClientNonce(String clientNonce)
Sets the client nonce.

Parameters:
clientNonce - The client nonce.

setNextServerNonce

public void setNextServerNonce(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.

setQuality

public void setQuality(String qop)
Sets the quality of protection. The value can be ChallengeMessage.QUALITY_AUTHENTICATION for authentication or ChallengeMessage.QUALITY_AUTHENTICATION_INTEGRITY for authentication with integrity protection.

Parameters:
qop - The quality of protection.

setResponseDigest

public void setResponseDigest(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.


Copyright © 2005-2013 Restlet.