Compare commits
	
		
			29 Commits
		
	
	
		
			v2.0.2-cxf
			...
			v2.0.7-jer
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 7c98ce5545 | |||
| 4c7e9da980 | |||
| bb20a78224 | |||
| f84279a148 | |||
| 518be99d4e | |||
| 2dd7de15a3 | |||
| 053b7a36ff | |||
| fa96a8cfb8 | |||
| 44e82b3a6b | |||
| ab920aedd7 | |||
| ab6b0d8da7 | |||
| c25988fc8f | |||
| a4a1b3a9e6 | |||
| 9e3c749f9b | |||
| 2cbb08e9cc | |||
| 9a9a958913 | |||
| 6844044395 | |||
| 37e8b63179 | |||
| 255a9c8e85 | |||
| 722a04fe16 | |||
| 1e5fcf6ab8 | |||
| efcfab1795 | |||
| bcb7d4a7ed | |||
| 5c242d88f1 | |||
| e56152c47b | |||
| eb843c3cb6 | |||
| 56aca63307 | |||
| 22ab063d4e | |||
| df402790b4 | 
							
								
								
									
										19
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,7 +1,7 @@ | ||||
|  | ||||
| # Common ReST Client Library | ||||
|  | ||||
| This project provides a library for Spring and POJO-based REST client instantiation.  It includes special classes with classifiers for two popular JAXRS-based client frameworks: Apache CXF and Jersey. | ||||
| This project provides a library for Spring and POJO-based REST client instantiation.  It includes special classes for the Jersey JAXRS-based client frameworks. | ||||
|  | ||||
| ## Usage | ||||
|  | ||||
| @@ -15,8 +15,7 @@ First, you will need to include the library in your project. | ||||
|         <dependency> | ||||
|             <groupId>com.inteligr8</groupId> | ||||
|             <artifactId>common-rest-client</artifactId> | ||||
|             <classifier>...</classifier> | ||||
|             <version>...</version> | ||||
|             <version>...-jersey</version> | ||||
|         </dependency> | ||||
|         ... | ||||
|     </dependencies> | ||||
| @@ -24,8 +23,6 @@ First, you will need to include the library in your project. | ||||
| </project> | ||||
| ``` | ||||
|  | ||||
| Valid `classifier` values are `cxf` or `jersey`. | ||||
|  | ||||
| ### Spring Framework | ||||
|  | ||||
| #### Single Client | ||||
| @@ -36,29 +33,27 @@ If you will only be declaring a single client in your Spring context, this is ea | ||||
| @Component | ||||
| public class ... { | ||||
|     @Autowired | ||||
|     @Qualifier("client.cxf")  // may be optional | ||||
|     @Qualifier("client.jersey")  // may be optional | ||||
|     private Client client; | ||||
| } | ||||
| ``` | ||||
|  | ||||
| Next, you need to configure that client.  You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientCxfConfiguration`) interface. | ||||
| Next, you need to configure that client.  You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientJerseyConfiguration`) interface. | ||||
|  | ||||
| ```java | ||||
| @Configuration | ||||
| public class ... implements ClientCxfConfiguration { | ||||
| public class ... implements ClientJerseyConfiguration { | ||||
|     ... | ||||
| } | ||||
| ``` | ||||
|  | ||||
| For Jersey implementations, just use `client.jersey` and `ClientJerseyConfiguration`.  If you want to provide one of each, then follow the instructions for multiple clients below. | ||||
|  | ||||
| #### Multiple Clients | ||||
|  | ||||
| If you will or may have multiple clients in your Spring context, there is an extra step.  You will still need to define a `ClientConfiguration` for each.  On top of that, you will need to create specialized implementations of each client.  That special implementation will reference the configuration directly.  An example is below. | ||||
|  | ||||
| ```java | ||||
| @Component("my.client") | ||||
| public class MyClient extends ClientCxfImpl { | ||||
| public class MyClient extends ClientJerseyImpl { | ||||
|     @Autowired | ||||
|     public MyClient(MyClientConfiguration config) { | ||||
|         super(config); | ||||
| @@ -87,6 +82,6 @@ You do not have to use the Spring framework to use these classes.  You can insta | ||||
| ```java | ||||
| MyClientConfiguration config = new MyClientConfiguration(); | ||||
| ... | ||||
| ClientCxfImpl client = new ClientCxfImpl(config); | ||||
| ClientJerseyImpl client = new ClientJerseyImpl(config); | ||||
| MyJaxRsApi api = client.getApi(MyJaxRsApi.class); | ||||
| ``` | ||||
|   | ||||
							
								
								
									
										40
									
								
								pom.xml
									
									
									
									
									
								
							
							
						
						
									
										40
									
								
								pom.xml
									
									
									
									
									
								
							| @@ -6,11 +6,11 @@ | ||||
| 	 | ||||
| 	<groupId>com.inteligr8</groupId> | ||||
| 	<artifactId>common-rest-client</artifactId> | ||||
| 	<version>2.0.2-cxf</version> | ||||
| 	<version>2.0.7-jersey</version> | ||||
| 	<packaging>jar</packaging> | ||||
|  | ||||
| 	<name>ReST API Client for Java</name> | ||||
| 	<description>A common library for building CXF REST API clients</description> | ||||
| 	<description>A common library for building Jersey REST API clients</description> | ||||
| 	<url>https://bitbucket.org/inteligr8/common-rest-client</url> | ||||
|  | ||||
| 	<licenses> | ||||
| @@ -46,7 +46,7 @@ | ||||
| 		<junit.version>5.7.2</junit.version> | ||||
| 		<spring.version>5.3.27</spring.version> | ||||
| 		<jackson.version>2.15.1</jackson.version> | ||||
| 		<cxf.version>3.5.6</cxf.version> | ||||
| 		<jersey.version>2.39.1</jersey.version> | ||||
| 	</properties> | ||||
|  | ||||
| 	<dependencies> | ||||
| @@ -99,11 +99,33 @@ | ||||
| 			<scope>test</scope> | ||||
| 		</dependency> | ||||
| 		 | ||||
| 		<!-- Apache CXF libraries --> | ||||
| 		<!-- Jersey libraries --> | ||||
| 		<dependency> | ||||
| 			<groupId>org.apache.cxf</groupId> | ||||
| 			<artifactId>cxf-rt-rs-client</artifactId> | ||||
| 			<version>${cxf.version}</version> | ||||
| 			<groupId>org.glassfish.jersey.ext</groupId> | ||||
| 			<artifactId>jersey-proxy-client</artifactId> | ||||
| 			<version>${jersey.version}</version> | ||||
| 		</dependency> | ||||
| 		<dependency> | ||||
| 			<groupId>org.glassfish.jersey.core</groupId> | ||||
| 			<artifactId>jersey-client</artifactId> | ||||
| 			<version>${jersey.version}</version> | ||||
| 		</dependency> | ||||
| 		<dependency> | ||||
| 			<groupId>org.glassfish.jersey.media</groupId> | ||||
| 			<artifactId>jersey-media-multipart</artifactId> | ||||
| 			<version>${jersey.version}</version> | ||||
| 		</dependency> | ||||
| 		<dependency> | ||||
| 			<groupId>org.glassfish.jersey.inject</groupId> | ||||
| 			<artifactId>jersey-hk2</artifactId> | ||||
| 			<version>${jersey.version}</version> | ||||
| 			<scope>test</scope> | ||||
| 		</dependency> | ||||
| 		<dependency> | ||||
| 			<groupId>org.glassfish.jersey.media</groupId> | ||||
| 			<artifactId>jersey-media-json-jackson</artifactId> | ||||
| 			<version>${jersey.version}</version> | ||||
| 			<scope>test</scope> | ||||
| 		</dependency> | ||||
| 	</dependencies> | ||||
| 	 | ||||
| @@ -119,7 +141,7 @@ | ||||
| 						<goals><goal>add-source</goal></goals> | ||||
| 						<configuration> | ||||
| 							<sources> | ||||
| 								<source>src/main/cxf</source> | ||||
| 								<source>src/main/jersey</source> | ||||
| 							</sources> | ||||
| 						</configuration> | ||||
| 					</execution> | ||||
| @@ -128,7 +150,7 @@ | ||||
| 						<goals><goal>add-test-source</goal></goals> | ||||
| 						<configuration> | ||||
| 							<sources> | ||||
| 								<source>src/test/cxf</source> | ||||
| 								<source>src/test/jersey</source> | ||||
| 							</sources> | ||||
| 						</configuration> | ||||
| 					</execution> | ||||
|   | ||||
| @@ -1,142 +0,0 @@ | ||||
| /* | ||||
|  * This program is free software: you can redistribute it and/or modify it | ||||
|  * under the terms of the GNU Lesser General Public License as published by | ||||
|  * the Free Software Foundation, either version 3 of the License, or (at your | ||||
|  * option) any later version. | ||||
|  *  | ||||
|  * This program is distributed in the hope that it will be useful, but WITHOUT | ||||
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||||
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for | ||||
|  * more details. | ||||
|  *  | ||||
|  * You should have received a copy of the GNU General Public License along | ||||
|  * with this program.  If not, see <https://www.gnu.org/licenses/>. | ||||
|  */ | ||||
| package com.inteligr8.rs; | ||||
|  | ||||
| import java.util.LinkedList; | ||||
| import java.util.List; | ||||
|  | ||||
| import javax.annotation.PostConstruct; | ||||
| import javax.ws.rs.ext.RuntimeDelegate; | ||||
|  | ||||
| import org.apache.cxf.BusFactory; | ||||
| import org.apache.cxf.jaxrs.client.JAXRSClientFactory; | ||||
| import org.apache.cxf.jaxrs.client.WebClient; | ||||
| import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
| import org.springframework.beans.factory.annotation.Autowired; | ||||
| import org.springframework.stereotype.Component; | ||||
|  | ||||
| import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; | ||||
|  | ||||
| /** | ||||
|  * A class that provides pre-configured JAX-RS Client & WebTarget & | ||||
|  * CXF WebClient objects. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| @Component("client.cxf") | ||||
| public class ClientCxfImpl extends Client { | ||||
| 	 | ||||
| 	private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class); | ||||
| 	 | ||||
| 	private ClientCxfConfiguration config; | ||||
| 	 | ||||
| 	/** | ||||
| 	 * This constructor is for Spring or POJO use. | ||||
| 	 * @param config The client configuration. | ||||
| 	 */ | ||||
| 	@Autowired | ||||
| 	public ClientCxfImpl(ClientCxfConfiguration config) { | ||||
| 		this.config = config; | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * This method registers the Apache CXF library as the default provider for | ||||
| 	 * the JAX-RS specification. | ||||
| 	 */ | ||||
| 	@PostConstruct | ||||
| 	public void register() { | ||||
| 		if (RuntimeDelegate.getInstance() == null) { | ||||
| 			this.logger.info("Setting JAX-RS runtime delegate to the CXF library"); | ||||
| 			RuntimeDelegate.setInstance(new RuntimeDelegateImpl()); | ||||
| 		} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) { | ||||
| 			this.logger.info("JAX-RS runtime delegate already the CXF library"); | ||||
| 		} else { | ||||
| 			this.logger.warn("Setting JAX-RS runtime delegate to the CXF library; was: " + RuntimeDelegate.getInstance().getClass().getName()); | ||||
| 			RuntimeDelegate.setInstance(new RuntimeDelegateImpl()); | ||||
| 		} | ||||
| 		 | ||||
| 		if (this.logger.isInfoEnabled()) | ||||
| 			this.logger.info("API Base URL: " + this.getConfig().getBaseUrl()); | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @return A CXF client (not JAX-RS). | ||||
| 	 */ | ||||
| 	public WebClient getCxfClient() { | ||||
| 		return this.getCxfClient(null); | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @param authFilter A post-configuration authorization filter. | ||||
| 	 * @return A CXF client (not JAX-RS). | ||||
| 	 */ | ||||
| 	public WebClient getCxfClient(AuthorizationFilter authFilter) { | ||||
| 		List<Object> providersAndFilters = new LinkedList<Object>(); | ||||
| 		providersAndFilters.add(new JacksonJaxbJsonProvider()); | ||||
| 		providersAndFilters.add(new CxfLoggingFilter()); | ||||
| 		providersAndFilters.add(new CxfMultipartProvider()); | ||||
| 		 | ||||
| 		if (authFilter == null) | ||||
| 			authFilter = this.getConfig().createAuthorizationFilter(); | ||||
| 		if (authFilter != null) | ||||
| 			providersAndFilters.add(authFilter); | ||||
| 		 | ||||
| 		this.addProvidersAndFilters(providersAndFilters); | ||||
|  | ||||
| 		// we can't use JAXRSClientFactory with a JAXRS client (duh!) | ||||
| 		// so we need to create a CXF client | ||||
| 		WebClient client = WebClient.create(this.getConfig().getBaseUrl(), providersAndFilters); | ||||
|  | ||||
| 		if (!this.getConfig().isDefaultBusEnabled()) { | ||||
| 			// Some applications (like ACS) add interceptors to the default bus | ||||
| 			// those interceptors may treat all messages as SOAP messages (like ACS), resulting in ClassCastExceptions | ||||
| 			// we need to ignore the default bus | ||||
| 			org.apache.cxf.jaxrs.client.ClientConfiguration config = WebClient.getConfig(client); | ||||
| 			config.setBus(BusFactory.newInstance().createBus()); | ||||
| 		} | ||||
| 		 | ||||
| 		return client; | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @param providersAndFilters A list of JAX-RS and CXF providers. | ||||
| 	 */ | ||||
| 	public void addProvidersAndFilters(List<Object> providersAndFilters) { | ||||
| 		// for extension purposes | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @return The client configuration. | ||||
| 	 */ | ||||
| 	public ClientCxfConfiguration getConfig() { | ||||
| 		return this.config; | ||||
| 	} | ||||
|  | ||||
| 	/** | ||||
| 	 * This method retrieves a JAX-RS implementation of the specified API with | ||||
| 	 * the specified authorization. | ||||
| 	 *  | ||||
| 	 * @param authFilter A dynamic authorization filter. | ||||
| 	 * @param apiClass A JAX-RS annotation API class. | ||||
| 	 * @return An instance of the API class. | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) { | ||||
| 		return JAXRSClientFactory.fromClient(this.getCxfClient(authFilter), apiClass); | ||||
| 	} | ||||
|  | ||||
| } | ||||
| @@ -1,52 +0,0 @@ | ||||
| /* | ||||
|  * This program is free software: you can redistribute it and/or modify it | ||||
|  * under the terms of the GNU Lesser General Public License as published by | ||||
|  * the Free Software Foundation, either version 3 of the License, or (at your | ||||
|  * option) any later version. | ||||
|  *  | ||||
|  * This program is distributed in the hope that it will be useful, but WITHOUT | ||||
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||||
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for | ||||
|  * more details. | ||||
|  *  | ||||
|  * You should have received a copy of the GNU General Public License along | ||||
|  * with this program.  If not, see <https://www.gnu.org/licenses/>. | ||||
|  */ | ||||
| package com.inteligr8.rs; | ||||
|  | ||||
| import java.io.IOException; | ||||
| import java.util.LinkedList; | ||||
| import java.util.List; | ||||
|  | ||||
| import javax.ws.rs.client.ClientRequestContext; | ||||
| import javax.ws.rs.core.MediaType; | ||||
|  | ||||
| import org.apache.cxf.jaxrs.ext.multipart.Attachment; | ||||
| import org.apache.cxf.jaxrs.ext.multipart.MultipartBody; | ||||
| import org.slf4j.Logger; | ||||
|  | ||||
| /** | ||||
|  * This is a CXF specific handling of the logging of multipart requests, which | ||||
|  * would otherwise be ignored by the base LoggingFilter.  It is meant to be | ||||
|  * used for debugging purposes.  When used, it will write to 'jaxrs.request' and | ||||
|  * 'jaxrs.response' loggers at the 'trace' level. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| public class CxfLoggingFilter extends LoggingFilter { | ||||
| 	 | ||||
| 	@Override | ||||
| 	protected void logUnhandledRequest(ClientRequestContext requestContext, Logger logger) throws IOException { | ||||
| 		if (MediaType.MULTIPART_FORM_DATA_TYPE.equals(requestContext.getMediaType())) { | ||||
| 			if (requestContext.getEntity() instanceof MultipartBody) { | ||||
| 				List<String> attIds = new LinkedList<>(); | ||||
| 				for (Attachment att : ((MultipartBody)requestContext.getEntity()).getAllAttachments()) | ||||
| 					attIds.add(att.getContentId()); | ||||
| 				logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(), attIds); | ||||
| 			} else { | ||||
| 				logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri()); | ||||
| 			} | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| } | ||||
| @@ -1,49 +0,0 @@ | ||||
| /* | ||||
|  * This program is free software: you can redistribute it and/or modify it | ||||
|  * under the terms of the GNU Lesser General Public License as published by | ||||
|  * the Free Software Foundation, either version 3 of the License, or (at your | ||||
|  * option) any later version. | ||||
|  *  | ||||
|  * This program is distributed in the hope that it will be useful, but WITHOUT | ||||
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||||
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for | ||||
|  * more details. | ||||
|  *  | ||||
|  * You should have received a copy of the GNU General Public License along | ||||
|  * with this program.  If not, see <https://www.gnu.org/licenses/>. | ||||
|  */ | ||||
| package com.inteligr8.rs; | ||||
|  | ||||
| import java.lang.annotation.Annotation; | ||||
| import java.lang.reflect.Type; | ||||
|  | ||||
| import javax.ws.rs.Consumes; | ||||
| import javax.ws.rs.Produces; | ||||
| import javax.ws.rs.core.MediaType; | ||||
| import javax.ws.rs.ext.Provider; | ||||
|  | ||||
| import org.apache.cxf.jaxrs.ext.multipart.MultipartBody; | ||||
| import org.apache.cxf.jaxrs.provider.MultipartProvider; | ||||
|  | ||||
| /** | ||||
|  * This implements a JAX-RS provider that adds support for the handling of CXF | ||||
|  * MultipartBody. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| @Consumes(MediaType.MULTIPART_FORM_DATA) | ||||
| @Produces(MediaType.MULTIPART_FORM_DATA) | ||||
| @Provider | ||||
| public class CxfMultipartProvider extends MultipartProvider { | ||||
| 	 | ||||
| 	@Override | ||||
| 	public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) { | ||||
| 		return MultipartBody.class.isAssignableFrom(type) || super.isReadable(type, genericType, annotations, mediaType); | ||||
| 	} | ||||
| 	 | ||||
| 	@Override | ||||
| 	public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) { | ||||
| 		return MultipartBody.class.isAssignableFrom(type) || super.isWriteable(type, genericType, annotations, mediaType); | ||||
| 	} | ||||
|  | ||||
| } | ||||
| @@ -18,9 +18,10 @@ import javax.ws.rs.client.ClientBuilder; | ||||
| import javax.ws.rs.client.WebTarget; | ||||
|  | ||||
| import com.fasterxml.jackson.databind.DeserializationFeature; | ||||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||||
| import com.fasterxml.jackson.databind.SerializationFeature; | ||||
| import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; | ||||
| import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; | ||||
| import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider; | ||||
|  | ||||
| /** | ||||
|  * A class that provides pre-configured JAX-RS Client & WebTarget objects. | ||||
| @@ -66,7 +67,12 @@ public abstract class Client { | ||||
| 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization. | ||||
| 	 */ | ||||
| 	public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) { | ||||
| 		JacksonJsonProvider provider = new JacksonJaxbJsonProvider(); | ||||
| 	    ObjectMapper om = new ObjectMapper(); | ||||
| 	    om.registerModules(new JavaTimeModule()); | ||||
| 	    this.getConfig().configureJacksonMapper(om); | ||||
| 	     | ||||
| 	    JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS); | ||||
| 		this.getConfig().configureJacksonProvider(provider); | ||||
|          | ||||
| 		if (this.getConfig().isWrapRootValueEnabled()) | ||||
| 			provider.enable(SerializationFeature.WRAP_ROOT_VALUE); | ||||
| @@ -82,16 +88,17 @@ public abstract class Client { | ||||
| 		if (authFilter != null) | ||||
| 			clientBuilder.register(authFilter); | ||||
| 		this.buildClient(clientBuilder); | ||||
| 		this.getConfig().configureClient(clientBuilder); | ||||
| 		 | ||||
| 		return clientBuilder.build(); | ||||
| 	} | ||||
|      | ||||
| 	/** | ||||
| 	 * @param clientBuilder A client builder | ||||
| 	 */ | ||||
| 	public void buildClient(ClientBuilder clientBuilder) { | ||||
| 		// for extension purposes | ||||
| 	} | ||||
|     /** | ||||
|      * @param clientBuilder A client builder | ||||
|      */ | ||||
|     public void buildClient(ClientBuilder clientBuilder) { | ||||
|         // for extension purposes | ||||
|     } | ||||
|  | ||||
| 	/** | ||||
| 	 * @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization. | ||||
|   | ||||
| @@ -16,6 +16,11 @@ package com.inteligr8.rs; | ||||
|  | ||||
| import java.net.URI; | ||||
|  | ||||
| import javax.ws.rs.client.ClientBuilder; | ||||
|  | ||||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||||
| import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; | ||||
|  | ||||
| /** | ||||
|  * This interface defines the configurable parameters of the clients; primarily | ||||
|  * their default authentication and authorization. | ||||
| @@ -129,6 +134,18 @@ public interface ClientConfiguration { | ||||
| 		return false; | ||||
| 	} | ||||
|      | ||||
|     /** | ||||
|      * @param mapper A Jackson object mapper to configure. | ||||
|      */ | ||||
|     default void configureJacksonMapper(ObjectMapper mapper) { | ||||
|     } | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @param provider A Jackson JAX-RS provider to configure. | ||||
| 	 */ | ||||
| 	default void configureJacksonProvider(JacksonJaxbJsonProvider provider) { | ||||
| 	} | ||||
| 	 | ||||
| 	 | ||||
|  | ||||
| 	/** | ||||
| @@ -170,4 +187,12 @@ public interface ClientConfiguration { | ||||
| 		} | ||||
| 	} | ||||
|      | ||||
|     /** | ||||
|      * A Jackson provider, logging filter, and authentication filter are already registered. | ||||
|      *  | ||||
|      * @param clientBuilder A JAX-RS client builder to configure. | ||||
|      */ | ||||
|     default void configureClient(ClientBuilder clientBuilder) { | ||||
|     } | ||||
|  | ||||
| } | ||||
|   | ||||
							
								
								
									
										83
									
								
								src/main/java/com/inteligr8/rs/ClientImpl.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										83
									
								
								src/main/java/com/inteligr8/rs/ClientImpl.java
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,83 @@ | ||||
| /* | ||||
|  * This program is free software: you can redistribute it and/or modify it | ||||
|  * under the terms of the GNU Lesser General Public License as published by | ||||
|  * the Free Software Foundation, either version 3 of the License, or (at your | ||||
|  * option) any later version. | ||||
|  *  | ||||
|  * This program is distributed in the hope that it will be useful, but WITHOUT | ||||
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||||
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for | ||||
|  * more details. | ||||
|  *  | ||||
|  * You should have received a copy of the GNU General Public License along | ||||
|  * with this program.  If not, see <https://www.gnu.org/licenses/>. | ||||
|  */ | ||||
| package com.inteligr8.rs; | ||||
|  | ||||
| import javax.annotation.PostConstruct; | ||||
| import javax.ws.rs.client.ClientBuilder; | ||||
|  | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
| import org.springframework.beans.factory.annotation.Autowired; | ||||
| import org.springframework.stereotype.Component; | ||||
|  | ||||
| /** | ||||
|  * A class that provides pre-configured JAX-RS Client & WebTarget objects | ||||
|  * for Jersey. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| @Component("client.jaxrs") | ||||
| public class ClientImpl extends Client { | ||||
| 	 | ||||
| 	private final Logger logger = LoggerFactory.getLogger(ClientImpl.class); | ||||
| 	 | ||||
| 	private ClientConfiguration config; | ||||
| 	 | ||||
| 	/** | ||||
| 	 * This constructor is for Spring or POJO use. | ||||
| 	 * @param config The client configuration. | ||||
| 	 */ | ||||
| 	@Autowired | ||||
| 	public ClientImpl(ClientConfiguration config) { | ||||
| 		this.config = config; | ||||
| 	} | ||||
|  | ||||
| 	/** | ||||
| 	 * This method registers the Jersey library as the default provider for the | ||||
| 	 * JAX-RS specification. | ||||
| 	 */ | ||||
| 	@PostConstruct | ||||
| 	public void register() { | ||||
| 		this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl()); | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @param clientBuilder A client builder. | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public void buildClient(ClientBuilder clientBuilder) { | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @return The client configuration. | ||||
| 	 */ | ||||
| 	public ClientConfiguration getConfig() { | ||||
| 		return this.config; | ||||
| 	} | ||||
|  | ||||
| 	/** | ||||
| 	 * This method retrieves a JAX-RS implementation of the specified API with | ||||
| 	 * the specified authorization. | ||||
| 	 *  | ||||
| 	 * @param authFilter A dynamic authorization filter. | ||||
| 	 * @param apiClass A JAX-RS annotation API class. | ||||
| 	 * @return An instance of the API class. | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) { | ||||
| 		throw new UnsupportedOperationException(); | ||||
| 	} | ||||
|  | ||||
| } | ||||
| @@ -58,7 +58,7 @@ public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter | ||||
| 				logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(), | ||||
| 						((Form)requestContext.getEntity()).asMap()); | ||||
| 			} else { | ||||
| 				this.loggerRequest.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri()); | ||||
| 				logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri()); | ||||
| 			} | ||||
| 		} else { | ||||
| 			this.logUnhandledRequest(requestContext, logger); | ||||
|   | ||||
| @@ -74,11 +74,15 @@ public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizatio | ||||
| 	 | ||||
| 	@Override | ||||
| 	protected Form createForm() { | ||||
| 		Form form = new Form().param("grant_type", "authorization_code") | ||||
| 				.param("code", this.code); | ||||
| 		Form form = new Form().param("grant_type", "authorization_code"); | ||||
| 		if (this.redirectUri != null) | ||||
| 			form.param("redirect_uri", this.redirectUri.toString()); | ||||
| 		return form; | ||||
| 	} | ||||
| 	 | ||||
| 	@Override | ||||
| 	protected void extendFormSensitive(Form form) { | ||||
| 	    form.param("code", this.code); | ||||
| 	} | ||||
|  | ||||
| } | ||||
|   | ||||
| @@ -17,12 +17,18 @@ package com.inteligr8.rs; | ||||
| import java.util.Map; | ||||
|  | ||||
| import javax.ws.rs.WebApplicationException; | ||||
| import javax.ws.rs.client.Client; | ||||
| import javax.ws.rs.client.ClientBuilder; | ||||
| import javax.ws.rs.client.ClientRequestContext; | ||||
| import javax.ws.rs.client.Entity; | ||||
| import javax.ws.rs.client.WebTarget; | ||||
| import javax.ws.rs.core.Form; | ||||
| import javax.ws.rs.core.HttpHeaders; | ||||
| import javax.ws.rs.core.Response; | ||||
| import javax.ws.rs.core.Response.Status.Family; | ||||
|  | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
|  | ||||
| import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; | ||||
|  | ||||
| @@ -33,6 +39,8 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; | ||||
|  */ | ||||
| public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { | ||||
| 	 | ||||
|     private final Logger logger = LoggerFactory.getLogger(this.getClass()); | ||||
|      | ||||
| 	private final String tokenUrl; | ||||
| 	private final String clientId; | ||||
| 	private final String clientSecret; | ||||
| @@ -40,6 +48,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { | ||||
| 	private String accessToken; | ||||
| 	private long expiration; | ||||
| 	private String refreshToken; | ||||
| 	private Long refreshTokenExpiration; | ||||
| 	 | ||||
| 	/** | ||||
| 	 * This constructor creates an OAuth-based authorization filter using the | ||||
| @@ -91,8 +100,29 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public void filter(ClientRequestContext requestContext) { | ||||
| 		if (this.accessToken == null || System.currentTimeMillis() > this.expiration) | ||||
| 			this.requestToken(); | ||||
| 		if (this.accessToken == null) { | ||||
| 		    this.requestToken(); | ||||
| 		} else if (System.currentTimeMillis() >= this.expiration) { | ||||
|             this.logger.trace("Access token expired; retrieving new one with refresh token"); | ||||
|              | ||||
| 		    if (this.refreshTokenExpiration != null && System.currentTimeMillis() >= this.refreshTokenExpiration.longValue()) { | ||||
|                 this.logger.debug("Refresh token expired; performing full authentication"); | ||||
|                 this.refreshToken = null; | ||||
|                 this.requestToken(); | ||||
| 		    } else { | ||||
|     		    try { | ||||
|     		        this.requestToken(); | ||||
|                 } catch (WebApplicationException wae) { | ||||
|                     if (wae.getResponse().getStatusInfo().getFamily() == Family.CLIENT_ERROR) { | ||||
|                         this.logger.debug("Received OAuth response {} using refresh token; performing full authentication", wae.getResponse().getStatus()); | ||||
|                         this.refreshToken = null; | ||||
|                         this.requestToken(); | ||||
|                     } else { | ||||
|                         throw wae; | ||||
|                     } | ||||
|                 } | ||||
| 		    } | ||||
| 		} | ||||
| 		 | ||||
| 		requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken); | ||||
| 	} | ||||
| @@ -111,29 +141,53 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { | ||||
| 		} | ||||
|  | ||||
| 		form.param("client_id", this.clientId); | ||||
| 		if (this.clientSecret != null) | ||||
| 			form.param("client_secret", this.clientSecret); | ||||
| 		if (this.scope != null) | ||||
| 			form.param("scope", this.scope); | ||||
| 		this.extendRefreshTokenForm(form); | ||||
| 		 | ||||
| 		this.logger.trace("Sending OAuth request: {}", form); | ||||
| 		 | ||||
| 		if (this.refreshToken != null) { | ||||
| 		    this.extendRefreshFormSensitive(form); | ||||
| 		} else { | ||||
|             this.extendFormSensitive(form); | ||||
| 		} | ||||
|  | ||||
|         if (this.clientSecret != null) | ||||
|             form.param("client_secret", this.clientSecret); | ||||
| 		 | ||||
| 		Entity<Form> entity = Entity.form(form); | ||||
| 		 | ||||
| 		WebTarget target = ClientBuilder.newBuilder() | ||||
| 				.register(new JacksonJaxbJsonProvider()) | ||||
| 				.build() | ||||
| 				.target(this.tokenUrl); | ||||
| 		Client client = ClientBuilder.newBuilder() | ||||
|                 .register(new JacksonJaxbJsonProvider()) | ||||
|                 .build(); | ||||
| 		WebTarget target = client.target(this.tokenUrl); | ||||
| 		 | ||||
| 		@SuppressWarnings("unchecked") | ||||
| 		Map<String, Object> response = target.request().post(entity, Map.class); | ||||
| 		long requestSendTime = System.currentTimeMillis(); | ||||
|  | ||||
| 		if (response.containsKey("error")) | ||||
| 			throw new WebApplicationException((String)response.get("error"), 400); | ||||
| 		Response response = target.request().post(entity); | ||||
| 		 | ||||
| 		this.accessToken = (String)response.get("access_token"); | ||||
| 		this.expiration = System.currentTimeMillis() + ((Number)response.get("expires_in")).longValue() * 1000L; | ||||
| 		this.refreshToken = (String)response.get("refresh_token"); | ||||
| 		this.extendRefreshTokenResponse(response); | ||||
|         this.logger.debug("Received OAuth response: {}", response.getStatus()); | ||||
|  | ||||
|         @SuppressWarnings("unchecked") | ||||
|         Map<String, Object> responseMap = response.readEntity(Map.class); | ||||
|  | ||||
|         this.logger.trace("Received OAuth response: {}", responseMap); | ||||
| 		 | ||||
| 		if (response.getStatusInfo().getFamily() != Family.SUCCESSFUL) { | ||||
|             String code = (String) responseMap.get("error"); | ||||
|             if (code != null) { | ||||
|                 String description = (String) responseMap.get("error_description"); | ||||
|     			throw new WebApplicationException(code + ": " + description, response.getStatus()); | ||||
|             } else { | ||||
|                 throw new WebApplicationException(response); | ||||
|             } | ||||
| 		} | ||||
| 		 | ||||
| 		this.accessToken = (String)responseMap.get("access_token"); | ||||
| 		this.expiration = requestSendTime + ((Number)responseMap.get("expires_in")).longValue() * 1000L; | ||||
| 		this.refreshToken = (String)responseMap.get("refresh_token"); | ||||
| 		if (responseMap.containsKey("refresh_token_expires_in")) | ||||
| 		    this.refreshTokenExpiration = requestSendTime + ((Number)responseMap.get("refresh_token_expires_in")).longValue() * 1000L; | ||||
| 	} | ||||
| 	 | ||||
| 	protected Form createRefreshForm() { | ||||
| @@ -143,10 +197,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { | ||||
| 	 | ||||
| 	protected abstract Form createForm(); | ||||
| 	 | ||||
| 	protected void extendRefreshTokenForm(Form form) { | ||||
| 	protected void extendRefreshFormSensitive(Form form) { | ||||
| 	} | ||||
|  | ||||
| 	protected void extendRefreshTokenResponse(Map<String, Object> response) { | ||||
| 	} | ||||
|     protected abstract void extendFormSensitive(Form form); | ||||
|  | ||||
| } | ||||
|   | ||||
| @@ -38,4 +38,8 @@ public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorization | ||||
| 		return new Form().param("grant_type", "client_credentials"); | ||||
| 	} | ||||
| 	 | ||||
| 	@Override | ||||
| 	protected void extendFormSensitive(Form form) { | ||||
| 	} | ||||
|  | ||||
| } | ||||
|   | ||||
| @@ -53,8 +53,12 @@ public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFil | ||||
| 	@Override | ||||
| 	protected Form createForm() { | ||||
| 		return new Form().param("grant_type", "password") | ||||
| 				.param("username", this.username) | ||||
| 				.param("password", this.password); | ||||
| 				.param("username", this.username); | ||||
| 	} | ||||
| 	 | ||||
| 	@Override | ||||
| 	protected void extendFormSensitive(Form form) { | ||||
| 	    form.param("password", this.password); | ||||
| 	} | ||||
|  | ||||
| } | ||||
|   | ||||
| @@ -15,23 +15,20 @@ | ||||
| package com.inteligr8.rs; | ||||
| 
 | ||||
| /** | ||||
|  * This interface defines additional configurations specific to the Apache CXF | ||||
|  * This interface defines additional configurations specific to the Jersey | ||||
|  * JAX-RS library and its nuances. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| public interface ClientCxfConfiguration extends ClientConfiguration { | ||||
| public interface ClientJerseyConfiguration extends ClientConfiguration { | ||||
| 	 | ||||
| 	/** | ||||
| 	 * Apache CXF uses a global bus configuration where interceptors could | ||||
| 	 * wreck havoc on your implementation.  This method allows you to | ||||
| 	 * explicitly by-pass the default bus. | ||||
| 	 * Jersey is automatically strict in its adherence to the ReST API | ||||
| 	 * specifications.  It requires a body to PUT calls by default. | ||||
| 	 *  | ||||
| 	 * See https://cxf.apache.org/docs/bus-configuration.html. | ||||
| 	 *  | ||||
| 	 * @return true to use the default bus; false otherwise. | ||||
| 	 * @return true to require body in PUT calls; false to make it optional | ||||
| 	 */ | ||||
| 	default boolean isDefaultBusEnabled() { | ||||
| 	default boolean isPutBodyRequired() { | ||||
| 		return true; | ||||
| 	} | ||||
| 
 | ||||
							
								
								
									
										105
									
								
								src/main/jersey/com/inteligr8/rs/ClientJerseyImpl.java
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										105
									
								
								src/main/jersey/com/inteligr8/rs/ClientJerseyImpl.java
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,105 @@ | ||||
| /* | ||||
|  * This program is free software: you can redistribute it and/or modify it | ||||
|  * under the terms of the GNU Lesser General Public License as published by | ||||
|  * the Free Software Foundation, either version 3 of the License, or (at your | ||||
|  * option) any later version. | ||||
|  *  | ||||
|  * This program is distributed in the hope that it will be useful, but WITHOUT | ||||
|  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||||
|  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for | ||||
|  * more details. | ||||
|  *  | ||||
|  * You should have received a copy of the GNU General Public License along | ||||
|  * with this program.  If not, see <https://www.gnu.org/licenses/>. | ||||
|  */ | ||||
| package com.inteligr8.rs; | ||||
|  | ||||
| import javax.annotation.PostConstruct; | ||||
| import javax.ws.rs.client.ClientBuilder; | ||||
| import javax.ws.rs.ext.RuntimeDelegate; | ||||
|  | ||||
| import org.glassfish.jersey.client.ClientProperties; | ||||
| import org.glassfish.jersey.client.proxy.WebResourceFactory; | ||||
| import org.glassfish.jersey.internal.RuntimeDelegateImpl; | ||||
| import org.glassfish.jersey.media.multipart.MultiPartFeature; | ||||
| import org.slf4j.Logger; | ||||
| import org.slf4j.LoggerFactory; | ||||
| import org.springframework.beans.factory.annotation.Autowired; | ||||
| import org.springframework.stereotype.Component; | ||||
|  | ||||
| /** | ||||
|  * A class that provides pre-configured JAX-RS Client & WebTarget objects | ||||
|  * for Jersey. | ||||
|  *  | ||||
|  * @author brian@inteligr8.com | ||||
|  */ | ||||
| @Component("client.jersey") | ||||
| public class ClientJerseyImpl extends Client { | ||||
| 	 | ||||
| 	private final Logger logger = LoggerFactory.getLogger(ClientJerseyImpl.class); | ||||
| 	 | ||||
| 	private ClientJerseyConfiguration config; | ||||
| 	 | ||||
| 	/** | ||||
| 	 * This constructor is for Spring or POJO use. | ||||
| 	 * @param config The client configuration. | ||||
| 	 */ | ||||
| 	@Autowired | ||||
| 	public ClientJerseyImpl(ClientJerseyConfiguration config) { | ||||
| 		this.config = config; | ||||
| 	} | ||||
|  | ||||
| 	/** | ||||
| 	 * This method registers the Jersey library as the default provider for the | ||||
| 	 * JAX-RS specification. | ||||
| 	 */ | ||||
| 	@PostConstruct | ||||
| 	public void register() { | ||||
| 		if (RuntimeDelegate.getInstance() == null) { | ||||
| 			this.logger.info("Setting JAX-RS runtime delegate to the Jersey library"); | ||||
| 			RuntimeDelegate.setInstance(new RuntimeDelegateImpl()); | ||||
| 		} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) { | ||||
| 			this.logger.info("JAX-RS runtime delegate already the Jersey library"); | ||||
| 		} else { | ||||
| 			this.logger.warn("Setting JAX-RS runtime delegate to the Jersey library; was: " + RuntimeDelegate.getInstance().getClass().getName()); | ||||
| 			RuntimeDelegate.setInstance(new RuntimeDelegateImpl()); | ||||
| 		} | ||||
| 		 | ||||
| 		if (this.logger.isInfoEnabled()) | ||||
| 			this.logger.info("API Base URL: " + this.getConfig().getBaseUrl()); | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @param clientBuilder A client builder. | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public void buildClient(ClientBuilder clientBuilder) { | ||||
| 		clientBuilder.register(MultiPartFeature.class); | ||||
|  | ||||
| 		if (!this.getConfig().isPutBodyRequired()) { | ||||
| 			// allow PUT operations without body data | ||||
| 			clientBuilder.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true); | ||||
| 		} | ||||
| 	} | ||||
| 	 | ||||
| 	/** | ||||
| 	 * @return The client configuration. | ||||
| 	 */ | ||||
| 	public ClientJerseyConfiguration getConfig() { | ||||
| 		return this.config; | ||||
| 	} | ||||
|  | ||||
| 	/** | ||||
| 	 * This method retrieves a JAX-RS implementation of the specified API with | ||||
| 	 * the specified authorization. | ||||
| 	 *  | ||||
| 	 * @param authFilter A dynamic authorization filter. | ||||
| 	 * @param apiClass A JAX-RS annotation API class. | ||||
| 	 * @return An instance of the API class. | ||||
| 	 */ | ||||
| 	@Override | ||||
| 	public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) { | ||||
| 		return WebResourceFactory.newResource(apiClass, this.getTarget(authFilter)); | ||||
| 	} | ||||
|  | ||||
| } | ||||
		Reference in New Issue
	
	Block a user