common/configuration/ConfigurationBase.java

	ConfigurationBase.java revision da46c370a4a81bf2f7f7604b672619186e235c88
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: ConfigurationBase.java,v 1.4 2009/07/07 06:14:12 veiming Exp $
 *
 * Portions Copyrighted 2010-2016 ForgeRock AS.
 */

package com.sun.identity.common.configuration;

import com.iplanet.sso.SSOException;
import com.iplanet.sso.SSOToken;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

import com.sun.identity.security.AdminTokenAction;
import com.sun.identity.shared.Constants;
import com.sun.identity.sm.AttributeSchema;
import com.sun.identity.sm.SMSException;
import com.sun.identity.sm.OrganizationConfigManager;
import com.sun.identity.sm.SchemaType;
import com.sun.identity.sm.ServiceConfig;
import com.sun.identity.sm.ServiceConfigManager;
import com.sun.identity.sm.ServiceManager;
import com.sun.identity.sm.ServiceSchema;
import com.sun.identity.sm.ServiceSchemaManager;

import java.security.AccessController;
import java.util.LinkedHashSet;

import org.forgerock.openam.utils.CollectionUtils;

/**
 * This is the base case for <code>ServerConfiguration</code> and
 * <code>SiteConfiguration</code> classes.
 */
public abstract class ConfigurationBase {
    protected static final String OLD_ATTR_SITE_LIST =
        "iplanet-am-platform-site-list";
    protected static final String OLD_ATTR_SERVER_LIST =
        "iplanet-am-platform-server-list";

    public static final String CONFIG_SERVERS = "com-sun-identity-servers";
    public static final String SUBSCHEMA_SERVER = "server";
    protected static final String ATTR_SERVER_ID = "serverid";

    public static final String SUBSCHEMA_SITE = "site";
    public static final String CONFIG_SITES = "com-sun-identity-sites";
    protected static final String SUBCONFIG_ACCESS_URL = "accesspoint";
    protected static final String ATTR_PRIMARY_SITE_ID = "primary-siteid";
    protected static final String ATTR_PRIMARY_SITE_URL = "primary-url";
    protected static final String SUBCONFIG_SEC_URLS = "secondary-urls";
    protected static final String ATTR_SEC_ID = "secondary-siteid";

    protected static String getNextId(SSOToken ssoToken)
        throws SMSException, SSOException {
        Set<String> currentIds = new HashSet<String>();

        ServiceConfig rootServerConfig = getRootServerConfigWithRetry(ssoToken);
        Set<String> serverConfigIds = getServerConfigurationId(rootServerConfig);
        currentIds.addAll(serverConfigIds);

        ServiceConfig rootSiteConfig = getRootSiteConfig(ssoToken);
        if (rootSiteConfig == null || !rootSiteConfig.isValid()) {
            //retry just one more time
            rootSiteConfig = getRootSiteConfig(ssoToken);
        }
        Set<String> siteConfigIds = getSiteConfigurationId(rootSiteConfig);
        currentIds.addAll(siteConfigIds);

        return getNextId(currentIds);
    }

    protected static Set<String> getServerConfigurationId(ServiceConfig svc) throws SMSException, SSOException {
        Set<String> currentIds = new HashSet<String>();

        if (svc != null && svc.isValid()) {
            Set<String> names = svc.getSubConfigNames("*");
            if (CollectionUtils.isNotEmpty(names)) {
                for (String name : names) {
                    ServiceConfig sc = svc.getSubConfig(name);
                    if (sc != null && sc.isValid()) {
                        Map<String, Set<String>> map = sc.getAttributes();
                        Set<String> set = map.get(ATTR_SERVER_ID);
                        if (CollectionUtils.isNotEmpty(set)) {
                            currentIds.add(set.iterator().next());
                        }
                    }
                }
            }
        }
        return currentIds;
    }

    protected static Set<String> getSiteConfigurationId(ServiceConfig svc) throws SMSException, SSOException {
        Set<String> currentIds = new HashSet<String>();
        if (svc != null && svc.isValid()) {
            Set<String> names = svc.getSubConfigNames("*");
            if (CollectionUtils.isNotEmpty(names)) {
                for (String name : names) {
                    currentIds.addAll(getSiteConfigurationIds(null, svc, name, false));
                }
            }
        }
        return currentIds;
    }

