org.springframework.social.oauth2.AbstractOAuth2ApiBinding Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2015 the original author or authors.
*
* Licensed 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.springframework.social.oauth2;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.converter.ByteArrayHttpMessageConverter;
import org.springframework.http.converter.FormHttpMessageConverter;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.ResourceHttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.social.ApiBinding;
import org.springframework.social.support.ClientHttpRequestFactorySelector;
import org.springframework.web.client.RestTemplate;
/**
* Base class for OAuth 2-based provider API bindings.
* @author Craig Walls
* @author Greg Turnquist
*/
public abstract class AbstractOAuth2ApiBinding implements ApiBinding, InitializingBean {
private final String accessToken;
private RestTemplate restTemplate;
/**
* Constructs the API template without user authorization. This is useful for accessing operations on a provider's API that do not require user authorization.
*/
protected AbstractOAuth2ApiBinding() {
accessToken = null;
restTemplate = createRestTemplateWithCulledMessageConverters();
configureRestTemplate(restTemplate);
}
/**
* Constructs the API template with OAuth credentials necessary to perform operations on behalf of a user.
* @param accessToken the access token
*/
protected AbstractOAuth2ApiBinding(String accessToken) {
this(accessToken, TokenStrategy.AUTHORIZATION_HEADER);
}
/**
* Constructs the API template with OAuth credentials necessary to perform operations on behalf of a user.
* @param accessToken the access token
* @param tokenStrategy Specifies how access tokens are sent on API requests. Defaults to sending them in Authorization header.
*/
protected AbstractOAuth2ApiBinding(String accessToken, TokenStrategy tokenStrategy) {
this.accessToken = accessToken;
restTemplate = createRestTemplate(accessToken, getOAuth2Version(), tokenStrategy);
configureRestTemplate(restTemplate);
}
/**
* Set the ClientHttpRequestFactory. This is useful when custom configuration of the request factory is required, such as configuring custom SSL details.
* @param requestFactory the request factory
*/
public void setRequestFactory(ClientHttpRequestFactory requestFactory) {
restTemplate.setRequestFactory(requestFactory);
}
// implementing ApiBinding
public boolean isAuthorized() {
return accessToken != null;
}
// public implementation operations
/**
* Obtains a reference to the REST client backing this API binding and used to perform API calls.
* Callers may use the RestTemplate to invoke other API operations not yet modeled by the binding interface.
* Callers may also modify the configuration of the RestTemplate to support unit testing the API binding with a mock server in a test environment.
* During construction, subclasses may apply customizations to the RestTemplate needed to invoke a specific API.
* @see RestTemplate#setMessageConverters(java.util.List)
* @see RestTemplate#setErrorHandler(org.springframework.web.client.ResponseErrorHandler)
* @return a reference to the {@link RestTemplate} that backs this API binding.
*/
public RestTemplate getRestTemplate() {
return restTemplate;
}
// subclassing hooks
/**
* Returns the version of OAuth2 the API implements.
* By default, returns {@link OAuth2Version#BEARER} indicating versions of OAuth2 that apply the bearer token scheme.
* Subclasses may override to return another version.
* @see OAuth2Version
* @return the version of OAuth 2 in play.
*/
protected OAuth2Version getOAuth2Version() {
return OAuth2Version.BEARER;
}
/**
* Subclassing hook to enable customization of the RestTemplate used to consume provider API resources.
* An example use case might be to configure a custom error handler.
* Note that this method is called after the RestTemplate has been configured with the message converters returned from getMessageConverters().
* @param restTemplate the RestTemplate to configure.
*/
protected void configureRestTemplate(RestTemplate restTemplate) {
}
/**
* Returns a list of {@link HttpMessageConverter}s to be used by the internal {@link RestTemplate}.
* By default, this includes a {@link StringHttpMessageConverter}, a {@link MappingJackson2HttpMessageConverter}, a {@link ByteArrayHttpMessageConverter}, and a {@link FormHttpMessageConverter}.
* The {@link FormHttpMessageConverter} is set to use "UTF-8" character encoding.
* Override this method to add additional message converters or to replace the default list of message converters.
* @return a list of message converters to be used by RestTemplate
*/
protected List> getMessageConverters() {
List> messageConverters = new ArrayList>();
messageConverters.add(new StringHttpMessageConverter());
messageConverters.add(getFormMessageConverter());
messageConverters.add(getJsonMessageConverter());
messageConverters.add(getByteArrayMessageConverter());
return messageConverters;
}
/**
* Returns an {@link FormHttpMessageConverter} to be used by the internal {@link RestTemplate}.
* By default, the message converter is set to use "UTF-8" character encoding.
* Override to customize the message converter (for example, to set supported media types or message converters for the parts of a multipart message).
* To remove/replace this or any of the other message converters that are registered by default, override the getMessageConverters() method instead.
* @return an {@link FormHttpMessageConverter} to be used by the internal {@link RestTemplate}.
*/
protected FormHttpMessageConverter getFormMessageConverter() {
FormHttpMessageConverter converter = new FormHttpMessageConverter();
converter.setCharset(Charset.forName("UTF-8"));
List> partConverters = new ArrayList>();
partConverters.add(new ByteArrayHttpMessageConverter());
StringHttpMessageConverter stringHttpMessageConverter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
stringHttpMessageConverter.setWriteAcceptCharset(false);
partConverters.add(stringHttpMessageConverter);
partConverters.add(new ResourceHttpMessageConverter());
converter.setPartConverters(partConverters);
return converter;
}
/**
* Returns a {@link MappingJackson2HttpMessageConverter} to be used by the internal {@link RestTemplate}.
* Override to customize the message converter (for example, to set a custom object mapper or supported media types).
* To remove/replace this or any of the other message converters that are registered by default, override the getMessageConverters() method instead.
* @return a {@link MappingJackson2HttpMessageConverter} to be used by the internal {@link RestTemplate}.
*/
protected MappingJackson2HttpMessageConverter getJsonMessageConverter() {
return new MappingJackson2HttpMessageConverter();
}
/**
* Returns a {@link ByteArrayHttpMessageConverter} to be used by the internal {@link RestTemplate} when consuming image or other binary resources.
* By default, the message converter supports "image/jpeg", "image/gif", and "image/png" media types.
* Override to customize the message converter (for example, to set supported media types).
* To remove/replace this or any of the other message converters that are registered by default, override the getMessageConverters() method instead.
* @return a {@link ByteArrayHttpMessageConverter} to be used by the internal {@link RestTemplate} when consuming image or other binary resources.
*/
protected ByteArrayHttpMessageConverter getByteArrayMessageConverter() {
ByteArrayHttpMessageConverter converter = new ByteArrayHttpMessageConverter();
converter.setSupportedMediaTypes(Arrays.asList(MediaType.IMAGE_JPEG, MediaType.IMAGE_GIF, MediaType.IMAGE_PNG));
return converter;
}
private RestTemplate createRestTemplate(String accessToken, OAuth2Version version, TokenStrategy tokenStrategy) {
RestTemplate client = createRestTemplateWithCulledMessageConverters();
ClientHttpRequestInterceptor interceptor = tokenStrategy.interceptor(accessToken, version);
List interceptors = new LinkedList();
interceptors.add(interceptor);
client.setInterceptors(interceptors);
return client;
}
// Temporary: The RestTemplate that accepts a list of message converters wasn't added until Spring 3.2.7.
// Remove this method and use that constructor exclusively when 3.1.x support is no longer necessary (Spring Social 2.0).
private RestTemplate createRestTemplateWithCulledMessageConverters() {
RestTemplate client;
List> messageConverters = getMessageConverters();
try {
client = new RestTemplate(messageConverters);
} catch (NoSuchMethodError e) {
client = new RestTemplate();
client.setMessageConverters(messageConverters);
}
client.setRequestFactory(ClientHttpRequestFactorySelector.getRequestFactory());
return client;
}
/**
* After construction, include option to decorate the {@link RestTemplate} followed by an optional
* configuration step. Many providers initialize sub-APIs, and this provides a convenient hook.
* @throws Exception if any error occurs decorating the RestTemplate
*/
@Override
public void afterPropertiesSet() throws Exception {
this.restTemplate = postProcess(this.restTemplate);
postConstructionConfiguration();
}
/**
* Extensible hook to decorate {@link RestTemplate} or wrap it with a proxy of any type. By default, it just passes it through with no changes.
*
* @param restTemplate the RestTemplate to decorate
* @return the decorated RestTemplate
*/
protected RestTemplate postProcess(RestTemplate restTemplate) {
return restTemplate;
}
/**
* An extension point to perform key initialization after everything is configured. Existing providers
* are encouraged to migrate any form of constructor-based initialization into this method.
*
* NOTE: To not break backwards compatibility, this method defaults to doing nothing.
*/
protected void postConstructionConfiguration() {
}
}