Package org.apache.ignite.internal.managers.systemview

Class AbstractSystemViewExporterSpi

java.lang.Object

org.apache.ignite.spi.IgniteSpiAdapter

org.apache.ignite.internal.managers.systemview.AbstractSystemViewExporterSpi

All Implemented Interfaces:

IgniteSpi, SystemViewExporterSpi

Direct Known Subclasses:

JmxSystemViewExporterSpi

public abstract class AbstractSystemViewExporterSpi
extends IgniteSpiAdapter
implements SystemViewExporterSpi

Basic class for SystemViewExporterSpi implementations.

See Also:

JmxSystemViewExporterSpi, IgniteConfiguration.setSystemViewExporterSpi(SystemViewExporterSpi...)

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Predicate<SystemView<?>>	filter	System view filter.
protected ReadOnlySystemViewRegistry	sysViewReg	System view registry.

Fields inherited from class org.apache.ignite.spi.IgniteSpiAdapter

ignite, igniteInstanceName, log

Constructor Summary

Constructors

Constructor	Description
AbstractSystemViewExporterSpi()

Method Summary

Modifier and Type	Method	Description
void	setExportFilter(Predicate<SystemView<?>> filter)	Sets export filter.
void	setSystemViewRegistry(ReadOnlySystemViewRegistry mlreg)	Sets system view registry that SPI should export.
void	spiStart(@Nullable String igniteInstanceName)	This method is called to start SPI.
void	spiStop()	This method is called to stop SPI.

Methods inherited from class org.apache.ignite.spi.IgniteSpiAdapter

addTimeoutObject, assertParameter, checkConfigurationConsistency0, clientFailureDetectionTimeout, configInfo, createSpiAttributeName, failureDetectionTimeout, failureDetectionTimeoutEnabled, failureDetectionTimeoutEnabled, getConsistentAttributeNames, getExceptionRegistry, getLocalNode, getName, getNodeAttributes, getSpiContext, ignite, initFailureDetectionTimeout, injectables, injectResources, isNodeStopping, onBeforeStart, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextDestroyed0, onContextInitialized, onContextInitialized0, registerMBean, removeTimeoutObject, setName, started, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.spi.IgniteSpi

getName, getNodeAttributes, onClientDisconnected, onClientReconnected, onContextDestroyed, onContextInitialized

Field Detail

sysViewReg

protected ReadOnlySystemViewRegistry sysViewReg

System view registry.

filter

@Nullable
protected @Nullable Predicate<SystemView<?>> filter

System view filter.

Constructor Detail

AbstractSystemViewExporterSpi

public AbstractSystemViewExporterSpi()

Method Detail

spiStart

public void spiStart(@Nullable
                     @Nullable String igniteInstanceName)
              throws IgniteSpiException

This method is called to start SPI. After this method returns successfully kernel assumes that SPI is fully operational.

Specified by:

spiStart in interface IgniteSpi

Parameters:

igniteInstanceName - Name of Ignite instance this SPI is being started for (null for default Ignite instance).

Throws:

IgniteSpiException - Throws in case of any error during SPI start.

spiStop

public void spiStop()
             throws IgniteSpiException

This method is called to stop SPI. After this method returns kernel assumes that this SPI is finished and all resources acquired by it are released.

Note that this method can be called at any point including during recovery of failed start. It should make no assumptions on what state SPI will be in when this method is called.

Specified by:

spiStop in interface IgniteSpi

Throws:

IgniteSpiException - Thrown in case of any error during SPI stop.

setSystemViewRegistry

public void setSystemViewRegistry(ReadOnlySystemViewRegistry mlreg)

Sets system view registry that SPI should export. This method called before IgniteSpi.spiStart(String).

Specified by:

setSystemViewRegistry in interface SystemViewExporterSpi

Parameters:

mlreg - System view registry.

setExportFilter

public void setExportFilter(Predicate<SystemView<?>> filter)

Sets export filter. System view that not satisfy filter shouldn't be exported.

Specified by:

setExportFilter in interface SystemViewExporterSpi

Parameters:

filter - Filter.