/*

   Derby - Class org.apache.derby.iapi.jdbc.AuthenticationService

   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.derby.iapi.jdbc;

import java.util.Properties;
import java.sql.SQLException;

/**
 *
 * <p>
 * The AuthenticationService provides a mechanism for authenticating
 * users willing to access JBMS.
 * </p>
 * <p>
 * There can be different and user defined authentication schemes, as long
 * the expected interface here below is implementing and registered
 * as a module when JBMS starts-up.
 * </p>
 */
public interface AuthenticationService 
{

	public static final String MODULE =
								"org.apache.derby.iapi.jdbc.AuthenticationService";
	/**
	 * Authenticate a User inside Derby.
	 *
     * @param databaseName The name of the database
	 * @param info			Connection properties info.
	 * @return true if authentication succeeded
     * @throws SQLException on error
	 */
	public boolean authenticate(String databaseName, Properties info)
	  throws SQLException;

    /**
     * <p>
     * Get the name of the credentials database used to authenticate system-wide operations.
     * This returns null for all implementations except NATIVE authentication.
     * </p>
     *
     * @return the name of the system-wide credentials database
     */
    public  String  getSystemCredentialsDatabaseName();

}
