1 /* Copyright (c) 2001-2016, The HSQL Development Group 2 * All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of the HSQL Development Group nor the names of its 15 * contributors may be used to endorse or promote products derived from this 16 * software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG, 22 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 23 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 24 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 32 package org.hsqldb.auth; 33 34 /** 35 * N.b. AuthFunctionBeans are NOT directly usable as HyperSQL Authentication 36 * Function methods, they are POJO beans to be managed by AuthBeanMultiplexer 37 * (which does have a real HyperSQL Authentication Function static method). 38 * 39 * @see AuthBeanMultiplexer for how these beans are used. 40 * @author Blaine Simpson (blaine dot simpson at admc dot com) 41 * @since 2.0.1 42 */ 43 public interface AuthFunctionBean { 44 45 /** 46 * Return a list of authorized roles or null to indicate that the 47 * implementation does not intend to produce a specific role list but only 48 * to indicate whether to allow access or not. 49 * A return value of String[0] is different from returning null, and means 50 * that the user should not be granted any roles. 51 * 52 * @throws Exception If user should not be allowed access to the specified 53 * database. Other registered AuthFunctionBeans will not be attempted. 54 * @throws RuntimeException Upon system problem. The exception will be 55 * logged to the HyperSQL application logger and other registered 56 * AuthFunctionBeans (if any) will be attempted. 57 * @return null or String[] according to the contract of HyperSQL 58 * authentication function contract, except that the role/schema 59 * list is returned as a String[] instead of a java.sql.Array. 60 */ authenticate(String userName, String password)61 String[] authenticate(String userName, String password) throws Exception; 62 } 63