View Javadoc
1   /*
2    * Copyright (c) 2002-2020, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  
35  package fr.paris.lutece.api.user;
36  
37  import java.util.List;
38  import java.util.Map;
39  
40  /**
41   * User
42   */
43  public interface User
44  {
45      /**
46       * Gets RBAC roles
47       * 
48       * @return The roles
49       */
50      Map<String, UserRole> getUserRoles( );
51  
52      /**
53       * Gets the access code of this user
54       * 
55       * @return the access code of this user
56       */
57      String getAccessCode( );
58  
59      /**
60       * Gets the email of this user.
61       * 
62       * @return The email
63       */
64      String getEmail( );
65  
66      /**
67       * Gets the last name of this user.
68       *
69       * @return the user last name
70       */
71      String getLastName( );
72  
73      /**
74       * Gets the first name of this user.
75       *
76       * @return the user first name
77       */
78      String getFirstName( );
79  
80      
81      /**
82       * Get the list of workgroups for this user
83       * 
84       * @return a list of workgroups for this user
85       */
86      List<String> getUserWorkgroups( );
87  
88      /**
89       * Gets the realm of this user
90       * 
91       * @return the realm of this user
92       */
93      String getRealm( );
94  
95  }