Package org.apache.catalina.ha.backend

Class HeartbeatListener

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String host  
      protected java.lang.String ip  
      protected int multiport  
      protected int port  
      protected java.lang.String proxyList
      Proxy list, format "address:port,address:port".
      protected java.lang.String proxyURL
      URL prefix.
      protected int ttl  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void containerEvent​(ContainerEvent event)
      Acknowledge the occurrence of the specified event.
      java.lang.String getGroup()  
      java.lang.String getHost()  
      int getMultiport()  
      int getPort()  
      java.lang.String getProxyList()  
      java.lang.String getProxyURL()  
      int getTtl()  
      void lifecycleEvent​(LifecycleEvent event)
      Acknowledge the occurrence of the specified event.
      void setGroup​(java.lang.String group)
      Set the Multicast IP to use for Multicast
      void setHost​(java.lang.String host)
      Set the host corresponding to the connector.
      void setMultiport​(int port)
      Set the Port to use for Multicast
      void setPort​(int port)
      Set the port corresponding to the connector.
      void setProxyList​(java.lang.String proxyList)
      Set the list of Proxies that send is requests, when not empty it toggles the multi to off.
      void setProxyURLString​(java.lang.String proxyURL)
      Set the URL of receiver in httpd.
      void setTtl​(int ttl)
      Set the TTL for Multicast packets.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • port

        protected int port

      • host

        protected java.lang.String host

      • ip

        protected java.lang.String ip

      • multiport

        protected int multiport

      • ttl

        protected int ttl

      • proxyList

        protected java.lang.String proxyList
        Proxy list, format "address:port,address:port".

      • proxyURL

        protected java.lang.String proxyURL
        URL prefix.

    • Constructor Detail

      • HeartbeatListener

        public HeartbeatListener()

    • Method Detail

      • getHost

        public java.lang.String getHost()
        Returns:
        the host corresponding to the connector we want to proxy.

      • setHost

        public void setHost​(java.lang.String host)
        Set the host corresponding to the connector.
        Parameters:
        host - the hostname or ip string.

      • getPort

        public int getPort()
        Returns:
        the port of the connector we want to proxy.

      • setPort

        public void setPort​(int port)
        Set the port corresponding to the connector.
        Parameters:
        port - default 8009 the ajp one.

      • getGroup

        public java.lang.String getGroup()
        Returns:
        the Multicast IP we are using for Multicast

      • setGroup

        public void setGroup​(java.lang.String group)
        Set the Multicast IP to use for Multicast
        Parameters:
        group - the multi address to use.

      • getMultiport

        public int getMultiport()
        Returns:
        the Multicast Port we are using for Multicast.

      • setMultiport

        public void setMultiport​(int port)
        Set the Port to use for Multicast
        Parameters:
        port - the port to use.

      • getTtl

        public int getTtl()
        Returns:
        the TTL for Multicast packets.

      • setTtl

        public void setTtl​(int ttl)
        Set the TTL for Multicast packets.
        Parameters:
        ttl - value for TTL.

      • getProxyList

        public java.lang.String getProxyList()
        Returns:
        the list of proxies that send us requests.

      • setProxyList

        public void setProxyList​(java.lang.String proxyList)
        Set the list of Proxies that send is requests, when not empty it toggles the multi to off. A SetHandler heartbeat must be existing in httpd.conf.
        Parameters:
        proxyList - the list of proxy, format "address:port,address:port".

      • getProxyURL

        public java.lang.String getProxyURL()
        Returns:
        the URL specified in <Location/> for the SetHandler heartbeat.

      • setProxyURLString

        public void setProxyURLString​(java.lang.String proxyURL)
        Set the URL of receiver in httpd. That is the location used in 
         <Location "/HeartbeatListener">
    SetHandler heartbeat
 </Location>
        All proxies MUST use the same location.
        Parameters:
        proxyURL - a String with the URL starting with /