Top Description Fields Constructors Methods
org.apache.http.impl.auth

public abstract Class RFC2617Scheme

extends AuthSchemeBase
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Known Direct Subclasses
org.apache.http.impl.auth.BasicScheme, org.apache.http.impl.auth.DigestScheme
Annotations
@SuppressWarnings:deprecation
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, .ObjectStreamException, .Serializable, java.nio.charset.Charset, java.util.HashMap, .Locale, .Map, org.apache.http.Consts, .HeaderElement, .HttpRequest, org.apache.http.auth.ChallengeState, .MalformedChallengeException, org.apache.http.auth.params.AuthPNames, org.apache.http.message.BasicHeaderValueParser, .HeaderValueParser, .ParserCursor, org.apache.http.util.CharArrayBuffer, .CharsetUtils
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

Field Summary

Modifier and TypeField and Description
private transient Charset
credentialsCharset

private final Map<String, String>
params

private static final long
serialVersionUID

Inherited from org.apache.http.impl.auth.AuthSchemeBase:
challengeState

Constructor Summary

AccessConstructor and Description
public
RFC2617Scheme(final ChallengeState challengeState)

Deprecated (4.3) do not use.
Creates an instance of RFC2617Scheme with the given challenge state.
public
RFC2617Scheme(final Charset credentialsCharset)

public
RFC2617Scheme()

Method Summary

Modifier and TypeMethod and Description
public Charset
getCredentialsCharset()

pack-priv String
getCredentialsCharset(final HttpRequest request)

public String

Returns:

the parameter with the given name
getParameter(final String
The name of the parameter to be returned
name)

Implements org.apache.http.auth.AuthScheme.getParameter.

Returns authentication parameter with the given name, if available.
protected Map<String, String>

Returns:

the map of authentication parameters
getParameters()

Returns authentication parameters map.

public String

Returns:

the authentication realm
getRealm()

Implements org.apache.http.auth.AuthScheme.getRealm.

Returns authentication realm.
protected void
parseChallenge(final CharArrayBuffer buffer, final int pos, final int len)

Implements abstract org.apache.http.impl.auth.AuthSchemeBase.parseChallenge.

private void
readObject(final ObjectInputStream in)

private void
readObjectNoData()

private void
writeObject(final ObjectOutputStream out)

Inherited from org.apache.http.impl.auth.AuthSchemeBase:
authenticategetChallengeStateisProxyprocessChallengetoString

Field Detail

credentialsCharsetback to summary
private transient Charset credentialsCharset
paramsback to summary
private final Map<String, String> params
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

RFC2617Schemeback to summary
public RFC2617Scheme(final ChallengeState challengeState)

Deprecated

(4.3) do not use.

Creates an instance of RFC2617Scheme with the given challenge state.

Annotations
@Deprecated
Since
4.2
RFC2617Schemeback to summary
public RFC2617Scheme(final Charset credentialsCharset)
Since
4.3
RFC2617Schemeback to summary
public RFC2617Scheme()

Method Detail

getCredentialsCharsetback to summary
public Charset getCredentialsCharset()
Since
4.3
getCredentialsCharsetback to summary
pack-priv String getCredentialsCharset(final HttpRequest request)
getParameterback to summary
public String getParameter(final String name)

Implements org.apache.http.auth.AuthScheme.getParameter.

Returns authentication parameter with the given name, if available.

Parameters
name:String

The name of the parameter to be returned

Returns:String

the parameter with the given name

Annotations
@Override
getParametersback to summary
protected Map<String, String> getParameters()

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

Returns:Map<String, String>

the map of authentication parameters

getRealmback to summary
public String getRealm()

Implements org.apache.http.auth.AuthScheme.getRealm.

Returns authentication realm. The realm may not be null.

Returns:String

the authentication realm

Annotations
@Override
parseChallengeback to summary
protected void parseChallenge(final CharArrayBuffer buffer, final int pos, final int len) throws MalformedChallengeException

Implements abstract org.apache.http.impl.auth.AuthSchemeBase.parseChallenge.

Annotations
@Override
readObjectback to summary
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException
Annotations
@SuppressWarnings:unchecked
readObjectNoDataback to summary
private void readObjectNoData() throws ObjectStreamException
writeObjectback to summary
private void writeObject(final ObjectOutputStream out) throws IOException