oauth.signpost
Class AbstractOAuthProvider

java.lang.Object
  extended by oauth.signpost.AbstractOAuthProvider
All Implemented Interfaces:
java.io.Serializable, OAuthProvider
Direct Known Subclasses:
DefaultOAuthProvider

public abstract class AbstractOAuthProvider
extends java.lang.Object
implements OAuthProvider

ABC for all provider implementations. If you're writing a custom provider, you will probably inherit from this class, since it takes a lot of work from you.

Author:
Matthias Kaeppler
See Also:
Serialized Form

Constructor Summary
AbstractOAuthProvider(java.lang.String requestTokenEndpointUrl, java.lang.String accessTokenEndpointUrl, java.lang.String authorizationWebsiteUrl)
           
 
Method Summary
protected  void closeConnection(HttpRequest request, HttpResponse response)
          Called when the connection is being finalized after receiving the response.
protected abstract  HttpRequest createRequest(java.lang.String endpointUrl)
          Overrride this method if you want to customize the logic for building a request object for the given endpoint URL.
 java.lang.String getAccessTokenEndpointUrl()
           
 java.lang.String getAuthorizationWebsiteUrl()
           
 java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()
           
 java.lang.String getRequestTokenEndpointUrl()
           
protected  java.lang.String getResponseParameter(java.lang.String key)
          Returns a single query parameter as served by the service provider in a token reply.
 HttpParameters getResponseParameters()
          Any additional non-OAuth parameters returned in the response body of a token request can be obtained through this method.
protected  void handleUnexpectedResponse(int statusCode, HttpResponse response)
           
 boolean isOAuth10a()
           
 void removeListener(OAuthProviderListener listener)
           
 void retrieveAccessToken(OAuthConsumer consumer, java.lang.String oauthVerifier, java.lang.String... customOAuthParams)
          Queries the service provider for an access token.
 java.lang.String retrieveRequestToken(OAuthConsumer consumer, java.lang.String callbackUrl, java.lang.String... customOAuthParams)
          Queries the service provider for a request token.
protected  void retrieveToken(OAuthConsumer consumer, java.lang.String endpointUrl, HttpParameters customOAuthParams)
           Implemented by subclasses.
protected abstract  HttpResponse sendRequest(HttpRequest request)
          Override this method if you want to customize the logic for how the given request is sent to the server.
 void setListener(OAuthProviderListener listener)
           
 void setOAuth10a(boolean isOAuth10aProvider)
           
 void setRequestHeader(java.lang.String header, java.lang.String value)
          Use this method to set custom HTTP headers to be used for the requests which are sent to retrieve tokens.
 void setResponseParameters(HttpParameters parameters)
          Subclasses must use this setter to preserve any non-OAuth query parameters contained in the server response.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractOAuthProvider

public AbstractOAuthProvider(java.lang.String requestTokenEndpointUrl,
                             java.lang.String accessTokenEndpointUrl,
                             java.lang.String authorizationWebsiteUrl)
Method Detail

retrieveRequestToken

public java.lang.String retrieveRequestToken(OAuthConsumer consumer,
                                             java.lang.String callbackUrl,
                                             java.lang.String... customOAuthParams)
                                      throws OAuthMessageSignerException,
                                             OAuthNotAuthorizedException,
                                             OAuthExpectationFailedException,
                                             OAuthCommunicationException
Description copied from interface: OAuthProvider
Queries the service provider for a request token.

Pre-conditions: the given OAuthConsumer must have a valid consumer key and consumer secret already set.

Post-conditions: the given OAuthConsumer will have an unauthorized request token and token secret set.

