org.apache.hc.client5.http.impl.auth

Class BasicCredentialsProvider

java.lang.Object

org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider

All Implemented Interfaces:

CredentialsProvider, CredentialsStore

@Contract(threading=SAFE)
public class BasicCredentialsProvider
extends Object
implements CredentialsStore

Default implementation of CredentialsStore.

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
BasicCredentialsProvider() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all credentials.
Credentials	getCredentials(AuthScope authScope, HttpContext httpContext) Returns credentials for the given authentication scope, if available.
void	setCredentials(AuthScope authScope, Credentials credentials) Sets the credentials for the given authentication scope.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicCredentialsProvider

public BasicCredentialsProvider()

Default constructor.

Method Detail

clear

public void clear()

Description copied from interface: CredentialsStore

Clears all credentials.

Specified by:

clear in interface CredentialsStore

getCredentials

public Credentials getCredentials(AuthScope authScope,
                                  HttpContext httpContext)

Description copied from interface: CredentialsProvider

Returns credentials for the given authentication scope, if available.

Specified by:

getCredentials in interface CredentialsProvider

Parameters:

authScope - the authentication scope

httpContext - the http context

Returns:

the credentials

setCredentials

public void setCredentials(AuthScope authScope,
                           Credentials credentials)

Description copied from interface: CredentialsStore

Sets the credentials for the given authentication scope. Any previous credentials for the given scope will be overwritten.

Specified by:

setCredentials in interface CredentialsStore

Parameters:

authScope - the authentication scope

credentials - the authentication credentials for the given scope.

See Also:

CredentialsProvider.getCredentials(AuthScope, org.apache.hc.core5.http.protocol.HttpContext)

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.