/src/edu/ucsb/nceas/metacat/service/SkinPropertyService.java - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 4762

Added by daigle over 15 years ago

Only configure skins that are correctly configured in the skins directory.

     import java.util.Set;
     import java.util.Vector;
     import javax.servlet.ServletContext;
     import javax.servlet.http.HttpServletRequest;
     import javax.xml.transform.TransformerException;
     import org.apache.log4j.Logger;
     import edu.ucsb.nceas.metacat.util.SkinUtil;
     import edu.ucsb.nceas.metacat.util.SystemUtil;
     import edu.ucsb.nceas.metacat.util.UtilException;
     import edu.ucsb.nceas.utilities.FileUtil;
     import edu.ucsb.nceas.utilities.GeneralPropertyException;
-...
      * A suite of utility classes for the skin configuration utility
      */
     public class SkinPropertyService extends BaseService {
     	private static SkinPropertyService skinService = null;
     	private static boolean bypassAlreadyChecked = false;
     	private static String SKIN_DIR = null;
     	private static String BACKUP_DIR = null;
     	private static Vector<String> skinNames = null;
     	private static HashMap<String, SortedProperties> skinPropertiesMap = null;
     	private static HashMap<String, SortedProperties> skinPropertiesMap = null;
     	private static HashMap<String, SortedProperties> skinBackupPropertiesMap = null;
     	private static HashMap<String, PropertiesMetaData> skinMetaDataMap = null;
     	private static Logger logMetacat = Logger.getLogger(SkinPropertyService.class);
     	/**
     	 * private constructor since this is a singleton
+    	 *
     	 * @param servletContext the context we will use to get relative paths
     	 * @param servletContext
     	 *            the context we will use to get relative paths
     	 */
     	private SkinPropertyService() throws ServiceException {
     		try {
-...
     					+ ioe.getMessage());
+    		}
+    	}
     	/**
     	 * Get the single instance of SkinPropertyService.
+    	 *
     	 * @param servletContext the context we will use to get relative paths
     	 * @param servletContext
     	 *            the context we will use to get relative paths
     	 * @return the single instance of SkinPropertyService
     	 */
     	public static SkinPropertyService getInstance() throws ServiceException {
-...
+    		}
     		return skinService;
+    	}
     	public boolean refreshable() {
     		return true;
+    	}
     	protected void doRefresh() throws ServiceException {
     		try {
     			initialize();
-...
     					+ " property error: " + gpe.getMessage());
+    		}
+    	}
     	/**
     	 * Initialize the singleton.
+    	 *
     	 * @param servletContext
     	 *            the context we will use to get relative paths
     	 */
     	private void initialize() throws IOException,
     			GeneralPropertyException, ServiceException {
     	private void initialize() throws IOException, GeneralPropertyException,
     			ServiceException {
     		logMetacat.debug("Initializing SkinService");
     		BACKUP_DIR = PropertyService.getProperty("application.backupDir") + FileUtil.getFS() + ".metacat";
     		BACKUP_DIR = PropertyService.getProperty("application.backupDir")
     				+ FileUtil.getFS() + ".metacat";
     		skinNames = SkinUtil.getSkinNames();
-...
     				String propertyFilePath = ServiceService.getRealSkinDir()
     						+ FileUtil.getFS() + skinName + FileUtil.getFS() + skinName
     						+ ".properties";
     				if (FileUtil.getFileStatus(propertyFilePath) < FileUtil.EXISTS_READ_WRITABLE) {
     					logMetacat.error("Skin property file: " + propertyFilePath
     							+ " does not exist read/writable");
     					continue;
+    				}
     				SortedProperties skinProperties = new SortedProperties(propertyFilePath);
     				skinProperties.load();
     				skinPropertiesMap.put(skinName, skinProperties);
-...
     						+ FileUtil.getFS() + skinName + FileUtil.getFS() + skinName
     						+ ".properties.metadata.xml";
     				if (FileUtil.getFileStatus(metaDataFilePath) == FileUtil.DOES_NOT_EXIST) {
     					throw new GeneralPropertyException("Could not find skin property metadata file: " + metaDataFilePath);
     					throw new GeneralPropertyException(
     							"Could not find skin property metadata file: "
     									+ metaDataFilePath);
     				} else {
     					PropertiesMetaData skinMetaData = new PropertiesMetaData(metaDataFilePath);
     					PropertiesMetaData skinMetaData = new PropertiesMetaData(
     							metaDataFilePath);
     					skinMetaDataMap.put(skinName, skinMetaData);
+    				}
+    				}
     				String backupPropertyFilePath =
     					BACKUP_DIR + FileUtil.getFS() + skinName + ".properties.backup";
     				String backupPropertyFilePath = BACKUP_DIR + FileUtil.getFS() + skinName
     						+ ".properties.backup";
     				if (FileUtil.getFileStatus(backupPropertyFilePath) > FileUtil.DOES_NOT_EXIST) {
     					SortedProperties skinBackupProperties =
     						new SortedProperties(backupPropertyFilePath);
     					SortedProperties skinBackupProperties = new SortedProperties(
     							backupPropertyFilePath);
     					skinBackupProperties.load();
     					skinBackupPropertiesMap.put(skinName, skinBackupProperties);
     				} else {
     					logMetacat.info("Could not find backup properties for skin: " + skinName
     							+ ". Backup file does not exist: " + backupPropertyFilePath);
     					logMetacat.info("Could not find backup properties for skin: "
     							+ skinName + ". Backup file does not exist: "
     							+ backupPropertyFilePath);
+    				}
+    			}
     		} catch (TransformerException te) {
-...
+    	}
     	/**
     	 * Utility method to get a property value from the properties file for
     	 * a specific skin.
     	 * Utility method to get a property value from the properties file for a
     	 * specific skin.
+    	 *
     	 * @param skinName the skin for which we want to retrieve the property
     	 * @param skinName
     	 *            the skin for which we want to retrieve the property
     	 * @param propertyName
     	 *            the name of the property requested
     	 * @return the String value for the property
-...
     			throws PropertyNotFoundException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new PropertyNotFoundException("There is not property map for " + skinName);
     			throw new PropertyNotFoundException("There is not property map for "
     					+ skinName);
+    		}
     		return skinProperties.getProperty(propertyName);
+    	}
     	/**
          * Get a set of all property names for a given skin.
+         *
          * @param skinName the skin for which we want to retrieve the property
          * names
          * @return Set of property names
          */
         public static Vector<String> getPropertyNames(String skinName) throws PropertyNotFoundException {
     	 * Get a set of all property names for a given skin.
+    	 *
     	 * @param skinName
     	 *            the skin for which we want to retrieve the property names
     	 * @return Set of property names
     	 */
     	public static Vector<String> getPropertyNames(String skinName)
     			throws PropertyNotFoundException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new PropertyNotFoundException("There is not property map for " + skinName);
     			throw new PropertyNotFoundException("There is not property map for "
     					+ skinName);
+    		}
         	return skinProperties.getPropertyNames();
+        }
     		return skinProperties.getPropertyNames();
+    	}
     	/**
     	 * Get a Set of all property names that start with the groupName prefix.
-...
     	 *            the prefix of the keys to search for.
     	 * @return Vector of property names
     	 */
         public static Vector<String> getPropertyNamesByGroup(String skinName, String groupName) throws PropertyNotFoundException {
     	public static Vector<String> getPropertyNamesByGroup(String skinName, String groupName)
     			throws PropertyNotFoundException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new PropertyNotFoundException("There is not property map for " + skinName);
     			throw new PropertyNotFoundException("There is not property map for "
     					+ skinName);
+    		}
         	return skinProperties.getPropertyNamesByGroup(groupName);
+        }
     		return skinProperties.getPropertyNamesByGroup(groupName);
+    	}
     	/**
     	 * Get the main backup properties file. These are configurable properties that
     	 * are stored outside the metacat install directories so the user does not
     	 * need to re-enter all the configuration information every time they do an
     	 * upgrade.
     	 * Get the main backup properties file. These are configurable properties
     	 * that are stored outside the metacat install directories so the user does
     	 * not need to re-enter all the configuration information every time they do
     	 * an upgrade.
+    	 *
     	 * @return a SortedProperties object with the backup properties
     	 */
     	public static HashMap<String, SortedProperties> getProperties() {
     		return skinPropertiesMap;
+    	}
     	/**
     	 * Get the main backup properties file. These are configurable properties that
     	 * are stored outside the metacat install directories so the user does not
     	 * need to re-enter all the configuration information every time they do an
     	 * upgrade.
     	 * Get the main backup properties file. These are configurable properties
     	 * that are stored outside the metacat install directories so the user does
     	 * not need to re-enter all the configuration information every time they do
     	 * an upgrade.
+    	 *
     	 * @return a SortedProperties object with the backup properties
     	 */
-...
+    	}
     	/**
     	 * Get the main backup properties file. These are configurable properties that
     	 * are stored outside the metacat install directories so the user does not
     	 * need to re-enter all the configuration information every time they do an
     	 * upgrade.
     	 * Get the main backup properties file. These are configurable properties
     	 * that are stored outside the metacat install directories so the user does
     	 * not need to re-enter all the configuration information every time they do
     	 * an upgrade.
+    	 *
     	 * @return a SortedProperties object with the backup properties
     	 */
     	public static HashMap<String, SortedProperties> getBackupProperties() {
     		return skinBackupPropertiesMap;
+    	}
     	/**
     	 * Get the main backup properties file. These are configurable properties that
     	 * are stored outside the metacat install directories so the user does not
     	 * need to re-enter all the configuration information every time they do an
     	 * upgrade.
     	 * Get the main backup properties file. These are configurable properties
     	 * that are stored outside the metacat install directories so the user does
     	 * not need to re-enter all the configuration information every time they do
     	 * an upgrade.
+    	 *
     	 * @return a SortedProperties object with the backup properties
     	 */
     	public static SortedProperties getBackupProperties(String skinName) {
     		return skinBackupPropertiesMap.get(skinName);
+    	}
     	/**
     	 * Get the main properties metadata. This is retrieved from an xml file that
     	 * describes the attributes of configurable properties.
-...
     	public static HashMap<String, PropertiesMetaData> getMetaData() {
     		return skinMetaDataMap;
+    	}
     	/**
     	 * Get the main properties metadata. This is retrieved from an xml file that
     	 * describes the attributes of configurable properties.
-...
     	 * @param newValue
     	 *            the new value for the property
     	 */
     	public static void setProperty(String skinName, String propertyName, String newValue) throws IOException, GeneralPropertyException {
     	public static void setProperty(String skinName, String propertyName, String newValue)
     			throws IOException, GeneralPropertyException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new GeneralPropertyException("There is not property map for " + skinName);
     			throw new GeneralPropertyException("There is not property map for "
     					+ skinName);
+    		}
     		skinProperties.setProperty(propertyName, newValue);
     		skinProperties.store();
-...
     	 * @param newValue
     	 *            the new value for the property
     	 */
     	public static void setPropertyNoPersist(String skinName, String propertyName, String newValue) throws GeneralPropertyException {
     	public static void setPropertyNoPersist(String skinName, String propertyName,
     			String newValue) throws GeneralPropertyException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new GeneralPropertyException("There is not property map for " + skinName);
     			throw new GeneralPropertyException("There is not property map for "
     					+ skinName);
+    		}
     		skinProperties.setPropertyNoPersist(propertyName, newValue);