Specified by:
retrieveRequestToken in interface OAuthProvider
Parameters:
consumer - the OAuthConsumer that should be used to sign the request
callbackUrl - Pass an actual URL if your app can receive callbacks and you want to get informed about the result of the authorization process. Pass OAuth.OUT_OF_BAND if the service provider implements OAuth 1.0a and your app cannot receive callbacks. Pass null if the service provider implements OAuth 1.0 and your app cannot receive callbacks. Please note that some services (among them Twitter) will fail authorization if you pass a callback URL but register your application as a desktop app (which would only be able to handle OOB requests).
customOAuthParams - you can pass custom OAuth parameters here which will go directly into the signer, i.e. you don't have to put them into the request first. This is useful for pre-setting OAuth params for signing. Pass them sequentially in key/value order.
Returns:
The URL to which the user must be sent in order to authorize the consumer. It includes the unauthorized request token (and in the case of OAuth 1.0, the callback URL -- 1.0a clients send along with the token request).
Throws:
OAuthMessageSignerException - if signing the request failed
OAuthNotAuthorizedException - if the service provider rejected the consumer
OAuthExpectationFailedException - if required parameters were not correctly set by the consumer or service provider
OAuthCommunicationException - if server communication failed

retrieveAccessToken

public void retrieveAccessToken(OAuthConsumer consumer,
                                java.lang.String oauthVerifier,
                                java.lang.String... customOAuthParams)
                         throws OAuthMessageSignerException,
                                OAuthNotAuthorizedException,
                                OAuthExpectationFailedException,
                                OAuthCommunicationException
Description copied from interface: OAuthProvider
Queries the service provider for an access token.

Pre-conditions: the given OAuthConsumer must have a valid consumer key, consumer secret, authorized request token and token secret already set.

Post-conditions: the given OAuthConsumer will have an access token and token secret set.

Specified by:
retrieveAccessToken in interface OAuthProvider
Parameters:
consumer - the OAuthConsumer that should be used to sign the request
oauthVerifier - NOTE: Only applies to service providers implementing OAuth 1.0a. Set to null if the service provider is still using OAuth 1.0. The verification code issued by the service provider after the the user has granted the consumer authorization. If the callback method provided in the previous step was OAuth.OUT_OF_BAND, then you must ask the user for this value. If your app has received a callback, the verfication code was passed as part of that request instead.
customOAuthParams - you can pass custom OAuth parameters here which will go directly into the signer, i.e. you don't have to put them into the request first. This is useful for pre-setting OAuth params for signing. Pass them sequentially in key/value order.
Throws:
OAuthMessageSignerException - if signing the request failed
OAuthNotAuthorizedException - if the service provider rejected the consumer
OAuthExpectationFailedException - if required parameters were not correctly set by the consumer or service provider
OAuthCommunicationException - if server communication failed

retrieveToken

protected void retrieveToken(OAuthConsumer consumer,
                             java.lang.String endpointUrl,
                             HttpParameters customOAuthParams)
                      throws OAuthMessageSignerException,
                             OAuthCommunicationException,
                             OAuthNotAuthorizedException,
                             OAuthExpectationFailedException

Implemented by subclasses. The responsibility of this method is to contact the service provider at the given endpoint URL and fetch a request or access token. What kind of token is retrieved solely depends on the URL being used.

Correct implementations of this method must guarantee the following post-conditions:

Parameters:
consumer - the OAuthConsumer that should be used to sign the request
endpointUrl - the URL at which the service provider serves the OAuth token that is to be fetched
customOAuthParams - you can pass custom OAuth parameters here (such as oauth_callback or oauth_verifier) which will go directly into the signer, i.e. you don't have to put them into the request first.
Throws:
OAuthMessageSignerException - if signing the token request fails
OAuthCommunicationException - if a network communication error occurs
OAuthNotAuthorizedException - if the server replies 401 - Unauthorized
OAuthExpectationFailedException - if an expectation has failed, e.g. because the server didn't reply in the expected format

handleUnexpectedResponse

protected void handleUnexpectedResponse(int statusCode,
                                        HttpResponse response)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

createRequest

protected abstract HttpRequest createRequest(java.lang.String endpointUrl)
                                      throws java.lang.Exception
Overrride this method if you want to customize the logic for building a request object for the given endpoint URL.

Parameters:
endpointUrl - the URL to which the request will go
Returns:
the request object
Throws:
java.lang.Exception - if something breaks

