Package org.jgroups.protocols

Class SOS

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.SOS
All Implemented Interfaces:
Lifecycle
public class SOS extends Protocol
Periodically fetches some attributes and writes them to a file (https://issues.redhat.com/browse/JGRP-2402)
Since:
4.2.2, 5.0.0

  • Field Details

  • Constructor Details

    • SOS

      public SOS()

  • Method Details

    • getFilename

      public String getFilename()

    • setFileName

      public SOS setFileName(String f)

    • getInterval

      public long getInterval()

    • setInterval

      public SOS setInterval(long i)

    • setCommand

      public SOS setCommand(String filename) throws IOException
      Throws:
      IOException

    • read

      public SOS read() throws IOException
      Throws:
      IOException

    • init

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

    • start

      public void start() throws Exception
      Description copied from class: Protocol
      This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.
      Specified by:
      start in interface Lifecycle
      Overrides:
      start in class Protocol
      Throws:
      Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) will throw an exception

    • stop

      public void stop()
      Description copied from class: Protocol
      Called on a JChannel.disconnect(); stops work (e.g. by closing multicast socket). Will be called from top to bottom.
      Specified by:
      stop in interface Lifecycle
      Overrides:
      stop in class Protocol

    • up

      public void up(MessageBatch batch)
      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(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.iterator(Predicate)), 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

    • exec

      public String exec()

    • getMetadata

      protected String getMetadata()

    • getInput

      protected InputStream getInput(String name) throws FileNotFoundException
      Throws:
      FileNotFoundException