org.apache.commons.httpclient
Class NTCredentials

java.lang.Object
  |
  +--org.apache.commons.httpclient.UsernamePasswordCredentials
        |
        +--org.apache.commons.httpclient.NTCredentials

All Implemented Interfaces:

Credentials

public class NTCredentials

extends UsernamePasswordCredentials

Credentials for use with the NTLM authentication scheme which requires additional information.

Since:

2.0

Version:

$Revision: 1.6.2.2 $ $Date: 2004/02/22 18:21:13 $

Author:

Adrian Sutton, Mike Bowler

Constructor Summary

NTCredentials()
Default constructor.

NTCredentials(String userName, String password, String host, String domain)
Constructor.

Method Summary

String	getDomain() Retrieves the name to authenticate with.
String	getHost() Retrieves the host name of the computer originating the request.
void	setDomain(String domain) Sets the domain to authenticate with.
void	setHost(String host) Sets the host name of the computer originating the request.
String	toString() Return a string representation of this object.

Methods inherited from class org.apache.commons.httpclient.UsernamePasswordCredentials

getPassword, getUserName, setPassword, setUserName

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NTCredentials

public NTCredentials()

Default constructor.

NTCredentials

public NTCredentials(String userName,
                     String password,
                     String host,
                     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.

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

domain - The domain to authenticate within.

Method Detail

setDomain

public void setDomain(String domain)

Sets the domain to authenticate with.

Parameters:

domain - the NT domain to authenticate in.

See Also:

getDomain()

getDomain

public String getDomain()

Retrieves the name to authenticate with.

Returns:

String the domain these credentials are intended to authenticate with.

See Also:

setDomain(String)

setHost

public void setHost(String host)

Sets the host name of the computer originating the request.

Parameters:

host - the Host the user is logged into.

getHost

public String getHost()

Retrieves the host name of the computer originating the request.

Returns:

String the host the user is logged into.

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class UsernamePasswordCredentials

Returns:

A string represenation of this object.