View Javadoc

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  package org.apache.james.services;
21  
22  /***
23   * Interface for objects representing users.
24   *
25   *
26   * @version $Revision: 494012 $
27   */
28  
29  public interface User {
30  
31      /***
32       * Return the user name of this user
33       *
34       * @return the user name for this user
35       */
36      String getUserName();
37  
38      /***
39       * Return true if pass matches password of this user.
40       *
41       * @param pass the password to test
42       * @return whether the password being tested is valid
43       */
44      boolean verifyPassword(String pass);
45  
46      /***
47       * Sets new password from String. No checks made on guessability of
48       * password.
49       *
50       * @param newPass the String that is the new password.
51       * @return true if newPass successfully added
52       */
53      boolean setPassword(String newPass);
54  }