sendRequest

protected abstract HttpResponse sendRequest(HttpRequest request)
                                     throws java.lang.Exception
Override this method if you want to customize the logic for how the given request is sent to the server.

Parameters:
request - the request to send
Returns:
the response to the request
Throws:
java.lang.Exception - if something breaks

closeConnection

protected void closeConnection(HttpRequest request,
                               HttpResponse response)
                        throws java.lang.Exception
Called when the connection is being finalized after receiving the response. Use this to do any cleanup / resource freeing.

Parameters:
request - the request that has been sent
response - the response that has been received
Throws:
java.lang.Exception - if something breaks

getResponseParameters

public HttpParameters getResponseParameters()
Description copied from interface: OAuthProvider
Any additional non-OAuth parameters returned in the response body of a token request can be obtained through this method. These parameters will be preserved until the next token request is issued. The return value is never null.

Specified by:
getResponseParameters in interface OAuthProvider

getResponseParameter

protected java.lang.String getResponseParameter(java.lang.String key)
Returns a single query parameter as served by the service provider in a token reply. You must call setResponseParameters(oauth.signpost.http.HttpParameters) with the set of parameters before using this method.

Parameters:
key - the parameter name
Returns:
the parameter value

setResponseParameters

public void setResponseParameters(HttpParameters parameters)
Description copied from interface: OAuthProvider
Subclasses must use this setter to preserve any non-OAuth query parameters contained in the server response. It's the caller's responsibility that any OAuth parameters be removed beforehand.

Specified by:
setResponseParameters in interface OAuthProvider
Parameters:
parameters - the map of query parameters served by the service provider in the token response

setOAuth10a

public void setOAuth10a(boolean isOAuth10aProvider)
Specified by:
setOAuth10a in interface OAuthProvider
Parameters:
isOAuth10aProvider - set to true if the service provider supports OAuth 1.0a. Note that you need only call this method if you reconstruct a provider object in between calls to retrieveRequestToken() and retrieveAccessToken() (i.e. if the object state isn't preserved). If instead those two methods are called on the same provider instance, this flag will be deducted automatically based on the server response during retrieveRequestToken(), so you can simply ignore this method.

isOAuth10a

public boolean isOAuth10a()
Specified by:
isOAuth10a in interface OAuthProvider
Returns:
true if the service provider supports OAuth 1.0a. Note that the value returned here is only meaningful after you have already performed the token handshake, otherwise there is no way to determine what version of the OAuth protocol the service provider implements.

getRequestTokenEndpointUrl

public java.lang.String getRequestTokenEndpointUrl()
Specified by:
getRequestTokenEndpointUrl in interface OAuthProvider

getAccessTokenEndpointUrl

public java.lang.String getAccessTokenEndpointUrl()
Specified by:
getAccessTokenEndpointUrl in interface OAuthProvider

getAuthorizationWebsiteUrl

public java.lang.String getAuthorizationWebsiteUrl()
Specified by:
getAuthorizationWebsiteUrl in interface OAuthProvider

setRequestHeader

public void setRequestHeader(java.lang.String header,
                             java.lang.String value)
Description copied from interface: OAuthProvider
Use this method to set custom HTTP headers to be used for the requests which are sent to retrieve tokens. @deprecated THIS METHOD HAS BEEN DEPRECATED. Use OAuthProviderListener to customize requests.

Specified by:
setRequestHeader in interface OAuthProvider
Parameters:
header - The header name (e.g. 'WWW-Authenticate')
value - The header value (e.g. 'realm=www.example.com')

getRequestHeaders

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaders()
Specified by:
getRequestHeaders in interface OAuthProvider
Returns:
all request headers set via OAuthProvider.setRequestHeader(java.lang.String, java.lang.String)

setListener

public void setListener(OAuthProviderListener listener)
Specified by:
setListener in interface OAuthProvider

removeListener

public void removeListener(OAuthProviderListener listener)
Specified by:
removeListener in interface OAuthProvider