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

« Previous | Next »

Revision 4159

Added by daigle over 15 years ago

Add support for separate LDAP and organization level configurations

     import org.apache.log4j.Logger;
     import edu.ucsb.nceas.metacat.util.LDAPUtil;
     import edu.ucsb.nceas.metacat.util.OrganizationUtil;
     import edu.ucsb.nceas.metacat.util.UtilException;
     import edu.ucsb.nceas.utilities.FileUtil;
     import edu.ucsb.nceas.utilities.GeneralPropertyException;
-...
     	private static final String MAIN_CONFIG_NAME = "metacat.properties";
     	private static final String ORG_CONFIG_NAME = "org.properties";
     	private static final String LDAP_CONFIG_NAME = "ldap.properties";
     	private static boolean bypassAlreadyChecked = false;
-...
     	private static String orgMetaDataFilePath = null;
     	private static PropertiesMetaData orgMetaData = null;
     	private static String ldapBackupPropertiesFilePath = null;
     	private static SortedProperties ldapBackupProperties = null;
     	private static String ldapMetaDataFilePath = null;
     	private static PropertiesMetaData ldapMetaData = null;
     	private static Logger logMetacat = Logger.getLogger(PropertyService.class);
     	/**
-...
+    			}
     			// orgMetaData holds configuration information about organization level
     			// properties.  these are mostly ldap information relative to an
     			// organization. This is primarily used to display input fields on
     			// properties.  This is primarily used to display input fields on
     			// the organization configuration page. The information is retrieved
     			// from an xml metadata file dedication just to organization properties.
     			// from an xml metadata file dedicated just to organization properties.
     			orgMetaDataFilePath = configDir + FileUtil.getFS() + ORG_CONFIG_NAME + ".metadata.xml";
     			if (orgMetaData == null) {
     				orgMetaData = new PropertiesMetaData(orgMetaDataFilePath);
+    			}
     			// ldapMetaData holds configuration information about organization level
     			// properties.  This is primarily used to display input fields on
     			// the ldap configuration page. The information is retrieved
     			// from an xml metadata file dedicated just to ldap properties.
     			ldapMetaDataFilePath = configDir + FileUtil.getFS() + LDAP_CONFIG_NAME + ".metadata.xml";
     			if (ldapMetaData == null) {
     				ldapMetaData = new PropertiesMetaData(ldapMetaDataFilePath);
+    			}
     		} catch (TransformerException te) {
     			throw new GeneralPropertyException(te.getMessage());
+    		}
-...
     				new SortedProperties(orgBackupPropertiesFilePath);
     			orgBackupProperties.load();
+    		}
     		// The ldapBackupProperties hold properties that were backed up the
     		// last time the LDAP was configured.  On disk, the file will
     		// look like a smaller version of metacat.properties.  It is stored
     		// in the data storage directory outside the application directories.
     		ldapBackupPropertiesFilePath = backupDirPath + FileUtil.getFS() +  LDAP_CONFIG_NAME + ".backup";
     		if (ldapBackupProperties == null) {
     			ldapBackupProperties =
     				new SortedProperties(ldapBackupPropertiesFilePath);
     			ldapBackupProperties.load();
+    		}
+    	}
-...
+    	}
     	/**
     	 * Get the LDAP 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 getLDAPBackupProperties() {
     		return ldapBackupProperties;
+    	}
     	/**
     	 * Get the main properties metadata. This is retrieved from an xml file that
     	 * describes the attributes of configurable properties.
+    	 *
-...
+    	}
     	/**
     	 * Get the LDAP properties metadata. This is retrieved from an xml
     	 * file that describes the attributes of configurable properties.
+    	 *
     	 * @return a PropertiesMetaData object with the organization properties
     	 *         metadata
     	 */
     	public static PropertiesMetaData getLDAPMetaData() {
     		return ldapMetaData;
+    	}
     	/**
     	 * Writes out backup configurable properties to a file.
     	 */
     	public static void persistMainBackupProperties(ServletContext servletContext)
