Package ac.simons.oembed

Class OembedEndpoint

  • public class OembedEndpoint
extends java.lang.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 Detail

      • OembedEndpoint

        public OembedEndpoint()

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        The name of this provider

      • setName

        public void setName​(java.lang.String name)
        Update the name of this provider.
        Parameters:
        name - The new name

      • getEndpoint

        public java.lang.String getEndpoint()
        Returns:
        The endpoint of this provider

      • setEndpoint

        public void setEndpoint​(java.lang.String endpoint)
        Updates the endpoint of this provider. Any .{format} parameter will be recognized.
        Parameters:
        endpoint - The new endpoint

      • setFormat

        public void setFormat​(OembedResponse.Format format)
        Updates the format of this endpoint.
        Parameters:
        format - The new format

      • getMaxWidth

        public java.lang.Integer getMaxWidth()
        Returns:
        The maximum width requested by this endpoint

      • setMaxWidth

        public void setMaxWidth​(java.lang.Integer maxWidth)
        Updates the maximum width requested by this endpoint.
        Parameters:
        maxWidth - The new maximum width. Can be null.

      • getMaxHeight

        public java.lang.Integer getMaxHeight()
        Returns:
        The maximum height requested by this endpoint

      • setMaxHeight

        public void setMaxHeight​(java.lang.Integer maxHeight)
        Updates the maximum height requested by this endpoint.
        Parameters:
        maxHeight - The new maximum height. Can be null.

      • getUrlSchemes

        public java.util.List<java.lang.String> getUrlSchemes()
        Returns:
        The list of recognized url schemes

      • setUrlSchemes

        public void setUrlSchemes​(java.util.List<java.lang.String> urlSchemes)
        Updates the list of recognized url schemes.
        Parameters:
        urlSchemes - A new list of url schemes. May not be null-

      • getRequestProviderClass

        public java.lang.Class<? extends RequestProvider> getRequestProviderClass()
        Returns:
        The class of the request provider for this endpoint

      • setRequestProviderClass

        public void setRequestProviderClass​(java.lang.Class<? extends RequestProvider> requestProviderClass)
        Update the request provider class.
        Parameters:
        requestProviderClass - New request provider class

      • getRequestProviderProperties

        public java.util.Map<java.lang.String,​java.lang.String> getRequestProviderProperties()
        Returns:
        Additional properties for the request provider instance

      • setRequestProviderProperties

        public void setRequestProviderProperties​(java.util.Map<java.lang.String,​java.lang.String> requestProviderProperties)
        Update the properties of the request provider instance.
        Parameters:
        requestProviderProperties - New map of properties

      • getResponseRendererClass

        public java.lang.Class<? extends OembedResponseRenderer> getResponseRendererClass()
        Returns:
        The class of the response renderer for this endpoint

      • setResponseRendererClass

        public void setResponseRendererClass​(java.lang.Class<? extends OembedResponseRenderer> responseRendererClass)
        Update the response renderer class.
        Parameters:
        responseRendererClass - New response renderer class

      • getResponseRendererProperties

        public java.util.Map<java.lang.String,​java.lang.String> getResponseRendererProperties()
        Returns:
        Additional properties for the response renderer instance

      • setResponseRendererProperties

        public void setResponseRendererProperties​(java.util.Map<java.lang.String,​java.lang.String> responseRendererProperties)
        Update the properties of the response renderer instance.
        Parameters:
        responseRendererProperties - New map of properties

      • toApiUrl

        public java.net.URI toApiUrl​(java.lang.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