org.apache.http.auth

Class NTCredentials

java.lang.Object

org.apache.http.auth.NTCredentials

All Implemented Interfaces:

Serializable, Credentials

@Contract(threading=IMMUTABLE)
public class NTCredentials
extends Object
implements Credentials, Serializable

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

Since:

4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NTCredentials(String usernamePassword) Deprecated. (4.5) will be replaced with String, char[] in 5.0
NTCredentials(String userName, String password, String workstation, String domain) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
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()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NTCredentials

@Deprecated
public NTCredentials(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 - the domain/username:password formed string

NTCredentials

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.

Method Detail

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface Credentials

getUserName

public String getUserName()

getPassword

public String getPassword()

Specified by:

getPassword in interface Credentials

getDomain

public String getDomain()

Retrieves the name to authenticate with.

Returns:

String the domain these credentials are intended to authenticate with.

getWorkstation

public String getWorkstation()

Retrieves the workstation name of the computer originating the request.

Returns:

String the workstation the user is logged into.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object