Package com.inductiveautomation.ignition.gateway.model

Interface DiagnosticsManager

public interface DiagnosticsManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DiagnosticsManager.BundleState
static interface	DiagnosticsManager.Contributor
static interface	DiagnosticsManager.DiagnosticsBundle
static class	DiagnosticsManager.SynchronousStreamContributor
static class	DiagnosticsManager.SynchronousWriterContributor

Method Summary

Modifier and Type	Method	Description
void	addContributor(DiagnosticsManager.Contributor contributor)
DiagnosticsManager.BundleState	getBundleState()
DiagnosticsManager.DiagnosticsBundle	getDiagnosticsBundle()	Calling this fetches the most recent diagnostic bundle.
static DiagnosticsManager.Contributor	newOutputStreamContributor(java.lang.String filename, FragileConsumer<java.io.OutputStream,java.io.IOException> writeMethod)
static DiagnosticsManager.Contributor	newStringContributor(java.lang.String filename, FragileSupplier<java.lang.String,java.io.IOException> supplier)	Creates a bundle contributor that writes a string to a utf-8 encoded text file in the diagnostic bundle.
static DiagnosticsManager.Contributor	newWriterContributor(java.lang.String filename, FragileConsumer<java.io.Writer,java.io.IOException> writeMethod)
void	removeContributor(DiagnosticsManager.Contributor contributor)

Method Detail

getDiagnosticsBundle

@Nonnull
DiagnosticsManager.DiagnosticsBundle getDiagnosticsBundle()

Calling this fetches the most recent diagnostic bundle. If no diagnostic bundle exists, or the most recent diagnostic bundle is expired or faulted, a new one will be generated and returned.

getBundleState

@Nonnull
DiagnosticsManager.BundleState getBundleState()

Returns:

The state of the diagnostic bundle. Reading this does not alter the state. In other words, calling this does not request a bundle to be generated

addContributor

void addContributor(@Nonnull
                    DiagnosticsManager.Contributor contributor)

removeContributor

void removeContributor(@Nonnull
                       DiagnosticsManager.Contributor contributor)

newOutputStreamContributor

static DiagnosticsManager.Contributor newOutputStreamContributor(java.lang.String filename,
                                                                 FragileConsumer<java.io.OutputStream,java.io.IOException> writeMethod)

newWriterContributor

static DiagnosticsManager.Contributor newWriterContributor(java.lang.String filename,
                                                           FragileConsumer<java.io.Writer,java.io.IOException> writeMethod)

newStringContributor

static DiagnosticsManager.Contributor newStringContributor(java.lang.String filename,
                                                           FragileSupplier<java.lang.String,java.io.IOException> supplier)

Creates a bundle contributor that writes a string to a utf-8 encoded text file in the diagnostic bundle.