Home | History | Annotate | Download | only in auth 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/auth/NTLMEngine.java $
      3  * $Revision: 659788 $
      4  * $Date: 2008-05-24 03:42:23 -0700 (Sat, 24 May 2008) $
      5  *
      6  * ====================================================================
      7  *
      8  *  Licensed to the Apache Software Foundation (ASF) under one or more
      9  *  contributor license agreements.  See the NOTICE file distributed with
     10  *  this work for additional information regarding copyright ownership.
     11  *  The ASF licenses this file to You under the Apache License, Version 2.0
     12  *  (the "License"); you may not use this file except in compliance with
     13  *  the License.  You may obtain a copy of the License at
     14  *
     15  *      http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  *  Unless required by applicable law or agreed to in writing, software
     18  *  distributed under the License is distributed on an "AS IS" BASIS,
     19  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     20  *  See the License for the specific language governing permissions and
     21  *  limitations under the License.
     22  * ====================================================================
     23  *
     24  * This software consists of voluntary contributions made by many
     25  * individuals on behalf of the Apache Software Foundation.  For more
     26  * information on the Apache Software Foundation, please see
     27  * <http://www.apache.org/>.
     28  *
     29  */
     30 
     31 package org.apache.http.impl.auth;
     32 
     33 /**
     34  * Abstract NTLM authentication engine. The engine can be used to
     35  * generate Type1 messages and Type3 messages in response to a
     36  * Type2 challenge.
     37  * <p/>
     38  * For details see <a href="http://davenport.sourceforge.net/ntlm.html">this resource</a>
     39  *
     40  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     41  *
     42  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     43  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     44  *     for further details.
     45 */
     46 @Deprecated
     47 public interface NTLMEngine {
     48 
     49     /**
     50      * Generates a Type1 message given the domain and workstation.
     51      *
     52      * @param domain Optional Windows domain name. Can be <code>null</code>.
     53      * @param workstation Optional Windows workstation name. Can be
     54      *  <code>null</code>.
     55      * @return Type1 message
     56      * @throws NTLMEngineException
     57      */
     58     String generateType1Msg(
     59             String domain,
     60             String workstation) throws NTLMEngineException;
     61 
     62     /**
     63      * Generates a Type3 message given the user credentials and the
     64      * authentication challenge.
     65      *
     66      * @param username Windows user name
     67      * @param password Password
     68      * @param domain Windows domain name
     69      * @param workstation Windows workstation name
     70      * @param challenge Type2 challenge.
     71      * @return Type3 response.
     72      * @throws NTLMEngineException
     73      */
     74     String generateType3Msg(
     75             String username,
     76             String password,
     77             String domain,
     78             String workstation,
     79             String challenge) throws NTLMEngineException;
     80 
     81 }
     82