com.sun.enterprise.deployment.node.AdministeredObjectDefinitionNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dol Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 2012, 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 com.sun.enterprise.deployment.node;

import com.sun.enterprise.deployment.AdministeredObjectDefinitionDescriptor;
import com.sun.enterprise.deployment.util.DOLUtils;
import com.sun.enterprise.deployment.xml.TagNames;

import java.util.Map;
import java.util.logging.Level;

import org.glassfish.logging.annotation.LogMessageInfo;
import org.w3c.dom.Node;

/**
 * This class handles all information related to the administered-object xml tag
 *
 * @author Dapeng Hu
 */
public class AdministeredObjectDefinitionNode extends DeploymentDescriptorNode {

    @LogMessageInfo(
        message = "For administered-object resource: {0}, there is no application part in its resource adapter name: {1}.",
        level = "WARNING",
        cause = "For embedded resource adapter, its internal format of resource adapter name should contains application name.",
        comment = "For the method writeDescriptor of com.sun.enterprise.deployment.node.AdministeredObjectDefinitionNode.")
    private static final String RESOURCE_ADAPTER_NAME_INVALID = "AS-DEPLOYMENT-00022";

    private AdministeredObjectDefinitionDescriptor descriptor;

    public AdministeredObjectDefinitionNode() {
        registerElementHandler(new XMLElement(TagNames.ADMINISTERED_OBJECT_PROPERTY), ResourcePropertyNode.class,
            "addAdministeredObjectPropertyDescriptor");
    }


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


    @Override
    protected Map getDispatchTable() {
        // no need to be synchronized for now
        Map table = super.getDispatchTable();
        table.put(TagNames.ADMINISTERED_OBJECT_NAME, "setName");
        table.put(TagNames.ADMINISTERED_OBJECT_INTERFACE_NAME, "setInterfaceName");
        table.put(TagNames.ADMINISTERED_OBJECT_CLASS_NAME, "setClassName");
        table.put(TagNames.ADMINISTERED_OBJECT_ADAPTER, "setResourceAdapter");

        return table;
    }


    @Override
    public Node writeDescriptor(Node parent, String nodeName, AdministeredObjectDefinitionDescriptor desc) {
        Node node = appendChild(parent, nodeName);
        appendTextChild(node, TagNames.ADMINISTERED_OBJECT_DESCRIPTION, desc.getDescription());
        appendTextChild(node, TagNames.ADMINISTERED_OBJECT_NAME, desc.getName());
        appendTextChild(node, TagNames.ADMINISTERED_OBJECT_INTERFACE_NAME, desc.getInterfaceName());
        appendTextChild(node, TagNames.ADMINISTERED_OBJECT_CLASS_NAME, desc.getClassName());

        // change the resource adapter name from internal format to standard format
        String resourceAdapterName = desc.getResourceAdapter();
        int poundIndex = resourceAdapterName.indexOf("#");
        if (poundIndex > 0) {
            // the internal format of resource adapter name is "appName#raName", remove the appName
            // part
            resourceAdapterName = resourceAdapterName.substring(poundIndex);

        } else if (poundIndex == 0) {
            // the resource adapter name should not be the standard format "#raName" here
            DOLUtils.getDefaultLogger().log(Level.WARNING, RESOURCE_ADAPTER_NAME_INVALID,
                new Object[] {desc.getName(), desc.getResourceAdapter()});
        } else {
            // the resource adapter name represent the standalone RA in this case.
        }
        appendTextChild(node, TagNames.ADMINISTERED_OBJECT_ADAPTER, resourceAdapterName);

        return ResourcePropertyNode.write(node, desc);
    }
}