com.omertron.fanarttvapi

Class FanartTvApi

java.lang.Object

com.omertron.fanarttvapi.FanartTvApi

public class FanartTvApi
extends Object

This is the main class for the API to connect to Fanart.TV http://fanart.tv/api-info/

Version:

3.0

Author:

Stuart.Boston

Constructor Summary

Constructors

Constructor and Description
FanartTvApi(String apiKey) Create a new API instance with the given API Key.
FanartTvApi(String apiKey, String clientKey) Create a new API instance with the given API keys.
FanartTvApi(String apiKey, String clientKey, org.apache.http.client.HttpClient httpClient) Create a new API instance with the given API Key and specific CommonHttpClient

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.ObjectMapper	getMapper() Provide access to the JSON mapper object
FTMovie	getMovieArtwork(String id) Get images for Movie
List<FTLatest>	getMovieLatest(String date) Latest Movies
FTMusicArtist	getMusicAlbum(String id) Get Album
FTMusicArtist	getMusicArtist(String id) Get images for artist
List<FTLatest>	getMusicArtistLatest(String date) Latest Artists
FTMusicLabel	getMusicLabel(String id) Get Label
FTSeries	getTvArtwork(String id) Get images for TV
List<FTLatest>	getTvLatest(String date) Latest Shows

Methods inherited from class java.lang.Object

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

Constructor Detail

FanartTvApi

public FanartTvApi(String apiKey)
            throws FanartTvException

Create a new API instance with the given API Key. A null client key will be used.

Parameters:

apiKey -

Throws:

FanartTvException

FanartTvApi

public FanartTvApi(String apiKey,
                   String clientKey)
            throws FanartTvException

Create a new API instance with the given API keys.

Parameters:

apiKey -

clientKey -

Throws:

FanartTvException

FanartTvApi

public FanartTvApi(String apiKey,
                   String clientKey,
                   org.apache.http.client.HttpClient httpClient)
            throws FanartTvException

Create a new API instance with the given API Key and specific CommonHttpClient

Parameters:

apiKey -

clientKey -

httpClient -

Throws:

FanartTvException

Method Detail

getMapper

public static com.fasterxml.jackson.databind.ObjectMapper getMapper()

Provide access to the JSON mapper object

Returns:

getTvArtwork

public FTSeries getTvArtwork(String id)
                      throws FanartTvException

Get images for TV

Parameters:

id -

Returns:

Throws:

FanartTvException

getTvLatest

public List<FTLatest> getTvLatest(String date)
                           throws FanartTvException

Latest Shows

Parameters:

date -

Returns:

Throws:

FanartTvException

getMovieArtwork

public FTMovie getMovieArtwork(String id)
                        throws FanartTvException

Get images for Movie

Parameters:

id -

Returns:

Throws:

FanartTvException

getMovieLatest

public List<FTLatest> getMovieLatest(String date)
                              throws FanartTvException

Latest Movies

Parameters:

date -

Returns:

Throws:

FanartTvException

getMusicArtist

public FTMusicArtist getMusicArtist(String id)
                             throws FanartTvException

Get images for artist

Parameters:

id -

Returns:

Throws:

FanartTvException

getMusicAlbum

public FTMusicArtist getMusicAlbum(String id)
                            throws FanartTvException

Get Album

Parameters:

id -

Returns:

Throws:

FanartTvException

getMusicLabel

public FTMusicLabel getMusicLabel(String id)
                           throws FanartTvException

Get Label

Parameters:

id -

Returns:

Throws:

FanartTvException

getMusicArtistLatest

public List<FTLatest> getMusicArtistLatest(String date)
                                    throws FanartTvException

Latest Artists

Parameters:

date -

Returns:

Throws:

FanartTvException