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

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SOS.DumperTask

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	cmd
protected java.lang.String	config
protected java.lang.String	filename
protected java.util.Set<DiagnosticsHandler.ProbeHandler>	handlers
protected long	interval

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
SOS()

Method Summary

Modifier and Type	Method	Description
java.lang.String	exec()
java.lang.String	getFilename()
protected java.io.InputStream	getInput(java.lang.String name)
long	getInterval()
protected java.lang.String	getMetadata()
void	init()	Called after a protocol has been created and before the protocol is started.
SOS	read()
SOS	setCommand(java.lang.String filename)
SOS	setFileName(java.lang.String f)
SOS	setInterval(long i)
void	start()	This method is called on a JChannel.connect(String); starts work.
void	stop()	Called on a JChannel.disconnect(); stops work (e.g.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, down, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString, up, up

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected java.lang.String filename

interval

protected long interval

cmd

protected java.lang.String cmd

config

protected java.lang.String config

handlers

protected java.util.Set<DiagnosticsHandler.ProbeHandler> handlers

Constructor Detail

SOS

public SOS()

Method Detail

getFilename

public java.lang.String getFilename()

setFileName

public SOS setFileName(java.lang.String f)

getInterval

public long getInterval()

setInterval

public SOS setInterval(long i)

setCommand

public SOS setCommand(java.lang.String filename)
               throws java.io.IOException

Throws:

java.io.IOException

read

public SOS read()
         throws java.io.IOException

Throws:

java.io.IOException

init

public void init()
          throws java.lang.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:

java.lang.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 java.lang.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:

java.lang.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 java.lang.String exec()

getMetadata

protected java.lang.String getMetadata()

getInput

protected java.io.InputStream getInput(java.lang.String name)
                                throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException