Package org.opencms.site.xmlsitemap

Class CmsXmlSeoConfiguration

  • public class CmsXmlSeoConfiguration
extends java.lang.Object
    Configuration bean which represents the options which are configurable from a 'seo-file' resource.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List<java.lang.String> m_excludes
      The exclude paths.
      protected java.util.List<java.lang.String> m_includes
      The include paths.
      protected java.lang.String m_mode
      The mode.
      protected java.lang.String m_robotsTxtText
      Text to be included in robots.txt after the sitemap references.
      static java.lang.Object MODE_ROBOTS_TXT
      Mode name constant.
      static java.lang.Object MODE_XML_SITEMAP
      Mode name constant.
      static java.lang.String N_CACHE
      Node name.
      static java.lang.String N_COMPUTE_CONTAINER_PAGE_DATES
      Node name.
      static java.lang.String N_EXCLUDE
      Node name.
      static java.lang.String N_GENERATOR_CLASS
      Node name.
      static java.lang.String N_INCLUDE
      Node name.
      static java.lang.String N_MODE
      Node name.
      static java.lang.String N_ROBOTS_TXT_TEXT
      Node name.
      static java.lang.String N_SERVER_URL
      Node name.
      static java.lang.String SEO_FILE_TYPE
      The file type used for generating XML sitemaps or robots.txt files.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getExcludes()
      Gets the list of exclude paths.
      java.util.List<java.lang.String> getIncludes()
      Gets the list of include paths.
      java.lang.String getMode()
      Gets the mode.
      java.lang.String getRobotsTxtText()
      Gets the text which should be inserted in robots.txt mode.
      java.lang.String getServerUrl()
      Gets the configured server URL.
      java.lang.String getSitemapGeneratorClassName()
      Gets the class name for the sitemap generator class (may return null if none is explicitly configured).
      boolean isXmlSitemapMode()
      Returns true if this configuration is configured as robots.txt mode.
      void load​(CmsObject cms, CmsResource resource)
      Loads the bean data from the given resource.
      boolean shouldComputeContainerPageModificationDates()
      Returns true if container page modification dates should be computed.
      boolean usesCache()
      True if caching should be used for the generated XML sitemap.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getExcludes

        public java.util.List<java.lang.String> getExcludes()
        Gets the list of exclude paths.

        Returns:
        the list of exclude paths

      • getIncludes

        public java.util.List<java.lang.String> getIncludes()
        Gets the list of include paths.

        Returns:
        the list of include paths

      • getMode

        public java.lang.String getMode()
        Gets the mode.

        Returns:
        the mode

      • getRobotsTxtText

        public java.lang.String getRobotsTxtText()
        Gets the text which should be inserted in robots.txt mode.

        Returns:
        the text to insert in robots.txt mode

      • getServerUrl

        public java.lang.String getServerUrl()
        Gets the configured server URL.

        This, if set, replaces the host/port used by getOnlineLink() for the URLs in the XML sitemap.

        Returns:
        the server URL

      • getSitemapGeneratorClassName

        public java.lang.String getSitemapGeneratorClassName()
        Gets the class name for the sitemap generator class (may return null if none is explicitly configured).
        Returns:
        the sitemap generator class name

      • isXmlSitemapMode

        public boolean isXmlSitemapMode()
        Returns true if this configuration is configured as robots.txt mode.

        Returns:
        true if the mode is set to the robots.txt mode

      • load

        public void load​(CmsObject cms,
                 CmsResource resource)
          throws CmsException
        Loads the bean data from the given resource.

        Parameters:
        cms - the CMS context to use
        resource - the resource from which to load the data
        Throws:
        CmsException - if something goes wrong

      • shouldComputeContainerPageModificationDates

        public boolean shouldComputeContainerPageModificationDates()
        Returns true if container page modification dates should be computed.

        Returns:
        true if container page modification dates should be computed

      • usesCache

        public boolean usesCache()
        True if caching should be used for the generated XML sitemap.

        Returns:
        true if caching should be used for the generated XML sitemap