ac.simons.oembed

Class OembedEndpoint

java.lang.Object

ac.simons.oembed.OembedEndpoint

public class OembedEndpoint
extends Object

This describes an oembed endpoint, with its name, url schemes etc. Such an endpoint can be embedded in several text documents around Daily Fratze.
This class is implemented as a plain java bean so that it can be used without much hassle inside spring @Configuration.

Author:

Michael J. Simons, 2014-12-30

Constructor Summary

Constructors

Constructor and Description
OembedEndpoint()

Method Summary

Modifier and Type	Method and Description
String	getEndpoint()
OembedResponse.Format	getFormat()
Integer	getMaxHeight()
Integer	getMaxWidth()
String	getName()
Class<? extends RequestProvider>	getRequestProviderClass()
Map<String,String>	getRequestProviderProperties()
Class<? extends OembedResponseRenderer>	getResponseRendererClass()
Map<String,String>	getResponseRendererProperties()
List<String>	getUrlSchemes()
void	setEndpoint(String endpoint) Updates the endpoint of this provider.
void	setFormat(OembedResponse.Format format) Updates the format of this endpoint.
void	setMaxHeight(Integer maxHeight) Updates the maximum height requested by this endpoint.
void	setMaxWidth(Integer maxWidth) Updates the maximum width requested by this endpoint.
void	setName(String name) Update the name of this provider.
void	setRequestProviderClass(Class<? extends RequestProvider> requestProviderClass) Update the request provider class.
void	setRequestProviderProperties(Map<String,String> requestProviderProperties) Update the properties of the request provider instance.
void	setResponseRendererClass(Class<? extends OembedResponseRenderer> responseRendererClass) Update the response renderer class.
void	setResponseRendererProperties(Map<String,String> responseRendererProperties) Update the properties of the response renderer instance.
void	setUrlSchemes(List<String> urlSchemes) Updates the list of recognized url schemes.
URI	toApiUrl(String url) Creates an URI that can be called to retrieve an oembed response for the url url.

Methods inherited from class java.lang.Object

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

Constructor Detail

OembedEndpoint

public OembedEndpoint()

Method Detail

getName

public String getName()

Returns:

The name of this provider

setName

public void setName(String name)

Update the name of this provider.

Parameters:

name - The new name

getEndpoint

public String getEndpoint()

Returns:

The endpoint of this provider

setEndpoint

public void setEndpoint(String endpoint)

Updates the endpoint of this provider. Any .{format} parameter will be recognized.

Parameters:

endpoint - The new endpoint

getFormat

public OembedResponse.Format getFormat()

Returns:

The format that this provider supports

setFormat

public void setFormat(OembedResponse.Format format)

Updates the format of this endpoint.

Parameters:

format - The new format

getMaxWidth

public Integer getMaxWidth()

Returns:

The maximum width requested by this endpoint

setMaxWidth

public void setMaxWidth(Integer maxWidth)

Updates the maximum width requested by this endpoint.

Parameters:

maxWidth - The new maximum width. Can be null.

getMaxHeight

public Integer getMaxHeight()

Returns:

The maximum height requested by this endpoint

setMaxHeight

public void setMaxHeight(Integer maxHeight)

Updates the maximum height requested by this endpoint.

Parameters:

maxHeight - The new maximum height. Can be null.

getUrlSchemes

public List<String> getUrlSchemes()

Returns:

The list of recognized url schemes

setUrlSchemes

public void setUrlSchemes(List<String> urlSchemes)

Updates the list of recognized url schemes.

Parameters:

urlSchemes - A new list of url schemes. May not be null-

getRequestProviderClass

public Class<? extends RequestProvider> getRequestProviderClass()

Returns:

The class of the request provider for this endpoint

setRequestProviderClass

public void setRequestProviderClass(Class<? extends RequestProvider> requestProviderClass)

Update the request provider class.

Parameters:

requestProviderClass - New request provider class

getRequestProviderProperties

public Map<String,String> getRequestProviderProperties()

Returns:

Additional properties for the request provider instance

setRequestProviderProperties

public void setRequestProviderProperties(Map<String,String> requestProviderProperties)

Update the properties of the request provider instance.

Parameters:

requestProviderProperties - New map of properties

getResponseRendererClass

public Class<? extends OembedResponseRenderer> getResponseRendererClass()

Returns:

The class of the response renderer for this endpoint

setResponseRendererClass

public void setResponseRendererClass(Class<? extends OembedResponseRenderer> responseRendererClass)

Update the response renderer class.

Parameters:

responseRendererClass - New response renderer class

getResponseRendererProperties

public Map<String,String> getResponseRendererProperties()

Returns:

Additional properties for the response renderer instance

setResponseRendererProperties

public void setResponseRendererProperties(Map<String,String> responseRendererProperties)

Update the properties of the response renderer instance.

Parameters:

responseRendererProperties - New map of properties

toApiUrl

public URI toApiUrl(String url)

Creates an URI that can be called to retrieve an oembed response for the url url.

Parameters:

url - The url for which an oembed api url should be created

Returns:

An api url that hopefully returns an oembed response for url

Throws:

OembedException - Any exceptions that occur during building the url