com.nmote.oembed

Class AbstractOEmbedProvider

java.lang.Object

com.nmote.oembed.AbstractOEmbedProvider

All Implemented Interfaces:

OEmbedProvider

Direct Known Subclasses:

DefaultOEmbedProvider, EmbedlyProvider, NoembedProvider

public abstract class AbstractOEmbedProvider
extends Object
implements OEmbedProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected okhttp3.OkHttpClient	httpClient
protected com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
AbstractOEmbedProvider() Makes an instance using default HTTP client and Jackson ObjectMapper.
AbstractOEmbedProvider(okhttp3.OkHttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper mapper) Makes an instance using supplied httpClient and mapper.

Method Summary

Modifier and Type	Method and Description
protected void	checkEmbedForErrors(OEmbed e) Some oEmbed providers return errors in response fields instead of using HTTP response error codes.
<T extends OEmbed> T	get(String url, Class<T> embedClass) Makes HTTP request expecting oEmbed response.
protected Class<? extends BasicOEmbed>	getEmbedClass(ProviderEndpoint endpoint) Get's BasicOEmbed subclass to use for mapping response.
protected abstract ProviderEndpoint	getProviderEndpointFor(String url) Returns ProviderEndpoint to use for given resource url.
protected void	prepareRequestURI(okhttp3.HttpUrl.Builder builder, String url, Integer... maxSize) Prepares URL prior to making request.
OEmbed	resolve(String url, Integer... maxSize) Resolves oEmbed data from passed resource URL.
OEmbed	resolve(String url, ProviderEndpoint provider, Integer... maxSize) Makes oEmebed request for url using provider.

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

protected final okhttp3.OkHttpClient httpClient

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

AbstractOEmbedProvider

public AbstractOEmbedProvider()

Makes an instance using default HTTP client and Jackson ObjectMapper.

AbstractOEmbedProvider

public AbstractOEmbedProvider(okhttp3.OkHttpClient httpClient,
                              com.fasterxml.jackson.databind.ObjectMapper mapper)

Makes an instance using supplied httpClient and mapper.

Parameters:

httpClient - OkHTTP client

mapper - Jackson ObjectMapper instance

Method Detail

get

public <T extends OEmbed> T get(String url,
                                Class<T> embedClass)
                         throws IOException

Makes HTTP request expecting oEmbed response. Maps to embedClass instance.

Type Parameters:

T - oEmbed subclass to map data on

Parameters:

url - oEmbed URL

embedClass - OEmbed implementation class

Returns:

OEmbed instance

Throws:

IOException - if HTTP request or mapping fail

resolve

public OEmbed resolve(String url,
                      Integer... maxSize)
               throws IOException

Description copied from interface: OEmbedProvider

Resolves oEmbed data from passed resource URL.

Specified by:

resolve in interface OEmbedProvider

Parameters:

url - resource URL

maxSize - optional width and height in px

Returns:

oEmbed instance

Throws:

IOException - if oEmbed data can't be resolved

See Also:

OEmbedProvider.resolve(java.lang.String, java.lang.Integer[])

resolve

public OEmbed resolve(String url,
                      ProviderEndpoint provider,
                      Integer... maxSize)
               throws IOException

Makes oEmebed request for url using provider.

Parameters:

url - url to embed

provider - oEmbed provider endpoint

maxSize - max width and height

Returns:

OEmbed instance

Throws:

IOException - if oEmbed data can't be fetched

checkEmbedForErrors

protected void checkEmbedForErrors(OEmbed e)
                            throws IOException

Some oEmbed providers return errors in response fields instead of using HTTP response error codes. Check for errors on such providers.

Parameters:

e - returned instance

Throws:

IOException - if error is found on oEmbed instance

getEmbedClass

protected Class<? extends BasicOEmbed> getEmbedClass(ProviderEndpoint endpoint)

Get's BasicOEmbed subclass to use for mapping response.

Parameters:

endpoint - endpoint used for request

Returns:

class used to map oEmbed response.

getProviderEndpointFor

protected abstract ProviderEndpoint getProviderEndpointFor(String url)

Returns ProviderEndpoint to use for given resource url.

Parameters:

url - resource URL

Returns:

ProviderEndoint for url or null if none found.

prepareRequestURI

protected void prepareRequestURI(okhttp3.HttpUrl.Builder builder,
                                 String url,
                                 Integer... maxSize)

Prepares URL prior to making request.

Parameters:

builder - URI

url - embed URL

maxSize - max width and height