com.sun.enterprise.deployment.node.runtime.application.wls.WeblogicApplicationNode Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
// Portions Copyright [2018-2020] [Payara Foundation and/or its affiliates]

package com.sun.enterprise.deployment.node.runtime.application.wls;

import static com.sun.enterprise.deployment.xml.TagNames.SCHEMA_LOCATION_TAG;
import static com.sun.enterprise.deployment.xml.TagNames.VERSION;
import static com.sun.enterprise.deployment.xml.TagNames.W3C_XML_SCHEMA_INSTANCE;
import static com.sun.enterprise.deployment.xml.TagNames.WLS_APPLICATION_NAMESPACE;
import static com.sun.enterprise.deployment.xml.TagNames.WLS_APPLICATION_SCHEMA_LOCATION;
import static com.sun.enterprise.deployment.xml.TagNames.XMLNS;
import static com.sun.enterprise.deployment.xml.TagNames.XMLNS_XSI;
import static java.util.Collections.unmodifiableList;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.w3c.dom.Element;
import org.w3c.dom.Node;

import com.sun.enterprise.deployment.Application;
import com.sun.enterprise.deployment.EnvironmentProperty;
import com.sun.enterprise.deployment.node.DataSourceNameVersionUpgrade;
import com.sun.enterprise.deployment.node.StartMdbsWithApplicationVersionUpgrade;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.node.runtime.RuntimeBundleNode;
import com.sun.enterprise.deployment.runtime.application.wls.ApplicationParam;
import com.sun.enterprise.deployment.xml.RuntimeTagNames;

/**
 * This node is responsible for handling all WebLogic runtime information for application.
 */
public class WeblogicApplicationNode extends RuntimeBundleNode {

    public final static String SCHEMA_ID = "weblogic-application.xsd";
    public final static String PUBLIC_DTD_ID_2 = "-//BEA Systems, Inc.//DTD WebLogic Application 8.1.0//EN";
    public final static String SYSTEM_ID_2 = "http://www.beasys.com/servers/wls810/dtd/weblogic-application_2_0.dtd";

    private final static List systemIDs = initSystemIDs();

    private static List initSystemIDs() {
        List systemIDs = new ArrayList<>();
        systemIDs.add(SCHEMA_ID);
        
        return unmodifiableList(systemIDs);
    }
   
    /** Creates new WeblogicApplicationNode */
    public WeblogicApplicationNode(Application descriptor) {
        super(descriptor);
    }

    /** Creates new WeblogicApplicationNode */
    public WeblogicApplicationNode() {
        super(null);
    }

    /**
     * Initialize the child handlers
     */
    protected void init() {
        super.init();
        registerElementHandler(new XMLElement(RuntimeTagNames.APPLICATION_PARAM), ApplicationParamNode.class);
    }

    /**
     * register this node as a root node capable of loading entire DD files
     *
     * @param publicIDToDTD is a mapping between xml Public-ID to DTD
     * @param versionUpgrades The list of upgrades from older versions
     * @return the doctype tag name
     */
    public static String registerBundle(Map publicIDToDTD, Map>> versionUpgrades) {
        // TODO: fill in all the previously supported DTD versions
        // for backward compatibility
        publicIDToDTD.put(PUBLIC_DTD_ID_2, SYSTEM_ID_2);
        List> list = new ArrayList<>();
        list.add(DataSourceNameVersionUpgrade.class);
        list.add(StartMdbsWithApplicationVersionUpgrade.class);
        versionUpgrades.put(RuntimeTagNames.WLS_APPLICATION_RUNTIME_TAG, list);
        
        return RuntimeTagNames.WLS_APPLICATION_RUNTIME_TAG;
    }

    /**
     * @return the XML tag associated with this XMLNode
     */
    @Override
    protected XMLElement getXMLRootTag() {
        return new XMLElement(RuntimeTagNames.WLS_APPLICATION_RUNTIME_TAG);
    }

    /**
     * @return the DOCTYPE that should be written to the XML file
     */
    @Override
    public String getDocType() {
        return null;
    }

    /**
     * @return the SystemID of the XML file
     */
    @Override
    public String getSystemID() {
        return SCHEMA_ID;
    }

    /**
     * @return the list of SystemID of the XML schema supported
     */
    @Override
    public List getSystemIDs() {
        return systemIDs;
    }

    /**
     * @return the application instance to associate with this XMLNode
     */
    @Override
    public Application getDescriptor() {
        return descriptor;
    }

    /**
     * Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode
     *
     * @param descriptor the new descriptor
     */
    @Override
    public void addDescriptor(Object newDescriptor) {
        if (newDescriptor instanceof EnvironmentProperty) {
            descriptor.addApplicationParam((ApplicationParam) newDescriptor);
        } else {
            super.addDescriptor(newDescriptor);
        }
    }

    /**
     * Write the descriptor class to a DOM tree and return it
     *
     * @param parent node for the DOM tree
     * @param nodeName the node name
     * @param descriptor the descriptor to write
     * @return the DOM tree top node
     */
    @Override
    public Node writeDescriptor(Node parent, String nodeName, Application application) {
        Element root = appendChildNS(parent, getXMLRootTag().getQName(), WLS_APPLICATION_NAMESPACE);
        root.setAttributeNS(XMLNS, XMLNS_XSI, W3C_XML_SCHEMA_INSTANCE);
        root.setAttributeNS(W3C_XML_SCHEMA_INSTANCE, SCHEMA_LOCATION_TAG, WLS_APPLICATION_SCHEMA_LOCATION);
        root.setAttribute(VERSION, getSpecVersion());

        writeSubDescriptors(root, nodeName, application);

        return root;
    }
}