org.apache.struts.apps.mailreader.dao.UserDatabase Maven / Gradle / Ivy
/*
* $Id$
*
* 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.struts.apps.mailreader.dao;
/**
* A Data Access Object (DAO) interface describing
* the available operations for retrieving and storing {@link User}s
* (and their associated {@link Subscription}s) in some persistence layer
* whose characteristics are not specified here. One or more implementations
* will be created to perform the actual I/O that is required.
*
* @version $Rev$ $Date$
* @since Struts 1.1
*/
public interface UserDatabase {
// --------------------------------------------------------- Public Methods
/**
* Create and return a new {@link User} defined in this user database.
*
*
* @param username Username of the new user
*
* @exception IllegalArgumentException if the specified username
* is not unique
*/
public User createUser(String username);
/**
* Finalize access to the underlying persistence layer.
*
* @exception Exception if a database access error occurs
*/
public void close() throws Exception;
/**
* Return the existing {@link User} with the specified username,
* if any; otherwise return null.
*
* @param username Username of the user to retrieve
* @throws ExpiredPasswordException if user password has expired
* and must be changed
*/
public User findUser(String username) throws ExpiredPasswordException;
/**
* Return the set of {@link User}s defined in this user database.
*/
public User[] findUsers();
/**
* Return true if open() has been called.
*
* @exception Exception if a database access error occurs
*/
public boolean isOpen();
/**
* Initiate access to the underlying persistence layer.
*
* @exception Exception if a database access error occurs
*/
public void open() throws Exception;
/**
* Remove the specified {@link User} from this database.
*
* @param user User to be removed
*
* @exception IllegalArgumentException if the specified user is not
* associated with this database
*/
public void removeUser(User user);
/**
* Save any pending changes to the underlying persistence layer.
*
* @exception Exception if a database access error occurs
*/
public void save() throws Exception;
}