org.restlet.gwt.data
Class ChallengeResponse

java.lang.Object
  org.restlet.gwt.data.ChallengeResponse

public final class ChallengeResponse
extends Object

Authentication response sent by client to an origin server.

Author:

Jerome Louvel

Constructor Summary

ChallengeResponse(ChallengeScheme scheme, String credentials)
Constructor.

ChallengeResponse(ChallengeScheme scheme, String identifier, char[] secret)
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	getCredentials() Returns the credentials.
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.
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(String credentials) Sets the credentials.
void	setIdentifier(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(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,
                         String credentials)

Constructor.

Parameters:

scheme - The challenge scheme.

credentials - The raw credentials for custom challenge schemes.

ChallengeResponse

public ChallengeResponse(ChallengeScheme scheme,
                         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,
                         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,
                         String identifier,
                         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(Object obj)

Overrides:

equals in class Object

getCredentials

public String getCredentials()

Returns the credentials.

Returns:

The credentials.

getIdentifier

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

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 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(String credentials)

Sets the credentials.

Parameters:

credentials - The credentials.

setIdentifier

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