service.tut.pori.users.twitter

Class TwitterUserService

java.lang.Object

service.tut.pori.users.twitter.TwitterUserService

@HTTPService(name="twitter")
public class TwitterUserService
extends java.lang.Object

Twitter User Service method definitions. This class defines the APIs for registering a new account with the system and authentication using Twitter credentials, or more precisely, using the Twitter OAuth authentication. The methods also describe the means for granting the system authorization for accessing content of the Twitter account. Creating an account or authenticating with Twitter credentials does not automatically grant the system persistent permissions for accessing the account contents. Note that the Twitter User Service does not contain a method for removing an existing user account. An existing account can be removed using the User Service.

Constructor Summary

Constructors

Constructor and Description
TwitterUserService()

Method Summary

Modifier and Type	Method and Description
Response	authorize(AuthenticationParameter authenticatedUser, StringParameter redirectUri) This method can be used to grant the service access to the authenticated user's Twitter account.
Response	login(AuthenticationParameter authenticatedUser) This method can be used to authenticate the user using Twitter credentials.
Response	oAuthAuthorizeCallback(StringParameter token, StringParameter verifier) This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.
Response	oAuthLoginCallback(AuthenticationParameter authenticatedUser, StringParameter token, StringParameter verifier) This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.
Response	oAuthRegisterCallback(StringParameter token, StringParameter verifier) This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.
Response	register() This method can be used to register a new user using a Twitter account.
Response	unauthorize(AuthenticationParameter authenticatedUser) This method allows a user to revoke the previously given authorization permissions.

Methods inherited from class java.lang.Object

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

Constructor Detail

TwitterUserService

public TwitterUserService()

Method Detail

oAuthLoginCallback

@HTTPServiceMethod(name="oAuthLoginCallback")
public Response oAuthLoginCallback(@HTTPAuthenticationParameter(required=false)
                                                                                  AuthenticationParameter authenticatedUser,
                                                                                  @HTTPMethodParameter(name="oauth_token")
                                                                                  StringParameter token,
                                                                                  @HTTPMethodParameter(name="oauth_verifier")
                                                                                  StringParameter verifier)

This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.

Parameters:

authenticatedUser -

token - OAuth token as provided by Twitter.

verifier - OAuth verifier generated by Twitter.

Returns:

response

oAuthAuthorizeCallback

@HTTPServiceMethod(name="oAuthAuthorizeCallback")
public Response oAuthAuthorizeCallback(@HTTPMethodParameter(name="oauth_token")
                                                                                          StringParameter token,
                                                                                          @HTTPMethodParameter(name="oauth_verifier")
                                                                                          StringParameter verifier)

This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.

Parameters:

token - OAuth token as provided by Twitter.

verifier - OAuth verifier generated by Twitter.

Returns:

response

oAuthRegisterCallback

@HTTPServiceMethod(name="oAuthRegisterCallback")
public Response oAuthRegisterCallback(@HTTPMethodParameter(name="oauth_token")
                                                                                        StringParameter token,
                                                                                        @HTTPMethodParameter(name="oauth_verifier")
                                                                                        StringParameter verifier)

This method is called by Twitter after user has either denied or granted the service permission to his/her Twitter account, and is not meant to be used directly by the end-users.

Parameters:

token - OAuth token as provided by Twitter.

verifier - OAuth verifier generated by Twitter.

Returns:

response

login

@HTTPServiceMethod(name="login")
public Response login(@HTTPAuthenticationParameter(required=false)
                                                        AuthenticationParameter authenticatedUser)

This method can be used to authenticate the user using Twitter credentials. The method redirects the user to Twitter's consent page, which will forward the user to the service's login OAuth callback method. This method implements the Sign in with Twitter OAuth flow as defined by Twitter.

Parameters:

authenticatedUser -

Returns:

response

register

@HTTPServiceMethod(name="register")
public Response register()

This method can be used to register a new user using a Twitter account. The method redirects the user to Twitter's consent page, which will forward the user to the service's register OAuth callback method. The twitter profile details will be used for the new user registration. This method implements the Sign in with Twitter OAuth flow as defined by Twitter. The Twitter account is assumed to be personal, and an attempt to use the same account to create multiple accounts will result in an error.

Returns:

response

authorize

@HTTPServiceMethod(name="authorize")
public Response authorize(@HTTPAuthenticationParameter
                                                                AuthenticationParameter authenticatedUser,
                                                                @HTTPMethodParameter(name="redirect_uri",required=false)
                                                                StringParameter redirectUri)

This method can be used to grant the service access to the authenticated user's Twitter account. The method redirects the user to Twitter's consent page, which will forward the user to the service's authorization OAuth callback method. This method implements the Sign in with Twitter OAuth flow as defined by Twitter. The Twitter account is assumed to be personal, and an attempt to authorize the same Twitter account to multiple users will result in an error.

Parameters:

authenticatedUser -

redirectUri - The final target, where the user should be redirected to after successful authorization. If not given, a default status message will be shown.

Returns:

response

unauthorize

@HTTPServiceMethod(name="unauthorize")
public Response unauthorize(@HTTPAuthenticationParameter
                                                                    AuthenticationParameter authenticatedUser)

This method allows a user to revoke the previously given authorization permissions. Note that calling this method does not prevent user from authenticating (logging in) using the credentials, nor will it remove the user account from the system, but calling this method will prevent the system from accessing the user's content stored in the Twitter account. In practice this means, that no synchronization can be performed for the account until authorization is restored. All previously synchronized content will be removed from the system.

Parameters:

authenticatedUser -

Returns:

response