001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2011-2014 UnboundID Corp.
026     */
027    
028    package com.unboundid.directory.sdk.http.types;
029    
030    import com.unboundid.util.NotExtensible;
031    
032    import javax.servlet.http.HttpServletRequest;
033    
034    
035    /**
036     * Represents a HTTP authentication request.
037     */
038    @NotExtensible
039    public interface AuthenticationRequest
040    {
041      /**
042       * The identity of the principal being authenticated. In the case of an
043       * authentication request with username and password, this would be the
044       * username.
045       *
046       * @return the <code>Principal</code> being authenticated
047       */
048      Object getPrincipal();
049    
050      /**
051       * The credentials that prove the principal is correct. This is usually a
052       * password, but could be anything relevant to the calling code.
053       *
054       * @return the credentials that prove the identity of the
055       *         <code>Principal</code>
056       */
057      Object getCredentials();
058    
059      /**
060       * The HttpServletRequest that initiated the authentication request.
061       *
062       * @return The HttpServletRequest that initiated the authentication request,
063       *         or <code>null</code> if not available.
064       */
065      HttpServletRequest getHttpServletRequest();
066    }