Added bunch of javadocs and restricted some visibility.

No functional changes
This commit is contained in:
Pablo Fernandez committed 2010-10-24 11:48:21 -03:00
1 parent aad8dac580
commit 59f16bfdda
35 files changed
+393 -64

No files matched your search

@@ -22,6 +22,9 @@ public class ServiceBuilder
private Api api;
private String scope;
/**
* Default constructor
*/
public ServiceBuilder()
{
this.callback = OAuthConstants.OUT_OF_BAND;
@@ -10,17 +10,6 @@ import org.scribe.oauth.*;
*/
public interface Api
{
/**
* Creates an {@link OAuthService}
*
* @param apiKey your application api key
* @param apiSecret your application api secret
* @param callback the callback url (or 'oob' for out of band OAuth)
*
* @return fully configured {@link OAuthService}
*/
OAuthService createService(String apiKey, String apiSecret, String callback);
/**
* Creates an {@link OAuthService}
*
@@ -5,52 +5,89 @@ import org.scribe.model.*;
import org.scribe.oauth.*;
import org.scribe.services.*;
/**
* Default implementation of the OAuth protocol, version 1.0a
*
* This class is meant to be extended by concrete implementations of the API.
* If your Api adheres to the 1.0a protocol correctly, you just need to extend
* this class and define the getters for your endpoints.
*
* @author Pablo Fernandez
*
*/
public abstract class DefaultApi10a implements Api
{
public AccessTokenExtractor getAccessTokenExtractor()
protected AccessTokenExtractor getAccessTokenExtractor()
{
return new TokenExtractorImpl();
}
public BaseStringExtractor getBaseStringExtractor()
protected BaseStringExtractor getBaseStringExtractor()
{
return new BaseStringExtractorImpl();
}
public HeaderExtractor getHeaderExtractor()
protected HeaderExtractor getHeaderExtractor()
{
return new HeaderExtractorImpl();
}
public RequestTokenExtractor getRequestTokenExtractor()
protected RequestTokenExtractor getRequestTokenExtractor()
{
return new TokenExtractorImpl();
}
public SignatureService getSignatureService()
protected SignatureService getSignatureService()
{
return new HMACSha1SignatureService();
}
public TimestampService getTimestampService()
protected TimestampService getTimestampService()
{
return new TimestampServiceImpl();
}
public Verb getAccessTokenVerb()
protected Verb getAccessTokenVerb()
{
return Verb.POST;
}
public Verb getRequestTokenVerb()
protected Verb getRequestTokenVerb()
{
return Verb.POST;
}
public abstract String getRequestTokenEndpoint();
public abstract String getAccessTokenEndpoint();
/**
* Returns the URL that receives the request token requests.
*
* @return request token URL
*/
protected abstract String getRequestTokenEndpoint();
public OAuthService createService(String apiKey, String apiSecret, String callback)
/**
* Returns the URL that receives the access token requests.
*
* @return access token URL
*/
protected abstract String getAccessTokenEndpoint();
/**
* Returns the {@link OAuthService} for this Api
*
* @param apiKey Key
* @param apiSecret Api Secret
* @param callback OAuth callback (either URL or 'oob')
* @param scope OAuth scope (optional)
*/
public OAuthService createService(String apiKey, String apiSecret, String callback, String scope)
{
OAuthService service = createService(apiKey, apiSecret, callback);
service.addScope(scope);
return service;
}
private OAuthService createService(String apiKey, String apiSecret, String callback)
{
return new OAuth10aServiceImpl( getSignatureService(),
getTimestampService(),
@@ -61,13 +98,6 @@ public abstract class DefaultApi10a implements Api
createConfig(apiKey, apiSecret, callback));
}
public OAuthService createService(String apiKey, String apiSecret, String callback, String scope)
{
OAuthService service = createService(apiKey, apiSecret, callback);
service.addScope(scope);
return service;
}
private OAuthConfig createConfig(String apiKey, String apiSecret, String callback)
{
OAuthConfig config = new OAuthConfig();
@@ -3,13 +3,13 @@ package org.scribe.builder.api;
public class FoursquareApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "http://foursquare.com/oauth/access_token";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "http://foursquare.com/oauth/request_token";
}
@@ -3,13 +3,13 @@ package org.scribe.builder.api;
public class GoogleApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "https://www.google.com/accounts/OAuthGetAccessToken";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "https://www.google.com/accounts/OAuthGetRequestToken";
}
@@ -7,19 +7,19 @@ public class LinkedInApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "https://api.linkedin.com/uas/oauth/accessToken";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "https://api.linkedin.com/uas/oauth/requestToken";
}
@Override
public BaseStringExtractor getBaseStringExtractor()
protected BaseStringExtractor getBaseStringExtractor()
{
return new LinkedInBaseStringExtractorImpl();
}
@@ -3,13 +3,13 @@ package org.scribe.builder.api;
public class TwitterApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "http://twitter.com/oauth/access_token";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "http://twitter.com/oauth/request_token";
}
@@ -3,13 +3,13 @@ package org.scribe.builder.api;
public class VimeoApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "http://vimeo.com/oauth/access_token";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "http://vimeo.com/oauth/request_token";
}
@@ -3,13 +3,13 @@ package org.scribe.builder.api;
public class YahooApi extends DefaultApi10a
{
@Override
public String getAccessTokenEndpoint()
protected String getAccessTokenEndpoint()
{
return "https://api.login.yahoo.com/oauth/v2/get_token";
}
@Override
public String getRequestTokenEndpoint()
protected String getRequestTokenEndpoint()
{
return "https://api.login.yahoo.com/oauth/v2/get_request_token";
}