ServletController.java
/**
* 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.util.logging.Level;
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 org.apache.cxf.Bus;
import org.apache.cxf.common.classloader.ClassLoaderUtils;
import org.apache.cxf.common.classloader.ClassLoaderUtils.ClassLoaderHolder;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.resource.ResourceManager;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import org.apache.cxf.transport.http.DestinationRegistry;
public class ServletController {
public static final String AUTH_SERVICE_LIST = "auth.service.list";
public static final String AUTH_SERVICE_LIST_REALM = "auth.service.list.realm";
protected static final String DEFAULT_LISTINGS_CLASSIFIER = "/services";
private static final Logger LOG = LogUtils.getL7dLogger(ServletController.class);
private static final String HTTP_PREFIX = "http";
protected boolean isHideServiceList;
protected boolean isAuthServiceListPage;
protected boolean disableAddressUpdates = true;
protected String authServiceListPageRealm;
protected String forcedBaseAddress;
protected String serviceListRelativePath = DEFAULT_LISTINGS_CLASSIFIER;
protected ServletConfig servletConfig;
protected DestinationRegistry destinationRegistry;
protected HttpServlet serviceListGenerator;
public ServletController(DestinationRegistry destinationRegistry,
ServletConfig config,
HttpServlet serviceListGenerator) {
this.servletConfig = config;
this.destinationRegistry = destinationRegistry;
this.serviceListGenerator = serviceListGenerator;
init();
}
public void setServiceListRelativePath(String relativePath) {
serviceListRelativePath = relativePath;
}
protected String getBaseURL(HttpServletRequest request) {
return forcedBaseAddress == null ? BaseUrlHelper.getBaseURL(request) : forcedBaseAddress;
}
protected void setBaseURLAttribute(HttpServletRequest request) {
request.setAttribute(Message.BASE_PATH, getBaseURL(request));
}
protected void updateDestination(HttpServletRequest request,
AbstractHTTPDestination d) {
String base = getBaseURL(request);
if (disableAddressUpdates) {
updateDestination(request, base, d);
} else {
synchronized (d) {
updateDestination(request, base, d);
}
}
}
protected void updateDestination(HttpServletRequest request,
String base,
AbstractHTTPDestination d) {
String ad = d.getEndpointInfo().getAddress();
if (ad == null
&& d.getAddress() != null
&& d.getAddress().getAddress() != null) {
ad = d.getAddress().getAddress().getValue();
if (ad == null) {
ad = "/";
}
}
// Using HTTP_PREFIX check is safe for ServletController
// URI.create(ad).isRelative() can be used - a bit more expensive though
if (ad != null && !ad.startsWith(HTTP_PREFIX)) {
if (disableAddressUpdates) {
request.setAttribute("org.apache.cxf.transport.endpoint.address",
base + ad);
} else {
BaseUrlHelper.setAddress(d, base + ad);
}
}
}
private void init() {
if (servletConfig == null) {
return;
}
String hideServiceList = servletConfig.getInitParameter("hide-service-list-page");
if (!StringUtils.isEmpty(hideServiceList)) {
this.isHideServiceList = Boolean.valueOf(hideServiceList);
}
String authServiceListPage = servletConfig.getInitParameter("service-list-page-authenticate");
if (!StringUtils.isEmpty(authServiceListPage)) {
this.isAuthServiceListPage = Boolean.valueOf(authServiceListPage);
}
String authServiceListRealm = servletConfig.getInitParameter("service-list-page-authenticate-realm");
if (!StringUtils.isEmpty(authServiceListRealm)) {
this.authServiceListPageRealm = authServiceListRealm;
}
String isDisableAddressUpdates = servletConfig.getInitParameter("disable-address-updates");
if (!StringUtils.isEmpty(isDisableAddressUpdates)) {
this.disableAddressUpdates = Boolean.valueOf(isDisableAddressUpdates);
}
String isForcedBaseAddress = servletConfig.getInitParameter("base-address");
if (!StringUtils.isEmpty(isForcedBaseAddress)) {
this.forcedBaseAddress = isForcedBaseAddress;
}
try {
serviceListGenerator.init(servletConfig);
} catch (ServletException e) {
throw new RuntimeException(e.getMessage(), e);
}
String serviceListPath = servletConfig.getInitParameter("service-list-path");
if (!StringUtils.isEmpty(serviceListPath)) {
this.serviceListRelativePath = serviceListPath;
}
}
public boolean filter(HttpServletRequest request, HttpServletResponse res) throws ServletException {
return invoke(request, res, false);
}
public void invoke(HttpServletRequest request, HttpServletResponse res) throws ServletException {
invoke(request, res, true);
}
public boolean invoke(HttpServletRequest request, HttpServletResponse res, boolean returnErrors)
throws ServletException {
try {
String pathInfo = request.getPathInfo() == null ? "" : request.getPathInfo();
AbstractHTTPDestination d = destinationRegistry.getDestinationForPath(pathInfo, true);
if (d == null) {
if (!isHideServiceList && (request.getRequestURI().endsWith(serviceListRelativePath)
|| request.getRequestURI().endsWith(serviceListRelativePath + "/")
|| StringUtils.isEmpty(pathInfo)
|| "/".equals(pathInfo))) {
if (isAuthServiceListPage) {
setAuthServiceListPageAttribute(request);
}
setBaseURLAttribute(request);
serviceListGenerator.service(request, res);
} else {
d = destinationRegistry.checkRestfulRequest(pathInfo);
if (d == null || d.getMessageObserver() == null) {
if (returnErrors) {
LOG.warning("Can't find the request for "
+ request.getRequestURL() + "'s Observer ");
generateNotFound(request, res);
}
return false;
}
}
}
if (d != null && d.getMessageObserver() != null) {
Bus bus = d.getBus();
ClassLoaderHolder orig = null;
try {
if (bus != null) {
ClassLoader loader = bus.getExtension(ClassLoader.class);
if (loader == null) {
ResourceManager manager = bus.getExtension(ResourceManager.class);
if (manager != null) {
loader = manager.resolveResource("", ClassLoader.class);
}
}
if (loader != null) {
//need to set the context classloader to the loader of the bundle
orig = ClassLoaderUtils.setThreadContextClassloader(loader);
}
}
updateDestination(request, d);
invokeDestination(request, res, d);
} finally {
if (orig != null) {
orig.reset();
}
}
}
} catch (IOException e) {
throw new ServletException(e);
}
return true;
}
private void setAuthServiceListPageAttribute(HttpServletRequest request) {
request.setAttribute(ServletController.AUTH_SERVICE_LIST, this.isAuthServiceListPage);
request.setAttribute(ServletController.AUTH_SERVICE_LIST_REALM, this.authServiceListPageRealm);
}
public void invokeDestination(final HttpServletRequest request, HttpServletResponse response,
AbstractHTTPDestination d) throws ServletException {
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Service http request on thread: " + Thread.currentThread());
}
try {
d.invoke(servletConfig, servletConfig.getServletContext(), 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());
}
}
}
protected void generateNotFound(HttpServletRequest request, HttpServletResponse res) throws IOException {
res.setStatus(404);
res.setContentType("text/html");
res.getWriter().write("<html><body>No service was found.</body></html>");
}
}