oauth.signpost.impl.DefaultOAuthConsumer.java Source code

Introduction

Here is the source code for oauth.signpost.impl.DefaultOAuthConsumer.java

Source

/* Copyright (c) 2009 Matthias Kaeppler
 *
 * 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 oauth.signpost.impl;

import java.util.HashMap;
import java.util.Map;

import oauth.signpost.OAuth;
import oauth.signpost.OAuthConsumer;
import oauth.signpost.exception.OAuthExpectationFailedException;
import oauth.signpost.exception.OAuthMessageSignerException;
import oauth.signpost.signature.OAuthMessageSigner;
import oauth.signpost.signature.SignatureMethod;

import org.apache.http.Header;
import org.apache.http.HttpRequest;
import org.apache.http.message.BasicHeader;

public class DefaultOAuthConsumer implements OAuthConsumer {

    private String consumerKey, consumerSecret;

    private String token;

    private SignatureMethod signatureMethod;

    private OAuthMessageSigner messageSigner;

    public DefaultOAuthConsumer(String consumerKey, String consumerSecret, SignatureMethod signatureMethod) {

        this.consumerKey = consumerKey;
        this.consumerSecret = consumerSecret;
        this.signatureMethod = signatureMethod;
        this.messageSigner = OAuthMessageSigner.create(signatureMethod);
        messageSigner.setConsumerSecret(consumerSecret);
    }

    public HttpRequest sign(HttpRequest request)
            throws OAuthMessageSignerException, OAuthExpectationFailedException {

        if (consumerKey == null) {
            throw new OAuthExpectationFailedException("consumer key not set");
        }
        if (consumerSecret == null) {
            throw new OAuthExpectationFailedException("consumer secret not set");
        }

        Map<String, String> oauthParams = buildOAuthParameterMap();

        String signature = messageSigner.sign(request, oauthParams);

        request.setHeader(buildOAuthHeader(oauthParams, signature));

        return request;
    }

    public void setTokenWithSecret(String token, String tokenSecret) {
        this.token = token;
        messageSigner.setTokenSecret(tokenSecret);
    }

    public String getToken() {
        return token;
    }

    public String getTokenSecret() {
        return messageSigner.getTokenSecret();
    }

    public String getConsumerKey() {
        return this.consumerKey;
    }

    public String getConsumerSecret() {
        return this.consumerSecret;
    }

    private Map<String, String> buildOAuthParameterMap() {
        HashMap<String, String> map = new HashMap<String, String>();

        map.put(OAuth.OAUTH_CONSUMER_KEY, consumerKey);
        map.put(OAuth.OAUTH_SIGNATURE_METHOD, signatureMethod.toString());
        map.put(OAuth.OAUTH_TIMESTAMP, Long.toString(System.currentTimeMillis() / 1000L));
        map.put(OAuth.OAUTH_NONCE, Long.toString(System.nanoTime()));
        map.put(OAuth.OAUTH_VERSION, OAuth.VERSION_1_0);
        if (token != null) {
            map.put(OAuth.OAUTH_TOKEN, token);
        }
        return map;
    }

    private Header buildOAuthHeader(Map<String, String> oauthParams, String signature) {

        StringBuilder sb = new StringBuilder();

        sb.append("OAuth ");

        for (String key : oauthParams.keySet()) {
            String value = oauthParams.get(key);
            sb.append(oauthHeaderElement(key, value));
            sb.append(",");
        }

        sb.append(oauthHeaderElement(OAuth.OAUTH_SIGNATURE, signature));

        return new BasicHeader(OAuth.HTTP_AUTHORIZATION_HEADER, sb.toString());
    }

    private String oauthHeaderElement(String name, String value) {
        return OAuth.percentEncode(name) + "=\"" + OAuth.percentEncode(value) + "\"";
    }
}