org.restlet.data
Class ChallengeResponse

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

public final class ChallengeResponse
extends java.lang.Object

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.

Author:
Jerome Louvel

Constructor Summary
ChallengeResponse(ChallengeScheme scheme, java.lang.String credentials)
          Constructor.
ChallengeResponse(ChallengeScheme scheme, java.lang.String identifier, char[] secret)
          Constructor.
ChallengeResponse(ChallengeScheme scheme, java.lang.String identifier, Series<Parameter> parameters)
          Constructor.
ChallengeResponse(ChallengeScheme scheme, java.lang.String identifier, java.lang.String secret)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object obj)
          
 java.lang.String getCredentials()
          Returns the credentials.
 java.lang.String getIdentifier()
          Returns the user identifier, such as a login name or an access key.
 Series<Parameter> getParameters()
          Returns the modifiable series of scheme parameters.
 java.security.Principal getPrincipal()
          Gets the principal associated to the identifier property.
 ChallengeScheme getScheme()
          Returns the scheme used.
 char[] getSecret()
          Returns the user secret, such as a password or a secret key.
 int hashCode()
          
 boolean isAuthenticated()
          Indicates if the identifier or principal has been authenticated.
 void setAuthenticated(boolean authenticated)
          Indicates if the identifier or principal has been authenticated.
 void setCredentialComponents(Series<Parameter> credentialComponents)
          Sets the credential components.
 void setCredentials(java.lang.String credentials)
          Sets the credentials.
 void setIdentifier(java.lang.String identifier)
          Sets the user identifier, such as a login name or an access key.
 void setScheme(ChallengeScheme scheme)
          Sets the scheme used.
 void setSecret(char[] secret)
          Sets the user secret, such as a password or a secret key.
 void setSecret(java.lang.String secret)
          Sets the user secret, such as a password or a secret key.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChallengeResponse

public ChallengeResponse(ChallengeScheme scheme,
                         java.lang.String credentials)
Constructor.

Parameters:
scheme - The challenge scheme.
credentials - The raw credentials for custom challenge schemes.

ChallengeResponse

public ChallengeResponse(ChallengeScheme scheme,
                         java.lang.String identifier,
                         char[] secret)
Constructor.

Parameters:
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.

ChallengeResponse

public ChallengeResponse(ChallengeScheme scheme,
                         java.lang.String identifier,
                         Series<Parameter> parameters)
Constructor.

Parameters:
scheme - The challenge scheme.
identifier - The user identifier, such as a login name or an access key.
parameters - The additional scheme parameters.

ChallengeResponse

public ChallengeResponse(ChallengeScheme scheme,
                         java.lang.String identifier,
                         java.lang.String secret)
Constructor.

Parameters:
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

equals

public boolean equals(java.lang.Object obj)

Overrides:
equals in class java.lang.Object

getCredentials

public java.lang.String getCredentials()
Returns the credentials.

Returns:
The credentials.

getIdentifier

public java.lang.String getIdentifier()
Returns the user identifier, such as a login name or an access key.

Returns:
The user identifier, such as a login name or an access key.

getParameters

public Series<Parameter> getParameters()
Returns the modifiable series of scheme parameters. Creates a new instance if no one has been set.

Returns:
The modifiable series of scheme parameters.

getPrincipal

public java.security.Principal getPrincipal()
Gets the principal associated to the identifier property.

Returns:
The Principal.

getScheme

public ChallengeScheme getScheme()
Returns the scheme used.

Returns:
The scheme used.

getSecret

public char[] getSecret()
Returns the user secret, such as a password or a secret key.

Returns:
The user secret, such as a password or a secret key.

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

isAuthenticated

public boolean isAuthenticated()
Indicates if the identifier or principal has been authenticated. The application is responsible for updating this property, relying on a Guard or manually.

Returns:
True if the identifier or principal has been authenticated.

setAuthenticated

public void setAuthenticated(boolean authenticated)
Indicates if the identifier or principal has been authenticated. The application is responsible for updating this property, relying on a Guard or manually.

Parameters:
authenticated - True if the identifier or principal has been authenticated.

setCredentialComponents

public void setCredentialComponents(Series<Parameter> credentialComponents)
Sets the credential components.

Parameters:
credentialComponents - The credential components.

setCredentials

public void setCredentials(java.lang.String credentials)
Sets the credentials.

Parameters:
credentials - The credentials.

setIdentifier

public void setIdentifier(java.lang.String identifier)
Sets the user identifier, such as a login name or an access key.

Parameters:
identifier - The user identifier, such as a login name or an access key.

setScheme

public void setScheme(ChallengeScheme scheme)
Sets the scheme used.

Parameters:
scheme - The scheme used.

setSecret

public void setSecret(char[] secret)
Sets the user secret, such as a password or a secret key.

Parameters:
secret - The user secret, such as a password or a secret key.

setSecret

public void setSecret(java.lang.String secret)
Sets the user secret, such as a password or a secret key.

Parameters:
secret - The user secret, such as a password or a secret key.


Copyright © 2005-2008 Noelios Technologies.