oracle.ifs.common

Class HttpDigestCredential

java.lang.Object

oracle.ifs.common.HttpDigestCredential

All Implemented Interfaces:

Serializable, Credential

public class HttpDigestCredential
extends Object
implements Credential

A HttpDigestCredential encapsulates a name, challenge, and response for presentation to a CredentialManager to authenticate a user.

Version:

1.0

Author:

Vijayanth Devadhar

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTPDIGESTCREDENTIALTYPE_RFC2069 Indicates that the credential is RFC 2069 type.
static int	HTTPDIGESTCREDENTIALTYPE_RFC2617 Indicates that the credential is RFC 2617 type.
protected String	m_Challenge The challenge.
protected String	m_Cnonce the cnonce value
protected String	m_Method the method of access.
protected String	m_Name The name of the user.
protected String	m_Nc the nc value
protected String	m_Qop the qop value
protected String	m_Realm The realm.
protected String	m_Response The 32 char hex string representing 16-byte response.
protected String	m_URI The URI.

Constructor Summary

Constructors

Constructor and Description
HttpDigestCredential() Constructs a HttpDigestCredential.
HttpDigestCredential(String name, String challenge, String response, String realm, String uri, String method) Constructs a HttpDigestCredential.
HttpDigestCredential(String name, String challenge, String response, String realm, String uri, String method, String qop, String cnonce, String nc) Constructs a HttpDigestCredential.

Method Summary

Modifier and Type	Method and Description
String	getChallenge() Gets the challenge.
String	getCnonce() Gets the cnonce.
String	getMethod() Gets the method.
String	getName() Gets the name of the user.
String	getNc() Gets the nc.
String	getQop() Gets the qop.
String	getRealm() Gets the realm.
String	getResponse() Gets the response.
int	getType() Returns the type of the HttpDigestCredential.
String	getUri() Gets the URI.
void	setChallenge(String challenge) Sets the challenge.
void	setCnonce(String cnonce) Sets the cnonce.
void	setMethod(String method) Sets the Method.
void	setName(String name) Sets the name of the user.
void	setNc(String nc) Sets the nc.
void	setQop(String qop) Sets the Qop.
void	setRealm(String realm) Sets the realm.
void	setResponse(String response) Sets the response.
void	setUri(String uri) Sets the URI.

Methods inherited from class java.lang.Object

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

Field Detail

HTTPDIGESTCREDENTIALTYPE_RFC2069

public static final int HTTPDIGESTCREDENTIALTYPE_RFC2069

Indicates that the credential is RFC 2069 type.

See Also:

Constant Field Values

(Published)

HTTPDIGESTCREDENTIALTYPE_RFC2617

public static final int HTTPDIGESTCREDENTIALTYPE_RFC2617

Indicates that the credential is RFC 2617 type.

See Also:

Constant Field Values

(Published)

m_Name

protected String m_Name

The name of the user.

(Unpublished)

m_Challenge

protected String m_Challenge

The challenge.

(Unpublished)

m_Response

protected String m_Response

The 32 char hex string representing 16-byte response.

(Unpublished)

m_Realm

protected String m_Realm

The realm.

(Unpublished)

m_URI

protected String m_URI

The URI.

(Unpublished)

m_Method

protected String m_Method

the method of access.

(Unpublished)

m_Qop

protected String m_Qop

the qop value

(Unpublished)

m_Cnonce

protected String m_Cnonce

the cnonce value

(Unpublished)

m_Nc

protected String m_Nc

the nc value

(Unpublished)

Constructor Detail

HttpDigestCredential

public HttpDigestCredential()
                     throws IfsException

Constructs a HttpDigestCredential.

Throws:

IfsException - if the operation fails

(Published)

HttpDigestCredential

public HttpDigestCredential(String name,
                            String challenge,
                            String response,
                            String realm,
                            String uri,
                            String method,
                            String qop,
                            String cnonce,
                            String nc)
                     throws IfsException

Constructs a HttpDigestCredential. Use this if you are using RFC 2617.

Parameters:

name - the name of the user

challenge - the challenge

