1 package org.apache.archiva.rest.services;
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
21 import org.apache.archiva.admin.model.RepositoryAdminException;
22 import org.apache.archiva.admin.model.beans.PropertyEntry;
23 import org.apache.archiva.admin.model.beans.RedbackRuntimeConfiguration;
24 import org.apache.archiva.admin.model.beans.LdapConfiguration;
25 import org.apache.archiva.admin.model.runtime.RedbackRuntimeConfigurationAdmin;
26 import org.apache.archiva.redback.authentication.AuthenticationException;
27 import org.apache.archiva.redback.authentication.Authenticator;
28 import org.apache.archiva.redback.common.ldap.user.LdapUserMapper;
29 import org.apache.archiva.redback.common.ldap.connection.LdapConnection;
30 import org.apache.archiva.redback.common.ldap.connection.LdapConnectionConfiguration;
31 import org.apache.archiva.redback.common.ldap.connection.LdapConnectionFactory;
32 import org.apache.archiva.redback.common.ldap.connection.LdapException;
33 import org.apache.archiva.redback.components.cache.Cache;
34 import org.apache.archiva.redback.policy.CookieSettings;
35 import org.apache.archiva.redback.policy.PasswordRule;
36 import org.apache.archiva.redback.users.UserManager;
37 import org.apache.archiva.rest.api.model.UserManagerImplementationInformation;
38 import org.apache.archiva.rest.api.services.ArchivaRestServiceException;
39 import org.apache.archiva.rest.api.services.RedbackRuntimeConfigurationService;
41 import org.apache.commons.lang.StringUtils;
42 import org.springframework.context.ApplicationContext;
43 import org.springframework.stereotype.Service;
45 import javax.inject.Inject;
46 import javax.inject.Named;
47 import javax.naming.InvalidNameException;
48 import java.util.ArrayList;
49 import java.util.Collection;
50 import java.util.Collections;
51 import java.util.Comparator;
52 import java.util.List;
54 import java.util.Properties;
57 * @author Olivier Lamy
60 @Service("redbackRuntimeConfigurationService#rest")
61 public class DefaultRedbackRuntimeConfigurationService
62 extends AbstractRestService
63 implements RedbackRuntimeConfigurationService
66 private RedbackRuntimeConfigurationAdmin redbackRuntimeConfigurationAdmin;
69 @Named(value = "userManager#configurable")
70 private UserManager userManager;
73 private ApplicationContext applicationContext;
76 @Named(value = "ldapConnectionFactory#configurable")
77 private LdapConnectionFactory ldapConnectionFactory;
80 @Named(value = "cache#users")
81 private Cache usersCache;
84 private LdapUserMapper ldapUserMapper;
87 public RedbackRuntimeConfiguration getRedbackRuntimeConfiguration()
88 throws ArchivaRestServiceException
92 return redbackRuntimeConfigurationAdmin.getRedbackRuntimeConfiguration();
94 catch ( RepositoryAdminException e )
96 throw new ArchivaRestServiceException( e.getMessage(), e );
100 public Boolean updateRedbackRuntimeConfiguration( RedbackRuntimeConfiguration redbackRuntimeConfiguration )
101 throws ArchivaRestServiceException
105 // has user manager impl changed ?
106 boolean userManagerChanged = redbackRuntimeConfiguration.getUserManagerImpls().size()
107 != redbackRuntimeConfigurationAdmin.getRedbackRuntimeConfiguration().getUserManagerImpls().size();
110 userManagerChanged || ( redbackRuntimeConfiguration.getUserManagerImpls().toString().hashCode()
111 != redbackRuntimeConfigurationAdmin.getRedbackRuntimeConfiguration().getUserManagerImpls().toString().hashCode() );
113 redbackRuntimeConfigurationAdmin.updateRedbackRuntimeConfiguration( redbackRuntimeConfiguration );
115 if ( userManagerChanged )
117 log.info( "user managerImpls changed to {} so reload it",
118 redbackRuntimeConfiguration.getUserManagerImpls() );
119 userManager.initialize();
122 ldapConnectionFactory.initialize();
124 Collection<PasswordRule> passwordRules = applicationContext.getBeansOfType( PasswordRule.class ).values();
126 for ( PasswordRule passwordRule : passwordRules )
128 passwordRule.initialize();
131 Collection<CookieSettings> cookieSettingsList =
132 applicationContext.getBeansOfType( CookieSettings.class ).values();
134 for ( CookieSettings cookieSettings : cookieSettingsList )
136 cookieSettings.initialize();
139 Collection<Authenticator> authenticators =
140 applicationContext.getBeansOfType( Authenticator.class ).values();
142 for ( Authenticator authenticator : authenticators )
144 authenticator.initialize();
148 usersCache.setTimeToIdleSeconds(
149 redbackRuntimeConfiguration.getUsersCacheConfiguration().getTimeToIdleSeconds() );
150 usersCache.setTimeToLiveSeconds(
151 redbackRuntimeConfiguration.getUsersCacheConfiguration().getTimeToLiveSeconds() );
152 usersCache.setMaxElementsInMemory(
153 redbackRuntimeConfiguration.getUsersCacheConfiguration().getMaxElementsInMemory() );
154 usersCache.setMaxElementsOnDisk(
155 redbackRuntimeConfiguration.getUsersCacheConfiguration().getMaxElementsOnDisk() );
157 ldapUserMapper.initialize();
161 catch ( AuthenticationException e )
163 throw new ArchivaRestServiceException( e.getMessage(), e );
165 catch ( RepositoryAdminException e )
167 throw new ArchivaRestServiceException( e.getMessage(), e );
172 public List<UserManagerImplementationInformation> getUserManagerImplementationInformations()
173 throws ArchivaRestServiceException
176 Map<String, UserManager> beans = applicationContext.getBeansOfType( UserManager.class );
178 if ( beans.isEmpty() )
180 return Collections.emptyList();
183 List<UserManagerImplementationInformation> informations =
184 new ArrayList<UserManagerImplementationInformation>( beans.size() );
186 for ( Map.Entry<String, UserManager> entry : beans.entrySet() )
188 UserManager userManager = applicationContext.getBean( entry.getKey(), UserManager.class );
189 if ( userManager.isFinalImplementation() )
191 UserManagerImplementationInformation information = new UserManagerImplementationInformation();
192 information.setBeanId( StringUtils.substringAfter( entry.getKey(), "#" ) );
193 information.setDescriptionKey( userManager.getDescriptionKey() );
194 information.setReadOnly( userManager.isReadOnly() );
195 informations.add( information );
203 public Boolean checkLdapConnection()
204 throws ArchivaRestServiceException
206 LdapConnection ldapConnection = null;
209 ldapConnection = ldapConnectionFactory.getConnection();
211 catch ( LdapException e )
213 log.warn( "fail to get LdapConnection: {}", e.getMessage() );
214 throw new ArchivaRestServiceException( e.getMessage(), e );
219 if ( ldapConnection != null )
221 ldapConnection.close();
228 public Boolean checkLdapConnection( LdapConfiguration ldapConfiguration )
229 throws ArchivaRestServiceException
231 LdapConnection ldapConnection = null;
234 LdapConnectionConfiguration ldapConnectionConfiguration =
235 new LdapConnectionConfiguration( ldapConfiguration.getHostName(), ldapConfiguration.getPort(),
236 ldapConfiguration.getBaseDn(), ldapConfiguration.getContextFactory(),
237 ldapConfiguration.getBindDn(), ldapConfiguration.getPassword(),
238 ldapConfiguration.getAuthenticationMethod(),
239 toProperties( ldapConfiguration.getExtraProperties() ) );
241 ldapConnection = ldapConnectionFactory.getConnection( ldapConnectionConfiguration );
243 ldapConnection.close();
245 // verify groups dn value too
247 ldapConnectionConfiguration =
248 new LdapConnectionConfiguration( ldapConfiguration.getHostName(), ldapConfiguration.getPort(),
249 ldapConfiguration.getBaseGroupsDn(),
250 ldapConfiguration.getContextFactory(), ldapConfiguration.getBindDn(),
251 ldapConfiguration.getPassword(),
252 ldapConfiguration.getAuthenticationMethod(),
253 toProperties( ldapConfiguration.getExtraProperties() ) );
255 ldapConnection = ldapConnectionFactory.getConnection( ldapConnectionConfiguration );
257 catch ( InvalidNameException e )
259 log.warn( "fail to get LdapConnection: {}", e.getMessage() );
260 throw new ArchivaRestServiceException( e.getMessage(), e );
262 catch ( LdapException e )
264 log.warn( "fail to get LdapConnection: {}", e.getMessage() );
265 throw new ArchivaRestServiceException( e.getMessage(), e );
270 if ( ldapConnection != null )
272 ldapConnection.close();
279 private Properties toProperties( Map<String, String> map )
281 Properties properties = new Properties();
282 if ( map == null || map.isEmpty() )
286 for ( Map.Entry<String, String> entry : map.entrySet() )
288 properties.put( entry.getKey(), entry.getValue() );