-...
     			// the associated metadata file
     			PropertiesMetaData orgMetadata = new PropertiesMetaData(orgMetaDataFilePath);
     			// Here we get the group definition for group 1 from the org
     			// metadata.  Group 1 should be global values across all
     			// organizations.  We then get all properties metadata associated
     			// with group 1, iterate through it and set it in the backup
     			// properties.
     			MetaDataGroup globalGroup = orgMetadata.getGroup(1);
     			SortedMap<Integer, MetaDataProperty> globalPropertyMap =
     				orgMetadata.getPropertiesInGroup(globalGroup.getIndex());
     			for (MetaDataProperty property : globalPropertyMap.values()) {
     				String orgPropertyName = property.getKey();
     				backupProperties.addProperty(orgPropertyName, getProperty(orgPropertyName));
+    			}
     			// We do the same thing here for organization specific properies
     			// with the addition that we need to iterate through all available
     			// organizations.  For instance, a metadata section that defines a
     			// property as "ldap.base" will be entered into the metacat.properties
     			// file with a key of "ldap.base.NCEAS" for the NCEAS organization.
     			// property as "organization.base" will be entered into the metacat.properties
     			// file with a key of "organization.base.NCEAS" for the NCEAS organization.
     			// This will be repeated for all available organizations.
     			MetaDataGroup orgGroup = orgMetadata.getGroup(2);
     			SortedMap<Integer, MetaDataProperty> orgPropertyMap = orgMetadata
     					.getPropertiesInGroup(orgGroup.getIndex());
     			for (String orgName : LDAPUtil.getOrganizations()) {
     				for (MetaDataProperty property : orgPropertyMap.values()) {
     					String orgPropertyName = property.getKey() + "." + orgName;
     					backupProperties.addProperty(orgPropertyName, getProperty(orgPropertyName));
     			Set<String> orgKeySet = orgMetadata.getKeys();
     			for (String orgName : OrganizationUtil.getOrganizations()) {
     				for (String propertyKey : orgKeySet) {
     					String orgPropertyKey = propertyKey + "." + orgName;
     					backupProperties.addProperty(orgPropertyKey, getProperty(orgPropertyKey));
+    				}
+    			}
-...
     			throw new GeneralPropertyException("Could not get organizations: " + ue.getMessage());
+    		}
+    	}
     	/**
     	 * Writes out backup configurable properties to a file.
     	 */
     	public static void persistLDAPBackupProperties(ServletContext servletContext)
     			throws GeneralPropertyException {
     		// Use the metadata to extract configurable properties from the
     		// overall properties list, and store those properties.
     		try {
     			SortedProperties backupProperties =
     				new SortedProperties(ldapBackupPropertiesFilePath);
     			// Populate the backup properties for ldap properties using
     			// the associated metadata file
     			PropertiesMetaData ldapMetadata = new PropertiesMetaData(ldapMetaDataFilePath);
     			Set<String> ldapKeySet = ldapMetadata.getKeys();
     			for (String propertyKey : ldapKeySet) {
     				backupProperties.addProperty(propertyKey, getProperty(propertyKey));
+    			}
     			// store the properties to file
     			backupProperties.store();
     		} catch (TransformerException te) {
     			throw new GeneralPropertyException("Could not transform backup properties xml: "
     					+ te.getMessage());
     		} catch (IOException ioe) {
     			throw new GeneralPropertyException("Could not backup configurable properties: "
     					+ ioe.getMessage());
+    		}
+    	}
     	/**
     	 * Gets the backup properties directory
+    	 *
-...
     				setPropertyNoPersist(orgBackupPropertyName, value);
+    			}
     			SortedProperties ldapBackupProperties = getLDAPBackupProperties();
     			Vector<String> ldapBackupPropertyNames =
     				ldapBackupProperties.getPropertyNames();
     			for (String ldapBackupPropertyName : ldapBackupPropertyNames) {
     				String value = ldapBackupProperties.getProperty(ldapBackupPropertyName);
     				setPropertyNoPersist(ldapBackupPropertyName, value);
+    			}
     			setPropertyNoPersist("configutil.propertiesConfigured", "true");
     			setPropertyNoPersist("configutil.ldapConfigured", "true");
     			setPropertyNoPersist("configutil.organizationsConfigured", "true");
     			setPropertyNoPersist("configutil.skinsConfigured", "true");
     			setPropertyNoPersist("configutil.databaseConfigured", "true");

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 4159

Added by daigle over 15 years ago