org.glassfish.webservices.JAXWSServlet 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 [2016-2021] [Payara Foundation and/or its affiliates]
package org.glassfish.webservices;
import static java.util.logging.Level.WARNING;
import static jakarta.xml.ws.http.HTTPBinding.HTTP_BINDING;
import static org.glassfish.webservices.LogUtils.SERVLET_ENDPOINT_FAILURE;
import java.io.IOException;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.logging.Logger;
import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.xml.ws.WebServiceException;
import jakarta.xml.ws.http.HTTPBinding;
import org.glassfish.external.probe.provider.annotations.Probe;
import org.glassfish.external.probe.provider.annotations.ProbeParam;
import org.glassfish.external.probe.provider.annotations.ProbeProvider;
import org.glassfish.internal.api.Globals;
import org.glassfish.webservices.monitoring.Endpoint;
import org.glassfish.webservices.monitoring.WebServiceEngineImpl;
import org.glassfish.webservices.monitoring.WebServiceTesterServlet;
import com.sun.enterprise.container.common.spi.util.ComponentEnvManager;
import com.sun.enterprise.deployment.JndiNameEnvironment;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.WebComponentDescriptor;
import com.sun.enterprise.deployment.WebServiceEndpoint;
import com.sun.enterprise.deployment.WebServicesDescriptor;
import com.sun.xml.ws.api.server.Adapter;
import com.sun.xml.ws.transport.http.servlet.ServletAdapter;
import fish.payara.notification.requesttracing.RequestTraceSpan;
import fish.payara.nucleus.requesttracing.RequestTracingService;
/**
* The JAX-WS dispatcher servlet.
*
* @author Bhakti Mehta
* @author Rama Pulavarthi
*/
@ProbeProvider(moduleProviderName = "glassfish", moduleName = "webservices", probeProviderName = "servlet-109")
public class JAXWSServlet extends HttpServlet {
private static final long serialVersionUID = 304728296263071933L;
private static final Logger logger = LogUtils.getLogger();
private WebServiceEndpoint endpoint;
private String contextRoot;
private transient WebServiceEngineImpl wsEngine_;
private boolean wsdlExposed = true;
private String urlPattern;
private RequestTracingService requestTracing;
@Override
public void init(ServletConfig servletConfig) throws ServletException {
String servletName = "unknown";
try {
super.init(servletConfig);
wsEngine_ = WebServiceEngineImpl.getInstance();
// Register endpoints here
WebServiceContractImpl wscImpl = WebServiceContractImpl.getInstance();
ComponentEnvManager compEnvManager = wscImpl.getComponentEnvManager();
JndiNameEnvironment jndiNameEnv = compEnvManager.getCurrentJndiNameEnvironment();
WebBundleDescriptor webBundle = null;
if (jndiNameEnv != null && jndiNameEnv instanceof WebBundleDescriptor) {
webBundle = ((WebBundleDescriptor) jndiNameEnv);
} else {
throw new WebServiceException("Cannot intialize the JAXWSServlet for " + jndiNameEnv);
}
servletName = servletConfig.getServletName();
contextRoot = webBundle.getContextRoot();
WebComponentDescriptor webComponent = webBundle.getWebComponentByCanonicalName(servletName);
if (webComponent != null) {
WebServicesDescriptor webServices = webBundle.getWebServices();
Collection endpoints = webServices.getEndpointsImplementedBy(webComponent);
// Only 1 endpoint per servlet is supported, even though
// data structure implies otherwise.
endpoint = endpoints.iterator().next();
} else {
throw new ServletException(servletName + " not found");
}
// Need to invoke the endpoint lifecylcle
if (!HTTP_BINDING.equals(endpoint.getProtocolBinding())) {
// Doing this so that restful service are not monitored
wsEngine_.createHandler(endpoint);
}
if (endpoint.getWsdlExposed() != null) {
wsdlExposed = Boolean.parseBoolean(endpoint.getWsdlExposed());
}
// For web components, this will be relative to the web app
// context root. Make sure there is a leading slash.
String uri = endpoint.getEndpointAddressUri();
urlPattern = uri.startsWith("/") ? uri : "/" + uri;
} catch (Throwable t) {
logger.log(WARNING, MessageFormat.format(logger.getResourceBundle().getString(SERVLET_ENDPOINT_FAILURE), servletName), t);
throw new ServletException(t);
}
requestTracing = Globals.get(RequestTracingService.class);
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException {
startedEvent(endpoint.getEndpointAddressPath());
if ("Tester".equalsIgnoreCase(request.getQueryString()) && !(HTTPBinding.HTTP_BINDING.equals(endpoint.getProtocolBinding()))) {
Endpoint endpt = wsEngine_.getEndpoint(request.getServletPath());
if (endpt != null && Boolean.parseBoolean(endpt.getDescriptor().getDebugging())) {
WebServiceTesterServlet.invoke(request, response, endpt.getDescriptor());
endedEvent(endpoint.getEndpointAddressPath());
return;
}
}
// Lookup registered URLs and get the appropriate adapter;
// pass control to the adapter
RequestTraceSpan span = null;
try {
ServletAdapter targetEndpoint = (ServletAdapter) getEndpointFor(request);
if (targetEndpoint != null) {
if (requestTracing.isRequestTracingEnabled()) {
span = constructWsRequestSpan(request, targetEndpoint.getAddress());
}
targetEndpoint.handle(getServletContext(), request, response);
} else {
throw new ServletException("Service not found");
}
} catch (Throwable t) {
throw new ServletException(t);
} finally {
if (requestTracing.isRequestTracingEnabled() && span != null) {
requestTracing.traceSpan(span);
}
}
endedEvent(endpoint.getEndpointAddressPath());
}
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
if (("Tester".equalsIgnoreCase(request.getQueryString())) && (!(HTTP_BINDING.equals(endpoint.getProtocolBinding())))) {
Endpoint endpt = wsEngine_.getEndpoint(request.getServletPath());
if ((endpt != null) && ((endpt.getDescriptor().isSecure()) || (endpt.getDescriptor().getMessageSecurityBinding() != null)
|| endpoint.hasSecurePipeline())) {
String message = endpt.getDescriptor().getWebService().getName()
+ "is a secured web service; Tester feature is not supported for secured services";
(new WsUtil()).writeInvalidMethodType(response, message);
return;
}
if (endpt != null && Boolean.parseBoolean(endpt.getDescriptor().getDebugging())) {
WebServiceTesterServlet.invoke(request, response, endpt.getDescriptor());
return;
}
}
// If it is not a "Tester request" and it is not a WSDL request,
// this might be a restful service
if (!("WSDL".equalsIgnoreCase(request.getQueryString())) && HTTP_BINDING.equals(endpoint.getProtocolBinding())) {
doPost(request, response);
return;
}
// Normal WSDL retrieval invocation
try {
ServletAdapter targetEndpoint = (ServletAdapter) getEndpointFor(request);
if (targetEndpoint != null && wsdlExposed) {
targetEndpoint.publishWSDL(getServletContext(), request, response);
} else {
String message = "Invalid wsdl request " + request.getRequestURL();
(new WsUtil()).writeInvalidMethodType(response, message);
}
} catch (Throwable t) {
throw new ServletException(t);
}
}
@Override
public void destroy() {
synchronized (this) {
wsEngine_.removeHandler(endpoint);
}
}
private RequestTraceSpan constructWsRequestSpan(HttpServletRequest httpServletRequest, URI uri) {
RequestTraceSpan span = new RequestTraceSpan("processSoapWebserviceRequest");
span.addSpanTag("URI", uri.toString());
span.addSpanTag("URL", httpServletRequest.getRequestURL().toString());
Enumeration headerNames = httpServletRequest.getHeaderNames();
while (headerNames.hasMoreElements()) {
String headerName = headerNames.nextElement();
List headers = Collections.list(httpServletRequest.getHeaders(headerName));
span.addSpanTag(headerName, headers.toString());
}
span.addSpanTag("Method", httpServletRequest.getMethod());
return span;
}
@Probe(name = "startedEvent")
private void startedEvent(@ProbeParam("endpointAddress") String endpointAddress) {
}
@Probe(name = "endedEvent")
private void endedEvent(@ProbeParam("endpointAddress") String endpointAddress) {
}
private Adapter getEndpointFor(HttpServletRequest request) {
String path = request.getRequestURI().substring(request.getContextPath().length());
return JAXWSAdapterRegistry.getInstance().getAdapter(contextRoot, urlPattern, path);
}
}