com.intuit.ipp.security.OAuthAuthorizer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ipp-v3-java-devkit Show documentation
IPP Java V3 DevKit Project - Core
The newest version!
/*******************************************************************************
 * Copyright (c) 2017 Intuit
 *
 * 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 com.intuit.ipp.security;

import java.net.HttpURLConnection;
import oauth.signpost.OAuthConsumer;
import oauth.signpost.basic.DefaultOAuthConsumer;
import oauth.signpost.commonshttp.CommonsHttpOAuthConsumer;
import oauth.signpost.exception.OAuthCommunicationException;
import oauth.signpost.exception.OAuthExpectationFailedException;
import oauth.signpost.exception.OAuthMessageSignerException;
import oauth.signpost.signature.AuthorizationHeaderSigningStrategy;

import org.apache.http.client.methods.HttpRequestBase;

import com.intuit.ipp.exception.FMSException;
import com.intuit.ipp.interceptors.HTTPURLConnectionInterceptor;
import com.intuit.ipp.util.Config;
import com.intuit.ipp.util.StringUtils;

/**
 * This class will sign the http request using oAuth credentials
 */
public class OAuthAuthorizer implements IAuthorizer {

	/**
	 * variable oAuthConsumer
	 */
	private OAuthConsumer oAuthConsumer;

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void authorize(HttpRequestBase httpRequest) throws FMSException {
		try {
			oAuthConsumer.sign(httpRequest);
		} catch (OAuthMessageSignerException e) {
			throw new FMSException(e);
		} catch (OAuthExpectationFailedException e) {
			throw new FMSException(e);
		} catch (OAuthCommunicationException e) {
			throw new FMSException(e);
		}
	}
	@Override
	public void authorize(HttpURLConnection httpUrlConnection) throws FMSException {
		try {
			oAuthConsumer.sign(httpUrlConnection);
		} catch (OAuthMessageSignerException e) {
			throw new FMSException(e);
		} catch (OAuthExpectationFailedException e) {
			throw new FMSException(e);
		} catch (OAuthCommunicationException e) {
			throw new FMSException(e);
		}		
	}

	/**
	 * This is a private constructor which creates the oAuthConsumer object
	 * 
	 * @param consumerKey
	 *            the consumer key
	 * @param consumerSecret
	 *            the consumer secret
	 */
	private OAuthAuthorizer(String consumerKey, String consumerSecret) {
		String httpTransport = Config.getProperty(Config.HTTP_TRANSPORT);
		if (StringUtils.hasText(httpTransport) && httpTransport.equals(HTTPURLConnectionInterceptor.HTTP_URL_CONNECTION)) {
		oAuthConsumer = new DefaultOAuthConsumer(consumerKey, consumerSecret);
		}else
		{
		oAuthConsumer = new CommonsHttpOAuthConsumer(consumerKey, consumerSecret);
		}
	}

	/**
	 * To create the oAuth authorizer object
	 * 
	 * @param consumerKey the consumer key
	 * @param consumerSecret the consumer secret
	 * @param accessToken the access token
	 * @param accessTokenSecret the access token secret
	 */
	public OAuthAuthorizer(String consumerKey, String consumerSecret, String accessToken, String accessTokenSecret) {
		this(trim(consumerKey), trim(consumerSecret));
		oAuthConsumer.setTokenWithSecret(trim(accessToken), trim(accessTokenSecret));
		oAuthConsumer.setSigningStrategy(new AuthorizationHeaderSigningStrategy());
	}
	
	private static String trim(String key) {
		if (key == null) {
            return null;
        }
		return key.trim();
	}

}