Consumer.java

/*
 * Copyright 2007 Sxip Identity Corporation
 *
 * 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 net.oauth.j2me;

import java.util.Hashtable;
import java.io.*;
import net.oauth.j2me.OAuthBadDataException;
import net.oauth.j2me.token.*;

public class Consumer { 
    private ConsumerConfig config;
    private String signatureMethod;

    /**
     * Default constructor
     **/
    public Consumer() {
        config = new ConsumerConfig();
        signatureMethod = "PLAINTEXT";
    }

    /**
     * Consumer constructor
     * @param   key consumer key (provided by your OAuth service provider)
     * @param   secret  consumer secret (from your Oauth service provider)
     **/
    public Consumer(String key, String secret) {
        config = new ConsumerConfig(key, secret);
        signatureMethod = "PLAINTEXT";
    }

    public Consumer(String key, String secret, String callbackEndpoint) {
        config = new ConsumerConfig(key, secret, callbackEndpoint);
        signatureMethod = "PLAINTEXT";
    }
    

    //
    // Getters and setters
    //
    public ConsumerConfig getConfig() {
        return config;
    }

    public void setConfig(ConsumerConfig config) {
        this.config = config;
    }

    public String getSignatureMethod() {
        return signatureMethod;
    }

    public void setSignatureMethod(String signatureMethod) {
        this.signatureMethod = signatureMethod;
    }

    //
    // Old way of doing things without passing a callback.
    //
    public RequestToken getRequestToken(String endpoint) throws OAuthServiceProviderException {
        return getRequestToken(endpoint, null);
    }

    //
    // Token request messages
    //
    public RequestToken getRequestToken(String endpoint, String app_callback) throws OAuthServiceProviderException {
        RequestToken token = null;

        OAuthMessage requestMessage = new OAuthMessage();
        requestMessage.setRequestURL(endpoint);
        requestMessage.setConsumerKey(config.getKey());
        if (app_callback != null)
            requestMessage.setCallback(app_callback);
        requestMessage.createSignature(signatureMethod, config.getSecret());
        
        String url=endpoint + "?" + requestMessage.convertToUrlParameters();
        System.out.println("Attempting to get RT from "+url);
        
        String responseString=null;
        try {
            responseString=Util.postViaHttpsConnection(url);
        } catch (IOException e) { // 
            System.out.println(e.toString());
            return null;
        }
        System.out.println("Consumer got responseString when requesting RequestToken..." + responseString);

        OAuthMessage responseMessage = new OAuthMessage();
        try {
            responseMessage.parseJSONResponseStringFroToken(responseString); // can throw an exception or return null if bad data...
        } catch (OAuthBadDataException e) {
            System.out.println(e.toString());
            return null;
        }

        if ((app_callback != null) && (responseMessage.getAdditionalProperty("oauth_callback_confirmed") == null)) {
            System.out.println("Server response error: Expected server to respond with oauth_callback_confirmed");
            return null;
        }
        token=new RequestToken(responseMessage.getToken(), responseMessage.getTokenSecret());
        return token;        
    }

    // returns null if something goes wrong
    public AccessToken getAccessToken(String endpoint, RequestToken requestToken, String verifier) throws OAuthServiceProviderException, BadTokenStateException{
        if (requestToken.getExchanged()) {
            throw new BadTokenStateException("Request token already used");
        }

        AccessToken token = null; 

        OAuthMessage requestMessage = new OAuthMessage();
        requestMessage.setRequestURL(endpoint);
        requestMessage.setConsumerKey(config.getKey());
        requestMessage.setToken(requestToken.getToken());
        requestMessage.setTokenSecret(requestToken.getSecret());
        //requestMessage.setCallback(config.getCallbackEndpoint());
        if ((verifier != null) && (verifier.length() > 0))
            requestMessage.setAdditionalProperty("oauth_verifier", verifier);
        requestMessage.createSignature(signatureMethod, config.getSecret());

       
        String url=endpoint + "?" + requestMessage.convertToUrlParameters();
        System.out.println("Attempting to get AT from "+url);
        String responseString=null;
        try {
            responseString=Util.postViaHttpsConnection(url);
        } catch (IOException e) {
            System.out.println(e.toString());
            return null;
        }
        System.out.println("Consumer got responseString when requesting AT..." + responseString);

        OAuthMessage responseMessage = new OAuthMessage();
        try {
            responseMessage.parseJSONResponseStringFroToken(responseString);
        } catch (OAuthBadDataException e) {
            System.out.println(e.toString());
            return null;
        }
        token=new AccessToken(responseMessage.getToken(), responseMessage.getTokenSecret());
        requestToken.setExchanged(true);

        return token;
    }
    
    
    public String accessProtectedResource(String endpoint, AccessToken accessToken, Hashtable queryParams) throws OAuthServiceProviderException, IOException
    {
        return accessProtectedResource(endpoint, accessToken, queryParams, OAuthMessage.METHOD_GET);
    }

    // return HTTP response body from server
    public String accessProtectedResource(String endpoint, AccessToken accessToken, Hashtable queryParams, String httpMethod) throws OAuthServiceProviderException, IOException {
        String responseString=null;
        OAuthMessage requestMessage = new OAuthMessage();
        requestMessage.setRequestMethod(httpMethod);
        requestMessage.setRequestURL(endpoint);
        requestMessage.setConsumerKey(config.getKey());
        if (accessToken!=null){
            requestMessage.setToken(accessToken.getToken());
            requestMessage.setTokenSecret(accessToken.getSecret());
        }
        if (queryParams==null) {
            requestMessage.setAttitionalProperties(new Hashtable());
        } else {
            requestMessage.setAttitionalProperties(queryParams);
        }
        requestMessage.createSignature(signatureMethod, config.getSecret());
        
        String url=endpoint + "?" + requestMessage.convertToUrlParameters();
        System.out.println("Attempting to access "+url);
            
        if (OAuthMessage.METHOD_POST.equals(httpMethod))
        {
            responseString=Util.postViaHttpsConnection(url);
        } else {
            responseString=Util.getViaHttpsConnection(url);
        }
        System.out.println("Consumer got responseString " + responseString);
        
        return responseString;
         
    }    
    
    public RequestToken markRequestTokenAuthorized(RequestToken token) {
        token.setAuthorized(true);
        return token;
    }

    public RequestToken markRequestTokenExchanged(RequestToken token) {
        token.setExchanged(true);
        return token;
    }
}