1 /****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20
21
22 package org.apache.james.api.user;
23
24 /**
25 * Interface for objects representing users.
26 *
27 *
28 * @version $Revision: 684466 $
29 */
30
31 public interface User {
32
33 /**
34 * Return the user name of this user
35 *
36 * @return the user name for this user
37 */
38 String getUserName();
39
40 /**
41 * Return true if pass matches password of this user.
42 *
43 * @param pass the password to test
44 * @return whether the password being tested is valid
45 */
46 boolean verifyPassword(String pass);
47
48 /**
49 * Sets new password from String. No checks made on guessability of
50 * password.
51 *
52 * @param newPass the String that is the new password.
53 * @return true if newPass successfully added
54 */
55 boolean setPassword(String newPass);
56 }