/*
* $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/NTCredentials.java,v 1.6.2.1 2003/08/16 00:09:37 adrian Exp $
* $Revision: 1.6.2.1 $
* $Date: 2003/08/16 00:09:37 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.commons.httpclient;
/** {@link Credentials} for use with the NTLM authentication scheme which requires additional
* information.
*
* @author <a href="mailto:[email protected]">Adrian Sutton</a>
* @author <a href="mailto:[email protected]">Mike Bowler</a>
*
* @version $Revision: 1.6.2.1 $ $Date: 2003/08/16 00:09:37 $
*
* @since 2.0
*/
public class NTCredentials extends UsernamePasswordCredentials {
// ----------------------------------------------------- Instance Variables
/** The Domain to authenticate with. */
private String domain;
/** The host the authentication request is originating from. */
private String host;
// ----------------------------------------------------------- Constructors
/**
* Default constructor.
*/
public NTCredentials() {
super();
}
/**
* Constructor.
* @param userName The user name. This should not include the domain to authenticate with.
* For example: "user" is correct whereas "DOMAIN\\user" is not.
* @param password The password.
* @param host The host the authentication request is originating from. Essentially, the
* computer name for this machine.
* @param domain The domain to authenticate within.
*/
public NTCredentials(String userName, String password, String host,
String domain) {
super(userName, password);
this.domain = domain;
this.host = host;
}
// ------------------------------------------------------- Instance Methods
/**
* Sets the domain to authenticate with.
*
* @param domain the NT domain to authenticate in.
*
* @see #getDomain()
*
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
* Retrieves the name to authenticate with.
*
* @return String the domain these credentials are intended to authenticate with.
*
* @see #setDomain(String)
*
*/
public String getDomain() {
return domain;
}
/** Sets the host name of the computer originating the request.
*
* @param host the Host the user is logged into.
*/
public void setHost(String host) {
this.host = host;
}
/**
* Retrieves the host name of the computer originating the request.
*
* @return String the host the user is logged into.
*/
public String getHost() {
return this.host;
}
/**
* Return a string representation of this object.
* @return A string represenation of this object.
*/
public String toString() {
final StringBuffer sbResult = new StringBuffer(super.toString());
sbResult.append(":");
sbResult.append(this.host == null ? "null" : this.host);
sbResult.append(this.domain == null ? "null" : this.domain);
return sbResult.toString();
}
}
|