001: /*
002: * $Id: UserDatabase.java 471754 2006-11-06 14:55:09Z husted $
003: *
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021: package org.apache.struts.apps.mailreader.dao;
022:
023: /**
024: * <p>A <strong>Data Access Object</strong> (DAO) interface describing
025: * the available operations for retrieving and storing {@link User}s
026: * (and their associated {@link Subscription}s) in some persistence layer
027: * whose characteristics are not specified here. One or more implementations
028: * will be created to perform the actual I/O that is required.</p>
029: *
030: * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
031: * @since Struts 1.1
032: */
033: public interface UserDatabase {
034:
035: // --------------------------------------------------------- Public Methods
036:
037: /**
038: * <p>Create and return a new {@link User} defined in this user database.
039: * </p>
040: *
041: * @param username Username of the new user
042: *
043: * @exception IllegalArgumentException if the specified username
044: * is not unique
045: */
046: public User createUser(String username);
047:
048: /**
049: * <p>Finalize access to the underlying persistence layer.</p>
050: *
051: * @exception Exception if a database access error occurs
052: */
053: public void close() throws Exception;
054:
055: /**
056: * <p>Return the existing {@link User} with the specified username,
057: * if any; otherwise return <code>null</code>.</p>
058: *
059: * @param username Username of the user to retrieve
060: * @throws ExpiredPasswordException if user password has expired
061: * and must be changed
062: */
063: public User findUser(String username)
064: throws ExpiredPasswordException;
065:
066: /**
067: * <p>Return the set of {@link User}s defined in this user database.</p>
068: */
069: public User[] findUsers();
070:
071: /**
072: * <p>Return true if open() has been called.</p>
073: *
074: * @exception Exception if a database access error occurs
075: */
076: public boolean isOpen();
077:
078: /**
079: * <p>Initiate access to the underlying persistence layer.</p>
080: *
081: * @exception Exception if a database access error occurs
082: */
083: public void open() throws Exception;
084:
085: /**
086: * Remove the specified {@link User} from this database.
087: *
088: * @param user User to be removed
089: *
090: * @exception IllegalArgumentException if the specified user is not
091: * associated with this database
092: */
093: public void removeUser(User user);
094:
095: /**
096: * <p>Save any pending changes to the underlying persistence layer.</p>
097: *
098: * @exception Exception if a database access error occurs
099: */
100: public void save() throws Exception;
101:
102: }
|