public class

NTCredentials

extends Object
implements Credentials
java.lang.Object
   ↳ org.apache.http.auth.NTCredentials

Class Overview

Credentials specific to the Windows platform.

Summary

Public Constructors
NTCredentials(String usernamePassword)
The constructor with the fully qualified username and password combined string argument.
NTCredentials(String userName, String password, String workstation, String domain)
Constructor.
Public Methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
String getDomain()
Retrieves the name to authenticate with.
String getPassword()
String getUserName()
Principal getUserPrincipal()
String getWorkstation()
Retrieves the workstation name of the computer originating the request.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.auth.Credentials

Public Constructors

public NTCredentials (String usernamePassword)

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

Parameters
usernamePassword the domain/username:password formed string

public NTCredentials (String userName, String password, String workstation, String domain)

Constructor.

Parameters
userName The user name. This should not include the domain to authenticate with. For example: "user" is correct whereas "DOMAIN\\user" is not.
password The password.
workstation The workstation the authentication request is originating from. Essentially, the computer name for this machine.
domain The domain to authenticate within.

Public Methods

public boolean equals (Object o)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be both transitive and reflexive.

The implementation in Object returns true only if o is the exact same object as the receiver (using the == operator for comparison). Subclasses often implement equals(Object) so that it takes into account the two object's types and states.

The general contract for the equals(Object) and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or none of them.

Parameters
o the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public String getDomain ()

Retrieves the name to authenticate with.

Returns
  • String the domain these credentials are intended to authenticate with.

public String getPassword ()

public String getUserName ()

public Principal getUserPrincipal ()

public String getWorkstation ()

Retrieves the workstation name of the computer originating the request.

Returns
  • String the workstation the user is logged into.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression: 

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

Returns
  • a printable representation of this object.