Package io.goobi.viewer.servlets.oembed

Class OEmbedResponse

java.lang.Object
io.goobi.viewer.servlets.oembed.OEmbedResponse
Direct Known Subclasses:
PhotoOEmbedResponse, RichOEmbedResponse
public abstract class OEmbedResponse extends Object
Base class for oEmbed response objects, containing the common fields defined by the oEmbed specification.

  • Field Details

    • version

      protected String version

    • type

      protected String type

    • width

      protected Integer width

    • height

      protected Integer height

    • title

      protected String title

    • authorName

      protected String authorName

    • authorUrl

      protected String authorUrl

    • providerName

      protected String providerName

    • providerUrl

      protected String providerUrl

    • cacheAge

      protected Integer cacheAge

    • thumbnailUrl

      protected String thumbnailUrl

    • thumbnailWidth

      protected Integer thumbnailWidth

    • thumbnailHeight

      protected Integer thumbnailHeight

  • Constructor Details

    • OEmbedResponse

      public OEmbedResponse()

  • Method Details

    • getVersion

      public String getVersion()
      Getter for the field version.
      Returns:
      the oEmbed spec version string (e.g. "1.0")

    • setVersion

      public void setVersion(String version)
      Setter for the field version.
      Parameters:
      version - the oEmbed spec version string (e.g. "1.0")

    • getType

      public String getType()
      Getter for the field type.
      Returns:
      the oEmbed response type (e.g. "photo", "rich", "video", "link")

    • setType

      public void setType(String type)
      Setter for the field type.
      Parameters:
      type - the oEmbed response type (e.g. "photo", "rich", "video", "link")

    • getWidth

      public Integer getWidth()
      Getter for the field width.
      Returns:
      the width in pixels of the embedded content

    • setWidth

      public void setWidth(Integer width)
      Setter for the field width.
      Parameters:
      width - the width in pixels of the embedded content

    • getHeight

      public Integer getHeight()
      Getter for the field height.
      Returns:
      the height in pixels of the embedded content

    • setHeight

      public void setHeight(Integer height)
      Setter for the field height.
      Parameters:
      height - the height in pixels of the embedded content

    • getTitle

      public String getTitle()
      Getter for the field title.
      Returns:
      the title of the embedded resource

    • setTitle

      public void setTitle(String title)
      Setter for the field title.
      Parameters:
      title - the title of the embedded resource

    • getAuthorName

      public String getAuthorName()
      Getter for the field authorName.
      Returns:
      the name of the author or creator of the embedded resource

    • setAuthorName

      public void setAuthorName(String authorName)
      Setter for the field authorName.
      Parameters:
      authorName - the name of the author or creator of the embedded resource

    • getAuthorUrl

      public String getAuthorUrl()
      Getter for the field authorUrl.
      Returns:
      the URL of the author's profile or homepage

    • setAuthorUrl

      public void setAuthorUrl(String authorUrl)
      Setter for the field authorUrl.
      Parameters:
      authorUrl - the URL of the author's profile or homepage

    • getProviderName

      public String getProviderName()
      Getter for the field providerName.
      Returns:
      the name of the oEmbed content provider

    • setProviderName

      public void setProviderName(String providerName)
      Setter for the field providerName.
      Parameters:
      providerName - the name of the oEmbed content provider

    • getProviderUrl

      public String getProviderUrl()
      Getter for the field providerUrl.
      Returns:
      the homepage URL of the oEmbed content provider

    • setProviderUrl

      public void setProviderUrl(String providerUrl)
      Setter for the field providerUrl.
      Parameters:
      providerUrl - the homepage URL of the oEmbed content provider

    • getCacheAge

      public Integer getCacheAge()
      Getter for the field cacheAge.
      Returns:
      the suggested cache lifetime of this response in seconds

    • setCacheAge

      public void setCacheAge(Integer cacheAge)
      Setter for the field cacheAge.
      Parameters:
      cacheAge - the suggested cache lifetime of this response in seconds

    • getThumbnailUrl

      public String getThumbnailUrl()
      Getter for the field thumbnailUrl.
      Returns:
      the URL of the thumbnail image for the embedded resource

    • setThumbnailUrl

      public void setThumbnailUrl(String thumbnailUrl)
      Setter for the field thumbnailUrl.
      Parameters:
      thumbnailUrl - the URL of the thumbnail image for the embedded resource

    • getThumbnailWidth

      public Integer getThumbnailWidth()
      Getter for the field thumbnailWidth.
      Returns:
      the width in pixels of the thumbnail image

    • setThumbnailWidth

      public void setThumbnailWidth(Integer thumbnailWidth)
      Setter for the field thumbnailWidth.
      Parameters:
      thumbnailWidth - the width in pixels of the thumbnail image

    • getThumbnailHeight

      public Integer getThumbnailHeight()
      Getter for the field thumbnailHeight.
      Returns:
      the height in pixels of the thumbnail image

    • setThumbnailHeight

      public void setThumbnailHeight(Integer thumbnailHeight)
      Setter for the field thumbnailHeight.
      Parameters:
      thumbnailHeight - the height in pixels of the thumbnail image