Package org.opencms.db

Class CmsRewriteAlias

  • public class CmsRewriteAlias
extends java.lang.Object
    This class represents an alias which does not just map a fixed path to a fixed resource, but instead uses a regular expression substitution to determine the target path.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsRewriteAlias​(CmsUUID id, java.lang.String siteRoot, java.lang.String patternString, java.lang.String replacementString, CmsAliasMode mode)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CmsUUID getId()
      Gets the id of the alias.
      CmsAliasMode getMode()
      Gets the alias mode.
      java.lang.String getPatternString()
      Gets the regular expression string.
      java.lang.String getReplacementString()
      Gets the string used to replace the string matching the regex.
      java.lang.String getSiteRoot()
      Gets the root of the site in which this alias is valid.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsRewriteAlias

        public CmsRewriteAlias​(CmsUUID id,
                       java.lang.String siteRoot,
                       java.lang.String patternString,
                       java.lang.String replacementString,
                       CmsAliasMode mode)
        Creates a new instance.

        Parameters:
        id - the id of the alias
        siteRoot - the site root inside which the alias is valid
        patternString - the regular expression used for matching the URI
        replacementString - the replacement string used when the URI is matched
        mode - the alias mode

    • Method Detail

      • getId

        public CmsUUID getId()
        Gets the id of the alias.

        Returns:
        the id of the alias

      • getPatternString

        public java.lang.String getPatternString()
        Gets the regular expression string.

        Returns:
        the regular expression string

      • getReplacementString

        public java.lang.String getReplacementString()
        Gets the string used to replace the string matching the regex.

        Returns:
        the replacement string

      • getSiteRoot

        public java.lang.String getSiteRoot()
        Gets the root of the site in which this alias is valid.

        Returns:
        the site root