Package net.officefloor.activity.procedure.spi

Interface ProcedureSource

All Known Subinterfaces:

ManagedFunctionProcedureSource

All Known Implementing Classes:

ClassProcedureSource, FilterProcedureSource, JaxRsProcedureSource, ServletProcedureSource, SpringWebFluxProcedureSource, SpringWebMvcProcedureSource, ThymeleafProcedureSource

public interface ProcedureSource

Source providing a Procedure.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
String	getSourceName()	Name of this source.
void	listProcedures(ProcedureListContext context)	Provides the available Procedure instances for the resource.
Method	loadMethod(ProcedureMethodContext context)	Loads the Method for the Procedure.

Method Details

getSourceName

String getSourceName()

Name of this source.

Note that this is the name used in configuration to identify this ProcedureSource. Therefore, it can not change without causing configurations to be updated.

The reasons for using this logical name over Class names is:

• Class names can be quite long
• Class names are not easily readable
• Enables swapping plugins for same logical service name

Returns:

Name of this source.

listProcedures

void listProcedures(ProcedureListContext context)
             throws Exception

Provides the available Procedure instances for the resource.

Parameters:

context - ProcedureListContext.

Throws:

Exception - If fails to list Procedure instances.

loadMethod

Method loadMethod(ProcedureMethodContext context)
           throws Exception

Loads the Method for the Procedure.

Parameters:

context - ProcedureMethodContext.

Returns:

Method for the ProcedureSource.

Throws:

Exception - If fails to load the method.