io.mats3.localinspect

Interface LocalHtmlInspectForMatsFactory

All Known Implementing Classes:

LocalHtmlInspectForMatsFactoryImpl

public interface LocalHtmlInspectForMatsFactory

Will produce an "embeddable" HTML interface - notice that there are CSS (getStyleSheet(Appendable)), JavaScript (getJavaScript(Appendable)) and HTML (createFactoryReport(Appendable,..)) to include. If the LocalStatsMatsInterceptor is installed on the MatsFactory implementing MatsInterceptable, it will include pretty nice "local statistics" for all initiators, endpoints and stages.

Note: You are expected to create one instance of an implementation of this interface per MatsFactory, and keep these around for the lifetime of the MatsFactories (i.e. for the JVM) - as in multiple singletons. Do not create one per HTML request. The reason for this is that at a later point, this class might be extended with "active" features, like stopping and starting endpoints, change the concurrency etc - at which point it might itself need active state, e.g. for a feature like "stop this endpoint for 30 minutes".

Method Summary

Modifier and Type	Method and Description
static LocalHtmlInspectForMatsFactory	create(MatsFactory matsFactory) Creates the standard implementation of this interface.
void	createEndpointReport(java.lang.Appendable out, MatsEndpoint<?,?> matsEndpoint, boolean includeStages) Creates the report of a single endpoint.
void	createFactoryReport(java.lang.Appendable out, boolean includeInitiators, boolean includeEndpoints, boolean includeStages) Creates the full MatsFactory HTML report.
void	createFactorySummary(java.lang.Appendable out, boolean includeInitiators, boolean includeEndpoints) Creates the "Summary table" which is a part of the factory report - it may be interesting to embed on a different page without the entire factory report.
void	createInitiatorReport(java.lang.Appendable out, MatsInitiator matsInitiator) Creates the report of a single initiator.
void	createStageReport(java.lang.Appendable out, MatsStage<?,?,?> matsStage) Creates the report of a single stage.
void	getJavaScript(java.lang.Appendable out) Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.
void	getStyleSheet(java.lang.Appendable out) Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Method Detail

create

static LocalHtmlInspectForMatsFactory create(MatsFactory matsFactory)

Creates the standard implementation of this interface.

getStyleSheet

void getStyleSheet(java.lang.Appendable out)
            throws java.io.IOException

Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Throws:

java.io.IOException

getJavaScript

void getJavaScript(java.lang.Appendable out)
            throws java.io.IOException

Note: The return from this method is static, and should only be included once per HTML page, no matter how many MatsFactories you display.

Throws:

java.io.IOException

createFactoryReport

void createFactoryReport(java.lang.Appendable out,
                         boolean includeInitiators,
                         boolean includeEndpoints,
                         boolean includeStages)
                  throws java.io.IOException

Creates the full MatsFactory HTML report.

Parameters:

out - where to output the HTML

includeInitiators - whether to include the initiators in the report

includeEndpoints - whether to include the endpoints in the report

includeStages - whether to include the stages of the endpoints in the report

Throws:

java.io.IOException - if the Appendable throws while being output to.

createFactorySummary

void createFactorySummary(java.lang.Appendable out,
                          boolean includeInitiators,
                          boolean includeEndpoints)
                   throws java.io.IOException

Creates the "Summary table" which is a part of the factory report - it may be interesting to embed on a different page without the entire factory report.

Parameters:

out - where to output the HTML

includeInitiators - whether to include the initiators in the report

includeEndpoints - whether to include the endpoints in the report

Throws:

java.io.IOException - if the Appendable throws while being output to.

createInitiatorReport

void createInitiatorReport(java.lang.Appendable out,
                           MatsInitiator matsInitiator)
                    throws java.io.IOException

Creates the report of a single initiator.

Throws:

java.io.IOException

createEndpointReport

void createEndpointReport(java.lang.Appendable out,
                          MatsEndpoint<?,?> matsEndpoint,
                          boolean includeStages)
                   throws java.io.IOException

Creates the report of a single endpoint.

Throws:

java.io.IOException

createStageReport

void createStageReport(java.lang.Appendable out,
                       MatsStage<?,?,?> matsStage)
                throws java.io.IOException

Creates the report of a single stage.

Throws:

java.io.IOException