org.glassfish.ejb.deployment.node.EjbRelationshipRoleNode Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ejb-container Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.ejb.deployment.node;

import com.sun.enterprise.deployment.EjbBundleDescriptor;
import com.sun.enterprise.deployment.node.ConfigurableNode;
import com.sun.enterprise.deployment.node.DeploymentDescriptorNode;
import com.sun.enterprise.deployment.node.LocalizedInfoNode;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.node.XMLNode;
import com.sun.enterprise.deployment.xml.TagNames;

import java.util.HashMap;
import java.util.Map;

import org.glassfish.ejb.deployment.EjbTagNames;
import org.glassfish.ejb.deployment.descriptor.EjbCMPEntityDescriptor;
import org.glassfish.ejb.deployment.descriptor.RelationRoleDescriptor;
import org.w3c.dom.Node;

/**
 * This class is responsible for handling the ejb-relationship-role xml elements
 *
 * @author  Jerome Dochez
 * @version
 */
public class EjbRelationshipRoleNode extends DeploymentDescriptorNode {

    private RelationRoleDescriptor descriptor;

    public EjbRelationshipRoleNode() {
        registerElementHandler(new XMLElement(TagNames.DESCRIPTION), LocalizedInfoNode.class);
    }


    @Override
    public  XMLNode getHandlerFor(XMLElement element) {
        if (EjbTagNames.RELATIONSHIP_ROLE_SOURCE.equals(element.getQName())) {
            Map dispatchTable = new HashMap<>();
            dispatchTable.put(TagNames.DESCRIPTION, "setRoleSourceDescription");
            ConfigurableNode newNode = new ConfigurableNode(getDescriptor(), dispatchTable, element);
            return newNode;
        }
        if (EjbTagNames.CMR_FIELD.equals(element.getQName())) {
            Map dispatchTable = new HashMap<>();
            dispatchTable.put(TagNames.DESCRIPTION, "setCMRFieldDescription");
            ConfigurableNode newNode = new ConfigurableNode(getDescriptor(), dispatchTable, element);
            return newNode;
        }
        return super.getHandlerFor(element);
    }


    @Override
    public boolean handlesElement(XMLElement element) {
        if (EjbTagNames.RELATIONSHIP_ROLE_SOURCE.equals(element.getQName())) {
            return true;
        }
        if (EjbTagNames.CMR_FIELD.equals(element.getQName())) {
            return true;
        }
        return super.handlesElement(element);
    }


    @Override
    public RelationRoleDescriptor getDescriptor() {
        if (descriptor == null) {
            descriptor = new RelationRoleDescriptor();
        }
        return descriptor;
    }


    @Override
    protected Map getDispatchTable() {
        // no need to be synchronized for now
        Map table = super.getDispatchTable();
        table.put(EjbTagNames.EJB_RELATIONSHIP_ROLE_NAME, "setName");
        table.put(EjbTagNames.CMR_FIELD_NAME, "setCMRField");
        table.put(EjbTagNames.CMR_FIELD_TYPE, "setCMRFieldType");
        return table;
    }


    @Override
    public boolean endElement(XMLElement element) {
        if (EjbTagNames.CASCADE_DELETE.equals(element.getQName())) {
            descriptor.setCascadeDelete(true);
        }
        return super.endElement(element);
    }


    @Override
    public void setElementValue(XMLElement element, String value) {
        if (EjbTagNames.MULTIPLICITY.equals(element.getQName())) {
            if (value.equals("Many")) {
                descriptor.setIsMany(true);
            } else if (value.equals("One")) {
                descriptor.setIsMany(false);
            } else if (value.equals("many")) {
                // for backward compat with 1.3 FCS
                descriptor.setIsMany(true);
            } else if (value.equals("one")) {
                // for backward compat with 1.3 FCS
                descriptor.setIsMany(false);
            } else {
                // for backward compat with 1.3 FCS
                throw new IllegalArgumentException(
                    "Error in value of multiplicity element in EJB deployment descriptor XML: the value must be One or Many");
            }
        } else if (TagNames.EJB_NAME.equals(element.getQName())) {
            // let's get our bunlde descriptor...
            EjbBundleDescriptor bundleDesc = getEjbBundleDescriptor();
            EjbCMPEntityDescriptor desc = (EjbCMPEntityDescriptor) bundleDesc.getEjbByName(value);
            if (desc != null) {
                descriptor.setPersistenceDescriptor(desc.getPersistenceDescriptor());
            } else {
                throw new IllegalArgumentException(
                    "Cannot find ejb " + value + " in bundle for relationship " + descriptor.getName());
            }
        } else {
            super.setElementValue(element, value);
        }
    }


    private EjbBundleDescriptor getEjbBundleDescriptor() {
        XMLNode parent = getParentNode();
        Object parentDesc = parent.getDescriptor();
        while (parent != null && !(parentDesc instanceof EjbBundleDescriptor)) {
            parent = parent.getParentNode();
            if (parent != null) {
                parentDesc = parent.getDescriptor();
            }
        }
        if (parent == null) {
            throw new IllegalArgumentException("Cannot find bundle descriptor");
        }
        return (EjbBundleDescriptor) parentDesc;
    }


    @Override
    public Node writeDescriptor(Node parent, String nodeName, RelationRoleDescriptor descriptor) {
        Node roleNode = super.writeDescriptor(parent, nodeName, descriptor);
        LocalizedInfoNode localizedNode = new LocalizedInfoNode();
        localizedNode.writeLocalizedMap(roleNode, TagNames.DESCRIPTION, descriptor.getLocalizedDescriptions());
        if (descriptor.getRelationRoleName() != null) {
            appendTextChild(roleNode, EjbTagNames.EJB_RELATIONSHIP_ROLE_NAME, descriptor.getRelationRoleName());
        }

        // multiplicity
        if (descriptor.getIsMany()) {
            appendTextChild(roleNode, EjbTagNames.MULTIPLICITY, "Many");
        } else {
            appendTextChild(roleNode, EjbTagNames.MULTIPLICITY, "One");
        }

        // cascade-delete
        if (descriptor.getCascadeDelete()) {
            appendChild(roleNode, EjbTagNames.CASCADE_DELETE);
        }

        Node roleSourceNode = appendChild(roleNode, EjbTagNames.RELATIONSHIP_ROLE_SOURCE);
        appendTextChild(roleSourceNode, TagNames.DESCRIPTION, descriptor.getRoleSourceDescription());
        appendTextChild(roleSourceNode, TagNames.EJB_NAME, descriptor.getOwner().getName());

        // cmr-field
        if (descriptor.getCMRField() != null) {
            Node cmrFieldNode = appendChild(roleNode, EjbTagNames.CMR_FIELD);

            // description
            appendTextChild(cmrFieldNode, TagNames.DESCRIPTION, descriptor.getCMRFieldDescription());
            // cmr-field-name
            appendTextChild(cmrFieldNode, EjbTagNames.CMR_FIELD_NAME, descriptor.getCMRField());
            // cmr-field-type
            appendTextChild(cmrFieldNode, EjbTagNames.CMR_FIELD_TYPE, descriptor.getCMRFieldType());
        }
        return roleNode;
    }
}