/*
* Sonatype Nexus (TM) Open Source Version
* Copyright (c) 2007-2014 Sonatype, Inc.
* All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
*
* This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
* which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
* of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
* Eclipse Foundation. All other trademarks are the property of their respective owners.
*/
package org.sonatype.security.configuration.upgrade;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.util.Map;
import javax.enterprise.inject.Typed;
import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;
import org.sonatype.configuration.upgrade.ConfigurationIsCorruptedException;
import org.sonatype.configuration.upgrade.UnsupportedConfigurationVersionException;
import org.sonatype.configuration.upgrade.UpgradeMessage;
import org.sonatype.security.configuration.model.SecurityConfiguration;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Default security configuration (security-configuration.xml) updater. It attempts to detect the version in the file,
* and iteratively apply the appropriate version-specific updaters to update the file to the latest version
*
* @author Steve Carlucci
*/
@Singleton
@Typed(SecurityConfigurationUpgrader.class)
@Named("default")
public class DefaultSecurityConfigurationUpgrader
implements SecurityConfigurationUpgrader
{
private static final Logger logger = LoggerFactory.getLogger(DefaultSecurityConfigurationUpgrader.class);
private final Map<String, SecurityConfigurationVersionUpgrader> upgraders;
//private final Map<String, SecurityDataUpgrader> dataUpgraders;
@Inject
public DefaultSecurityConfigurationUpgrader(Map<String, SecurityConfigurationVersionUpgrader> upgraders) {
this.upgraders = upgraders;
//this.dataUpgraders = dataUpgraders;
}
/**
* This implementation relies to plexus registered upgraders. It will cycle through them until the configuration is
* the needed (current) model version.
*/
public SecurityConfiguration loadOldConfiguration(File file)
throws IOException, ConfigurationIsCorruptedException, UnsupportedConfigurationVersionException
{
// try to find out the model version
String modelVersion = null;
try {
Reader r = new BufferedReader(ReaderFactory.newXmlReader(file));
Xpp3Dom dom = Xpp3DomBuilder.build(r);
modelVersion = dom.getChild("version").getValue();
}
catch (XmlPullParserException e) {
throw new ConfigurationIsCorruptedException(file.getAbsolutePath(), e);
}
if (SecurityConfiguration.MODEL_VERSION.equals(modelVersion)) {
// we have a problem here, model version is OK but we could not load it previously?
throw new ConfigurationIsCorruptedException(file);
}
UpgradeMessage msg = new UpgradeMessage();
msg.setModelVersion(modelVersion);
SecurityConfigurationVersionUpgrader upgrader = upgraders.get(msg.getModelVersion());
if (upgrader != null) {
logger.info("Upgrading old Security configuration file (version {}) from {}", msg.getModelVersion(),
file.getAbsolutePath());
msg.setConfiguration(upgrader.loadConfiguration(file));
while (!SecurityConfiguration.MODEL_VERSION.equals(msg.getModelVersion())) {
if (upgrader != null) {
upgrader.upgrade(msg);
}
else {
// we could parse the XML but have no model version? Is this security config at all?
throw new UnsupportedConfigurationVersionException(modelVersion, file);
}
upgrader = upgraders.get(msg.getModelVersion());
}
logger.info("Security configuration file upgraded to current version {} successfully", msg.getModelVersion());
return (SecurityConfiguration) msg.getConfiguration();
}
else {
// we could parse the XML but have no model version? Is this security config at all?
throw new UnsupportedConfigurationVersionException(modelVersion, file);
}
}
}