This example, AuthExampleEmbedded.java, shows how to turn on, use, and turn off user authentication using Derby's built-in user authentication and user authorization using the embedded driver.
This example is a single long program. A similar example that uses the client driver, in User authentication and authorization client example, uses one program to set properties and a second program to perform database operations. Either example would work equally well in the other format.
See User authentication and SQL authorization embedded example for an example similar to this one that uses SQL authorization.
The program does the following:
Make sure that the javac command is in your path, then compile the program as follows:
javac AuthExampleEmbedded.java
When you run AuthExampleEmbedded, make sure that %DERBY_HOME%\lib\derby.jar (or $DERBY_HOME/lib/derby.jar) is in your classpath. For example, you might use the following command on a UNIX system:
java -cp .:${DERBY_HOME}/lib/derby.jar AuthExampleEmbedded
import java.sql.*;
public class AuthExampleEmbedded {
public static void main(String[] args) {
String driver = "org.apache.derby.jdbc.EmbeddedDriver";
String dbName="authEmbDB";
String connectionURL = "jdbc:derby:" + dbName + ";create=true";
Connection conn = null;
// Load the driver. This code is not needed if you are using
// JDK 6, because in that environment the driver is loaded
// automatically when the application requests a connection.
try {
Class.forName(driver);
System.out.println(driver + " loaded.");
} catch (java.lang.ClassNotFoundException ce) {
System.err.print("ClassNotFoundException: ");
System.err.println(ce.getMessage());
System.out.println("\n Make sure your CLASSPATH variable " +
"contains %DERBY_HOME%\\lib\\derby.jar " +
"(${DERBY_HOME}/lib/derby.jar).\n");
} catch (Exception ee) {
errorPrintAndExit(ee);
}
// Create and boot the database and set up users, then shut down
// the database as one of the users with full access
try {
System.out.println("Trying to connect to " + connectionURL);
conn = DriverManager.getConnection(connectionURL);
System.out.println("Connected to database " + connectionURL);
turnOnBuiltInUsers(conn);
// close the connection
conn.close();
System.out.println("Closed connection");
/* Shut down the database to make static properties take
* effect. Because the default connection mode is now
* noAccess, you must specify a user that has access. But
* because requireAuthentication does not take effect until
* you restart the database, the password is not checked.
*
* Database shutdown throws the 08006 exception to confirm
* success.
*/
try {
DriverManager.getConnection("jdbc:derby:" + dbName +
";user=sa;password=badpass;shutdown=true");
} catch (SQLException se) {
if ( !se.getSQLState().equals("08006") ) {
throw se;
}
}
System.out.println("Database shut down normally");
} catch (SQLException e) {
errorPrintAndExit(e);
}
// Restart database and confirm that unauthorized users cannot
// access it
connectionURL = "jdbc:derby:" + dbName;
// Try to log in with no username or password
try {
// connection attempt should fail
System.out.println("Trying to connect to " + connectionURL +
" without username or password");
conn = DriverManager.getConnection(connectionURL);
System.out.println(
"ERROR: Unexpectedly connected to database " + dbName);
cleanUpAndShutDown(conn);
} catch (SQLException e) {
if (e.getSQLState().equals("08004")) {
System.out.println("Correct behavior: SQLException: " +
e.getMessage());
} else {
errorPrintAndExit(e);
}
}
// Log in as a user with read-only access
try {
// connection should succeed, but create table should fail
String newURL = connectionURL +
";user=guest;password=java5w6x";
System.out.println("Trying to connect to " + newURL);
conn = DriverManager.getConnection(newURL);
System.out.println("Connected to database " + dbName +
" with read-only access");
Statement s = conn.createStatement();
s.executeUpdate("CREATE TABLE t1(C1 VARCHAR(6))");
System.out.println(
"ERROR: Unexpectedly allowed to modify database " +
dbName);
cleanUpAndShutDown(conn);
} catch (SQLException e) {
if (e.getSQLState().equals("25503")) {
System.out.println("Correct behavior: SQLException: " +
e.getMessage());
try {
conn.close();
} catch (SQLException ee) {
errorPrintAndExit(ee);
}
} else {
errorPrintAndExit(e);
}
}
// Log in as a user with full access
// Create, update, and query table
try {
// this should succeed
String newURL = connectionURL +
";user=mary;password=little7xylamb";
System.out.println("Trying to connect to " + newURL);
conn = DriverManager.getConnection(newURL);
System.out.println("Connected to database " + dbName);
Statement s = conn.createStatement();
s.executeUpdate("CREATE TABLE T1(C1 VARCHAR(6))");
System.out.println("Created table T1");
s.executeUpdate("INSERT INTO T1 VALUES('hello')");
ResultSet rs = s.executeQuery("SELECT * FROM T1");
rs.next();
System.out.println("Value of T1/C1 is " + rs.getString(1));
s.executeUpdate("DROP TABLE T1");
s.close();
} catch (SQLException e) {
errorPrintAndExit(e);
}
try {
cleanUpAndShutDown(conn);
} catch (SQLException e) {
errorPrintAndExit(e);
}
}
/**
* Close connection and shut down database. Since this is embedded
* mode, we must also shut down the Derby system.
*
* @param conn a connection to the database
*/
public static void cleanUpAndShutDown (Connection conn)
throws SQLException {
String dbName="authEmbDB";
String connectionURL = "jdbc:derby:" + dbName;
try {
conn.close();
System.out.println("Closed connection");
// As mary, shut down the database.
try {
String newURL = connectionURL +
";user=mary;password=little7xylamb;shutdown=true";
DriverManager.getConnection(newURL);
} catch (SQLException se) {
if ( !se.getSQLState().equals("08006") ) {
throw se;
}
}
System.out.println("Database shut down normally");
try {
DriverManager.getConnection("jdbc:derby:;shutdown=true");
} catch (SQLException se) {
if ( !se.getSQLState().equals("XJ015") ) {
throw se;
}
}
System.out.println("Derby system shut down normally");
} catch (SQLException e) {
errorPrintAndExit(e);
}
}
/**
* Turn on built-in user authentication and user authorization.
*
* @param conn a connection to the database
*/
public static void turnOnBuiltInUsers(Connection conn)
throws SQLException {
String setProperty =
"CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(";
String getProperty =
"VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY(";
String requireAuth = "'derby.connection.requireAuthentication'";
String defaultConnMode =
"'derby.database.defaultConnectionMode'";
String fullAccessUsers = "'derby.database.fullAccessUsers'";
String readOnlyAccessUsers =
"'derby.database.readOnlyAccessUsers'";
String provider = "'derby.authentication.provider'";
String propertiesOnly = "'derby.database.propertiesOnly'";
System.out.println("Turning on authentication.");
Statement s = conn.createStatement();
// Set and confirm requireAuthentication
s.executeUpdate(setProperty + requireAuth + ", 'true')");
ResultSet rs = s.executeQuery(getProperty + requireAuth + ")");
rs.next();
System.out.println("Value of requireAuthentication is " +
rs.getString(1));
// Set authentication scheme to Derby builtin
s.executeUpdate(setProperty + provider + ", 'BUILTIN')");
// Create some sample users
s.executeUpdate(
setProperty + "'derby.user.sa', 'ajaxj3x9')");
s.executeUpdate(
setProperty + "'derby.user.guest', 'java5w6x')");
s.executeUpdate(
setProperty + "'derby.user.mary', 'little7xylamb')");
// Define noAccess as default connection mode
s.executeUpdate(
setProperty + defaultConnMode + ", 'noAccess')");
// Confirm default connection mode
rs = s.executeQuery(getProperty + defaultConnMode + ")");
rs.next();
System.out.println("Value of defaultConnectionMode is " +
rs.getString(1));
// Define read-write user
s.executeUpdate(
setProperty + fullAccessUsers + ", 'sa,mary')");
// Define read-only user
s.executeUpdate(
setProperty + readOnlyAccessUsers + ", 'guest')");
// Confirm full-access users
rs = s.executeQuery(getProperty + fullAccessUsers + ")");
rs.next();
System.out.println(
"Value of fullAccessUsers is " + rs.getString(1));
// Confirm read-only users
rs = s.executeQuery(getProperty + readOnlyAccessUsers + ")");
rs.next();
System.out.println(
"Value of readOnlyAccessUsers is " + rs.getString(1));
// We would set the following property to TRUE only when we were
// ready to deploy. Setting it to FALSE means that we can always
// override using system properties if we accidentally paint
// ourselves into a corner.
s.executeUpdate(setProperty + propertiesOnly + ", 'false')");
s.close();
}
/**
* Report exceptions, with special handling of SQLExceptions,
* and exit.
*
* @param e an exception (Throwable)
*/
static void errorPrintAndExit(Throwable e) {
if (e instanceof SQLException)
SQLExceptionPrint((SQLException)e);
else {
System.out.println("A non-SQL error occurred.");
e.printStackTrace();
}
System.exit(1);
}
/**
* Iterate through a stack of SQLExceptions.
*
* @param sqle a SQLException
*/
static void SQLExceptionPrint(SQLException sqle) {
while (sqle != null) {
System.out.println("\n---SQLException Caught---\n");
System.out.println("SQLState: " + (sqle).getSQLState());
System.out.println("Severity: " + (sqle).getErrorCode());
System.out.println("Message: " + (sqle).getMessage());
sqle = sqle.getNextException();
}
}
}