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

public Class NTCredentials

extends Object
implements Credentials, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.apache.http.auth.Credentials
Annotations
@Contract
threading:IMMUTABLE
Imports
java.io.Serializable, java.security.Principal, java.util.Locale, org.apache.http.annotation.Contract, .ThreadingBehavior, org.apache.http.util.Args, .LangUtils

Credentials implementation for Microsoft Windows platforms that includes Windows specific attributes such as name of the domain the user belongs to.
Since
4.0

Field Summary

Modifier and TypeField and Description
private final String
password

Password

private final NTUserPrincipal
principal

The user principal

private static final long
private final String
workstation

The host the authentication request is originating from.

Constructor Summary

AccessConstructor and Description
public
NTCredentials(final String
the domain/username:password formed string
usernamePassword
)

Deprecated (4.5) will be replaced with String, char[] in 5.0
The constructor with the fully qualified username and password combined string argument.
public
NTCredentials(final String
The user name. This should not include the domain to authenticate with. For example: "user" is correct whereas "DOMAIN\user" is not.
userName
,
final String
The password.
password
,
final String
The workstation the authentication request is originating from. Essentially, the computer name for this machine.
workstation
,
final String
The domain to authenticate within.
domain
)

Constructor.

Method Summary

Modifier and TypeMethod 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 String

Returns:

String the domain these credentials are intended to authenticate with.
getDomain
()

Retrieves the name to authenticate with.

public String
public String
public Principal
public String

Returns:

String the workstation the user is logged into.
getWorkstation
()

Retrieves the workstation name of the computer originating the request.

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.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

passwordback to summary
private final String password

Password

principalback to summary
private final NTUserPrincipal principal

The user principal

serialVersionUIDback to summary
private static final long serialVersionUID
workstationback to summary
private final String workstation

The host the authentication request is originating from.

Constructor Detail

NTCredentialsback to summary
public NTCredentials(final String usernamePassword)

Deprecated

(4.5) will be replaced with String, char[] in 5.0

The constructor with the fully qualified username and password combined string argument.

Parameters
usernamePassword:String

the domain/username:password formed string

Annotations
@Deprecated
NTCredentialsback to summary
public NTCredentials(final String userName, final String password, final String workstation, final String domain)

Constructor.

Parameters
userName:String

The user name. This should not include the domain to authenticate with. For example: "user" is correct whereas "DOMAIN\user" is not.

password:String

The password.

workstation:String

The workstation the authentication request is originating from. Essentially, the computer name for this machine.

domain:String

The domain to authenticate within.

Method Detail

equalsback 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
getDomainback to summary
public String getDomain()

Retrieves the name to authenticate with.

Returns:String

String the domain these credentials are intended to authenticate with.

getPasswordback to summary
public String getPassword()

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

Annotations
@Override
getUserNameback to summary
public String getUserName()
getUserPrincipalback to summary
public Principal getUserPrincipal()

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

Annotations
@Override
getWorkstationback to summary
public String getWorkstation()

Retrieves the workstation name of the computer originating the request.

Returns:String

String the workstation the user is logged into.

hashCodeback 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
toStringback 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