org.apache.cxf.transport.servlet.ServletController Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.transport.servlet;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.cxf.Bus;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.common.util.UrlUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.service.model.EndpointInfo;
import org.apache.cxf.service.model.OperationInfo;
import org.apache.cxf.transports.http.QueryHandler;
import org.apache.cxf.transports.http.QueryHandlerRegistry;
import org.apache.cxf.wsdl.http.AddressType;
public class ServletController {
private static final Logger LOG = LogUtils.getL7dLogger(ServletController.class);
private ServletTransportFactory transport;
private ServletContext servletContext;
private ServletConfig servletConfig;
private Bus bus;
private String lastBase = "";
private boolean isHideServiceList;
private boolean disableAddressUpdates;
private String forcedBaseAddress;
private String serviceListStyleSheet;
public ServletController(ServletTransportFactory df,
ServletConfig config,
ServletContext context,
Bus b) {
this.transport = df;
this.servletConfig = config;
this.servletContext = context;
this.bus = b;
init();
}
public void setHideServiceList(boolean generate) {
isHideServiceList = generate;
}
public void setDisableAddressUpdates(boolean noupdates) {
disableAddressUpdates = noupdates;
}
public void setForcedBaseAddress(String s) {
forcedBaseAddress = s;
}
public void setServiceListStyleSheet(String serviceListStyleSheet) {
this.serviceListStyleSheet = serviceListStyleSheet;
}
String getLastBaseURL() {
return lastBase;
}
private synchronized void updateDests(HttpServletRequest request) {
if (disableAddressUpdates) {
return;
}
String base = forcedBaseAddress == null ? getBaseURL(request) : forcedBaseAddress;
if (base.equals(lastBase)) {
return;
}
Set paths = transport.getDestinationsPaths();
for (String path : paths) {
ServletDestination d2 = transport.getDestinationForPath(path);
String ad = d2.getEndpointInfo().getAddress();
if (ad.equals(path)
|| ad.equals(lastBase + path)) {
d2.getEndpointInfo().setAddress(base + path);
if (d2.getEndpointInfo().getExtensor(AddressType.class) != null) {
d2.getEndpointInfo().getExtensor(AddressType.class).setLocation(base + path);
}
}
}
lastBase = base;
}
public void invoke(HttpServletRequest request, HttpServletResponse res) throws ServletException {
try {
EndpointInfo ei = new EndpointInfo();
String address = request.getPathInfo() == null ? "" : request.getPathInfo();
ei.setAddress(address);
ServletDestination d = (ServletDestination)transport.getDestinationForPath(ei.getAddress());
if (d == null) {
if (request.getRequestURI().endsWith("/services")
|| request.getRequestURI().endsWith("/services/")
|| StringUtils.isEmpty(request.getPathInfo())
|| "/".equals(request.getPathInfo())) {
updateDests(request);
if (request.getParameter("stylesheet") != null) {
renderStyleSheet(request, res);
} else if ("false".equals(request.getParameter("formatted"))) {
generateUnformattedServiceList(request, res);
} else {
generateServiceList(request, res);
}
} else {
d = checkRestfulRequest(request);
if (d == null || d.getMessageObserver() == null) {
LOG.warning("Can't find the request for "
+ request.getRequestURL() + "'s Observer ");
generateNotFound(request, res);
} else { // the request should be a restful service request
updateDests(request);
invokeDestination(request, res, d);
}
}
} else {
ei = d.getEndpointInfo();
if (null != request.getQueryString()
&& request.getQueryString().length() > 0
&& bus.getExtension(QueryHandlerRegistry.class) != null) {
String ctxUri = request.getPathInfo();
String baseUri = request.getRequestURL().toString()
+ "?" + request.getQueryString();
// update the EndPoint Address with request url
if ("GET".equals(request.getMethod())) {
updateDests(request);
}
for (QueryHandler qh : bus.getExtension(QueryHandlerRegistry.class).getHandlers()) {
if (qh.isRecognizedQuery(baseUri, ctxUri, ei)) {
res.setContentType(qh.getResponseContentType(baseUri, ctxUri));
OutputStream out = res.getOutputStream();
try {
qh.writeResponse(baseUri, ctxUri, ei, out);
} catch (Exception e) {
LogUtils.log(LOG, Level.WARNING,
qh.getClass().getName()
+ " Exception caught writing response.",
e);
throw new ServletException(e);
}
out.flush();
return;
}
}
}
invokeDestination(request, res, d);
}
} catch (Fault ex) {
if (ex.getCause() instanceof RuntimeException) {
throw (RuntimeException)ex.getCause();
} else {
throw new ServletException(ex.getCause());
}
} catch (IOException e) {
throw new ServletException(e);
}
}
private ServletDestination checkRestfulRequest(HttpServletRequest request) throws IOException {
String address = request.getPathInfo() == null ? "" : request.getPathInfo();
int len = -1;
ServletDestination ret = null;
for (String path : transport.getDestinationsPaths()) {
if (address.startsWith(path)
&& path.length() > len) {
ret = transport.getDestinationForPath(path);
len = path.length();
}
}
return ret;
}
protected void generateServiceList(HttpServletRequest request, HttpServletResponse response)
throws IOException {
response.setContentType("text/html; charset=UTF-8");
response.getWriter().write("");
response.getWriter().write("");
if (serviceListStyleSheet != null) {
response.getWriter().write(
"");
} else {
response.getWriter().write(
"");
}
response.getWriter().write("");
response.getWriter().write("CXF - Service list ");
response.getWriter().write("");
if (!isHideServiceList) {
List destinations = getServletDestinations();
if (destinations.size() > 0) {
response.getWriter().write("Available services:
");
response.getWriter().write("");
for (ServletDestination sd : destinations) {
if (null != sd.getEndpointInfo().getName()
&& null != sd.getEndpointInfo().getInterface()) {
response.getWriter().write("");
response.getWriter().write(""
+ sd.getEndpointInfo().getInterface().getName().getLocalPart()
+ "");
response.getWriter().write("");
for (OperationInfo oi : sd.getEndpointInfo().getInterface().getOperations()) {
response.getWriter().write("- " + oi.getName().getLocalPart() + "
");
}
response.getWriter().write("
");
response.getWriter().write(" ");
String address = sd.getEndpointInfo().getAddress();
response.getWriter().write("Endpoint address: "
+ "" + address + "");
response.getWriter().write("
Wsdl: "
+ ""
+ sd.getEndpointInfo().getService().getName() + "");
response.getWriter().write("
Target namespace: "
+ ""
+ sd.getEndpointInfo().getService().getTargetNamespace() + "");
response.getWriter().write("
");
} else {
response.getWriter().write("No service was found.");
}
}
response.getWriter().write("");
}
private void renderStyleSheet(HttpServletRequest request,
HttpServletResponse response) throws IOException {
response.setContentType("text/css; charset=UTF-8");
URL url = this.getClass().getResource("servicelist.css");
if (url != null) {
IOUtils.copy(url.openStream(), response.getOutputStream());
}
}
private List getServletDestinations() {
List destinations = new LinkedList(
transport.getDestinations());
Collections.sort(destinations, new Comparator() {
public int compare(ServletDestination o1, ServletDestination o2) {
if (o1.getEndpointInfo().getInterface() == null) {
return -1;
}
if (o2.getEndpointInfo().getInterface() == null) {
return 1;
}
return o1.getEndpointInfo().getInterface().getName()
.getLocalPart().compareTo(
o2.getEndpointInfo().getInterface().getName()
.getLocalPart());
}
});
return destinations;
}
protected void generateUnformattedServiceList(HttpServletRequest request,
HttpServletResponse response) throws IOException {
response.setContentType("text/plain; charset=UTF-8");
if (!isHideServiceList) {
List destinations = getServletDestinations();
boolean renderWsdlList = "true".equals(request.getParameter("wsdlList"));
for (ServletDestination sd : destinations) {
String address = sd.getEndpointInfo().getAddress();
response.getWriter().write(address);
if (renderWsdlList) {
response.getWriter().write("?wsdl");
}
response.getWriter().write('\n');
}
}
}
private String getBaseURL(HttpServletRequest request) {
String reqPrefix = request.getRequestURL().toString();
String pathInfo = request.getPathInfo() == null ? "" : request.getPathInfo();
//fix for CXF-898
if (!"/".equals(pathInfo) || reqPrefix.endsWith("/")) {
// needs to be done given that pathInfo is decoded
// TODO : it's unlikely servlet path will contain encoded values so we're most
// likely safe however we need to ensure if it happens then this code works properly too
reqPrefix = UrlUtils.pathDecode(reqPrefix);
// pathInfo drops matrix parameters attached to a last path segment
int offset = 0;
int index = reqPrefix.lastIndexOf(';');
if (index >= pathInfo.length()) {
offset = reqPrefix.length() - index;
}
reqPrefix = reqPrefix.substring(0, reqPrefix.length() - pathInfo.length() - offset);
}
return reqPrefix;
}
protected void generateNotFound(HttpServletRequest request, HttpServletResponse res) throws IOException {
res.setStatus(404);
res.setContentType("text/html");
res.getWriter().write("No service was found.");
}
public void invokeDestination(final HttpServletRequest request, HttpServletResponse response,
ServletDestination d) throws ServletException {
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Service http request on thread: " + Thread.currentThread());
}
try {
d.invoke(servletConfig, servletContext, request, response);
} catch (IOException e) {
throw new ServletException(e);
} finally {
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Finished servicing http request on thread: " + Thread.currentThread());
}
}
}
private void init() {
transport.setServletController(this);
String hideServiceList = servletConfig.getInitParameter("hide-service-list-page");
if (hideServiceList != null) {
isHideServiceList = Boolean.valueOf(hideServiceList);
}
String isDisableAddressUpdates = servletConfig.getInitParameter("disable-address-updates");
if (isDisableAddressUpdates != null) {
disableAddressUpdates = Boolean.valueOf(isDisableAddressUpdates);
}
String isForcedBaseAddress = servletConfig.getInitParameter("base-address");
if (isForcedBaseAddress != null) {
forcedBaseAddress = isForcedBaseAddress;
}
String serviceListTransform = servletConfig.getInitParameter("service-list-stylesheet");
if (serviceListTransform != null) {
serviceListStyleSheet = serviceListTransform;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy