Package org.jgroups.stack

Class DiagnosticsHandler

java.lang.Object

org.jgroups.blocks.cs.ReceiverAdapter

org.jgroups.stack.DiagnosticsHandler

All Implemented Interfaces:

Closeable, AutoCloseable, Receiver

public class DiagnosticsHandler
extends ReceiverAdapter
implements Closeable

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DiagnosticsHandler.ProbeHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected InetAddress	bind_addr
protected List<NetworkInterface>	bind_interfaces
protected boolean	enable_tcp
protected boolean	enable_udp
protected boolean	enabled
protected final Set<DiagnosticsHandler.ProbeHandler>	handlers
protected final Log	log
protected InetAddress	mcast_addr
protected String	passcode
protected int	port
protected int	port_range
protected Function<Boolean,String>	print_headers
protected Function<String,Boolean>	same_cluster
protected final SocketFactory	socket_factory
protected ServerSocket	srv_sock
protected Runner	tcp_runner
static final String	TCP_THREAD_NAME
protected final ThreadFactory	thread_factory
protected int	ttl
protected MulticastSocket	udp_mcast_sock
protected final BiConsumer<SocketAddress,String>	udp_response_sender
protected Runner	udp_runner
static final String	UDP_THREAD_NAME
protected DatagramSocket	udp_ucast_sock

Constructor Summary

Constructors

Constructor	Description
DiagnosticsHandler()	Constructor used for standalone apps (without a JGroups stack)
DiagnosticsHandler(Log log, SocketFactory socket_factory, ThreadFactory thread_factory)

Method Summary

Modifier and Type	Method	Description
protected int	authorizeProbeRequest(byte[] request)	Performs authorization on given byte array
protected void	bindToInterfaces(List<NetworkInterface> interfaces, MulticastSocket s)
void	close()
DiagnosticsHandler	enableTcp(boolean f)
DiagnosticsHandler	enableUdp(boolean f)
InetAddress	getBindAddress()
List<NetworkInterface>	getBindInterfaces()
SocketAddress	getLocalAddress()	Returns the local datagram socket address (UDP) or the srv address (TCP)
InetAddress	getMcastAddress()
String	getPasscode()
int	getPort()
int	getPortRange()
Set<DiagnosticsHandler.ProbeHandler>	getProbeHandlers()
int	getTtl()
protected void	handleDiagnosticProbe(SocketAddress sender, String request, BiConsumer<SocketAddress,String> rsp_sender)
protected static boolean	isCompatible(InetAddress addr, List<InterfaceAddress> addrs)	Checks if there's any address in the address list that's compatible (same address family) to addr
boolean	isEnabled()
boolean	isRunning()
DiagnosticsHandler	printHeaders(Function<Boolean,String> f)
DiagnosticsHandler	registerProbeHandler(DiagnosticsHandler.ProbeHandler handler)
protected void	runTCP()
protected void	runUDP()
DiagnosticsHandler	sameCluster(Function<String,Boolean> f)
protected void	sendResponse(DatagramSocket sock, SocketAddress sender, byte[] buf)
DiagnosticsHandler	setBindAddress(InetAddress a)
DiagnosticsHandler	setBindInterfaces(List<NetworkInterface> l)
DiagnosticsHandler	setEnabled(boolean f)
DiagnosticsHandler	setMcastAddress(InetAddress a)
DiagnosticsHandler	setPasscode(String d)
DiagnosticsHandler	setPort(int p)
DiagnosticsHandler	setPortRange(int r)
DiagnosticsHandler	setThreadNames()
DiagnosticsHandler	setTtl(int d)
DiagnosticsHandler	start()
protected DiagnosticsHandler	startTCP()
protected DiagnosticsHandler	startUDP()
DiagnosticsHandler	stop()
boolean	tcpEnabled()
boolean	udpEnabled()
DiagnosticsHandler	unregisterProbeHandler(DiagnosticsHandler.ProbeHandler handler)
DiagnosticsHandler	unsetThreadNames()

Methods inherited from class org.jgroups.blocks.cs.ReceiverAdapter

receive

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgroups.blocks.cs.Receiver

receive, receive, receive

Field Details

UDP_THREAD_NAME

public static final String UDP_THREAD_NAME

See Also:

• Constant Field Values

TCP_THREAD_NAME

public static final String TCP_THREAD_NAME

See Also:

• Constant Field Values

enabled

protected boolean enabled

enable_udp

protected volatile boolean enable_udp

enable_tcp

protected volatile boolean enable_tcp

mcast_addr

protected InetAddress mcast_addr

port

protected int port

bind_addr

protected InetAddress bind_addr

port_range

protected int port_range

ttl

protected int ttl

bind_interfaces

protected List<NetworkInterface> bind_interfaces

passcode

protected String passcode

srv_sock

protected ServerSocket srv_sock

udp_runner

protected Runner udp_runner

tcp_runner

protected Runner tcp_runner

udp_mcast_sock

protected MulticastSocket udp_mcast_sock

udp_ucast_sock

protected DatagramSocket udp_ucast_sock

handlers

protected final Set<DiagnosticsHandler.ProbeHandler> handlers

log

protected final Log log

socket_factory

protected final SocketFactory socket_factory

thread_factory

protected final ThreadFactory thread_factory

print_headers

protected Function<Boolean,String> print_headers

same_cluster

protected Function<String,Boolean> same_cluster

udp_response_sender

protected final BiConsumer<SocketAddress,String> udp_response_sender

Constructor Details

DiagnosticsHandler

public DiagnosticsHandler()
                   throws Exception

Constructor used for standalone apps (without a JGroups stack)

Throws:

Exception

DiagnosticsHandler

public DiagnosticsHandler(Log log,
 SocketFactory socket_factory,
 ThreadFactory thread_factory)

Method Details

printHeaders

public DiagnosticsHandler printHeaders(Function<Boolean,String> f)

sameCluster

public DiagnosticsHandler sameCluster(Function<String,Boolean> f)

isEnabled

public boolean isEnabled()

setEnabled

public DiagnosticsHandler setEnabled(boolean f)

setMcastAddress

public DiagnosticsHandler setMcastAddress(InetAddress a)

getMcastAddress

public InetAddress getMcastAddress()

setBindAddress

public DiagnosticsHandler setBindAddress(InetAddress a)

getBindAddress

public InetAddress getBindAddress()

udpEnabled

public boolean udpEnabled()

enableUdp

public DiagnosticsHandler enableUdp(boolean f)

tcpEnabled

public boolean tcpEnabled()

enableTcp

public DiagnosticsHandler enableTcp(boolean f)

getPort

public int getPort()

setPort

public DiagnosticsHandler setPort(int p)

getPortRange

public int getPortRange()

setPortRange

public DiagnosticsHandler setPortRange(int r)

getTtl

public int getTtl()

setTtl

public DiagnosticsHandler setTtl(int d)

getPasscode

public String getPasscode()

setPasscode

public DiagnosticsHandler setPasscode(String d)

getBindInterfaces

public List<NetworkInterface> getBindInterfaces()

setBindInterfaces

public DiagnosticsHandler setBindInterfaces(List<NetworkInterface> l)

setThreadNames

public DiagnosticsHandler setThreadNames()

unsetThreadNames

public DiagnosticsHandler unsetThreadNames()

getProbeHandlers

public Set<DiagnosticsHandler.ProbeHandler> getProbeHandlers()

registerProbeHandler

public DiagnosticsHandler registerProbeHandler(DiagnosticsHandler.ProbeHandler handler)

unregisterProbeHandler

public DiagnosticsHandler unregisterProbeHandler(DiagnosticsHandler.ProbeHandler handler)

start

public DiagnosticsHandler start()
                         throws Exception

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

stop

public DiagnosticsHandler stop()

isRunning

public boolean isRunning()

getLocalAddress

public SocketAddress getLocalAddress()

Returns the local datagram socket address (UDP) or the srv address (TCP)

runUDP

protected void runUDP()

runTCP

protected void runTCP()

startUDP

protected DiagnosticsHandler startUDP()
                               throws Exception

Throws:

Exception

startTCP

protected DiagnosticsHandler startTCP()
                               throws Exception

Throws:

Exception

handleDiagnosticProbe

protected void handleDiagnosticProbe(SocketAddress sender,
 String request,
 BiConsumer<SocketAddress,String> rsp_sender)

authorizeProbeRequest

protected int authorizeProbeRequest(byte[] request)
                             throws Exception

Performs authorization on given byte array

Parameters:

request - to authorize

Returns:

offset in DatagramPacket where request payload starts

Throws:

Exception - thrown if passcode received from client does not match set passcode

sendResponse

protected void sendResponse(DatagramSocket sock,
 SocketAddress sender,
 byte[] buf)

bindToInterfaces

protected void bindToInterfaces(List<NetworkInterface> interfaces,
 MulticastSocket s)

isCompatible

protected static boolean isCompatible(InetAddress addr,
 List<InterfaceAddress> addrs)

Checks if there's any address in the address list that's compatible (same address family) to addr