org.miniauth.web.oauth

Class OAuthSingleConsumerURLConnectionAuthHandler

java.lang.Object

org.miniauth.web.AbstractAuthHandler

org.miniauth.web.oauth.OAuthAuthHandler

org.miniauth.web.oauth.OAuthSingleConsumerURLConnectionAuthHandler

All Implemented Interfaces:

Serializable, AuthHandler, ClientAuthHandler, SingleConsumerURLConnectionAuthHandler

public class OAuthSingleConsumerURLConnectionAuthHandler
extends OAuthAuthHandler
implements SingleConsumerURLConnectionAuthHandler

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthSingleConsumerURLConnectionAuthHandler(OAuthSingleConsumerCredentialMapper credentialMapper)
OAuthSingleConsumerURLConnectionAuthHandler(String consumerKey, String consumerSecret)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	endorseRequest(HttpURLConnection conn) "Signs" or "endorses" the request.
OAuthConsumerCredentialMapper	getOAuthConsumerCredentialMapper()
OAuthSingleConsumerCredentialMapper	getOAuthSingleConsumerCredentialMapper()

Methods inherited from class org.miniauth.web.oauth.OAuthAuthHandler

getOAuthCredentialMapper

Methods inherited from class org.miniauth.web.AbstractAuthHandler

getCredentialMapper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.miniauth.web.AuthHandler

getCredentialMapper

Constructor Detail

OAuthSingleConsumerURLConnectionAuthHandler

public OAuthSingleConsumerURLConnectionAuthHandler(String consumerKey,
                                           String consumerSecret)

OAuthSingleConsumerURLConnectionAuthHandler

public OAuthSingleConsumerURLConnectionAuthHandler(OAuthSingleConsumerCredentialMapper credentialMapper)

Method Detail

getOAuthConsumerCredentialMapper

public OAuthConsumerCredentialMapper getOAuthConsumerCredentialMapper()

getOAuthSingleConsumerCredentialMapper

public OAuthSingleConsumerCredentialMapper getOAuthSingleConsumerCredentialMapper()

endorseRequest

public boolean endorseRequest(HttpURLConnection conn)
                       throws MiniAuthException,
                              IOException

"Signs" or "endorses" the request. In the context of OAuth, this method should be really called signRequest(). However, we (plan to) use this for other auth schemes, hence we use a more generic (but somewhat unusual name), "endorse".

Specified by:

endorseRequest in interface SingleConsumerURLConnectionAuthHandler

Parameters:

conn - URLConnection. conn is an "in-out" param.

Returns:

true if "endorsing" is successful.

Throws:

MiniAuthException

IOException