Apache HttpClient 5.3 · org.apache.hc.client5.http.auth.UsernamePasswordCredentials

public Class UsernamePasswordCredentials

Simple Credentials representation based on a user name / password pair.

Since

4.0

Field Summary

Modifier and Type	Field and Description
private final char[]	password
private final Principal	principal
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	UsernamePasswordCredentials(final Principal the user principal principal, final char[] the password password) The constructor with the username and password arguments.
public	UsernamePasswordCredentials(final String the user name username, final char[] the password password) The constructor with the username and password arguments.

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public char[]	getPassword() Implements org.apache.hc.client5.http.auth.Credentials.getPassword. Deprecated Use `getUserPassword()`.
public String	getUserName()
public char[]	getUserPassword()
public Principal	getUserPrincipal() Implements org.apache.hc.client5.http.auth.Credentials.getUserPrincipal.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Modifier and Type

Method and Description

public boolean

equals(final Object

the reference object with which to compare.

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public char[]

getPassword()

Implements org.apache.hc.client5.http.auth.Credentials.getPassword.

Deprecated Use getUserPassword().

public String

getUserName()

public char[]

getUserPassword()

public Principal

getUserPrincipal()

Implements org.apache.hc.client5.http.auth.Credentials.getUserPrincipal.

public int

hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.

public String

toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Field Detail

password	back to summary
private final char[] password

principal	back to summary
private final Principal principal

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

UsernamePasswordCredentials back to summary

UsernamePasswordCredentials	back to summary
public UsernamePasswordCredentials(final Principal principal, final char[] password) The constructor with the username and password arguments. Parameters principal:Principal the user principal password:char[] the password Since 5.3 See Also `BasicUserPrincipal`, `NTUserPrincipal`

public UsernamePasswordCredentials(final Principal principal, final char[] password)

The constructor with the username and password arguments.

Parameters

principal:Principal: the user principal
password:char[]: the password

Since

5.3

See Also

BasicUserPrincipal, NTUserPrincipal

UsernamePasswordCredentials	back to summary
public UsernamePasswordCredentials(final String username, final char[] password) The constructor with the username and password arguments. Parameters username:String the user name password:char[] the password

UsernamePasswordCredentials

back to summary

public UsernamePasswordCredentials(final String username, final char[] password)

The constructor with the username and password arguments.

Parameters

username:String: the user name
password:char[]: the password

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getPassword back to summary

getPassword	back to summary
public char[] getPassword() Implements org.apache.hc.client5.http.auth.Credentials.getPassword. Deprecated Use `getUserPassword()`. Annotations @Deprecated @Override

public char[] getPassword()

Implements org.apache.hc.client5.http.auth.Credentials.getPassword.

Deprecated

Use getUserPassword().

Annotations

@Deprecated
@Override

getUserName	back to summary
public String getUserName()

getUserPassword	back to summary
public char[] getUserPassword() Since 5.3

getUserPrincipal	back to summary
public Principal getUserPrincipal() Implements org.apache.hc.client5.http.auth.Credentials.getUserPrincipal. Annotations @Override

getUserPrincipal

back to summary

public Principal getUserPrincipal()

Implements org.apache.hc.client5.http.auth.Credentials.getUserPrincipal.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations