Skip to content

cxf-rt-transports-http: allow to use service list endpoint as lightweight healthcheck endpoint using HTTP HEAD method #880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amarkevich merged 1 commit into from
Dec 2, 2021
Merged

cxf-rt-transports-http: allow to use service list endpoint as lightweight healthcheck endpoint using HTTP HEAD method #880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 21 additions & 31 deletions ...c/main/java/org/apache/cxf/transport/servlet/servicelist/ServiceListGeneratorServlet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.servlet.ServletConfig;
Expand All @@ -33,6 +34,7 @@
import org.apache.cxf.Bus;
import org.apache.cxf.BusFactory;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.service.model.EndpointInfo;
Expand All @@ -45,17 +47,12 @@ public class ServiceListGeneratorServlet extends HttpServlet {
private DestinationRegistry destinationRegistry;
private Bus bus;
private String serviceListStyleSheet;
private String title;
private String title = "CXF - Service list";
private boolean showForeignContexts = true;

public ServiceListGeneratorServlet(DestinationRegistry destinationRegistry, Bus bus) {
this.destinationRegistry = destinationRegistry;
this.bus = bus;
if (this.bus == null) {
this.bus = BusFactory.getDefaultBus(false);
}

this.title = "CXF - Service list";
this.bus = bus != null ? bus : BusFactory.getDefaultBus(false);
}

public void setServiceListStyleSheet(String serviceListStyleSheet) {
Expand All @@ -66,17 +63,11 @@ public void setTitle(String title) {
this.title = title;
}


@SuppressWarnings("unchecked")
@Override
public void service(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
Object obj = request.getAttribute(ServletController.AUTH_SERVICE_LIST);
boolean isAuthServiceList = false;
if (obj != null) {
isAuthServiceList = Boolean.valueOf(obj.toString());
}
if (isAuthServiceList) {
final Object isAuthServiceList = request.getAttribute(ServletController.AUTH_SERVICE_LIST);
if (isAuthServiceList != null && Boolean.valueOf(isAuthServiceList.toString())) {
String authServiceListRealm = (String)request.getAttribute(ServletController.AUTH_SERVICE_LIST_REALM);
ServiceListJAASAuthenticator authenticator = new ServiceListJAASAuthenticator();
authenticator.setRealm(authServiceListRealm);
Expand All @@ -86,24 +77,18 @@ public void service(HttpServletRequest request,
request.removeAttribute(ServletController.AUTH_SERVICE_LIST);
request.removeAttribute(ServletController.AUTH_SERVICE_LIST_REALM);
}
AbstractDestination[] destinations = destinationRegistry.getSortedDestinations();
if (request.getParameter("stylesheet") != null) {
renderStyleSheet(request, response);
return;
}
List<String> privateEndpoints;

if ("HEAD".equals(request.getMethod())) {
return;
}
if (bus == null) {
bus = BusFactory.getDefaultBus(false);
}
if (bus != null) {
privateEndpoints = (List<String>)bus.getProperty("org.apache.cxf.private.endpoints");
} else {
privateEndpoints = new ArrayList<>();
}

AbstractDestination[] soapEndpoints = getSOAPEndpoints(destinations, privateEndpoints);
AbstractDestination[] restEndpoints = getRestEndpoints(destinations, privateEndpoints);
ServiceListWriter serviceListWriter;
final ServiceListWriter serviceListWriter;
if ("false".equals(request.getParameter("formatted"))) {
boolean renderWsdlList = "true".equals(request.getParameter("wsdlList"));
serviceListWriter = new UnformattedServiceListWriter(renderWsdlList, bus);
Expand Down Expand Up @@ -136,14 +121,19 @@ public void service(HttpServletRequest request,

}
response.setContentType(serviceListWriter.getContentType());
Object basePath = request.getAttribute(Message.BASE_PATH);
final Object basePath = request.getAttribute(Message.BASE_PATH);
final AbstractDestination[] destinations = destinationRegistry.getSortedDestinations();
final List<String> privateEndpoints = bus != null
? CastUtils.cast((List<?>) bus.getProperty("org.apache.cxf.private.endpoints"))
: Collections.emptyList();
serviceListWriter.writeServiceList(response.getWriter(),
basePath == null ? null : basePath.toString(),
soapEndpoints, restEndpoints);
getSOAPEndpoints(destinations, privateEndpoints),
getRestEndpoints(destinations, privateEndpoints));
}


private boolean isPrivate(EndpointInfo ei, List<String> privateEndpoints) {
private static boolean isPrivate(EndpointInfo ei, List<String> privateEndpoints) {
if (privateEndpoints != null) {
for (String s : privateEndpoints) {
if (ei.getAddress().endsWith(s)) {
Expand All @@ -154,7 +144,7 @@ private boolean isPrivate(EndpointInfo ei, List<String> privateEndpoints) {
return false;
}

private AbstractDestination[] getSOAPEndpoints(AbstractDestination[] destinations,
private static AbstractDestination[] getSOAPEndpoints(AbstractDestination[] destinations,
List<String> privateEndpoints) {
List<AbstractDestination> soapEndpoints = new ArrayList<>();
for (AbstractDestination sd : destinations) {
Expand All @@ -166,7 +156,7 @@ private AbstractDestination[] getSOAPEndpoints(AbstractDestination[] destination
return soapEndpoints.toArray(new AbstractDestination[0]);
}

private AbstractDestination[] getRestEndpoints(AbstractDestination[] destinations,
private static AbstractDestination[] getRestEndpoints(AbstractDestination[] destinations,
List<String> privateEndpoints) {
List<AbstractDestination> restfulDests = new ArrayList<>();
for (AbstractDestination sd : destinations) {
Expand Down
58 changes: 27 additions & 31 deletions rt/transports/http/src/test/java/org/apache/cxf/transport/servlet/ServletControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,50 +30,33 @@
import org.apache.cxf.transport.MessageObserver;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import org.apache.cxf.transport.http.DestinationRegistry;
import org.apache.cxf.transport.servlet.servicelist.ServiceListGeneratorServlet;

import org.easymock.EasyMock;
import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

public class ServletControllerTest {

private HttpServletRequest req;
private HttpServletResponse res;
private DestinationRegistry registry;
private HttpServlet serviceListGenerator;

@Before
public void setUp() {
req = EasyMock.createMock(HttpServletRequest.class);
res = EasyMock.createMock(HttpServletResponse.class);
registry = EasyMock.createMock(DestinationRegistry.class);
serviceListGenerator = EasyMock.createMock(HttpServlet.class);
}
private HttpServletRequest req = EasyMock.createMock(HttpServletRequest.class);
private HttpServletResponse res = EasyMock.createMock(HttpServletResponse.class);
private DestinationRegistry registry = EasyMock.createMock(DestinationRegistry.class);
private HttpServlet serviceListGenerator = EasyMock.createMock(HttpServlet.class);

private void setReq(String pathInfo, String requestUri, String styleSheet, String formatted) {
req.getPathInfo();
EasyMock.expectLastCall().andReturn(pathInfo).anyTimes();
req.getContextPath();
EasyMock.expectLastCall().andReturn("").anyTimes();
req.getServletPath();
EasyMock.expectLastCall().andReturn("").anyTimes();
EasyMock.expect(req.getPathInfo()).andReturn(pathInfo).anyTimes();
EasyMock.expect(req.getContextPath()).andReturn("").anyTimes();
EasyMock.expect(req.getServletPath()).andReturn("").anyTimes();
req.setAttribute(Message.BASE_PATH, "http://localhost:8080");
EasyMock.expectLastCall().anyTimes();
req.getRequestURI();
EasyMock.expectLastCall().andReturn(requestUri).times(2);
req.getParameter("stylesheet");
EasyMock.expectLastCall().andReturn(styleSheet);
req.getParameter("formatted");
EasyMock.expectLastCall().andReturn(formatted);
req.getRequestURL();
EasyMock.expectLastCall().andReturn(new StringBuffer("http://localhost:8080" + requestUri)); //NOPMD
registry.getDestinationsPaths();
EasyMock.expectLastCall().andReturn(Collections.emptySet()).atLeastOnce();
registry.getDestinationForPath("", true);
EasyMock.expectLastCall().andReturn(null).anyTimes();
EasyMock.expect(req.getRequestURI()).andReturn(requestUri).times(2);
EasyMock.expect(req.getParameter("stylesheet")).andReturn(styleSheet);
EasyMock.expect(req.getParameter("formatted")).andReturn(formatted);
EasyMock.expect(req.getRequestURL()).andReturn(new StringBuffer("http://localhost:8080").append(requestUri));
EasyMock.expect(registry.getDestinationsPaths()).andReturn(Collections.emptySet()).atLeastOnce();
EasyMock.expect(registry.getDestinationForPath("", true)).andReturn(null).anyTimes();
}

private void expectServiceListGeneratorCalled() throws ServletException, IOException {
Expand Down Expand Up @@ -162,6 +145,19 @@ public void testDifferentServiceListPath() throws Exception {
assertFalse(sc.invokeDestinationCalled());
}

@Test
public void testHealthcheck() throws Exception {
setReq(null, "/services", null, "true");
EasyMock.expect(req.getAttribute(ServletController.AUTH_SERVICE_LIST)).andReturn(null);
EasyMock.expect(req.getMethod()).andReturn("HEAD");

EasyMock.replay(req, registry);
TestServletController sc = new TestServletController(registry, new ServiceListGeneratorServlet(registry, null));
sc.invoke(req, res);
assertFalse(sc.invokeDestinationCalled());
}


public static class TestServletController extends ServletController {
private boolean invokeDestinationCalled;

Expand Down