|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.data.ChallengeMessage
org.restlet.data.ChallengeResponse
public final class ChallengeResponse
Authentication response sent by client to an origin server. This is typically
following a ChallengeRequest
sent by the origin server to the client.
Sometimes, it might be faster to preemptively issue a challenge response if
the client knows for sure that the target resource will require
authentication.
Note that when used with HTTP connectors, this class maps to the
"Authorization" header.
Field Summary |
---|
Fields inherited from class org.restlet.data.ChallengeMessage |
---|
QUALITY_AUTHENTICATION, QUALITY_AUTHENTICATION_INTEGRITY |
Constructor Summary | |
---|---|
ChallengeResponse(ChallengeRequest challengeRequest,
Response response,
String identifier,
char[] secret)
Constructor. |
|
ChallengeResponse(ChallengeRequest challengeRequest,
Response response,
String identifier,
char[] secret,
String secretAlgorithm)
Constructor. |
|
ChallengeResponse(ChallengeRequest challengeRequest,
Response response,
String identifier,
String secret)
Constructor. |
|
ChallengeResponse(ChallengeScheme scheme)
Constructor with no credentials. |
|
ChallengeResponse(ChallengeScheme scheme,
Series<Parameter> parameters,
String identifier,
char[] secret,
String secretAlgorithm,
String realm,
String quality,
Reference digestRef,
String digestAlgorithm,
String opaque,
String clientNonce,
String serverNonce,
int serverNounceCount,
long timeIssued)
Constructor. |
|
ChallengeResponse(ChallengeScheme scheme,
String identifier,
char[] secret)
Constructor. |
|
ChallengeResponse(ChallengeScheme scheme,
String identifier,
char[] secret,
Series<Parameter> parameters)
Constructor. |
|
ChallengeResponse(ChallengeScheme scheme,
String identifier,
Series<Parameter> parameters)
Constructor. |
|
ChallengeResponse(ChallengeScheme scheme,
String identifier,
String secret)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
String |
getClientNonce()
Returns the client nonce. |
Reference |
getDigestRef()
Returns the Request.getResourceRef() value duplicated here in
case a proxy changed it. |
String |
getIdentifier()
Returns the user identifier, such as a login name or an access key. |
Principal |
getPrincipal()
Gets the principal associated to the identifier property. |
String |
getQuality()
Returns the chosen quality of protection. |
char[] |
getSecret()
Returns the user secret, such as a password or a secret key. |
String |
getSecretAlgorithm()
Returns the digest algorithm name optionally applied on the user secret. |
int |
getServerNounceCount()
Returns the server nonce count. |
String |
getServerNounceCountAsHex()
Returns the server nonce count as an hexadecimal string of eight characters. |
long |
getTimeIssued()
Returns the time when the response was issued, as returned by System.currentTimeMillis() . |
int |
hashCode()
|
void |
setClientNonce(String clientNonce)
Sets the client nonce. |
void |
setDigestRef(Reference digestRef)
Sets the digest URI reference. |
void |
setIdentifier(String identifier)
Sets the user identifier, such as a login name or an access key. |
void |
setQuality(String quality)
Sets the chosen quality of protection. |
void |
setSecret(char[] secret)
Sets the user secret, such as a password or a secret key. |
void |
setSecret(String secret)
Sets the user secret, such as a password or a secret key. |
void |
setSecretAlgorithm(String secretDigestAlgorithm)
Sets the digest algorithm name optionally applied on the user secret. |
void |
setServerNounceCount(int serverNounceCount)
Sets the server nonce count. |
void |
setTimeIssued(long timeIssued)
Sets the time when the response was issued, as returned by System.currentTimeMillis() . |
Methods inherited from class org.restlet.data.ChallengeMessage |
---|
getDigestAlgorithm, getOpaque, getParameters, getRawValue, getRealm, getScheme, getServerNonce, setDigestAlgorithm, setOpaque, setParameters, setRawValue, setRealm, setScheme, setServerNonce |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ChallengeResponse(ChallengeRequest challengeRequest, Response response, String identifier, char[] secret)
challengeRequest
- The challenge request sent by the origin server.response
- The latest server response.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret, such as a password or a secret key, with no
digest applied.public ChallengeResponse(ChallengeRequest challengeRequest, Response response, String identifier, char[] secret, String secretAlgorithm)
challengeRequest
- The challenge request sent by the origin server.response
- The latest server response.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret used to compute the secret, with an optional
digest applied.secretAlgorithm
- The digest algorithm of the user secret (see Digest
class).public ChallengeResponse(ChallengeRequest challengeRequest, Response response, String identifier, String secret)
challengeRequest
- The challenge request sent by the origin server.response
- The latest server response.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret, such as a password or a secret key.public ChallengeResponse(ChallengeScheme scheme)
scheme
- The challenge scheme.public ChallengeResponse(ChallengeScheme scheme, Series<Parameter> parameters, String identifier, char[] secret, String secretAlgorithm, String realm, String quality, Reference digestRef, String digestAlgorithm, String opaque, String clientNonce, String serverNonce, int serverNounceCount, long timeIssued)
scheme
- The challenge scheme.parameters
- The additional scheme parameters.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret, such as a password or a secret key.secretAlgorithm
- The digest algorithm name optionally applied on the user
secret.realm
- The authentication realm.quality
- The chosen quality of protection.digestRef
- The Request.getResourceRef()
value duplicated here in
case a proxy changed it.digestAlgorithm
- The digest algorithm.opaque
- An opaque string of data which should be returned by the
client unchanged.clientNonce
- The client nonce value.serverNonce
- The server nonce.serverNounceCount
- The server nonce count.timeIssued
- The time when the response was issued, as returned by
System.currentTimeMillis()
.public ChallengeResponse(ChallengeScheme scheme, String identifier, char[] secret)
scheme
- The challenge scheme.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret, such as a password or a secret key.public ChallengeResponse(ChallengeScheme scheme, String identifier, char[] secret, Series<Parameter> parameters)
scheme
- The challenge scheme.identifier
- The user identifier, such as a login name or an access key.parameters
- The additional scheme parameters.public ChallengeResponse(ChallengeScheme scheme, String identifier, Series<Parameter> parameters)
scheme
- The challenge scheme.identifier
- The user identifier, such as a login name or an access key.parameters
- The additional scheme parameters.public ChallengeResponse(ChallengeScheme scheme, String identifier, String secret)
scheme
- The challenge scheme.identifier
- The user identifier, such as a login name or an access key.secret
- The user secret, such as a password or a secret key.Method Detail |
---|
public boolean equals(Object obj)
equals
in class Object
public String getClientNonce()
public Reference getDigestRef()
Request.getResourceRef()
value duplicated here in
case a proxy changed it.
public String getIdentifier()
public Principal getPrincipal()
public String getQuality()
public char[] getSecret()
String.String(char[])
for security
reasons.
public String getSecretAlgorithm()
public int getServerNounceCount()
public String getServerNounceCountAsHex()
public long getTimeIssued()
System.currentTimeMillis()
.
public int hashCode()
hashCode
in class ChallengeMessage
public void setClientNonce(String clientNonce)
clientNonce
- The client nonce.public void setDigestRef(Reference digestRef)
digestRef
- The digest URI reference.public void setIdentifier(String identifier)
identifier
- The user identifier, such as a login name or an access key.public void setQuality(String quality)
quality
- The chosen quality of protection.public void setSecret(char[] secret)
secret
- The user secret, such as a password or a secret key.public void setSecret(String secret)
secret
- The user secret, such as a password or a secret key.public void setSecretAlgorithm(String secretDigestAlgorithm)
secretDigestAlgorithm
- The digest algorithm name optionally applied on the user
secret.public void setServerNounceCount(int serverNounceCount)
serverNounceCount
- The server nonce count.public void setTimeIssued(long timeIssued)
System.currentTimeMillis()
.
timeIssued
- The time when the response was issued.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |