com.sun.enterprise.deployment.node.runtime.common.MessageSecurityNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 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 [2019] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.deployment.node.runtime.common;

import static com.sun.enterprise.deployment.xml.WebServicesTagNames.MESSAGE;
import static com.sun.enterprise.deployment.xml.WebServicesTagNames.REQUEST_PROTECTION;
import static com.sun.enterprise.deployment.xml.WebServicesTagNames.RESPONSE_PROTECTION;

import java.util.List;

import org.w3c.dom.Node;

import com.sun.enterprise.deployment.node.DeploymentDescriptorNode;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.runtime.common.MessageDescriptor;
import com.sun.enterprise.deployment.runtime.common.MessageSecurityDescriptor;
import com.sun.enterprise.deployment.runtime.common.ProtectionDescriptor;

/**
 * This node handles the message-security element.
 *
 */
public class MessageSecurityNode extends DeploymentDescriptorNode {

    MessageSecurityDescriptor descriptor;

    public MessageSecurityNode() {
        registerElementHandler(new XMLElement(MESSAGE), MessageNode.class, "addMessageDescriptor");
        registerElementHandler(new XMLElement(REQUEST_PROTECTION), ProtectionNode.class, "setRequestProtectionDescriptor");
        registerElementHandler(new XMLElement(RESPONSE_PROTECTION), ProtectionNode.class, "setResponseProtectionDescriptor");
    }

    /**
     * @return the descriptor instance to associate with this XMLNode
     */
    public MessageSecurityDescriptor getDescriptor() {
        if (descriptor == null) {
            descriptor = new MessageSecurityDescriptor();
        }
        
        return descriptor;
    }

    /**
     * Write the descriptor class to a DOM tree and return it
     *
     * @param parent node for the DOM tree
     * @param node name for
     * @param the descriptor to write
     * @return the DOM tree top node
     */
    public Node writeDescriptor(Node parent, String nodeName, MessageSecurityDescriptor messageSecurityDesc) {
        Node messageSecurityNode = super.writeDescriptor(parent, nodeName, messageSecurityDesc);

        List messageDescriptors = messageSecurityDesc.getMessageDescriptors();
        if (!messageDescriptors.isEmpty()) {
            MessageNode messageNode = new MessageNode();
            for (MessageDescriptor messageDesc : messageDescriptors) {
                messageNode.writeDescriptor(messageSecurityNode, MESSAGE, messageDesc);
            }
        }

        // request-protection
        ProtectionDescriptor requestProtectionDesc = messageSecurityDesc.getRequestProtectionDescriptor();
        if (requestProtectionDesc != null) {
            new ProtectionNode().writeDescriptor(messageSecurityNode, REQUEST_PROTECTION, requestProtectionDesc);
        }

        // response-protection
        ProtectionDescriptor responseProtectionDesc = messageSecurityDesc.getResponseProtectionDescriptor();
        if (responseProtectionDesc != null) {
            new ProtectionNode().writeDescriptor(messageSecurityNode, RESPONSE_PROTECTION, responseProtectionDesc);
        }

        return messageSecurityNode;
    }
}