+    	}
     	/**
     	 * Save the properties to a properties file. Note, the
     	 * order and comments will be preserved.
     	 * Save the properties to a properties file. Note, the order and comments
     	 * will be preserved.
     	 */
     	public static void persistProperties(String skinName) throws IOException, GeneralPropertyException {
     	public static void persistProperties(String skinName) throws IOException,
     			GeneralPropertyException {
     		SortedProperties skinProperties = skinPropertiesMap.get(skinName);
     		if (skinProperties == null) {
     			throw new GeneralPropertyException("There is not property map for " + skinName);
     			throw new GeneralPropertyException("There is not property map for "
     					+ skinName);
+    		}
     		skinProperties.store();
+    	}
-...
     			persistProperties(skinName);
+    		}
+    	}
     	/**
     	 * Writes out backup configurable properties to a file.
     	 */
     	public static void persistBackupProperties(String skinName) throws GeneralPropertyException {
     	public static void persistBackupProperties(String skinName)
     			throws GeneralPropertyException {
     		try {
     			String metaDataFilePath = ServiceService.getRealSkinDir() + FileUtil.getFS()
     					+ skinName + FileUtil.getFS() + skinName + ".properties.metadata.xml";
-...
     			// Use the metadata to extract configurable properties from the
     			// overall properties list, and store those properties.
     			SortedProperties backupProperties =
     				new SortedProperties(backupPropertyFilePath);
     			SortedProperties backupProperties = new SortedProperties(
     					backupPropertyFilePath);
     			// Populate the backup properties for main metacat properties using
     			// the associated metadata file
     			PropertiesMetaData mainMetadata = new PropertiesMetaData(metaDataFilePath);
     			Set<String> mainKeySet = mainMetadata.getKeys();
     			for (String propertyKey : mainKeySet) {
     				backupProperties.addProperty(propertyKey, getProperty(skinName, propertyKey));
     				backupProperties.addProperty(propertyKey, getProperty(skinName,
     						propertyKey));
+    			}
     			// store the properties to file
     			backupProperties.store();
     		} catch (TransformerException te) {
     			throw new GeneralPropertyException("Could not transform backup properties xml: "
     					+ te.getMessage());
     			throw new GeneralPropertyException(
     					"Could not transform backup properties xml: " + te.getMessage());
     		} catch (IOException ioe) {
     			throw new GeneralPropertyException("Could not backup configurable properties: "
     					+ ioe.getMessage());
     			throw new GeneralPropertyException(
     					"Could not backup configurable properties: " + ioe.getMessage());
     		} catch (ServiceException se) {
     			throw new GeneralPropertyException("Could not get skins property file: "
     					+ se.getMessage());
+    		}
+    	}
     	/**
     	 * Reports whether properties are fully configured.
+    	 *
-...
     					+ pnfe.getMessage());
+    		}
+    	}
     	/**
     	 * Take input from the user in an HTTP request about an property to be changed
     	 * and update the metacat property file with that new value if it has
     	 * changed from the value that was originally set.
     	 * Take input from the user in an HTTP request about an property to be
     	 * changed and update the metacat property file with that new value if it
     	 * has changed from the value that was originally set.
+    	 *
     	 * @param request
     	 *            that was generated by the user
-...
     	 * @param propertyName
     	 *            the name of the property to be checked and set
     	 */
     	public static void checkAndSetProperty(HttpServletRequest request, String skinName, String propertyName)
     			throws GeneralPropertyException {
     	public static void checkAndSetProperty(HttpServletRequest request, String skinName,
     			String propertyName) throws GeneralPropertyException {
     		String newValue = request.getParameter(skinName + "." + propertyName);
     		checkAndSetProperty(newValue, skinName, propertyName);
     		checkAndSetProperty(newValue, skinName, propertyName);
+    	}
     	/**
     	 * Check user input against existing value
     	 * and update the metacat property file with that new value if it has
     	 * changed from the value that was originally set.
     	 * Check user input against existing value and update the metacat property
     	 * file with that new value if it has changed from the value that was
     	 * originally set.
+    	 *
     	 * @param newValue
     	 *            the value that was returned by the form
-...
     	 * @param propertyName
     	 *            the name of the property to be checked and set
     	 */
     	public static void checkAndSetProperty(String newValue, String skinName, String propertyName)
     			throws GeneralPropertyException {
     	public static void checkAndSetProperty(String newValue, String skinName,
     			String propertyName) throws GeneralPropertyException {
     		String oldValue = SkinPropertyService.getProperty(skinName, propertyName);
     		if (newValue != null && !newValue.equals(oldValue)) {
     			SkinPropertyService.setPropertyNoPersist(skinName, propertyName, newValue);
+    		}
+    	}
     	/**
     	 * Reports whether the metacat configuration utility should be run.
     	 * Returns false if
     	 *   -- dev.runConfiguration=false and
     	 *   -- backup properties file exists
     	 * Note that dev.runConfiguration should only be set to false when
     	 * Reports whether the metacat configuration utility should be run. Returns
     	 * false if -- dev.runConfiguration=false and -- backup properties file
     	 * exists Note that dev.runConfiguration should only be set to false when
     	 * reinstalling the same version of the application in developement.
+    	 *
     	 * @return a boolean that is false if dev.runConfiguration is false and
     	 * the backup properties file exists.
     	 * @return a boolean that is false if dev.runConfiguration is false and the
     	 *         backup properties file exists.
     	 */
     	public static boolean bypassConfiguration() {
     		boolean bypass = false;
     		// We only want to go through the check once to see if we want to
     		// bypass the configuration.  We don't want to run through all of
     		// this every time  we hit metacat.
     		// bypass the configuration. We don't want to run through all of
     		// this every time we hit metacat.
     		if (bypassAlreadyChecked) {
     			return bypass;
+    		}
     		try {
     		try {
     			// check how dev.runConfiguration is set in metacat.properties
     			String strRunConfiguration = PropertyService.getProperty("dev.runConfiguration");
     			String strRunConfiguration = PropertyService
     					.getProperty("dev.runConfiguration");
     			bypass = !(Boolean.parseBoolean(strRunConfiguration));
     			// if the deb.runConfiguration is true, return false here.
     			if (!bypass) {
     				bypassAlreadyChecked = true;
-...
     			// the system is bypassing the configuration utility. We need to
     			// get the backup properties and replace existing properties with
     			// backup values.  We do this for main and org properties.
     			// backup values. We do this for main and org properties.
     			for (String skinName : skinNames) {
     				SortedProperties backupProperties = getBackupProperties(skinName);
     				Vector<String> backupPropertyNames =
     					backupProperties.getPropertyNames();
     				Vector<String> backupPropertyNames = backupProperties.getPropertyNames();
     				for (String backupPropertyName : backupPropertyNames) {
     					String value = backupProperties.getProperty(backupPropertyName);
     					backupProperties.setPropertyNoPersist(backupPropertyName, value);

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 4762

Added by daigle over 15 years ago