ac.simons.oembed

Class Oembed

java.lang.Object

ac.simons.oembed.Oembed

public class Oembed
extends Object

Author:

Michael J. Simons

Constructor Summary

Constructors

Constructor and Description
Oembed(org.apache.http.client.HttpClient httpClient) Constructs the Oembed Api with the default parsers (json and xml) and an empty map of provider

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToCache(String url, OembedResponse response)
String	getBaseUri()
net.sf.ehcache.CacheManager	getCacheManager()
String	getCacheName()
String	getConsumer()
int	getDefaultCacheAge()
protected OembedResponse	getFromCache(String key)
Map<String,OembedResponseHandler>	getHandler()
Long	getIgnoreFailedUrlsForSeconds()
Map<String,OembedParser>	getParser()
OembedParser	getParser(String format)
Map<String,OembedProvider>	getProvider()
String	getUserAgent()
boolean	isAutodiscovery()
void	setAutodiscovery(boolean autodiscovery)
void	setBaseUri(String baseUri)
void	setCacheManager(net.sf.ehcache.CacheManager cacheManager)
void	setCacheName(String cacheName)
void	setConsumer(String consumer)
void	setDefaultCacheAge(int defaultCacheAge)
void	setHandler(Map<String,OembedResponseHandler> handler)
void	setIgnoreFailedUrlsForSeconds(Long ignoreFailedUrlsForSeconds)
void	setParser(Map<String,OembedParser> parser)
OembedParser	setParser(String format, OembedParser parser) Sets the parser for the given format, returns the old parser if any
void	setProvider(Map<String,OembedProvider> provider)
void	setUserAgent(String userAgent)
org.jsoup.nodes.Document	transformDocument(org.jsoup.nodes.Document document) Parses the given html document into a document and processes all anchor elements.
org.jsoup.nodes.Document	transformDocument(String documentHtml)
String	transformDocumentString(String documentHtml)
OembedResponse	transformUrl(String url) Transforms the given URL into an OembedResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

Oembed

public Oembed(org.apache.http.client.HttpClient httpClient)

Constructs the Oembed Api with the default parsers (json and xml) and an empty map of provider

Parameters:

httpClient -

Method Detail

getProvider

public Map<String,OembedProvider> getProvider()

setProvider

public void setProvider(Map<String,OembedProvider> provider)

getParser

public OembedParser getParser(String format)

setParser

public OembedParser setParser(String format,
                     OembedParser parser)

Sets the parser for the given format, returns the old parser if any

Parameters:

format -

parser -

Returns:

transformUrl

public OembedResponse transformUrl(String url)
                            throws OembedException

Transforms the given URL into an OembedResponse. Returns null if there is no provider configured for this url.

Parameters:

url -

Returns:

Throws:

OembedException

transformDocumentString

public String transformDocumentString(String documentHtml)

transformDocument

public org.jsoup.nodes.Document transformDocument(String documentHtml)

transformDocument

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

Parses the given html document into a document and processes all anchor elements. If a valid anchor is found, it tries to get an oembed response for it's url and than render the result into the document replacing the given anchor.
It returns the html representation of the new document.
If there's an error or no oembed result for an url, the anchor tag will be left as it was.

Parameters:

documentHtml -

Returns:

getCacheManager

public net.sf.ehcache.CacheManager getCacheManager()

setCacheManager

public void setCacheManager(net.sf.ehcache.CacheManager cacheManager)

getDefaultCacheAge

public int getDefaultCacheAge()

setDefaultCacheAge

public void setDefaultCacheAge(int defaultCacheAge)

getHandler

public Map<String,OembedResponseHandler> getHandler()

setHandler

public void setHandler(Map<String,OembedResponseHandler> handler)

getParser

public Map<String,OembedParser> getParser()

setParser

public void setParser(Map<String,OembedParser> parser)

isAutodiscovery

public boolean isAutodiscovery()

setAutodiscovery

public void setAutodiscovery(boolean autodiscovery)

getBaseUri

public String getBaseUri()

setBaseUri

public void setBaseUri(String baseUri)

getCacheName

public String getCacheName()

setCacheName

public void setCacheName(String cacheName)

getFromCache

protected OembedResponse getFromCache(String key)

addToCache

protected void addToCache(String url,
              OembedResponse response)

getIgnoreFailedUrlsForSeconds

public Long getIgnoreFailedUrlsForSeconds()

setIgnoreFailedUrlsForSeconds

public void setIgnoreFailedUrlsForSeconds(Long ignoreFailedUrlsForSeconds)

getUserAgent

public String getUserAgent()

setUserAgent

public void setUserAgent(String userAgent)

getConsumer

public String getConsumer()

setConsumer

public void setConsumer(String consumer)