HttpAuthentication.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nutch.protocol.httpclient;
 
import java.util.List;

/**
 *  The base level of services required for Http Authentication
 *
 * @see HttpAuthenticationFactory
 * 
 * @author    Matt Tencati
 */
public interface HttpAuthentication {

    /**
     *  Gets the credentials generated by the HttpAuthentication
     *  object.  May return null.
     *
     * @return    The credentials value
     */
    public List getCredentials();

    /**
     *  Gets the realm used by the HttpAuthentication object during creation.
     *
     *  @return    The realm value
     */
    public String getRealm();

}