Package de.uplanet.lucy.server.urlredirect.scripting.groovy

Class GroovyRedirectRules

    • Method Detail

      • createNew

        public static GroovyRedirectRules createNew()
        Create a new and empty redirect rules object.
        Returns:
        The new and empty redirect rules.

      • reloadConfiguration

        public static void reloadConfiguration()
        Reload the currently deployed redirect rules in the system.

        Calling this method does not affect rules possibly loaded with load().

      • save

        public void save()
          throws IOException,
                 SAXException
        Save these redirect rules to the configuration file internal/cfg/urlredirect.cfg.

        Note: The content of the existing file will be completely overwritten.

        Throws:
        SAXException
        IOException

      • size

        public int size()
        Returns the number of rules.
        Returns:
        The number of rules.

      • isEmpty

        public boolean isEmpty()
        Check if there are any rules defined.
        Returns:
        true if there are any rules defined, or false otherwise.

      • contains

        public boolean contains​(GroovyRedirectRule p_rule)
        Check if the rules contain the given one.
        Parameters:
        p_rule - The rule whose presence in this list is to be tested.
        Returns:
        true if the rules contain the given one, or false otherwise.

      • indexOf

        public int indexOf​(GroovyRedirectRule p_rule)
        Get the index of the given rule in this list.
        Parameters:
        p_rule - The rule to search for.
        Returns:
        The index of the given rule, or -1 if the list does not contain the rule.

      • add

        public boolean add​(GroovyRedirectRule p_rule)
        Append the given rule to the end of the list.
        Parameters:
        p_rule - The rule to be appended.
        Returns:
        true if the rules have been changed by this call, or false otherwise.

      • leftShift

        public GroovyRedirectRules leftShift​(GroovyRedirectRule p_rule)
        Append the given rule to the end of the list.
        Parameters:
        p_rule - The rule to be appended.
        Returns:
        This redirect rules.

      • get

        public GroovyRedirectRule get​(int p_iIndex)
        Get the redirect rule at the specified index in this list.
        Parameters:
        p_iIndex - The index of the redirect rule.
        Returns:
        The redirect rule.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e. (index < 0 || index >= size()).
        See Also:
        getAt(int)

      • set

        public GroovyRedirectRule set​(int p_iIndex,
                              GroovyRedirectRule p_rule)
        Replace the redirect rule at the specified index in this list.
        Parameters:
        p_iIndex - The index of the redirect rule to be replaced.
        Returns:
        The redirect rule previously at the specified index.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e. (index < 0 || index >= size()).
        See Also:
        getAt(int)

      • add

        public void add​(int p_iIndex,
                GroovyRedirectRule p_rule)
        Inserts the given redirect rule at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).
        Parameters:
        p_iIndex - The index at which the specified redirect rule is to be inserted.
        p_rule - The rule to be appended.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e (index < 0 || index > size()).

      • getAt

        public GroovyRedirectRule getAt​(int p_iIndex)
        Get the redirect rule at the specified index in this list.

        This methods supports Groovy's subscript operator, e.g. 

         def rules = GroovyRedirectRules.load()
 def firstRule = rules[0]
 def lastRule  = rules[-1]

        Parameters:
        p_iIndex - The index of the redirect rule.
        Returns:
        The redirect rule.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e. (index < 0 || index >= size()).
        See Also:
        get(int)

      • putAt

        public void putAt​(int p_iIndex,
                  GroovyRedirectRule p_rule)
        Set the redirect rule at the specified index in this list.

        This methods supports Groovy's subscript operator, e.g. 

         def rules = GroovyRedirectRules.load()
 rules[0]  = firstRule
 rules[-1] = lastRule

        Parameters:
        p_iIndex - The index of the redirect rule.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e. (index < 0 || index > size()).
        See Also:
        set(int, GroovyRedirectRule), add(GroovyRedirectRule)

      • remove

        public boolean remove​(GroovyRedirectRule p_rule)
        Remove the given redirect rule if it is contained in this list.
        Parameters:
        p_rule - The rule to be removed.
        Returns:
        true if this list contained the specified redirect rule, or false otherwise.

      • removeAll

        public boolean removeAll​(Collection<?> p_rules)
        Remove the redirect rules contained in this list.
        Parameters:
        p_rules - The rules to be removed.
        Returns:
        true if this list changed as a result of the call, or false otherwise.

      • remove

        public GroovyRedirectRule remove​(int p_iIndex)
        Removes the redirect rule at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
        Parameters:
        p_iIndex - The index of the redirect rule to be removed.
        Returns:
        The removed redirect rule.
        Throws:
        IndexOutOfBoundsException - If the index is out of range, i.e (index < 0 || index >= size()).

      • clear

        public void clear()
        Delete all redirect rules.