OpenSSO源码分析之配置篇（SystemProperties类分析）

这个类提供了允许访问单点登录系统有关的系统属性。

这个系统属性能够通过几个方式进行设置：

以编程方式调用 initializeProperties方法，或者通过static 方法从AMConfig.properties文件中加载。

该类中有以下几个属性用来存储属性信息：

• Map attributeMap  //存储serverAttributeMap.properties文件中的属性,Property name to service attribute schema name mapping
• Properties props  //存储AMConfig.properties文件中的属性
• Map mapTagswap = new HashMap(); //KEY是某个System的属性的别名，value为某个System的属性名，这样可以避免在程序中直接引　　　　　　用System的属性名
• Map tagswapValues   //key保存着某个System的属性的别名,value保存着System的属性的值

主要对外暴露出以下方法：

• public static String get(String key)

//查询系统属性（如果是server模式，SMS services中查找，然后在props中查找，否则只在props中查找）

//如果查找到的属性值中有System的属性的别名占位符的话，通过tagswapValues变量进行替换

• public static String get(String key, String def)
• public static Properties getProperties()
• public static Properties getAll()
• public static synchronized void initializeProperties(String file)
• public static synchronized void initializeProperties(Properties properties)
• public static synchronized void initializeProperties(Properties properties,boolean reset)  //将被OpenSSO调用
• public static synchronized void initializeProperties(Properties properties,boolean reset,boolean withDefaults)
• public static synchronized void initializeProperties(String propertyName,String propertyValue)
• public static boolean isServerMode()
• public static Map getAttributeMap()

在该类中有两个static代码块，用来加载属性信息

private static void initAttributeMapping() {
 ResourceBundle rb = ResourceBundle.getBundle("serverAttributeMap");
     for (Enumeration e = rb.getKeys(); e.hasMoreElements(); ) {
            String propertyName = (String)e.nextElement();
            attributeMap.put(propertyName, new AttributeStruct(
                rb.getString(propertyName)));
     }
}

//加载serverAttributeMap.properties文件中的属性到attributeMap中

static {
        mapTagswap.put("%SERVER_PORT%", Constants.AM_SERVER_PORT);
        mapTagswap.put("%SERVER_URI%", Constants.AM_SERVICES_DEPLOYMENT_DESCRIPTOR);
        mapTagswap.put("%SERVER_HOST%", Constants.AM_SERVER_HOST);
        mapTagswap.put("%SERVER_PROTO%", Constants.AM_SERVER_PROTOCOL);
        mapTagswap.put("%BASE_DIR%", CONFIG_PATH);
        
        try {
            // Initialize properties
            props = new Properties();

            // Load properties from file
            String serverName = System.getProperty(SERVER_NAME_PROPERTY);
            // 如果配置文件名的属性不存在，默认为AMConfig.properties
            String configName = System.getProperty(CONFIG_NAME_PROPERTY,AMCONFIG_FILE_NAME);
            String fname = null;
            FileInputStream fis = null;
            if (serverName != null) { //如果有多个服务实例，则每个实例会访问各自的配置文件
                serverName = serverName.replace('.', '_');
                fname = configName + "-" + serverName;
            } else {
                fname = configName;
            }
             //把AMConfig.properties中的属性追加到props变量中,并修改最后编辑时间
            initializeProperties(fname);

            // Get the location of the new configuration file in case
            // of single war deployment
             //以下提供了扩展配置的机制,如果需要，得先在AMConfig.properties属性中
//配置com.sun.identity.configFilePath属性
            try {
                String newConfigFileLoc = props.getProperty(Constants.AM_NEW_CONFIGFILE_PATH);
                if ((newConfigFileLoc != null) && (newConfigFileLoc.length() > 0) && 
                    !newConfigFileLoc.equals(NEWCONFDIR) ) {
                    String hostName = InetAddress.getLocalHost().getHostName().toLowerCase();
                    String serverURI = props.getProperty( Constants.AM_SERVICES_DEPLOYMENT_DESCRIPTOR);
                    serverURI = serverURI.replace('/', '_').toLowerCase();
                    StringBuffer fileName = new StringBuffer();
                    fileName.append(newConfigFileLoc).append("/").append(
                            AMCONFIG_FILE_NAME).append(serverURI).append(
                            hostName).append(props.getProperty(Constants.AM_SERVER_PORT))
                            .append(".").append(PROPERTIES);
                    Properties modProp = new Properties();
                    try {
                        fis = new FileInputStream(fileName.toString());
                        modProp.load(fis);
                        props.putAll(modProp);
                    } catch (IOException ioe) {
                        StringBuffer fileNameOrig = new StringBuffer();
                        fileNameOrig.append(newConfigFileLoc).append("/")
                                .append(AMCONFIG_FILE_NAME).append(".").append(
                                        PROPERTIES);
                        try {
                            fis = new FileInputStream(fileNameOrig.toString());
                            modProp.load(fis);
                            props.putAll(modProp);
                        } catch (IOException ioexp) {
                            saveException(ioexp);
                        }
                    } finally {
                        if (fis != null) {
                            fis.close();
                        }
                    }
                }
            } catch (Exception ex) {
                saveException(ex);
            }
        } catch (MissingResourceException e) {
            // Can't print the message to debug due to dependency
            // Save it as a String and provide when requested.
            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            e.printStackTrace(new PrintStream(baos));
            initError = baos.toString();
            try {
                baos.close();
            } catch (IOException ioe) {
                // Should not happend, ignore the exception
            }
        }
    }