    protected static Set<String> getSiteConfigurationIds(SSOToken ssoToken, ServiceConfig rootNode,
            String name, boolean bPrimaryOnly) throws SMSException, SSOException {
        if (rootNode == null) {
            rootNode = getRootSiteConfig(ssoToken);
        }

        Set<String> currentIds = new LinkedHashSet<String>();
        if (rootNode != null && rootNode.isValid()) {
            ServiceConfig sc = rootNode.getSubConfig(name);

            if (sc != null && sc.isValid()) {
                ServiceConfig accessPoint = sc.getSubConfig(SUBCONFIG_ACCESS_URL);
                if (accessPoint != null && accessPoint.isValid()) {
                    Map<String, Set<String>> map = accessPoint.getAttributes();
                    Set<String> set = map.get(ATTR_PRIMARY_SITE_ID);
                    currentIds.add(set.iterator().next());

                    if (!bPrimaryOnly) {
                        Set<String> failovers = accessPoint.getSubConfigNames("*");
                        if (CollectionUtils.isNotEmpty(failovers)) {
                            for (String foName : failovers) {
                                ServiceConfig s = accessPoint.getSubConfig(foName);
                                if (s != null && s.isValid()) {
                                    Map<String, Set<String>> mapValues = s.getAttributes();
                                    set = mapValues.get(ATTR_SEC_ID);
                                    if (CollectionUtils.isNotEmpty(set)) {
                                        currentIds.add(set.iterator().next());
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        return currentIds;
    }

    protected static String getNextId(Set<String> currentIds) {
        String id = null;
        if (CollectionUtils.isNotEmpty(currentIds)) {
            for (int i = 1; (id == null); i++) {
                String test =  (i < 10) ? "0" + Integer.toString(i) : Integer.toString(i);
                if (!currentIds.contains(test)) {
                    id = test;
                }
            }
        }
        return (id == null) ? "01" : id;
    }

    protected static void updateOrganizationAlias(SSOToken ssoToken, String instanceName, boolean bAdd)
            throws SMSException {
        String hostName = null;
        try {
            URL url = new URL(instanceName);
            hostName = url.getHost();
        } catch (MalformedURLException e) {
            throw new RuntimeException(e.getMessage());
        }
        OrganizationConfigManager ocm = new OrganizationConfigManager(ssoToken, "/");
        Map<String, Set<String>> allAttrs = ocm.getAttributes(ServiceManager.REALM_SERVICE);
        Set<String> values = allAttrs.get(OrganizationConfigManager.SUNORG_ALIAS);
        if (CollectionUtils.isNotEmpty(values)) {
            if (bAdd) {
                if (!values.contains(hostName)) {
                    values.add(hostName);
                    ocm.setAttributes(ServiceManager.REALM_SERVICE, allAttrs);
                }
            } else {
                if (values.contains(hostName)) {
                    values.remove(hostName);
                    ocm.setAttributes(ServiceManager.REALM_SERVICE, allAttrs);
                }
            }
        }
    }

    protected static ServiceConfig getRootServerConfig(SSOToken ssoToken)
        throws SMSException, SSOException {
        ServiceConfigManager scm = new ServiceConfigManager(Constants.SVC_NAME_PLATFORM, ssoToken);
        ServiceConfig globalSvcConfig = scm.getGlobalConfig(null);
        if (globalSvcConfig != null && globalSvcConfig.isValid()) {
            return globalSvcConfig.getSubConfig(CONFIG_SERVERS);
        }
        return null;
    }

    protected static ServiceConfig getRootServerConfigWithRetry(SSOToken ssoToken)
            throws SMSException, SSOException {
        ServiceConfig serverConfig = getRootServerConfig(ssoToken);
        if (serverConfig == null || !serverConfig.isValid()) {
            //Because SMS classes are wrapped and cached as class variable,
            //there is no way to "lock" these classes from getting cleared
            //by SMSNotificationManager if these objects are being used.
            //The best we can do at the moment is to retry just one more time
            serverConfig = getRootServerConfig(ssoToken);
        }
        return serverConfig;
    }

    protected static ServiceConfig getServerConfig(SSOToken ssoToken, String name) throws SMSException, SSOException {
        ServiceConfig sc = getRootServerConfigWithRetry(ssoToken);
        return (sc != null && sc.isValid()) ? sc.getSubConfig(name) : null;
    }

    protected static ServiceConfig getRootSiteConfig(SSOToken ssoToken) throws SMSException, SSOException {
        ServiceConfigManager scm = new ServiceConfigManager(Constants.SVC_NAME_PLATFORM, ssoToken);
        ServiceConfig globalSvcConfig = scm.getGlobalConfig(null);
        if (globalSvcConfig != null && globalSvcConfig.isValid()) {
            return globalSvcConfig.getSubConfig(CONFIG_SITES);
        }
        return null;
    }
}