Package com.funnelback.publicui.search.model.curator.trigger

Class RequestParameterTrigger

  • All Implemented Interfaces:
    Trigger, HasNoBeans
    public final class RequestParameterTrigger
extends java.lang.Object
implements Trigger, HasNoBeans

    A trigger which activates when a request parameter has a particular value (e.g. the request URL contains &parameter=value)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private StringMatchType matchType
      The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).
      private java.lang.String parameter
      The request parameter to check
      private java.lang.String value
      The 'value' to check for in the request parameter

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean activatesOn​(SearchTransaction searchTransaction)
      Check whether the given searchTransaction contains a parameter of the given name which matches (as defined by matchType) the value.
      void configure​(Configurer configurer)
      Configure this trigger (expected to autowire in any dependencies)
      boolean equals​(java.lang.Object o)  
      StringMatchType getMatchType()
      The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).
      java.lang.String getParameter()
      The request parameter to check
      java.lang.String getValue()
      The 'value' to check for in the request parameter
      int hashCode()  
      void setMatchType​(StringMatchType matchType)
      The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).
      void setParameter​(java.lang.String parameter)
      The request parameter to check
      void setValue​(java.lang.String value)
      The 'value' to check for in the request parameter
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • parameter

        private java.lang.String parameter
        The request parameter to check

      • value

        private java.lang.String value
        The 'value' to check for in the request parameter

      • matchType

        private StringMatchType matchType
        The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).

    • Constructor Detail

      • RequestParameterTrigger

        public RequestParameterTrigger​(java.lang.String parameter,
                               java.lang.String value,
                               StringMatchType matchType)

      • RequestParameterTrigger

        public RequestParameterTrigger()

    • Method Detail

      • activatesOn

        public boolean activatesOn​(SearchTransaction searchTransaction)
        Check whether the given searchTransaction contains a parameter of the given name which matches (as defined by matchType) the value. In the case of multiple parameters, each is checked, and false returned only if none match.
        Specified by:
        activatesOn in interface Trigger
        Parameters:
        searchTransaction - Current search transaction
        Returns:
        true if this trigger should activate on the given searchTransaction, and false otherwise.

      • configure

        public void configure​(Configurer configurer)
        Configure this trigger (expected to autowire in any dependencies)
        Specified by:
        configure in interface Trigger

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getParameter

        public java.lang.String getParameter()
        The request parameter to check

      • setParameter

        public void setParameter​(java.lang.String parameter)
        The request parameter to check

      • getValue

        public java.lang.String getValue()
        The 'value' to check for in the request parameter

      • setValue

        public void setValue​(java.lang.String value)
        The 'value' to check for in the request parameter

      • getMatchType

        public StringMatchType getMatchType()
        The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).

      • setMatchType

        public void setMatchType​(StringMatchType matchType)
        The type of matching to be performed between each request parameter value (haystack) and the given value parameter (needle).