com.omertron.themoviedbapi.methods

Class TmdbAuthentication

java.lang.Object

com.omertron.themoviedbapi.methods.AbstractMethod

com.omertron.themoviedbapi.methods.TmdbAuthentication

public class TmdbAuthentication
extends AbstractMethod

Class to hold the Authentication Methods

Author:

stuart.boston

Field Summary

Fields inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

apiKey, httpTools, MAPPER

Constructor Summary

Constructors

Constructor and Description
TmdbAuthentication(String apiKey, HttpTools httpTools) Constructor

Method Summary

Modifier and Type	Method and Description
TokenAuthorisation	getAuthorisationToken() This method is used to generate a valid request token for user based authentication.
TokenSession	getGuestSessionToken() This method is used to generate a guest session id.
TokenSession	getSessionToken(TokenAuthorisation token) This method is used to generate a session id for user based authentication.
TokenAuthorisation	getSessionTokenLogin(TokenAuthorisation token, String username, String password) This method is used to generate a session id for user based authentication.

Methods inherited from class com.omertron.themoviedbapi.methods.AbstractMethod

getMediaChanges, getTypeReference, processWrapper, processWrapperList

Methods inherited from class java.lang.Object

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

Constructor Detail

TmdbAuthentication

public TmdbAuthentication(String apiKey,
                          HttpTools httpTools)

Constructor

Parameters:

apiKey -

httpTools -

Method Detail

getAuthorisationToken

public TokenAuthorisation getAuthorisationToken()
                                         throws MovieDbException

This method is used to generate a valid request token for user based authentication. A request token is required in order to request a session id. You can generate any number of request tokens but they will expire after 60 minutes. As soon as a valid session id has been created the token will be destroyed.

Returns:

Throws:

MovieDbException

getSessionToken

public TokenSession getSessionToken(TokenAuthorisation token)
                             throws MovieDbException

This method is used to generate a session id for user based authentication. A session id is required in order to use any of the write methods.

Parameters:

token -

Returns:

Throws:

MovieDbException

getSessionTokenLogin

public TokenAuthorisation getSessionTokenLogin(TokenAuthorisation token,
                                               String username,
                                               String password)
                                        throws MovieDbException

This method is used to generate a session id for user based authentication. User must provide their username and password A session id is required in order to use any of the write methods.

Parameters:

token - Session token

username - User's username

password - User's password

Returns:

Throws:

MovieDbException

getGuestSessionToken

public TokenSession getGuestSessionToken()
                                  throws MovieDbException

This method is used to generate a guest session id. A guest session can be used to rate movies without having a registered TMDb user account. You should only generate a single guest session per user (or device) as you will be able to attach the ratings to a TMDb user account in the future. There are also IP limits in place so you should always make sure it's the end user doing the guest session actions. If a guest session is not used for the first time within 24 hours, it will be automatically discarded.

Returns:

Throws:

MovieDbException