ac.simons.oembed

Class OembedService

java.lang.Object

ac.simons.oembed.OembedService

public class OembedService
extends Object

Author:

Michael J. Simons, 2014-12-31

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
OembedService(org.apache.http.client.HttpClient httpClient, net.sf.ehcache.CacheManager cacheManager, List<OembedEndpoint> endpoints, String applicationName) Creates a new OembedService.

Method Summary

Modifier and Type	Method and Description
org.jsoup.nodes.Document	embedUrls(org.jsoup.nodes.Document document) A convenience method to embed urls in an existing document.
String	embedUrls(String textWithEmbeddableUrls, Optional<String> baseUrl)
<T> T	embedUrls(String textWithEmbeddableUrls, Optional<String> baseUrl, Class<? extends T> targetClass) Scans the text textWithEmbeddableUrls for anchor tags and tries to find OembedEndpoint for those urls.
String	getCacheName()
long	getDefaultCacheAge()
Optional<OembedResponse>	getOembedResponseFor(String url) Tries to find an OembedResponse for the URL url.
OembedParser	getParser(OembedResponse.Format format) Returns an instance of an OembedParser for the given OembedResponse.Format.
boolean	isAutodiscovery()
void	setAutodiscovery(boolean autodiscovery) Updates to configuration of oembed autodiscovery.
void	setCacheName(String cacheName) Changes the name of the cache used.
void	setDefaultCacheAge(long defaultCacheAge) Changes the default cache age.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

OembedService

public OembedService(org.apache.http.client.HttpClient httpClient,
                     net.sf.ehcache.CacheManager cacheManager,
                     List<OembedEndpoint> endpoints,
                     String applicationName)

Creates a new OembedService. This service depends on a HttpClient and can use a CacheManager for caching requests.

Parameters:

httpClient - Mandatory http client

cacheManager - Optional cache manager

endpoints - The static endpoints

applicationName - Optional application name

Method Detail

isAutodiscovery

public boolean isAutodiscovery()

Returns:

the current configuration of oembed autodiscovery

setAutodiscovery

public void setAutodiscovery(boolean autodiscovery)

Updates to configuration of oembed autodiscovery.

Parameters:

autodiscovery - New flag wether oembed endpoints should be autodiscovered

getCacheName

public String getCacheName()

Returns:

The name of the cached used by this service

setCacheName

public void setCacheName(String cacheName)

Changes the name of the cache used. If a cache manager is present, it clears the old cache and removes it.

Parameters:

cacheName - The new cache name

getDefaultCacheAge

public long getDefaultCacheAge()

Returns:

The default time in seconds responses are cached.

setDefaultCacheAge

public void setDefaultCacheAge(long defaultCacheAge)

Changes the default cache age.

Parameters:

defaultCacheAge - New default cache age in seconds

getOembedResponseFor

public Optional<OembedResponse> getOembedResponseFor(String url)

Tries to find an OembedResponse for the URL url. If a cache manager is present, it tries that first. If an OembedResponse can be discovered and a cache manager is present, that response will be cached.

Parameters:

url - The URL that might be represented by oembed.

Returns:

An oembed response

embedUrls

public String embedUrls(String textWithEmbeddableUrls,
                        Optional<String> baseUrl)

Parameters:

textWithEmbeddableUrls - Text that may contain links

baseUrl - Base url for constructing absolute links

Returns:

A string with urls embedded

See Also:

embedUrls(java.lang.String, java.util.Optional, java.lang.Class)

embedUrls

public <T> T embedUrls(String textWithEmbeddableUrls,
                       Optional<String> baseUrl,
                       Class<? extends T> targetClass)

Scans the text textWithEmbeddableUrls for anchor tags and tries to find OembedEndpoint for those urls. If such an endpoint exists, it tries to get an OembedResponse of that url from the endpoint. This response will then be rendered as html and is used to replace the anchor tag.

Type Parameters:

T - Type of the resulting document with embedded links

Parameters:

textWithEmbeddableUrls - Text that contains embeddable urls

baseUrl - An optional base url for resolving relative urls

targetClass - The concrete classe for the document node

Returns:

The same text with embedded urls if such urls existed

embedUrls

public org.jsoup.nodes.Document embedUrls(org.jsoup.nodes.Document document)

A convenience method to embed urls in an existing document.

Parameters:

document - Existing document, will be modified

Returns:

Modified document with embedded urls

See Also:

embedUrls(java.lang.String, java.util.Optional, java.lang.Class)

getParser

public OembedParser getParser(OembedResponse.Format format)

Returns an instance of an OembedParser for the given OembedResponse.Format.

Parameters:

format - The format for which a parser is needed

Returns:

The parser if a parser for the given format exists