/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package npanday.vendor.impl;
import npanday.registry.NPandayRepositoryException;
import npanday.registry.Repository;
import npanday.registry.RepositoryRegistry;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.*;
import java.util.Collections;
import java.util.Hashtable;
import java.util.List;
import java.util.ArrayList;
import npanday.model.settings.NPandaySettings;
import npanday.model.settings.Vendor;
import npanday.model.settings.DefaultSetup;
import npanday.model.settings.Framework;
import npanday.model.settings.io.xpp3.NPandaySettingsXpp3Reader;
import npanday.PlatformUnsupportedException;
import npanday.vendor.VendorFactory;
import npanday.vendor.VendorInfo;
import npanday.vendor.VendorUnsupportedException;
/**
* Provides methods for loading and reading the npanday-settings config file.
*
* @author Shane Isbell
*/
public final class SettingsRepository
implements Repository
{
/**
* List of all vendors from the npanday-settings file. The <code>Vendor</code> is the raw model type.
*/
private List<Vendor> vendors;
/**
* The default setup: framework version, vendor, vendor version. If no information is provided by the user, then
* this information will be used to choose the environment. It may also be used for partial matches, if appropriate.
*/
private DefaultSetup defaultSetup;
private String fileUri;
private Hashtable props;
private boolean reloaded = false;
/**
* Constructor. This method is intended to be invoked by the <code>RepositoryRegistry<code>, not by the
* application developer.
*/
public SettingsRepository()
{
}
/**
* @see Repository#load(java.io.InputStream, java.util.Hashtable)
*/
public void load( InputStream inputStream, Hashtable properties )
throws NPandayRepositoryException
{
NPandaySettingsXpp3Reader xpp3Reader = new NPandaySettingsXpp3Reader();
Reader reader = new InputStreamReader( inputStream );
NPandaySettings settings;
try
{
settings = xpp3Reader.read( reader );
}
catch( IOException e )
{
throw new NPandayRepositoryException( "NPANDAY-104-000: An error occurred while reading npanday-settings.xml", e );
}
catch ( XmlPullParserException e )
{
throw new NPandayRepositoryException( "NPANDAY-104-001: Could not read npanday-settings.xml", e );
}
vendors = settings.getVendors();
defaultSetup = settings.getDefaultSetup();
props = properties;
}
/**
* Gets the raw configured model.
*
* @return Unmodifiable list.
*/
public List<Vendor> getVendors() {
return Collections.unmodifiableList(vendors);
}
/**
* @see Repository#setRepositoryRegistry(npanday.registry.RepositoryRegistry)
*/
public void setRepositoryRegistry( RepositoryRegistry repositoryRegistry )
{
}
public void setSourceUri( String fileUri )
{
this.fileUri = fileUri;
}
public void reload()
throws IOException, NPandayRepositoryException {
if ( fileUri == null || fileUri.trim().equals( "" ) )
{
throw new IOException( "NPANDAY-084-001: File uri must be provided." );
}
InputStream stream;
try
{
stream = new FileInputStream( fileUri );
}
catch ( IOException e )
{
stream = this.getClass().getResourceAsStream( fileUri );
}
String message =
"File Name = " + fileUri + ", Repository Class = " + this.getClass().getName() + ", Properties = " + props.toString();
boolean optional = ( props.containsKey( "optional" ) &&
( (String) props.get( "optional" ) ).equalsIgnoreCase( "true" ) );
if ( stream == null )
{
if ( !optional )
{
throw new IOException( "NPANDAY-084-003: Unable to loadRegistry config file: " + message );
}
}
else
{
try
{
load( stream, props );
}
catch ( NPandayRepositoryException e )
{
throw new NPandayRepositoryException( "NPANDAY-084-004: " + e.toString() + " : " + message, e );
}
catch ( Exception e )
{
throw new NPandayRepositoryException( "NPANDAY-084-005: " + e.toString() + " : " + message, e );
}
catch ( Error e )
{
throw new NPandayRepositoryException( "NPANDAY-084-006: " + e.toString() + " : " + message, e );
}
}
reloaded = true;
}
public void setReloaded( boolean status )
{
this.reloaded = status;
}
public boolean isReloaded()
{
return this.reloaded;
}
File getSdkInstallRootFor( String vendor, String vendorVersion, String frameworkVersion )
throws PlatformUnsupportedException
{
if ( vendor == null || vendorVersion == null || frameworkVersion == null )
{
throw new PlatformUnsupportedException( "NPANDAY-104-004: One of more of the parameters is null: Vendor = " +
vendor + ", Vendor Version = " + vendorVersion + ", Framework Version = " + frameworkVersion );
}
for ( Vendor v : vendors )
{
if ( vendor.equals( v.getVendorName().trim() ) && vendorVersion.equals( v.getVendorVersion().trim() ) )
{
List<Framework> frameworks = v.getFrameworks();
for ( Framework framework : frameworks )
{
if ( frameworkVersion.equals( framework.getFrameworkVersion().trim() ) )
{
String sdkRoot = framework.getSdkInstallRoot();
if(sdkRoot != null) return new File(sdkRoot );
}
}
}
}
return null;
}
/**
* Returns the install root for the .NET framework for the specified parameters. None of the parameter values
* should be null.
*
* @param vendor the vendor name
* @param vendorVersion the vendor version
* @param frameworkVersion the .NET framework version
* @return the install root for the .NET framework
* @throws npanday.PlatformUnsupportedException if there is no install root found for the specified parameters
*/
public File getInstallRootFor( String vendor, String vendorVersion, String frameworkVersion )
throws PlatformUnsupportedException
{
if ( vendor == null || vendorVersion == null || frameworkVersion == null )
{
throw new PlatformUnsupportedException( "NPANDAY-104-001: One of more of the parameters is null: Vendor = " +
vendor + ", Vendor Version = " + vendorVersion + ", Framework Version = " + frameworkVersion );
}
for ( Vendor v : vendors )
{
if ( vendor.equals( v.getVendorName().trim() ) && vendorVersion.equals( v.getVendorVersion().trim() ) )
{
List<Framework> frameworks = v.getFrameworks();
for ( Framework framework : frameworks )
{
if ( frameworkVersion.equals( framework.getFrameworkVersion().trim() ))
{
return new File( framework.getInstallRoot() );
}
}
}
}
throw new PlatformUnsupportedException( "NPANDAY-104-002: Unable to find install root: Vendor = " + vendor +
", Vendor Version = " + vendorVersion + ", Framework Version = " + frameworkVersion );
}
List<File> getExecutablePathsFor( String vendor, String vendorVersion, String frameworkVersion )
throws PlatformUnsupportedException
{
List<File> executablePaths = new ArrayList<File>();
if ( vendor == null || vendorVersion == null || frameworkVersion == null )
{
throw new PlatformUnsupportedException( "NPANDAY-104-006: One of more of the parameters is null: Vendor = " +
vendor + ", Vendor Version = " + vendorVersion + ", Framework Version = " + frameworkVersion );
}
for ( Vendor v : vendors )
{
if ( vendor.equals( v.getVendorName().trim() ) && vendorVersion.equals( v.getVendorVersion().trim() ) )
{
List<Framework> frameworks = v.getFrameworks();
for ( Framework framework : frameworks )
{
if ( frameworkVersion.equals( framework.getFrameworkVersion().trim() ) )
{
List paths = framework.getExecutablePaths();
for(Object path : paths)
{
executablePaths.add(new File((String)path));
}
}
}
}
}
return executablePaths;
}
/**
* Returns the default setup: framework version, vendor, vendor version. If no information is provided by the user, then
* this information will be used to choose the environment. It may also be used for partial matches, if appropriate.
*
* @return the default setup: framework version, vendor, vendor version
*/
DefaultSetup getDefaultSetup()
{
return defaultSetup;
}
}