Java tutorial
/* * Copyright (c) 2004-2012 YAMJ Members * http://code.google.com/p/moviejukebox/people/list * * Web: http://code.google.com/p/moviejukebox/ * * This software is licensed under a Creative Commons License * See this page: http://code.google.com/p/moviejukebox/wiki/License * * For any reuse or distribution, you must make clear to others the * license terms of this work. */ package com.moviejukebox.themoviedb.tools; import com.moviejukebox.themoviedb.TheMovieDb; import java.io.UnsupportedEncodingException; import java.net.MalformedURLException; import java.net.URL; import java.net.URLEncoder; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * The API URL that is used to construct the API call * * @author Stuart */ public class ApiUrl { /* * Logger */ private static final Logger LOGGER = LoggerFactory.getLogger(ApiUrl.class); /* * TheMovieDb API Base URL */ private static final String TMDB_API_BASE = "http://api.themoviedb.org/3/"; /* * Parameter configuration */ private static final String DELIMITER_FIRST = "?"; private static final String DELIMITER_SUBSEQUENT = "&"; private static final String PARAMETER_API_KEY = "api_key="; // The API Key is always needed and always first private static final String PARAMETER_QUERY = "query="; private static final String PARAMETER_LANGUAGE = DELIMITER_SUBSEQUENT + "language="; private static final String PARAMETER_COUNTRY = DELIMITER_SUBSEQUENT + "country="; private static final String PARAMETER_PAGE = DELIMITER_SUBSEQUENT + "page="; public static final String DEFAULT_STRING = ""; public static final int DEFAULT_INT = -1; /* * Properties */ private String method; private String submethod; private TheMovieDb tmdb; //<editor-fold defaultstate="collapsed" desc="Constructor Methods"> /** * Constructor for the simple API URL method without a sub-method * @param method */ public ApiUrl(TheMovieDb tmdb, String method) { this.tmdb = tmdb; this.method = method; this.submethod = DEFAULT_STRING; } /** * Constructor for the API URL with a sub-method * @param method * @param submethod */ public ApiUrl(TheMovieDb tmdb, String method, String submethod) { this.tmdb = tmdb; this.method = method; this.submethod = submethod; } //</editor-fold> /** * Create the full URL with the API. * * @param query * @param tmdbId * @param language * @param country * @param page * @return */ private URL getFullUrl(String query, String movieId, String language, String country, int page) { StringBuilder urlString = new StringBuilder(TMDB_API_BASE); // Get the start of the URL urlString.append(method); // Append the search term if required if (StringUtils.isNotBlank(query)) { urlString.append(DELIMITER_FIRST); urlString.append(PARAMETER_QUERY); try { urlString.append(URLEncoder.encode(query, "UTF-8")); } catch (UnsupportedEncodingException ex) { // If we can't encode it, try it raw urlString.append(query); } } // Append the ID if provided if (StringUtils.isNotBlank(movieId)) { urlString.append(movieId); } // Append the suffix of the API URL urlString.append(submethod); // Append the key information if (StringUtils.isBlank(query)) { // This is the first parameter urlString.append(DELIMITER_FIRST); } else { // The first parameter was the query urlString.append(DELIMITER_SUBSEQUENT); } urlString.append(PARAMETER_API_KEY); urlString.append(tmdb.getApiKey()); // Append the language to the URL if (StringUtils.isNotBlank(language)) { urlString.append(PARAMETER_LANGUAGE); urlString.append(language); } // Append the country to the URL if (StringUtils.isNotBlank(country)) { urlString.append(PARAMETER_COUNTRY); urlString.append(country); } // Append the page to the URL if (page > DEFAULT_INT) { urlString.append(PARAMETER_PAGE); urlString.append(page); } try { LOGGER.trace("URL: " + urlString.toString()); return new URL(urlString.toString()); } catch (MalformedURLException ex) { LOGGER.warn("Failed to create URL " + urlString.toString() + " - " + ex.toString()); return null; } } /** * Create an URL using the query (string), language and page * * @param query * @param language * @param page * @return */ public URL getQueryUrl(String query, String language, int page) { return getFullUrl(query, DEFAULT_STRING, language, null, page); } /** * Create an URL using the query (string) * @param query * @return */ public URL getQueryUrl(String query) { return getQueryUrl(query, DEFAULT_STRING, DEFAULT_INT); } /** * Create an URL using the query (string) and language * @param query * @param language * @return */ public URL getQueryUrl(String query, String language) { return getQueryUrl(query, language, DEFAULT_INT); } /** * Create an URL using the movie ID, language and country code * * @param movieId * @param language * @param country * @return */ public URL getIdUrl(String movieId, String language, String country) { return getFullUrl(DEFAULT_STRING, movieId, language, country, DEFAULT_INT); } /** * Create an URL using the movie ID and language * @param movieId * @param language * @return */ public URL getIdUrl(String movieId, String language) { return getIdUrl(movieId, language, DEFAULT_STRING); } /** * Create an URL using the movie ID * @param movieId * @return */ public URL getIdUrl(String movieId) { return getIdUrl(movieId, DEFAULT_STRING, DEFAULT_STRING); } /** * Create an URL using the movie ID, language and country code * * @param movieId * @param language * @param country * @return */ public URL getIdUrl(int movieId, String language, String country) { return getIdUrl(String.valueOf(movieId), language, country); } /** * Create an URL using the movie ID and language * @param movieId * @param language * @return */ public URL getIdUrl(int movieId, String language) { return getIdUrl(String.valueOf(movieId), language, DEFAULT_STRING); } /** * Create an URL using the movie ID * @param movieId * @return */ public URL getIdUrl(int movieId) { return getIdUrl(String.valueOf(movieId), DEFAULT_STRING, DEFAULT_STRING); } }