ConnectorObjectCreator.java

/*
 *
 * Copyright (c) 2010 ForgeRock 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
 * http://www.opensource.org/licenses/cddl1.php or
 * OpenIDM/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 OpenIDM/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 2010 [name of copyright owner]"
 *
 * $Id$
 */
package org.forgerock.openicf.connectors.xml;

import org.forgerock.openicf.connectors.xml.util.AttributeTypeUtil;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

import org.identityconnectors.common.logging.Log;
import org.identityconnectors.framework.common.objects.Attribute;
import org.identityconnectors.framework.common.objects.AttributeBuilder;
import org.identityconnectors.framework.common.objects.AttributeInfo;
import org.identityconnectors.framework.common.objects.ConnectorObject;
import org.identityconnectors.framework.common.objects.ConnectorObjectBuilder;
import org.identityconnectors.framework.common.objects.Name;
import org.identityconnectors.framework.common.objects.ObjectClass;
import org.identityconnectors.framework.common.objects.Uid;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

class ConnectorObjectCreator {

    private static final Log logger = Log.getLog(ConnectorObjectCreator.class);

    private Map<String, String> attributeClassMap;
    private Map<String, AttributeInfo> attributeInfoMap;
    private ObjectClass objectClass;
    private NodeList nodeList;
    private ConnectorObjectBuilder conObjBuilder;

    protected ConnectorObjectCreator(HashMap<String, String> attrClasses, HashMap<String, AttributeInfo> attrInfos, ObjectClass objClass) {
        this.attributeClassMap = attrClasses;
        this.attributeInfoMap = attrInfos;
        this.objectClass = objClass;
    }

    protected ConnectorObject createConnectorObject(NodeList nodes) {
        nodeList = nodes;
        conObjBuilder = new ConnectorObjectBuilder();
        conObjBuilder.setObjectClass(objectClass);

        addAllAttributesToBuilder();

        return conObjBuilder.build();
    }

    // Add all the attributes to the connectorbuilder-object
    private void addAllAttributesToBuilder() {

        boolean hasUid = false;

        // map for storing multivalued attributes
        HashMap<String, ArrayList<String>> multivalues = new HashMap<String, ArrayList<String>>();

        String nameTmp = "";

        for (int i = 0; i < nodeList.getLength(); i++) {
            Node attributeNode = nodeList.item(i);
            if (attributeNode.getNodeType() == Node.ELEMENT_NODE) {

                Node textNode = attributeNode.getFirstChild();

                if (isTextNode(textNode)) {
                    String attrName = attributeNode.getLocalName();
                    String attrValue = textNode.getNodeValue();

                    if (attrName.equals(Uid.NAME)) {
                        conObjBuilder.setUid(attrValue);
                        hasUid = true;
                    }
                    if (!hasUid && attrName.equals(Name.NAME)) {
                        nameTmp = attrValue;
                    }

                    Attribute attribute = null;
                    AttributeInfo info = attributeInfoMap.get(attrName);
                    if (null == info) {
                        logger.ok("There is no AttributeInfo found for attribute {0} but it in the XML document and violates the schema.", attrName);
                        continue;
                    }
                    if (info.isReadable()) {
                        if (!info.isMultiValued()) {
                            attribute = createAttribute(attrName, attrValue);
                        } else { // collect all multivalues in a map
                            if (multivalues.containsKey(attrName)) {
                                multivalues.get(attrName).add(attrValue);
                            } else {
                                ArrayList<String> values = new ArrayList<String>();
                                values.add(attrValue);
                                multivalues.put(attrName, values);
                            }
                        }
                    }
                    if (attribute != null) {
                        conObjBuilder.addAttribute(attribute);
                    }
                }
            }
        }

        // set __NAME__ attribute as UID if no UID was wound
        if (!hasUid) {
            conObjBuilder.setUid(nameTmp);
        }

        //add multivalued attributes
        for (String s : multivalues.keySet()) {
            Attribute attribute = createMultivaluedAttribute(s, multivalues.get(s));
            if (attribute != null) {
                conObjBuilder.addAttribute(attribute);
            }
        }
    }

    private Attribute createAttribute(String attributeName, String attributeValue) {
        AttributeBuilder attrBuilder = new AttributeBuilder();
        attrBuilder.setName(attributeName);

        // check if attrInfo has the attributes object-type
        if (attributeClassMap.containsKey(attributeName)) {
            String javaclass = attributeClassMap.get(attributeName);
            Object value = AttributeTypeUtil.createInstantiatedObject(attributeValue, javaclass);

            attrBuilder.addValue(value);
            Attribute result = attrBuilder.build();

            return result;
        }
        return null;
    }

    private Attribute createMultivaluedAttribute(String attributeName, ArrayList<String> attributeValues) {
        AttributeBuilder attrBuilder = new AttributeBuilder();
        attrBuilder.setName(attributeName);

        if (attributeClassMap.containsKey(attributeName)) {
            String javaclass = attributeClassMap.get(attributeName);

            for (String attrValue : attributeValues) {
                Object value = AttributeTypeUtil.createInstantiatedObject(attrValue, javaclass);
                attrBuilder.addValue(value);
            }
            Attribute result = attrBuilder.build();
            return result;
        }
        return null;
    }

    // see if an attribute-node has text-content
    private boolean isTextNode(Node node) {
        return node != null && node.getNodeType() == Node.TEXT_NODE;
    }
}