org.glassfish.webservices.node.WebServicesDescriptorNode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 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] [Payara Foundation and/or its affiliates]
package org.glassfish.webservices.node;
import static com.sun.enterprise.deployment.xml.TagNames.VERSION;
import static com.sun.enterprise.deployment.xml.WebServicesTagNames.WEB_SERVICE;
import static java.util.Collections.emptyMap;
import static java.util.Collections.unmodifiableList;
import static java.util.logging.Level.INFO;
import static org.glassfish.webservices.connector.LogUtils.WS_COMP_LINK_NOT_VALID;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.logging.Logger;
import org.glassfish.webservices.connector.LogUtils;
import org.jvnet.hk2.annotations.Service;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import com.sun.enterprise.deployment.BundleDescriptor;
import com.sun.enterprise.deployment.WebService;
import com.sun.enterprise.deployment.WebServiceEndpoint;
import com.sun.enterprise.deployment.WebServicesDescriptor;
import com.sun.enterprise.deployment.node.AbstractBundleNode;
import com.sun.enterprise.deployment.node.SaxParserHandler;
import com.sun.enterprise.deployment.node.XMLElement;
import com.sun.enterprise.deployment.xml.WebServicesTagNames;
/**
* Root node for web services deployment descriptor
*
* @author Kenneth Saks
* @version
*/
@Service
public class WebServicesDescriptorNode extends AbstractBundleNode {
public final static XMLElement ROOT_ELEMENT = new XMLElement(WebServicesTagNames.WEB_SERVICES);
public final static String SCHEMA_ID = "jakartaee_web_services_2_0.xsd";
public final static String SCHEMA_ID_12 = "javaee_web_services_1_2.xsd";
public final static String SCHEMA_ID_13 = "javaee_web_services_1_3.xsd";
public final static String SCHEMA_ID_14 = "javaee_web_services_1_4.xsd";
public final static String SPEC_VERSION = "2.0";
private final static List systemIDs = initSystemIDs();
private static final Logger logger = LogUtils.getLogger();
private BundleDescriptor bundleDescriptor;
private static List initSystemIDs() {
List sysIDs = new ArrayList();
sysIDs.add(SCHEMA_ID);
sysIDs.add(SCHEMA_ID_12);
sysIDs.add(SCHEMA_ID_13);
sysIDs.add(SCHEMA_ID_14);
return unmodifiableList(sysIDs);
}
public WebServicesDescriptorNode() {
this(null);
}
public WebServicesDescriptorNode(BundleDescriptor descriptor) {
bundleDescriptor = descriptor;
registerElementHandler(new XMLElement(WebServicesTagNames.WEB_SERVICE), WebServiceNode.class);
SaxParserHandler.registerBundleNode(this, WebServicesTagNames.WEB_SERVICES);
}
@Override
public String registerBundle(Map publicIDToSystemIDMapping) {
return ROOT_ELEMENT.getQName();
}
@Override
public Map> registerRuntimeBundle(Map publicIDToSystemIDMapping, Map>> versionUpgrades) {
return emptyMap();
}
/**
* @return the DOCTYPE of 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 XML tag associated with this XMLNode
*/
@Override
protected XMLElement getXMLRootTag() {
return ROOT_ELEMENT;
}
/**
* Receives notiification of the value for a particular tag
*
* @param element the xml element
* @param value it's associated value
*/
@Override
public void setElementValue(XMLElement element, String value) {
if (VERSION.equals(element.getQName())) {
bundleDescriptor.getWebServices().setSpecVersion(value);
} else {
super.setElementValue(element, value);
}
}
/**
* Adds a new DOL descriptor instance to the descriptor instance associated with this XMLNode
*
* @param descriptor the new descriptor
*/
@Override
public void addDescriptor(Object descriptor) {
WebServicesDescriptor webServicesDesc = bundleDescriptor.getWebServices();
WebService webService = (WebService) descriptor;
webServicesDesc.addWebService(webService);
for (Iterator iter = webService.getEndpoints().iterator(); iter.hasNext();) {
WebServiceEndpoint next = iter.next();
if (!next.resolveComponentLink()) {
logger.log(INFO, WS_COMP_LINK_NOT_VALID, new Object[] { next.getEndpointName(), next.getLinkName() });
}
}
}
/**
* @return the descriptor instance to associate with this XMLNode
*/
@Override
public BundleDescriptor getDescriptor() {
return bundleDescriptor;
}
/**
* write the descriptor class to a DOM tree and return it
*
* @param parent node for the DOM tree
* @param descriptor to write
* @return the DOM tree top node
*/
@Override
public Node writeDescriptor(Node parent, BundleDescriptor descriptor) {
if (parent instanceof Document) {
Node topNode = super.writeDescriptor(parent, descriptor);
WebServicesDescriptor webServicesDesc = descriptor.getWebServices();
WebServiceNode wsNode = new WebServiceNode();
for (WebService next : webServicesDesc.getWebServices()) {
wsNode.writeDescriptor(topNode, WEB_SERVICE, next);
}
}
return parent;
}
/**
* @return the default spec version level this node complies to
*/
@Override
public String getSpecVersion() {
return SPEC_VERSION;
}
}