Skip to content

Commit

Permalink
jbpm-workitems: fixes after CXF 2.x -> CXF 3.x upgrade (#469)
Browse files Browse the repository at this point in the history 
* RequestHandler was removed in CXF 3.x and needs to be replaced
   by ContainerRequestFilter

 * see http://cxf.apache.org/docs/30-migration-guide.html
   for additional info
  • Loading branch information
@psiroky
psiroky committed May 23, 2016
1 parent 6babf37 commit 9730c0b
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 76 deletions.
7 changes: 6 additions & 1 deletion jbpm-workitems/pom.xml
View file
Expand Up @@ -109,9 +109,10 @@
<scope>test</scope>
</dependency>
<!-- JaxWS dependencies -->

<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-api</artifactId>
<artifactId>cxf-core</artifactId>
<exclusions>
<exclusion>
<groupId>org.apache.geronimo.specs</groupId>
Expand Down Expand Up @@ -143,6 +144,10 @@
<artifactId>cxf-rt-transports-http</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-simple</artifactId>
</dependency>
<dependency>
<groupId>wsdl4j</groupId>
<artifactId>wsdl4j</artifactId>
Expand Down
154 changes: 81 additions & 73 deletions ...kitems/src/test/java/org/jbpm/process/workitem/rest/BasicAuthRestWorkItemHandlerTest.java
View file
Expand Up @@ -15,24 +15,9 @@

package org.jbpm.process.workitem.rest;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;

import java.util.Arrays;
import java.util.Collection;
import java.util.Map;

import javax.ws.rs.core.Response;
import javax.ws.rs.ext.RuntimeDelegate;

import org.apache.cxf.configuration.security.AuthorizationPolicy;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.ext.RequestHandler;
import org.apache.cxf.jaxrs.model.ClassResourceInfo;
import org.apache.cxf.jaxrs.provider.JAXBElementProvider;
import org.apache.cxf.message.Message;
import org.drools.core.process.instance.impl.WorkItemImpl;
import org.jbpm.bpmn2.handler.WorkItemHandlerRuntimeException;
import org.junit.AfterClass;
Expand All @@ -46,6 +31,21 @@
import org.kie.api.runtime.process.WorkItemHandler;
import org.kie.api.runtime.process.WorkItemManager;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.RuntimeDelegate;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Base64;
import java.util.Collection;
import java.util.Map;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;

@RunWith(Parameterized.class)
public class BasicAuthRestWorkItemHandlerTest {

Expand All @@ -58,19 +58,19 @@ public static Collection<Object[]> parameters() {
return Arrays.asList(locking);
};

private final boolean httpClient43;

private final static String serverURL = "http://localhost:9998/test";
private static final String SERVER_URL = "http://localhost:9998/test";
private static final String USERNAME = "username";
private static final String PASSWORD = "password";

private static Server server;

private String username = "username";
private String password = "password";


private final boolean httpClient43;

public BasicAuthRestWorkItemHandlerTest(boolean httpClient43) {
this.httpClient43 = httpClient43;
}

@SuppressWarnings({ "rawtypes"})
@SuppressWarnings({"rawtypes"})
@BeforeClass
public static void initialize() throws Exception {

Expand All @@ -82,15 +82,17 @@ public static void initialize() throws Exception {
bean.setAddress("http://localhost:9998" + bean.getAddress());
// disabled logging interceptor by default but proves to be useful
// bean.getInInterceptors().add(new LoggingInInterceptor(new PrintWriter(System.out, true)));
bean.setProvider(new AuthenticationHandler());
bean.setProvider(new AuthenticationFilter());
server = bean.create();
server.start();
}

@AfterClass
public static void destroy() throws Exception {
server.stop();
server.destroy();
if (server != null) {
server.stop();
server.destroy();
}
}

@Before
Expand All @@ -100,10 +102,10 @@ public void setClientApiVersion() {

@Test
public void testGETOperation() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL);
workItem.setParameter( "Url", SERVER_URL);
workItem.setParameter( "Method", "GET" );


Expand All @@ -123,10 +125,10 @@ public void testGETOperation() {

@Test
public void testGETOperationWithCustomTimeout() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL);
workItem.setParameter( "Url", SERVER_URL);
workItem.setParameter( "Method", "GET" );
workItem.setParameter( "ConnectTimeout", "30000" );
workItem.setParameter( "ReadTimeout", "25000" );
Expand All @@ -148,10 +150,10 @@ public void testGETOperationWithCustomTimeout() {

@Test
public void testGETOperationWithInvalidTimeout() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL);
workItem.setParameter( "Url", SERVER_URL);
workItem.setParameter( "Method", "GET" );
workItem.setParameter( "ConnectTimeout", "" );
workItem.setParameter( "ReadTimeout", "" );
Expand All @@ -173,10 +175,10 @@ public void testGETOperationWithInvalidTimeout() {

@Test
public void testGETOperationWithQueryParam() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"?param=test");
workItem.setParameter( "Url", SERVER_URL +"?param=test");
workItem.setParameter( "Method", "GET" );


Expand All @@ -196,12 +198,12 @@ public void testGETOperationWithQueryParam() {

@Test
public void testPOSTOperation() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);
String expected = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<person><age>25</age><name>Post john</name></person>";

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/xml");
workItem.setParameter( "Url", SERVER_URL +"/xml");
workItem.setParameter( "Method", "POST" );
workItem.setParameter( "ContentType", "application/xml" );
workItem.setParameter( "Content", "<person><name>john</name><age>25</age></person>" );
Expand All @@ -223,10 +225,10 @@ public void testPOSTOperation() {

@Test
public void testPOSTOperationWithPathParamAndNoContent() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/john");
workItem.setParameter( "Url", SERVER_URL +"/john");
workItem.setParameter( "Method", "POST" );


Expand All @@ -246,12 +248,12 @@ public void testPOSTOperationWithPathParamAndNoContent() {

@Test
public void testPUTOperation() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);
String expected = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<person><age>25</age><name>Put john</name></person>";

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/xml");
workItem.setParameter( "Url", SERVER_URL +"/xml");
workItem.setParameter( "Method", "PUT" );
workItem.setParameter( "ContentType", "application/xml" );
workItem.setParameter( "Content", "<person><name>john</name><age>25</age></person>" );
Expand All @@ -273,12 +275,12 @@ public void testPUTOperation() {

@Test
public void testDELETEOperation() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);
String expected = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>" +
"<person><age>-1</age><name>deleted john</name></person>";

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/xml/john");
workItem.setParameter( "Url", SERVER_URL +"/xml/john");
workItem.setParameter( "Method", "DELETE" );


Expand All @@ -298,10 +300,10 @@ public void testDELETEOperation() {

@Test(expected=IllegalArgumentException.class)
public void testUnsupportedOperation() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/xml/john");
workItem.setParameter( "Url", SERVER_URL +"/xml/john");
workItem.setParameter( "Method", "HEAD" );


Expand All @@ -311,10 +313,10 @@ public void testUnsupportedOperation() {

@Test
public void testHandleErrorOnNotSuccessfulResponse() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, password);
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, PASSWORD);

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL+"/notexisting");
workItem.setParameter( "Url", SERVER_URL +"/notexisting");
workItem.setParameter( "Method", "GET" );
workItem.setParameter("HandleResponseErrors", "true");

Expand All @@ -327,17 +329,17 @@ public void testHandleErrorOnNotSuccessfulResponse() {

RESTServiceException e = (RESTServiceException) ex.getCause().getCause();
assertEquals(405, e.getStatus());
assertEquals(serverURL+"/notexisting", e.getEndoint());
assertEquals(SERVER_URL +"/notexisting", e.getEndoint());
assertEquals("", e.getResponse());
}
}

@Test
public void testHandleErrorOnNotSuccessfulResponseWrongCredentials() {
RESTWorkItemHandler handler = new RESTWorkItemHandler(username, "wrongpassword");
RESTWorkItemHandler handler = new RESTWorkItemHandler(USERNAME, "wrongpassword");

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL);
workItem.setParameter( "Url", SERVER_URL);
workItem.setParameter( "Method", "GET" );
workItem.setParameter("HandleResponseErrors", "true");

Expand All @@ -350,7 +352,7 @@ public void testHandleErrorOnNotSuccessfulResponseWrongCredentials() {

RESTServiceException e = (RESTServiceException) ex.getCause().getCause();
assertEquals(401, e.getStatus());
assertEquals(serverURL, e.getEndoint());
assertEquals(SERVER_URL, e.getEndoint());
assertEquals("", e.getResponse());
}
}
Expand All @@ -360,11 +362,11 @@ public void testGETOperationAuthTypeAsParam() {
RESTWorkItemHandler handler = new RESTWorkItemHandler();

WorkItemImpl workItem = new WorkItemImpl();
workItem.setParameter( "Url", serverURL);
workItem.setParameter( "Url", SERVER_URL);
workItem.setParameter( "Method", "GET" );
workItem.setParameter( "AuthType", "BASIC" );
workItem.setParameter( "Username", username );
workItem.setParameter( "Password", password );
workItem.setParameter( "Username", USERNAME);
workItem.setParameter( "Password", PASSWORD);


WorkItemManager manager = new TestWorkItemManager(workItem);
Expand Down Expand Up @@ -406,28 +408,34 @@ public void registerWorkItemHandler(String workItemName, WorkItemHandler handler
}

}

private static class AuthenticationHandler implements RequestHandler {

public Response handleRequest(Message m, ClassResourceInfo resourceClass) {
AuthorizationPolicy policy = (AuthorizationPolicy)m.get(AuthorizationPolicy.class);
String username = policy.getUserName();
String password = policy.getPassword();
if (isAuthenticated(username, password)) {
// let request to continue
return null;
} else {
// authentication failed, request the authetication, add the realm name if needed to the value of WWW-Authenticate
return Response.status(401).header("WWW-Authenticate", "Basic").build();

/**
* Intercepts the request and checks whether the HTTP Basic authentication header was correctly set (e.g. has
* correct username+password).
*
* For test purposes only.
*/
private static class AuthenticationFilter implements ContainerRequestFilter {

@Override
public void filter(ContainerRequestContext containerRequestContext) throws IOException {
String[] usernamePassword = decodeBase64UsernameAndPassword(containerRequestContext.getHeaderString("Authorization"));
String username = usernamePassword[0];
String password = usernamePassword[1];
if (!isAuthenticated(username, password)) {
containerRequestContext.abortWith(Response.status(401).header("WWW-Authenticate", "Basic").build());
}
}

private boolean isAuthenticated(String username, String password) {
if ("username".equals(username) && "password".equals(password)) {
return true;
}
return false;
}

private String[] decodeBase64UsernameAndPassword(String base64authzHeader) {
// extract just the username:password part (removing the "Basic " prefix)
String usernamePasswordBase64 = base64authzHeader.substring("Basic ".length());
String usernamePassword = new String(Base64.getDecoder().decode(usernamePasswordBase64), StandardCharsets.UTF_8);
return usernamePassword.split(":");
}

private boolean isAuthenticated(String username, String password) {
return USERNAME.equals(username) && PASSWORD.equals(password);
}
}
}
6 changes: 4 additions & 2 deletions jbpm-workitems/src/test/java/org/jbpm/process/workitem/rest/RestWorkItemHandlerTest.java
View file
Expand Up @@ -78,8 +78,10 @@ public static void initialize() throws Exception {

@AfterClass
public static void destroy() throws Exception {
server.stop();
server.destroy();
if (server != null) {
server.stop();
server.destroy();
}
}

@Before
Expand Down

0 comments on commit 9730c0b

Please sign in to comment.