jforum example source code file (ModulesRepository.java)

This example jforum source code file (ModulesRepository.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - jforum tags/keywords

askes, askes, entries, entries, hashmap, io, logger, map, modulesrepository, modulesrepository, null, properties, string, string, util

The jforum ModulesRepository.java source code

/*
 * Copyright (c) JForum Team
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met:
 * 
 * 1) Redistributions of source code must retain the above 
 * copyright notice, this list of conditions and the 
 * following  disclaimer.
 * 2)  Redistributions in binary form must reproduce the 
 * above copyright notice, this list of conditions and 
 * the following disclaimer in the documentation and/or 
 * other materials provided with the distribution.
 * 3) Neither the name of "Rafael Steil" nor 
 * the names of its contributors may be used to endorse 
 * or promote products derived from this software without 
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT 
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
 * IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
 * 
 * Created on 29/11/2004 22:53:28
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum.repository;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

import net.jforum.ConfigLoader;
import net.jforum.JForumExecutionContext;

import org.apache.log4j.Logger;

/**
 * @author Rafael Steil
 * @version $Id: ModulesRepository.java,v 1.11 2006/08/20 22:47:38 rafaelsteil Exp $
 */
public class ModulesRepository
{
	private static final Logger logger = Logger.getLogger(ModulesRepository.class);
	
	private static Map cache = new HashMap();
	private static final String ENTRIES = "entries";

	/**
	 * Loads all modules mapping.
	 * 
	 * @param baseDir The directory where the file "modulesMapping.properties"
	 * is placed.
	 * @throws IOException
	 */
	public static void init(String baseDir)
	{
		cache.put(ENTRIES, ConfigLoader.loadModulesMapping(baseDir));
	}
	
	public static int size()
	{
		return cache.size();
	}
	
	/**
	 * Gets the fully qualified name of some given module name.
	 * 
	 * @param moduleName The module's name to get its class name
	 * @return The class name associated to the module name passed
	 * as argument, or <code>null if not found.
	 */
	public static String getModuleClass(String moduleName) {
		Properties p = (Properties)cache.get(ENTRIES);
		
		if (p == null) {
			logger.error("Null modules. Askes moduleName: " + moduleName
					+ ", url=" + JForumExecutionContext.getRequest().getQueryString());
			return null;
		}
		
		return p.getProperty(moduleName);
	}
}