View Javadoc
1   /*
2    * Copyright (c) 2002-2021, City of 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.service;
35  
36  import fr.paris.lutece.plugins.mylutece.business.LuteceUserRoleDescription;
37  import fr.paris.lutece.portal.business.role.Role;
38  import fr.paris.lutece.portal.business.role.RoleHome;
39  import fr.paris.lutece.portal.service.datastore.DatastoreService;
40  import fr.paris.lutece.portal.service.i18n.I18nService;
41  import fr.paris.lutece.portal.service.security.LuteceUser;
42  
43  import java.util.ArrayList;
44  import java.util.Arrays;
45  import java.util.Collection;
46  import java.util.List;
47  import java.util.Locale;
48  
49  /**
50   * This class is used to provide default roles for myluteceusers
51   */
52  public class MyLuteceDefaultRoleProvider implements IMyLuteceExternalRolesProvider
53  {
54      // DS key
55      
56      private static final String PROPERTY_DEFAULT_ROLE_DESCRIPTION = "mylutece.defaultRoleProvider.roleDescription";
57      private static final String PROPERTY_DEFAULT_ROLE_NOT_EXIST = "mylutece.defaultRoleProvider.roleNotExist";
58      
59  	
60  	private static final String KEY_DATASTORE_DEFAULT_ROLES = "mylutece.site_property.default_role_keys";
61      
62  
63      @Override
64      public Collection<String> providesRoles( LuteceUser user )
65      {
66  
67          String strDefaultRoleKeys = DatastoreService.getDataValue( KEY_DATASTORE_DEFAULT_ROLES, null );
68  
69          if ( strDefaultRoleKeys != null )
70          {
71              return Arrays.asList( strDefaultRoleKeys.split( "," ) );
72          }
73          else
74          {
75              return new ArrayList<>( );
76          }
77      }
78  
79  	/**
80  	 * {@inheritDoc}
81  	 */
82  	@Override
83  	public List<LuteceUserRoleDescription> getLuteceUserRolesProvided(Locale locale) {
84  		String strDefaultRoleKeys = DatastoreService.getDataValue(KEY_DATASTORE_DEFAULT_ROLES, null);
85  		List<LuteceUserRoleDescription> lisDescriptions = new ArrayList<LuteceUserRoleDescription>();
86  		if (strDefaultRoleKeys != null) {
87  
88  			for (String strRole : Arrays.asList(strDefaultRoleKeys.split(","))) {
89  				Role role = RoleHome.findByPrimaryKey(strRole);
90  				if (role != null) {
91  					lisDescriptions.add(
92  							new LuteceUserRoleDescription(role, LuteceUserRoleDescription.TYPE_AUTOMATIC_ASSIGNMENT,
93  									I18nService.getLocalizedString(PROPERTY_DEFAULT_ROLE_DESCRIPTION, locale)));
94  
95  				} else {
96  					Role roleEmty = new Role();
97  					roleEmty.setRole(strRole);
98  					lisDescriptions.add(new LuteceUserRoleDescription(roleEmty,
99  							LuteceUserRoleDescription.TYPE_AUTOMATIC_ASSIGNMENT,
100 							I18nService.getLocalizedString(PROPERTY_DEFAULT_ROLE_NOT_EXIST, locale)));
101 
102 				}
103 
104 			}
105 
106 		}
107 		return lisDescriptions;
108 
109 	}
110     
111 }