001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010 Sun Microsystems, Inc.
015 * Portions copyright 2013 ForgeRock AS.
016 */
017
018package org.forgerock.opendj.server.core;
019
020import org.forgerock.opendj.ldap.Entry;
021import org.forgerock.opendj.ldap.requests.BindRequest;
022
023/**
024 * The bind request context allows for updating the authentication state of the
025 * connection.
026 */
027public interface BindRequestContext extends Operation {
028
029    /**
030     * Specifies information about the authentication that has been performed
031     * for this connection.
032     *
033     * @param bindRequest
034     *            The bind request the client used for authentication.
035     * @param authenticationEntry
036     *            The entry for the user as whom the client is authenticated, or
037     *            {@code null} if the client is unauthenticated.
038     * @param authorizationEntry
039     *            The entry for the user that should be considered the
040     *            authorization identity for this client, or {@code null} if it
041     *            should be the unauthenticated user.
042     */
043    void setAuthenticationInfo(BindRequest bindRequest, Entry authenticationEntry,
044            Entry authorizationEntry);
045}