org.apache.http.impl.auth

Class RFC2617SchemeHC4

java.lang.Object

org.apache.http.impl.auth.AuthSchemeBaseHC4

org.apache.http.impl.auth.RFC2617SchemeHC4

All Implemented Interfaces:

org.apache.http.auth.AuthScheme, ContextAwareAuthScheme

Direct Known Subclasses:

BasicSchemeHC4, DigestSchemeHC4

@NotThreadSafe
public abstract class RFC2617SchemeHC4
extends AuthSchemeBaseHC4

Abstract authentication scheme class that lays foundation for all RFC 2617 compliant authentication schemes and provides capabilities common to all authentication schemes defined in RFC 2617.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
RFC2617SchemeHC4()
RFC2617SchemeHC4(ChallengeState challengeState) Deprecated. (4.3) do not use.
RFC2617SchemeHC4(java.nio.charset.Charset credentialsCharset)

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.charset.Charset	getCredentialsCharset()
java.lang.String	getParameter(java.lang.String name) Returns authentication parameter with the given name, if available.
protected java.util.Map<java.lang.String,java.lang.String>	getParameters() Returns authentication parameters map.
java.lang.String	getRealm() Returns authentication realm.
protected void	parseChallenge(org.apache.http.util.CharArrayBuffer buffer, int pos, int len)

Methods inherited from class org.apache.http.impl.auth.AuthSchemeBaseHC4

authenticate, getChallengeState, isProxy, processChallenge, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.http.auth.AuthScheme

authenticate, getSchemeName, isComplete, isConnectionBased

Constructor Detail

RFC2617SchemeHC4

@Deprecated
public RFC2617SchemeHC4(ChallengeState challengeState)

Deprecated. (4.3) do not use.

Creates an instance of RFC2617Scheme with the given challenge state.

Since:

4.2

RFC2617SchemeHC4

public RFC2617SchemeHC4(java.nio.charset.Charset credentialsCharset)

Since:

4.3

RFC2617SchemeHC4

public RFC2617SchemeHC4()

Method Detail

getCredentialsCharset

public java.nio.charset.Charset getCredentialsCharset()

Since:

4.3

parseChallenge

protected void parseChallenge(org.apache.http.util.CharArrayBuffer buffer,
                  int pos,
                  int len)
                       throws org.apache.http.auth.MalformedChallengeException

Specified by:

parseChallenge in class AuthSchemeBaseHC4

Throws:

org.apache.http.auth.MalformedChallengeException

getParameters

protected java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns authentication parameters map. Keys in the map are lower-cased.

Returns:

the map of authentication parameters

getParameter

public java.lang.String getParameter(java.lang.String name)

Returns authentication parameter with the given name, if available.

Parameters:

name - The name of the parameter to be returned

Returns:

the parameter with the given name

getRealm

public java.lang.String getRealm()

Returns authentication realm. The realm may not be null.

Returns:

the authentication realm