com.flickr4java.flickr.auth

Class AuthInterface

java.lang.Object

com.flickr4java.flickr.auth.AuthInterface

public class AuthInterface
extends java.lang.Object

Authentication interface.

Constructor Summary

Constructors

Constructor and Description
AuthInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transport) Construct the AuthInterface.

Method Summary

Methods

Modifier and Type	Method and Description
Auth	checkToken(java.lang.String authToken, java.lang.String tokenSecret)
Auth	checkToken(org.scribe.model.Token accessToken) Returns the credentials attached to an OAuth authentication token.
org.scribe.model.Token	exchangeAuthToken(java.lang.String authToken) Exchange an auth token from the old Authentication API, to an OAuth access token.
org.scribe.model.Token	getAccessToken(org.scribe.model.Token oAuthRequestToken, org.scribe.model.Verifier verifier) Trade the request token for an access token, this is step three of authorization.
java.lang.String	getAuthorizationUrl(org.scribe.model.Token oAuthRequestToken, Permission permission) Get the auth URL, this is step two of authorization.
org.scribe.model.Token	getRequestToken() Get the OAuth request token - this is step one of authorization.
org.scribe.model.Token	getRequestToken(java.lang.String callbackUrl) Get the OAuth request token - this is step one of authorization.
void	setMaxGetTokenRetries(int maxGetTokenRetries)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthInterface

public AuthInterface(java.lang.String apiKey,
             java.lang.String sharedSecret,
             Transport transport)

Construct the AuthInterface.

Parameters:

apiKey - The API key

transport - The Transport interface

Method Detail

getRequestToken

public org.scribe.model.Token getRequestToken()

Get the OAuth request token - this is step one of authorization.

Returns:

the Token, store this for when the user returns from the Flickr website.

getRequestToken

public org.scribe.model.Token getRequestToken(java.lang.String callbackUrl)

Get the OAuth request token - this is step one of authorization.

Parameters:

callbackUrl - optional callback URL - required for web auth flow, will be set to "oob" if not specified.

Returns:

the Token, store this for when the user returns from the Flickr website.

getAuthorizationUrl

public java.lang.String getAuthorizationUrl(org.scribe.model.Token oAuthRequestToken,
                                   Permission permission)

Get the auth URL, this is step two of authorization.

Parameters:

oAuthRequestToken - the token from a getRequestToken() call.

getAccessToken

public org.scribe.model.Token getAccessToken(org.scribe.model.Token oAuthRequestToken,
                                    org.scribe.model.Verifier verifier)

Trade the request token for an access token, this is step three of authorization.

Parameters:

oAuthRequestToken - this is the token returned by the getRequestToken() call.

verifier - the Verifier created from the code entered by a user or passed back to a callback URL.

checkToken

public Auth checkToken(org.scribe.model.Token accessToken)
                throws FlickrException

Returns the credentials attached to an OAuth authentication token.

Parameters:

accessToken - The authentication token

Returns:

The Auth object

Throws:

FlickrException

checkToken

public Auth checkToken(java.lang.String authToken,
              java.lang.String tokenSecret)
                throws FlickrException

Parameters:

authToken - The authentication token

tokenSecret -

Returns:

The Auth object

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.auth.oauth.checkToken.html"

exchangeAuthToken

public org.scribe.model.Token exchangeAuthToken(java.lang.String authToken)
                                         throws FlickrException

Exchange an auth token from the old Authentication API, to an OAuth access token. Calling this method will delete the auth token used to make the request.

Parameters:

authToken -

Throws:

FlickrException

See Also:

"http://www.flickr.com/services/api/flickr.auth.oauth.getAccessToken.html"

setMaxGetTokenRetries

public void setMaxGetTokenRetries(int maxGetTokenRetries)