Package org.nekosoft.pdffer.actuator

Class TemplateRegistryEndpoint

java.lang.Object

org.nekosoft.pdffer.actuator.TemplateRegistryEndpoint

@Component
@Endpoint(id="pdffer-template-registry")
@ConditionalOnClass(name="org.springframework.boot.actuate.endpoint.annotation.Endpoint")
@Profile("pddfer-actuator")
public class TemplateRegistryEndpoint
extends Object

A Spring Actuator endpoint that allows inspection of the PDFfer registry.

Constructor Summary

Constructors

Constructor	Description
TemplateRegistryEndpoint(PdfferRegistryBean registry)	Allows Spring to create the endpoint instance and pass the PdfferRegistryBean instance into it.

Method Summary

Modifier and Type	Method	Description
List<String>	allTemplates()	A READ operation that returns a list of all available templates in the registry.
Map<String,Object>	template(String path)	A READ operation that returns details about a specific template identified by the given path.

Methods inherited from class java.lang.Object

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

Constructor Details

TemplateRegistryEndpoint

public TemplateRegistryEndpoint(PdfferRegistryBean registry)

Allows Spring to create the endpoint instance and pass the PdfferRegistryBean instance into it.

Parameters:

registry - the PdfferRegistryBean instance to be injected by the Spring framework

Method Details

allTemplates

@ReadOperation
public List<String> allTemplates()

A READ operation that returns a list of all available templates in the registry.

Returns:

the list of templates in the registry

template

@ReadOperation
public Map<String,Object> template(@Selector
 String path)

A READ operation that returns details about a specific template identified by the given path.

Parameters:

path - the path of the template to be inspected

Returns:

a Java map with the details about the template (the keys are "Class Name", "Template Path" , "Template Group", "Template Name", "Template Scope").