org.miniauth.web.oauth

Class OAuthConsumerURLConnectionAuthHandler

java.lang.Object

org.miniauth.web.AbstractAuthHandler

org.miniauth.web.oauth.OAuthAuthHandler

org.miniauth.web.oauth.OAuthConsumerURLConnectionAuthHandler

All Implemented Interfaces:

Serializable, AuthHandler, ClientAuthHandler, ConsumerURLConnectionAuthHandler

public class OAuthConsumerURLConnectionAuthHandler
extends OAuthAuthHandler
implements ConsumerURLConnectionAuthHandler

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuthConsumerURLConnectionAuthHandler()
OAuthConsumerURLConnectionAuthHandler(OAuthConsumerCredentialMapper credentialMapper)

Method Summary

Methods

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

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

OAuthConsumerURLConnectionAuthHandler

public OAuthConsumerURLConnectionAuthHandler()

OAuthConsumerURLConnectionAuthHandler

public OAuthConsumerURLConnectionAuthHandler(OAuthConsumerCredentialMapper credentialMapper)

Method Detail

getOAuthConsumerCredentialMapper

public OAuthConsumerCredentialMapper getOAuthConsumerCredentialMapper()

endorseRequest

public boolean endorseRequest(String consumerKey,
                     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 ConsumerURLConnectionAuthHandler

Parameters:

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

Returns:

true if "endorsing" is successful.

Throws:

MiniAuthException

IOException