core/src/main/java/org/apache/ldap/server/authn/AuthenticatorContext.java

/*
 *   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed 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.ldap.server.authn;


import org.apache.ldap.server.PartitionNexus;
import org.apache.ldap.server.configuration.AuthenticatorConfiguration;
import org.apache.ldap.server.configuration.StartupConfiguration;


/**
 * Defines a set of methods that an authenticator uses to communicate with its container,
 * for example, to get the partition nexus, or whether the server is configured to accept
 * anonymous connection.
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 * @version $Rev$
 */
public interface AuthenticatorContext
{
    /**
     * Returns root configuration.
     */
    public StartupConfiguration getRootConfiguration();

    /**
     * Returns configuration of the {@link Authenticator}.
     */
    public AuthenticatorConfiguration getConfiguration();

    /**
     * Returns {@link PartitionNexus}.
     */
    public PartitionNexus getPartitionNexus();
}