Package org.jgroups.protocols.rules

Class SUPERVISOR

  • @Deprecated
public class SUPERVISOR
extends Protocol
    Deprecated.
    Not really needed; all of this can be done by external code, ie. code running in the application.
    Protocol which supervises other protocols. Essentially a rule engine, where rule conditions are checked periodically, triggering (optional) actions. Example: start failure detection in FD is it isn't running

    https://issues.jboss.org/browse/JGRP-1557

    Since:
    3.3
    Author:
    Bela Ban

    • Field Detail

      • local_addr

        protected Address local_addr
        Deprecated.

      • view

        protected volatile View view
        Deprecated.

      • executions

        protected final BoundedList<java.lang.String> executions
        Deprecated.

      • config

        protected java.lang.String config
        Deprecated.

      • rules

        protected final java.util.Map<java.lang.String,​Tuple<Rule,​java.util.concurrent.Future<?>>> rules
        Deprecated.

      • event_handlers

        protected final java.util.List<EventHandler> event_handlers
        Deprecated.

      • num_event_handlers

        protected volatile int num_event_handlers
        Deprecated.

    • Constructor Detail

      • SUPERVISOR

        public SUPERVISOR()
        Deprecated.

    • Method Detail

      • getLocalAddress

        public Address getLocalAddress()
        Deprecated.

      • getView

        public View getView()
        Deprecated.

      • executions

        public java.lang.String executions()
        Deprecated.

      • addCondition

        public void addCondition​(java.lang.String cond)
        Deprecated.

      • getNumRules

        public int getNumRules()
        Deprecated.

      • dumpRules

        public java.lang.String dumpRules()
        Deprecated.

      • register

        public void register​(EventHandler handler)
        Deprecated.

      • unregister

        public void unregister​(EventHandler handler)
        Deprecated.

      • init

        public void init()
          throws java.lang.Exception
        Deprecated.
        Description copied from class: Protocol
        Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
        Overrides:
        init in class Protocol
        Throws:
        java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception

      • destroy

        public void destroy()
        Deprecated.
        Description copied from class: Protocol
        This method is called on a JChannel.close(). Does some cleanup; after the call the VM will terminate
        Overrides:
        destroy in class Protocol

      • installRule

        public void installRule​(long interval,
                        Rule rule)
        Deprecated.
        Installs a new rule
        Parameters:
        interval - Number of ms between executions of the rule
        rule - The rule

      • installRule

        public void installRule​(java.lang.String name,
                        long interval,
                        Rule rule)
        Deprecated.
        Installs a new rule
        Parameters:
        name - The name of the rule
        interval - Number of ms between executions of the rule
        rule - The rule

      • installRule

        public void installRule​(java.lang.String name,
                        long interval,
                        java.lang.String classname)
                 throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception

      • installRule

        public void installRule​(long interval,
                        java.lang.String classname)
                 throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception

      • uninstallRule

        public void uninstallRule​(java.lang.String name)
        Deprecated.

      • down

        public java.lang.Object down​(Event evt)
        Deprecated.
        Description copied from class: Protocol
        An event is to be sent down the stack. A protocol may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the protocol may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down().
        Overrides:
        down in class Protocol

      • down

        public java.lang.Object down​(Message msg)
        Deprecated.
        Description copied from class: Protocol
        A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it before passing it down.
        Overrides:
        down in class Protocol

      • up

        public java.lang.Object up​(Event evt)
        Deprecated.
        Description copied from class: Protocol
        An event was received from the protocol below. Usually the current protocol will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
        Overrides:
        up in class Protocol

      • up

        public void up​(MessageBatch batch)
        Deprecated.
        Description copied from class: Protocol
        Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

        The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(org.jgroups.Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

        Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.getMatchingMessages(short,boolean)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

        Overrides:
        up in class Protocol
        Parameters:
        batch - The message batch

      • handleView

        protected void handleView​(View view)
        Deprecated.

      • parseConfig

        protected void parseConfig​(java.lang.String filename)
                    throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception

      • parseRules

        protected void parseRules​(java.io.InputStream input)
                   throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception

      • parseRule

        protected void parseRule​(org.w3c.dom.Node root)
                  throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception

      • match

        protected static void match​(java.lang.String expected_name,
                            java.lang.String name,
                            boolean is_element)
                     throws java.lang.Exception
        Deprecated.
        Throws:
        java.lang.Exception