View Javadoc
1   /*
2    * Copyright (c) 2002-2015, 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  package fr.paris.lutece.plugins.mylutece.modules.franceconnect.authentication;
35  
36  import fr.paris.lutece.portal.service.security.LuteceAuthentication;
37  import fr.paris.lutece.portal.service.security.LuteceUser;
38  
39  import java.io.Serializable;
40  
41  
42  /**
43   * This class implements The Lutece User in a OpenID configuration.
44   */
45  public class FranceConnectUser extends LuteceUser implements Serializable
46  {
47      public static final String BIRTH_DATE = "franceconnect.user.birthDate";
48      public static final String ACCESS_TOKEN = "franceconnect.user.accessToken";
49      public static final String BIRTH_PLACE = "franceconnect.user.birthPlace";
50      public static final String BIRTH_COUNTRY = "franceconnect.user.birthCountry";
51      public static final String ADDRESS = "franceconnect.user.address";
52      public static final String IDP_ID = "franceconnect.user.idp.id";
53      public static final String IDP_ACR = "franceconnect.user.idp.acr";
54      
55      private static final long serialVersionUID = 1L;
56      private String _strEmail;
57      private String _strBirthPlace;
58      private String _strBirthCountry;
59  
60      /**
61       * Constructor
62       * @param strUserName The user's name
63       * @param authenticationService The authentication service that authenticates the user
64       */
65      public FranceConnectUser( String strUserName, LuteceAuthentication authenticationService )
66      {
67          super( strUserName, authenticationService );
68          this.setLuteceAuthenticationService( authenticationService );
69      }
70  
71      /**
72       * {@inheritDoc }
73       */
74      @Override
75      public String getEmail(  )
76      {
77          return ( _strEmail != null ) ? _strEmail : "";
78      }
79  
80      /**
81       * Returns the BirthCountry
82       * @return The BirthCountry
83       */
84      public String getBirthCountry(  )
85      {
86          return _strBirthCountry;
87      }
88  
89      /**
90       * Sets the BirthCountry
91       * @param strBirthCountry The BirthCountry
92       */
93      public void setBirthCountry( String strBirthCountry )
94      {
95          _strBirthCountry = strBirthCountry;
96      }
97  
98      /**
99       * Returns the BirthPlace
100      * @return The BirthPlace
101      */
102     public String getBirthPlace(  )
103     {
104         return _strBirthPlace;
105     }
106 
107     /**
108      * Sets the BirthPlace
109      * @param strBirthPlace The BirthPlace
110      */
111     public void setBirthPlace( String strBirthPlace )
112     {
113         _strBirthPlace = strBirthPlace;
114     }
115 
116     /**
117      * Sets the Email
118      * @param strEmail         The Email
119      */
120     public void setEmail( String strEmail )
121     {
122         _strEmail = strEmail;
123     }
124 }