org.jdtaus.banking.ri.currencydir.ClasspathCurrenciesProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdtaus-banking-ri-currencydirectory Show documentation
jDTAUS CurrencyDirectory reference implementation.
There is a newer version: 1.16
Show newest version
/*
 *  jDTAUS Banking RI CurrencyDirectory
 *  Copyright (c) 2005 Christian Schulte
 *
 *  Christian Schulte, Haldener Strasse 72, 58095 Hagen, Germany
 *   (+49 2331 3543887)
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
package org.jdtaus.banking.ri.currencydir;

import java.io.IOException;
import java.net.URL;
import java.util.Collection;
import java.util.Enumeration;
import java.util.LinkedList;
import org.jdtaus.core.container.ContainerFactory;
import org.jdtaus.core.container.PropertyException;

/**
 * Classpath {@code CurrenciesProvider} implementation.
 * This implementation provides resources by searching the classpath.
 * Property {@code resourceName} holds the name of the resources to search and
 * defaults to {@code META-INF/jdtaus/currencies.xml}.
 *
 * @author Christian Schulte
 * @version $Id: ClasspathCurrenciesProvider.java 5539 2008-10-28 23:40:53Z schulte2005 $
 *
 * @see XMLCurrencyDirectory
 */
public final class ClasspathCurrenciesProvider implements CurrenciesProvider
{
    //--Constructors------------------------------------------------------------

// //GEN-BEGIN:jdtausConstructors
    // This section is managed by jdtaus-container-mojo.

    /** Standard implementation constructor org.jdtaus.banking.ri.currencydir.ClasspathCurrenciesProvider. */
    public ClasspathCurrenciesProvider()
    {
        super();
    }

// //GEN-END:jdtausConstructors

    //------------------------------------------------------------Constructors--
    //--Properties--------------------------------------------------------------

// //GEN-BEGIN:jdtausProperties
    // This section is managed by jdtaus-container-mojo.

    /**
     * Gets the value of property defaultResourceName.
     *
     * @return Default name of the resources to provide.
     */
    private java.lang.String getDefaultResourceName()
    {
        return (java.lang.String) ContainerFactory.getContainer().
            getProperty( this, "defaultResourceName" );

    }

// //GEN-END:jdtausProperties

    //--------------------------------------------------------------Properties--
    //--CurrenciesProvider------------------------------------------------------

    public URL[] getResources() throws IOException
    {
        this.assertValidProperties();
        final Collection col = new LinkedList();
        final Enumeration en =
            this.getClassLoader().getResources( this.getResourceName() );

        while ( en.hasMoreElements() )
        {
            col.add( en.nextElement() );
        }

        return (URL[]) col.toArray( new URL[ col.size() ] );
    }

    //------------------------------------------------------CurrenciesProvider--
    //--ClasspathCurrenciesProvider---------------------------------------------

    /** Classloader searched for resources. */
    private ClassLoader classLoader;

    /** Name of the classpath resource to search. */
    private String resourceName;

    /**
     * Creates a new {@code ClasspathCurrenciesProvider} instance taking
     * the name of the classpath resources to search.
     *
     * @param resourceName name of the classpath resources to search.
     */
    public ClasspathCurrenciesProvider( final String resourceName )
    {
        this( resourceName, null );
    }

    /**
     * Creates a new {@code ClasspathCurrenciesProvider} instance taking
     * the classloader to search for resources.
     *
     * @param classLoader the classloader to search for resources.
     */
    public ClasspathCurrenciesProvider( final ClassLoader classLoader )
    {
        this( null, classLoader );
    }

    /**
     * Creates a new {@code ClasspathCurrenciesProvider} instance taking the
     * name of the classpath resources to search and the classloader to search
     * for resources.
     *
     * @param resourceName name of the classpath resources to search.
     * @param classLoader the classloader to search for resources.
     */
    public ClasspathCurrenciesProvider( final String resourceName,
        final ClassLoader classLoader )
    {
        this.resourceName = resourceName;
        this.classLoader = classLoader;
    }

    /**
     * Gets the name of the classpath resource to search.
     *
     * @return the name of the classpath resource to search.
     */
    public String getResourceName()
    {
        if ( this.resourceName == null )
        {
            this.resourceName = this.getDefaultResourceName();
        }

        return this.resourceName;
    }

    /**
     * Gets the classloader searched for resources.
     * This method returns either the current thread's context classloader or
     * this classes classloader, if the current thread has no context
     * classloader set. A custom classloader can be specified by using one of
     * the constructors taking a classloader.
     *
     * @return the classloader to search for resources.
     */
    public ClassLoader getClassLoader()
    {
        if ( this.classLoader == null )
        {
            this.classLoader =
                Thread.currentThread().getContextClassLoader();

        }

        if ( this.classLoader == null )
        {
            this.classLoader = this.getClass().getClassLoader();
        }

        return this.classLoader;
    }

    /**
     * Checks configured properties.
     *
     * @throws PropertyException if properties hold invalid values.
     */
    private void assertValidProperties()
    {
        if ( this.getResourceName() == null ||
            this.getResourceName().length() <= 0 )
        {

            throw new PropertyException( "resourceName",
                this.getResourceName() );

        }
    }

    //---------------------------------------------ClasspathCurrenciesProvider--
}