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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2010 Sun Microsystems, Inc. 025 * Portions copyright 2013 ForgeRock AS. 026 */ 027 028package org.forgerock.opendj.server.core; 029 030import org.forgerock.opendj.ldap.Entry; 031import org.forgerock.opendj.ldap.requests.BindRequest; 032 033/** 034 * The bind request context allows for updating the authentication state of the 035 * connection. 036 */ 037public interface BindRequestContext extends Operation { 038 039 /** 040 * Specifies information about the authentication that has been performed 041 * for this connection. 042 * 043 * @param bindRequest 044 * The bind request the client used for authentication. 045 * @param authenticationEntry 046 * The entry for the user as whom the client is authenticated, or 047 * {@code null} if the client is unauthenticated. 048 * @param authorizationEntry 049 * The entry for the user that should be considered the 050 * authorization identity for this client, or {@code null} if it 051 * should be the unauthenticated user. 052 */ 053 void setAuthenticationInfo(BindRequest bindRequest, Entry authenticationEntry, 054 Entry authorizationEntry); 055}