This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 10690f4e17d870f7b495781f432d66be562d90d9
Author: Benoit Tellier <btell...@linagora.com>
AuthorDate: Tue Sep 10 10:08:47 2019 +0700
JAMES-2703 Remove JamesUsersJdbcRepository
---
.../user/jdbc/AbstractJdbcUsersRepository.java | 705 ---------------------
.../user/jdbc/DefaultUsersJdbcRepository.java | 82 ---
.../james/user/jdbc/JamesUsersJdbcRepository.java | 131 ----
.../user/jdbc/AbstractUsersJdbcRepositoryTest.java | 33 -
.../user/jdbc/DefaultUsersJdbcRepositoryTest.java | 106 ----
.../user/jdbc/JamesUsersJdbcRepositoryTest.java | 105 ---
6 files changed, 1162 deletions(-)
diff --git
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java
b/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java
deleted file mode 100644
index 35de38e..0000000
---
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/AbstractJdbcUsersRepository.java
+++ /dev/null
@@ -1,705 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import java.io.InputStream;
-import java.sql.Connection;
-import java.sql.DatabaseMetaData;
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-
-import javax.annotation.PostConstruct;
-import javax.inject.Inject;
-import javax.sql.DataSource;
-
-import org.apache.commons.configuration2.HierarchicalConfiguration;
-import org.apache.commons.configuration2.ex.ConfigurationException;
-import org.apache.commons.configuration2.tree.ImmutableNode;
-import org.apache.james.filesystem.api.FileSystem;
-import org.apache.james.user.api.UsersRepositoryException;
-import org.apache.james.user.api.model.User;
-import org.apache.james.user.lib.AbstractJamesUsersRepository;
-import org.apache.james.util.sql.JDBCUtil;
-import org.apache.james.util.sql.SqlResources;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * An abstract base class for creating UserRepository implementations which use
- * a database for persistence.
- *
- * To implement a new UserRepository using by extending this class, you need to
- * implement the 3 abstract methods defined below, and define the required SQL
- * statements in an SQLResources file.
- *
- * The SQL statements used by this implementation are:
- * <table>
- * <tr>
- * <td><b>Required</b></td>
- * <td></td>
- * </tr>
- * <tr>
- * <td>select</td>
- * <td>Select all users.</td>
- * </tr>
- * <tr>
- * <td>insert</td>
- * <td>Insert a user.</td>
- * </tr>
- * <tr>
- * <td>update</td>
- * <td>Update a user.</td>
- * </tr>
- * <tr>
- * <td>delete</td>
- * <td>Delete a user by name.</td>
- * </tr>
- * <tr>
- * <td>createTable</td>
- * <td>Create the users table.</td>
- * </tr>
- * <tr>
- * <td><b>Optional</b></td>
- * <td></td>
- * </tr>
- * <tr>
- * <td>selectByLowercaseName</td>
- * <td>Select a user by name (case-insensitive lowercase).</td>
- * </tr>
- * </table>
- *
- * @deprecated JAMES-2703 This class is deprecated and will be removed
straight after upcoming James 3.4.0 release, unless it finds a maintainer
- *
- * Please migrate to other UsersRepository implementations like
JpaUsersRepository
- */
-@Deprecated
-public abstract class AbstractJdbcUsersRepository extends
AbstractJamesUsersRepository {
- private static final Logger LOGGER =
LoggerFactory.getLogger(AbstractJdbcUsersRepository.class);
-
- protected Map<String, String> sqlParameters;
-
- private String sqlFileName;
-
- private DataSource datasource;
-
- // Fetches all Users from the db.
- private String getUsersSql;
-
- // This fetch a user by name, ensuring case-insensitive matching.
- private String userByNameCaseInsensitiveSql;
-
- // Insert, update and delete sql statements are not guaranteed
- // to be case-insensitive; this is handled in code.
- private String insertUserSql;
-
- private String updateUserSql;
-
- private String deleteUserSql;
-
- // The JDBCUtil helper class
- private JDBCUtil theJDBCUtil;
-
- private FileSystem fileSystem;
-
- /**
- * Removes a user from the repository
- *
- * @param userName
- * the user to be removed
- * @throws UsersRepositoryException
- */
- @Override
- public void removeUser(String userName) throws UsersRepositoryException {
- User user = getUserByName(userName);
- if (user != null) {
- doRemoveUser(user);
- } else {
- throw new UsersRepositoryException("User " + userName + " does not
exist");
- }
- }
-
- /**
- * Get the user object with the specified user name. Return null if no such
- * user.
- *
- * @param name
- * the name of the user to retrieve
- *
- * @return the user if found, null otherwise
- *
- * @since James 1.2.2
- */
- @Override
- public User getUserByName(String name) throws UsersRepositoryException {
- return getUserByName(name, ignoreCase);
- }
-
- /**
- * Returns whether or not this user is in the repository
- *
- * @return true or false
- */
- @Override
- public boolean contains(String name) throws UsersRepositoryException {
- User user = getUserByName(name, ignoreCase);
- return (user != null);
- }
-
- /**
- * Returns whether or not this user is in the repository. Names are matched
- * on a case insensitive basis.
- *
- * @return true or false
- */
- public boolean containsCaseInsensitive(String name) throws
UsersRepositoryException {
- User user = getUserByName(name, true);
- return (user != null);
- }
-
- /**
- * Test if user with name 'name' has password 'password'.
- *
- * @param name
- * the name of the user to be tested
- * @param password
- * the password to be tested
- *
- * @return true if the test is successful, false if the password is
- * incorrect or the user doesn't exist
- * @since James 1.2.2
- */
- @Override
- public boolean test(String name, String password) throws
UsersRepositoryException {
- User user = getUserByName(name, ignoreCase);
- return user != null && user.verifyPassword(password);
- }
-
- /**
- * Returns a count of the users in the repository.
- *
- * @return the number of users in the repository
- */
- @Override
- public int countUsers() throws UsersRepositoryException {
- List<String> usernames = listUserNames();
- return usernames.size();
- }
-
- /**
- * List users in repository.
- *
- * @return Iterator over a collection of Strings, each being one user in
the
- * repository.
- */
- @Override
- public Iterator<String> list() throws UsersRepositoryException {
- return listUserNames().iterator();
- }
-
- /**
- * Set the DataSourceSelector
- *
- * @param datasource
- * the DataSourceSelector
- */
- @Inject
- public void setDatasource(DataSource datasource) {
- this.datasource = datasource;
- }
-
- /**
- * Sets the filesystem service
- *
- * @param system
- * the new service
- */
- @Inject
- public void setFileSystem(FileSystem system) {
- this.fileSystem = system;
- }
-
- /**
- * Initialises the JDBC repository.
- * <ol>
- * <li>Tests the connection to the database.</li>
- * <li>Loads SQL strings from the SQL definition file, choosing the
- * appropriate SQL for this connection, and performing parameter
- * substitution,</li>
- * <li>Initialises the database with the required tables, if
necessary.</li>
- * </ol>
- *
- * @throws Exception
- * if an error occurs
- */
- @PostConstruct
- public void init() throws Exception {
- LOGGER.debug("{}.initialize()", getClass().getName());
-
- theJDBCUtil = new JDBCUtil();
-
- // Test the connection to the database, by getting the
DatabaseMetaData.
- Connection conn = openConnection();
- try {
- DatabaseMetaData dbMetaData = conn.getMetaData();
-
- InputStream sqlFile;
-
- try {
- sqlFile = fileSystem.getResource(sqlFileName);
- } catch (Exception e) {
- LOGGER.error(e.getMessage(), e);
- throw e;
- }
-
- LOGGER.debug("Reading SQL resources from: {}, section {}.",
sqlFileName, getClass().getName());
-
- SqlResources sqlStatements = new SqlResources();
- sqlStatements.init(sqlFile, this.getClass().getName(), conn,
sqlParameters);
-
- // Create the SQL Strings to use for this table.
- // Fetches all Users from the db.
- getUsersSql = sqlStatements.getSqlString("select", true);
-
- // Get a user by lowercase name. (optional)
- // If not provided, the entire list is iterated to find a user.
- userByNameCaseInsensitiveSql =
sqlStatements.getSqlString("selectByLowercaseName");
-
- // Insert, update and delete are not guaranteed to be
- // case-insensitive
- // Will always be called with correct case in username..
- insertUserSql = sqlStatements.getSqlString("insert", true);
- updateUserSql = sqlStatements.getSqlString("update", true);
- deleteUserSql = sqlStatements.getSqlString("delete", true);
-
- // Creates a single table with "username" the Primary Key.
- String createUserTableSql =
sqlStatements.getSqlString("createTable", true);
-
- // Check if the required table exists. If not, create it.
- // The table name is defined in the SqlResources.
- String tableName = sqlStatements.getSqlString("tableName", true);
-
- // Need to ask in the case that identifiers are stored, ask the
- // DatabaseMetaInfo.
- // NB this should work, but some drivers (eg mm MySQL)
- // don't return the right details, hence the hackery below.
- /*
- * String tableName = m_tableName; if (
- * dbMetaData.storesLowerCaseIdentifiers() ) { tableName =
- * tableName.toLowerCase(Locale.US); } else if (
- * dbMetaData.storesUpperCaseIdentifiers() ) { tableName =
- * tableName.toUpperCase(Locale.US); }
- */
-
- // Try UPPER, lower, and MixedCase, to see if the table is there.
- if (!theJDBCUtil.tableExists(dbMetaData, tableName)) {
- // Users table doesn't exist - create it.
- PreparedStatement createStatement = null;
- try {
- createStatement =
conn.prepareStatement(createUserTableSql);
- createStatement.execute();
- } finally {
- theJDBCUtil.closeJDBCStatement(createStatement);
- }
-
- LOGGER.info("{}: Created table '{}'.", getClass().getName(),
tableName);
- } else {
- LOGGER.debug("Using table: {}", tableName);
- }
-
- } finally {
- theJDBCUtil.closeJDBCConnection(conn);
- }
- }
-
- /**
- * <p>
- * Configures the UserRepository for JDBC access.
- * </p>
- * <p>
- * Requires a configuration element in the .conf.xml file of the form:
- * </p>
- *
- * <pre>
- * <repository name="so even "
- *
class="org.apache.james.userrepository.JamesUsersJdbcRepository">
- * <!-- Name of the datasource to use -->
- * <data-source>MailDb</data-source>
- * <!-- File to load the SQL definitions from -->
- * <sqlFile>dist/conf/sqlResources.xml</sqlFile>
- * <!-- replacement parameters for the sql file -->
- * <sqlParameters table="JamesUsers"/>
- * </repository>
- * </pre>
- */
- @Override
- protected void doConfigure(HierarchicalConfiguration<ImmutableNode>
configuration) throws ConfigurationException {
- LOGGER.debug("{}.configure()", getClass().getName());
-
- // Parse the DestinationURL for the name of the datasource,
- // the table to use, and the (optional) repository Key.
- String destUrl = configuration.getString("[@destinationURL]", null);
- // throw an exception if the attribute is missing
- if (destUrl == null) {
- throw new ConfigurationException("destinationURL attribute is
missing from Configuration");
- }
-
- // normalise the destination, to simplify processing.
- if (!destUrl.endsWith("/")) {
- destUrl += "/";
- }
- // Split on "/", starting after "db://"
- List<String> urlParams = new ArrayList<>();
- int start = 5;
- int end = destUrl.indexOf('/', start);
- while (end > -1) {
- urlParams.add(destUrl.substring(start, end));
- start = end + 1;
- end = destUrl.indexOf('/', start);
- }
-
- // Build SqlParameters and get datasource name from URL parameters
- sqlParameters = new HashMap<>();
- switch (urlParams.size()) {
- case 3:
- sqlParameters.put("key", urlParams.get(2));
- sqlParameters.put("table", urlParams.get(1));
- urlParams.get(0);
- break;
- case 2:
- sqlParameters.put("table", urlParams.get(1));
- urlParams.get(0);
- break;
- case 1:
- urlParams.get(0);
- break;
- default:
- throw new ConfigurationException("Malformed destinationURL - " +
"Must be of the format \"db://<data-source>[/<table>[/<key>]]\".");
- }
-
- LOGGER.debug("Parsed URL: table = '{}', key = '{}'",
sqlParameters.get("table"), sqlParameters.get("key"));
-
- // Get the SQL file location
- sqlFileName = configuration.getString("sqlFile", null);
-
- // Get other sql parameters from the configuration object,
- // if any.
- Iterator<String> paramIt = configuration.getKeys("sqlParameters");
- while (paramIt.hasNext()) {
- String rawName = paramIt.next();
- String paramName =
paramIt.next().substring("sqlParameters.[@".length(), rawName.length() - 1);
- String paramValue = configuration.getString(rawName);
- sqlParameters.put(paramName, paramValue);
- }
- }
-
- /**
- * Produces the complete list of User names, with correct case.
- *
- * @return a <code>List</code> of <code>String</code>s representing user
- * names.
- */
- protected List<String> listUserNames() throws UsersRepositoryException {
- Collection<User> users = getAllUsers();
- List<String> userNames = new ArrayList<>(users.size());
- for (User user : users) {
- userNames.add(user.getUserName());
- }
- users.clear();
- return userNames;
- }
-
- /**
- * Returns a list populated with all of the Users in the repository.
- *
- * @return an <code>Iterator</code> of <code>User</code>s.
- */
- protected Iterator<User> listAllUsers() throws UsersRepositoryException {
- return getAllUsers().iterator();
- }
-
- /**
- * Returns a list populated with all of the Users in the repository.
- *
- * @return a <code>Collection</code> of <code>JamesUser</code>s.
- * @throws UsersRepositoryException
- */
- private Collection<User> getAllUsers() throws UsersRepositoryException {
- List<User> userList = new ArrayList<>(); // Build the users into this
list.
-
- Connection conn = null;
- PreparedStatement getUsersStatement = null;
- ResultSet rsUsers = null;
- try {
- conn = openConnection();
- // Get a ResultSet containing all users.
- getUsersStatement = conn.prepareStatement(getUsersSql);
- rsUsers = getUsersStatement.executeQuery();
-
- // Loop through and build a User for every row.
- while (rsUsers.next()) {
- User user = readUserFromResultSet(rsUsers);
- userList.add(user);
- }
- } catch (SQLException sqlExc) {
- throw new UsersRepositoryException("Error accessing database",
sqlExc);
- } finally {
- theJDBCUtil.closeJDBCResultSet(rsUsers);
- theJDBCUtil.closeJDBCStatement(getUsersStatement);
- theJDBCUtil.closeJDBCConnection(conn);
- }
-
- return userList;
- }
-
- /**
- * Adds a user to the underlying Repository. The user name must not clash
- * with an existing user.
- *
- * @param user
- * the user to add
- * @throws UsersRepositoryException
- */
- @Override
- protected void doAddUser(User user) throws UsersRepositoryException {
- Connection conn = null;
- PreparedStatement addUserStatement = null;
-
- // Insert into the database.
- try {
- conn = openConnection();
- // Get a PreparedStatement for the insert.
- addUserStatement = conn.prepareStatement(insertUserSql);
-
- setUserForInsertStatement(user, addUserStatement);
-
- addUserStatement.execute();
- } catch (SQLException sqlExc) {
- throw new UsersRepositoryException("Error accessing database",
sqlExc);
- } finally {
- theJDBCUtil.closeJDBCStatement(addUserStatement);
- theJDBCUtil.closeJDBCConnection(conn);
- }
- }
-
- /**
- * Removes a user from the underlying repository. If the user doesn't
exist,
- * returns ok.
- *
- * @param user
- * the user to remove
- * @throws UsersRepositoryException
- */
- protected void doRemoveUser(User user) throws UsersRepositoryException {
- String username = user.getUserName();
-
- Connection conn = null;
- PreparedStatement removeUserStatement = null;
-
- // Delete from the database.
- try {
- conn = openConnection();
- removeUserStatement = conn.prepareStatement(deleteUserSql);
- removeUserStatement.setString(1, username);
- removeUserStatement.execute();
- } catch (SQLException sqlExc) {
- throw new UsersRepositoryException("Error accessing database",
sqlExc);
- } finally {
- theJDBCUtil.closeJDBCStatement(removeUserStatement);
- theJDBCUtil.closeJDBCConnection(conn);
- }
- }
-
- /**
- * Updates a user record to match the supplied User.
- *
- * @param user
- * the user to update
- * @throws UsersRepositoryException
- */
- @Override
- protected void doUpdateUser(User user) throws UsersRepositoryException {
- Connection conn = null;
- PreparedStatement updateUserStatement = null;
-
- // Update the database.
- try {
- conn = openConnection();
- updateUserStatement = conn.prepareStatement(updateUserSql);
- setUserForUpdateStatement(user, updateUserStatement);
- updateUserStatement.execute();
- } catch (SQLException sqlExc) {
- throw new UsersRepositoryException("Error accessing database",
sqlExc);
- } finally {
- theJDBCUtil.closeJDBCStatement(updateUserStatement);
- theJDBCUtil.closeJDBCConnection(conn);
- }
- }
-
- /**
- * Gets a user by name, ignoring case if specified. This implementation
gets
- * the entire set of users, and scrolls through searching for one matching
- * <code>name</code>.
- *
- * @param name
- * the name of the user being retrieved
- * @param ignoreCase
- * whether the name is regarded as case-insensitive
- *
- * @return the user being retrieved, null if the user doesn't exist
- * @throws UsersRepositoryException
- */
- protected User getUserByNameIterating(String name, boolean ignoreCase)
throws UsersRepositoryException {
- // Just iterate through all of the users until we find one matching.
- Iterator<User> users = listAllUsers();
- while (users.hasNext()) {
- User user = users.next();
- String username = user.getUserName();
- if ((!ignoreCase && username.equals(name)) || (ignoreCase &&
username.equalsIgnoreCase(name))) {
- return user;
- }
- }
- // Not found - return null
- return null;
- }
-
- /**
- * Gets a user by name, ignoring case if specified. If the specified SQL
- * statement has been defined, this method overrides the basic
- * implementation in AbstractJamesUsersRepository to increase performance.
- *
- * @param name
- * the name of the user being retrieved
- * @param ignoreCase
- * whether the name is regarded as case-insensitive
- *
- * @return the user being retrieved, null if the user doesn't exist
- * @throws UsersRepositoryException
- */
- protected User getUserByName(String name, boolean ignoreCase) throws
UsersRepositoryException {
- // See if this statement has been set, if not, use
- // simple superclass method.
- if (userByNameCaseInsensitiveSql == null) {
- return getUserByNameIterating(name, ignoreCase);
- }
-
- // Always get the user via case-insensitive SQL,
- // then check case if necessary.
- Connection conn = null;
- PreparedStatement getUsersStatement = null;
- ResultSet rsUsers = null;
- try {
- conn = openConnection();
- // Get a ResultSet containing all users.
- String sql = userByNameCaseInsensitiveSql;
- getUsersStatement = conn.prepareStatement(sql);
-
- getUsersStatement.setString(1, name.toLowerCase(Locale.US));
-
- rsUsers = getUsersStatement.executeQuery();
-
- // For case-insensitive matching, the first matching user will be
- // returned.
- User user = null;
- while (rsUsers.next()) {
- User rowUser = readUserFromResultSet(rsUsers);
- String actualName = rowUser.getUserName();
-
- // Check case before we assume it's the right one.
- if (ignoreCase || actualName.equals(name)) {
- user = rowUser;
- break;
- }
- }
- return user;
- } catch (SQLException sqlExc) {
- throw new UsersRepositoryException("Error accessing database",
sqlExc);
- } finally {
- theJDBCUtil.closeJDBCResultSet(rsUsers);
- theJDBCUtil.closeJDBCStatement(getUsersStatement);
- theJDBCUtil.closeJDBCConnection(conn);
- }
- }
-
- /**
- * Reads properties for a User from an open ResultSet. Subclass
- * implementations of this method must have knowledge of the fields
- * presented by the "select" and "selectByLowercaseName" SQL statements.
- * These implemenations may generate a subclass-specific User instance.
- *
- * @param rsUsers
- * A ResultSet with a User record in the current row.
- * @return A User instance
- * @throws SQLException
- * if an exception occurs reading from the ResultSet
- */
- protected abstract User readUserFromResultSet(ResultSet rsUsers) throws
SQLException;
-
- /**
- * Set parameters of a PreparedStatement object with property values from a
- * User instance. Implementations of this method have knowledge of the
- * parameter ordering of the "insert" SQL statement definition.
- *
- * @param user
- * a User instance, which should be an implementation class
which
- * is handled by this Repostory implementation.
- * @param userInsert
- * a PreparedStatement initialised with SQL taken from the
- * "insert" SQL definition.
- * @throws SQLException
- * if an exception occurs while setting parameter values.
- */
- protected abstract void setUserForInsertStatement(User user,
PreparedStatement userInsert) throws SQLException;
-
- /**
- * Set parameters of a PreparedStatement object with property values from a
- * User instance. Implementations of this method have knowledge of the
- * parameter ordering of the "update" SQL statement definition.
- *
- * @param user
- * a User instance, which should be an implementation class
which
- * is handled by this Repostory implementation.
- * @param userUpdate
- * a PreparedStatement initialised with SQL taken from the
- * "update" SQL definition.
- * @throws SQLException
- * if an exception occurs while setting parameter values.
- */
- protected abstract void setUserForUpdateStatement(User user,
PreparedStatement userUpdate) throws SQLException;
-
- /**
- * Opens a connection, throwing a runtime exception if a SQLException is
- * encountered in the process.
- *
- * @return the new connection
- * @throws SQLException
- */
- private Connection openConnection() throws SQLException {
- return datasource.getConnection();
-
- }
-}
diff --git
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepository.java
b/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepository.java
deleted file mode 100644
index daa110a..0000000
---
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepository.java
+++ /dev/null
@@ -1,82 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-
-import org.apache.james.user.api.AlreadyExistInUsersRepositoryException;
-import org.apache.james.user.api.UsersRepositoryException;
-import org.apache.james.user.api.model.User;
-import org.apache.james.user.lib.model.DefaultUser;
-
-/**
- * A Jdbc-backed UserRepository which handles User instances of the
- * <code>DefaultUser</code> class.<br>
- * Although this repository can handle subclasses of DefaultUser, like
- * <code>DefaultJamesUser</code>, only properties from the DefaultUser class
are
- * persisted.
- * <p/>
- *
- * @deprecated JAMES-2703 This class is deprecated and will be removed
straight after upcoming James 3.4.0 release, unless it finds a maintainer
- *
- * Please migrate to other UsersRepository implementations like
JpaUsersRepository
- */
-@Deprecated
-public class DefaultUsersJdbcRepository extends AbstractJdbcUsersRepository {
-
- @Override
- protected User readUserFromResultSet(ResultSet rsUsers) throws
SQLException {
- // Get the username, and build a DefaultUser with it.
- String username = rsUsers.getString(1);
- String passwordHash = rsUsers.getString(2);
- String passwordAlg = rsUsers.getString(3);
- return new DefaultUser(username, passwordHash, passwordAlg);
- }
-
- @Override
- protected void setUserForInsertStatement(User user, PreparedStatement
userInsert) throws SQLException {
- DefaultUser defUser = (DefaultUser) user;
- userInsert.setString(1, defUser.getUserName());
- userInsert.setString(2, defUser.getHashedPassword());
- userInsert.setString(3, defUser.getHashAlgorithm());
- }
-
- @Override
- protected void setUserForUpdateStatement(User user, PreparedStatement
userUpdate) throws SQLException {
- DefaultUser defUser = (DefaultUser) user;
- userUpdate.setString(1, defUser.getHashedPassword());
- userUpdate.setString(2, defUser.getHashAlgorithm());
- userUpdate.setString(3, defUser.getUserName());
- }
-
- @Override
- public void addUser(String username, String password) throws
UsersRepositoryException {
- if (contains(username)) {
- throw new AlreadyExistInUsersRepositoryException("User " +
username + " already exist");
- }
- isValidUsername(username);
- User newbie = new DefaultUser(username, "SHA");
- newbie.setPassword(password);
- doAddUser(newbie);
- }
-
-}
diff --git
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/JamesUsersJdbcRepository.java
b/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/JamesUsersJdbcRepository.java
deleted file mode 100644
index 94b19dd..0000000
---
a/server/data/data-jdbc/src/main/java/org/apache/james/user/jdbc/JamesUsersJdbcRepository.java
+++ /dev/null
@@ -1,131 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-
-import org.apache.james.core.MailAddress;
-import org.apache.james.user.api.model.User;
-import org.apache.james.user.lib.model.DefaultJamesUser;
-import org.apache.james.user.lib.model.DefaultUser;
-
-/**
- * A Jdbc-backed UserRepository which handles User instances of the
- * <code>DefaultJamesUser</code> class, or any superclass.
- *
- * @deprecated JAMES-2703 This class is deprecated and will be removed
straight after upcoming James 3.4.0 release, unless it finds a maintainer
- *
- * Please migrate to other UsersRepository implementations like
JpaUsersRepository
- */
-@Deprecated
-public class JamesUsersJdbcRepository extends AbstractJdbcUsersRepository {
-
- @Override
- protected User readUserFromResultSet(ResultSet rsUsers) throws
SQLException {
- // Get the column values
- String username = rsUsers.getString(1);
- String pwdHash = rsUsers.getString(2);
- String pwdAlgorithm = rsUsers.getString(3);
- boolean useForwarding = rsUsers.getBoolean(4);
- String forwardingDestination = rsUsers.getString(5);
- boolean useAlias = rsUsers.getBoolean(6);
- String alias = rsUsers.getString(7);
-
- MailAddress forwardAddress = null;
- if (forwardingDestination != null) {
- try {
- forwardAddress = new MailAddress(forwardingDestination);
- } catch (javax.mail.internet.ParseException pe) {
- String exceptionBuffer = "Invalid mail address in database: "
+ forwardingDestination + ", for user " + username + ".";
- throw new RuntimeException(exceptionBuffer);
- }
- }
-
- // Build a DefaultJamesUser with these values, and add to the list.
- DefaultJamesUser user = new DefaultJamesUser(username, pwdHash,
pwdAlgorithm);
- user.setForwarding(useForwarding);
- user.setForwardingDestination(forwardAddress);
- user.setAliasing(useAlias);
- user.setAlias(alias);
-
- return user;
- }
-
- @Override
- protected void setUserForInsertStatement(User user, PreparedStatement
userInsert) throws SQLException {
- setUserForStatement(user, userInsert, false);
- }
-
- @Override
- protected void setUserForUpdateStatement(User user, PreparedStatement
userUpdate) throws SQLException {
- setUserForStatement(user, userUpdate, true);
- }
-
- /**
- * Sets the data for the prepared statement to match the information in the
- * user object.
- *
- * @param user
- * the user whose data is to be stored in the PreparedStatement.
- * @param stmt
- * the PreparedStatement to be modified.
- * @param userNameLast
- * whether the user id is the last or the first column
- */
- private void setUserForStatement(User user, PreparedStatement stmt,
boolean userNameLast) throws SQLException {
- // Determine column offsets to use, based on username column pos.
- int nameIndex = 1;
- int colOffset = 1;
- if (userNameLast) {
- nameIndex = 7;
- colOffset = 0;
- }
-
- // Can handle instances of DefaultJamesUser and DefaultUser.
- DefaultJamesUser jamesUser;
- if (user instanceof DefaultJamesUser) {
- jamesUser = (DefaultJamesUser) user;
- } else if (user instanceof DefaultUser) {
- DefaultUser aUser = (DefaultUser) user;
- jamesUser = new DefaultJamesUser(aUser.getUserName(),
aUser.getHashedPassword(), aUser.getHashAlgorithm());
- } else {
- // Can't handle any other implementations.
- throw new RuntimeException("An unknown implementation of User was
" + "found. This implementation cannot be " + "persisted to a
UsersJDBCRepsitory.");
- }
-
- // Get the user details to save.
- stmt.setString(nameIndex, jamesUser.getUserName());
- stmt.setString(1 + colOffset, jamesUser.getHashedPassword());
- stmt.setString(2 + colOffset, jamesUser.getHashAlgorithm());
- stmt.setInt(3 + colOffset, (jamesUser.getForwarding() ? 1 : 0));
-
- MailAddress forwardAddress = jamesUser.getForwardingDestination();
- String forwardDestination = null;
- if (forwardAddress != null) {
- forwardDestination = forwardAddress.toString();
- }
- stmt.setString(4 + colOffset, forwardDestination);
- stmt.setInt(5 + colOffset, (jamesUser.getAliasing() ? 1 : 0));
- stmt.setString(6 + colOffset, jamesUser.getAlias());
- }
-
-}
diff --git
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/AbstractUsersJdbcRepositoryTest.java
b/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/AbstractUsersJdbcRepositoryTest.java
deleted file mode 100644
index 88a442a..0000000
---
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/AbstractUsersJdbcRepositoryTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import org.apache.james.user.api.UsersRepositoryException;
-import org.apache.james.user.lib.AbstractUsersRepositoryTest;
-import org.junit.Ignore;
-import org.junit.Test;
-
-public abstract class AbstractUsersJdbcRepositoryTest extends
AbstractUsersRepositoryTest {
-
- @Override
- @Ignore
- @Test(expected = UsersRepositoryException.class)
- public void addUserShouldThrowWhenSameUsernameWithDifferentCase() throws
UsersRepositoryException {
- }
-}
diff --git
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepositoryTest.java
b/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepositoryTest.java
deleted file mode 100644
index d73d0ec..0000000
---
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/DefaultUsersJdbcRepositoryTest.java
+++ /dev/null
@@ -1,106 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import java.util.Iterator;
-
-import javax.sql.DataSource;
-
-import org.apache.commons.configuration2.BaseHierarchicalConfiguration;
-import org.apache.commons.dbcp.BasicDataSource;
-import org.apache.derby.jdbc.EmbeddedDriver;
-import org.apache.james.filesystem.api.mock.MockFileSystem;
-import org.apache.james.lifecycle.api.LifecycleUtil;
-import org.apache.james.user.api.UsersRepositoryException;
-import org.apache.james.user.lib.AbstractUsersRepository;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Ignore;
-
-/**
- * Test basic behaviors of UsersFileRepository
- */
-public class DefaultUsersJdbcRepositoryTest extends
AbstractUsersJdbcRepositoryTest {
-
- @Override
- @Before
- public void setUp() throws Exception {
- super.setUp();
- }
-
- @Override
- @After
- public void tearDown() throws Exception {
- super.tearDown();
- }
-
- /**
- * Create the repository to be tested.
- *
- * @return the user repository
- * @throws Exception
- */
- @SuppressWarnings("deprecation")
- @Override
- protected AbstractUsersRepository getUsersRepository() throws Exception {
- DefaultUsersJdbcRepository res = new DefaultUsersJdbcRepository();
- String tableString = "defusers";
- configureAbstractJdbcUsersRepository(res, tableString);
- return res;
- }
-
- @SuppressWarnings("deprecation")
- protected void
configureAbstractJdbcUsersRepository(AbstractJdbcUsersRepository res, String
tableString) throws Exception {
- res.setFileSystem(new MockFileSystem());
- DataSource dataSource = getDataSource();
-
- res.setDatasource(dataSource);
-
- BaseHierarchicalConfiguration configuration = new
BaseHierarchicalConfiguration();
- configuration.addProperty("[@destinationURL]", "db://maildb/" +
tableString);
- configuration.addProperty("sqlFile", "file://conf/sqlResources.xml");
- res.configure(configuration);
- res.init();
- }
-
- private BasicDataSource getDataSource() {
- BasicDataSource ds = new BasicDataSource();
- ds.setDriverClassName(EmbeddedDriver.class.getName());
- ds.setUrl("jdbc:derby:memory:testdb;create=true");
- ds.setUsername("james");
- ds.setPassword("james");
- return ds;
- }
-
- @Override
- protected void disposeUsersRepository() throws UsersRepositoryException {
- Iterator<String> i = this.usersRepository.list();
- while (i.hasNext()) {
- this.usersRepository.removeUser(i.next());
- }
- LifecycleUtil.dispose(this.usersRepository);
- }
-
- @Ignore
- @Override
- public void
testShouldReturnTrueWhenAUserHasACorrectPasswordAndOtherCaseInDomain() throws
Exception {
- }
-
-}
diff --git
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/JamesUsersJdbcRepositoryTest.java
b/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/JamesUsersJdbcRepositoryTest.java
deleted file mode 100644
index f5d003d..0000000
---
a/server/data/data-jdbc/src/test/java/org/apache/james/user/jdbc/JamesUsersJdbcRepositoryTest.java
+++ /dev/null
@@ -1,105 +0,0 @@
-/****************************************************************
- * 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.james.user.jdbc;
-
-import java.util.Iterator;
-
-import javax.sql.DataSource;
-
-import org.apache.commons.configuration2.BaseHierarchicalConfiguration;
-import org.apache.commons.dbcp.BasicDataSource;
-import org.apache.derby.jdbc.EmbeddedDriver;
-import org.apache.james.filesystem.api.mock.MockFileSystem;
-import org.apache.james.lifecycle.api.LifecycleUtil;
-import org.apache.james.user.api.UsersRepositoryException;
-import org.apache.james.user.lib.AbstractUsersRepository;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Ignore;
-
-/**
- * Test basic behaviors of UsersFileRepository
- */
-public class JamesUsersJdbcRepositoryTest extends
AbstractUsersJdbcRepositoryTest {
-
- @Override
- @Before
- public void setUp() throws Exception {
- super.setUp();
- }
-
- @Override
- @After
- public void tearDown() throws Exception {
- super.tearDown();
- }
-
-
- /**
- * Create the repository to be tested.
- *
- * @return the user repository
- * @throws Exception
- */
- @Override
- protected AbstractUsersRepository getUsersRepository() throws Exception {
- @SuppressWarnings("deprecation")
- JamesUsersJdbcRepository res = new JamesUsersJdbcRepository();
- String tableString = "jamesusers";
- configureAbstractJdbcUsersRepository(res, tableString);
- return res;
- }
-
- @SuppressWarnings("deprecation")
- protected void
configureAbstractJdbcUsersRepository(AbstractJdbcUsersRepository res, String
tableString) throws Exception {
- res.setFileSystem(new MockFileSystem());
- DataSource dataSource = getDataSource();
- res.setDatasource(dataSource);
- BaseHierarchicalConfiguration configuration = new
BaseHierarchicalConfiguration();
- configuration.addProperty("[@destinationURL]", "db://maildb/" +
tableString);
- configuration.addProperty("sqlFile", "file://conf/sqlResources.xml");
- res.configure(configuration);
- res.init();
- }
-
- private BasicDataSource getDataSource() {
- BasicDataSource ds = new BasicDataSource();
- ds.setDriverClassName(EmbeddedDriver.class.getName());
- ds.setUrl("jdbc:derby:memory:testdb;create=true");
- ds.setUsername("james");
- ds.setPassword("james");
- return ds;
- }
-
- @Override
- protected void disposeUsersRepository() throws UsersRepositoryException {
- Iterator<String> i = this.usersRepository.list();
- while (i.hasNext()) {
- this.usersRepository.removeUser(i.next());
- }
- LifecycleUtil.dispose(this.usersRepository);
- }
-
- @Ignore
- @Override
- public void
testShouldReturnTrueWhenAUserHasACorrectPasswordAndOtherCaseInDomain() throws
Exception {
- }
-
-}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
