org.apache.hc.client5.http.auth

Class NTCredentials

java.lang.Object

org.apache.hc.client5.http.auth.NTCredentials

All Implemented Interfaces:

java.io.Serializable, Credentials

public class NTCredentials
extends java.lang.Object
implements Credentials, java.io.Serializable

Microsoft Windows specific Credentials representation 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(java.lang.String userName, char[] password, java.lang.String workstation, java.lang.String domain) Constructor.
NTCredentials(java.lang.String userName, char[] password, java.lang.String workstation, java.lang.String domain, java.lang.String netbiosDomain) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getDomain() Retrieves the name to authenticate with.
java.lang.String	getNetbiosDomain() Retrieves the netbios domain to authenticate with.
char[]	getPassword()
java.lang.String	getUserName()
java.security.Principal	getUserPrincipal()
java.lang.String	getWorkstation() Retrieves the netbios workstation name of the computer originating the request.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NTCredentials

public NTCredentials(java.lang.String userName,
                     char[] password,
                     java.lang.String workstation,
                     java.lang.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.

NTCredentials

public NTCredentials(java.lang.String userName,
                     char[] password,
                     java.lang.String workstation,
                     java.lang.String domain,
                     java.lang.String netbiosDomain)

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 netbios workstation name that the authentication request is originating from. Essentially, the computer name for this machine.

domain - The domain to authenticate within.

netbiosDomain - The netbios version of the domain name.

Method Detail

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface Credentials

getUserName

public java.lang.String getUserName()

getPassword

public char[] getPassword()

Specified by:

getPassword in interface Credentials

getDomain

public java.lang.String getDomain()

Retrieves the name to authenticate with.

Returns:

String the domain these credentials are intended to authenticate with.

getNetbiosDomain

public java.lang.String getNetbiosDomain()

Retrieves the netbios domain to authenticate with.

Returns:

String the netbios domain name.

getWorkstation

public java.lang.String getWorkstation()

Retrieves the netbios workstation name of the computer originating the request.

Returns:

String the netbios workstation the user is logged into.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object