response - the 16-byte response

realm - the realm

uri - the URI

method - the method

qop - the qop

cnonce - the cnonce

nc - the nc value

Throws:

IfsException - if the operation fails

(Published)

HttpDigestCredential

public HttpDigestCredential(String name,
                            String challenge,
                            String response,
                            String realm,
                            String uri,
                            String method)
                     throws IfsException

Constructs a HttpDigestCredential. Use this if you are using RFC 2069.

Parameters:

name - the name of the user

challenge - the challenge

response - the 16-byte response

realm - the realm

uri - the URI

method - the method

Throws:

IfsException - if the operation fails

(Published)

Method Detail

getName

public String getName()
               throws IfsException

Gets the name of the user.

Specified by:

getName in interface Credential

Returns:

the name of the user

Throws:

IfsException - (IFS-10187) if the operation fails

(Published)

setName

public void setName(String name)
             throws IfsException

Sets the name of the user.

Specified by:

setName in interface Credential

Parameters:

name - the name of the user

Throws:

IfsException - (IFS-10188) if the operation fails

(Published)

getChallenge

public String getChallenge()
                    throws IfsException

Gets the challenge.

Returns:

the challenge

Throws:

IfsException - if the operation fails

(Published)

setChallenge

public void setChallenge(String challenge)
                  throws IfsException

Sets the challenge.

Parameters:

challenge - the challenge

Throws:

IfsException - if the operation fails

(Published)

getResponse

public String getResponse()
                   throws IfsException

Gets the response.

Returns:

the response

Throws:

IfsException - if the operation fails

(Published)

setResponse

public void setResponse(String response)
                 throws IfsException

Sets the response.

Parameters:

response - 16 bytes rep as a 32 Hex string

Throws:

IfsException - if the operation fails

(Published)

getRealm

public String getRealm()
                throws IfsException

Gets the realm.

Returns:

the realm

Throws:

IfsException - if the operation fails

(Published)

setRealm

public void setRealm(String realm)
              throws IfsException

Sets the realm.

Parameters:

realm - the realm of the user

Throws:

IfsException - if the operation fails

(Published)

getUri

public String getUri()
              throws IfsException

Gets the URI.

Returns:

the uri

Throws:

IfsException - if the operation fails

(Published)

setUri

public void setUri(String uri)
            throws IfsException

Sets the URI.

Parameters:

uri - the URI of the request

Throws:

IfsException - if the operation fails

(Published)

getMethod

public String getMethod()
                 throws IfsException

Gets the method.

Returns:

the method

Throws:

IfsException - if the operation fails

(Published)

setMethod

public void setMethod(String method)
               throws IfsException

Sets the Method.

Parameters:

method - the Method of the request

Throws:

IfsException - if the operation fails

(Published)

getQop

public String getQop()
              throws IfsException

Gets the qop.

Returns:

the qop

Throws:

IfsException - if the operation fails

(Published)

setQop

public void setQop(String qop)
            throws IfsException

Sets the Qop.

Parameters:

qop - the Qop of the request

Throws:

IfsException - if the operation fails

(Published)

getCnonce

public String getCnonce()
                 throws IfsException

Gets the cnonce.

Returns:

the cnonce

Throws:

IfsException - if the operation fails

(Published)

setCnonce

public void setCnonce(String cnonce)
               throws IfsException

Sets the cnonce.

Parameters:

cnonce - the cnonce of the request

Throws:

IfsException - if the operation fails

(Published)

getNc

public String getNc()
             throws IfsException

Gets the nc.

Returns:

the nc

Throws:

IfsException - if the operation fails

(Published)

setNc

public void setNc(String nc)
           throws IfsException

Sets the nc.

Parameters:

nc - the nonce of the request

Throws:

IfsException - if the operation fails

(Published)

getType

public int getType()

Returns the type of the HttpDigestCredential.

Returns:

HTTPDIGESTCREDENTIALTYPE_RFC2069 if credential type is RFC 2069, or HTTPDIGESTCREDENTIALTYPE_RFC2617 if credential type is RFC 2617.

(Published)