Package net.officefloor.servlet.procedure

Class FilterProcedureSource

java.lang.Object

net.officefloor.servlet.procedure.FilterProcedureSource

All Implemented Interfaces:

ManagedFunctionProcedureSource, ProcedureSource, ProcedureSourceServiceFactory, ServiceFactory<ProcedureSource>

public class FilterProcedureSource
extends Object
implements ManagedFunctionProcedureSource, ProcedureSourceServiceFactory

Filter ProcedureSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FilterProcedureSource.FlowKeys	Flow keys.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOURCE_NAME	FilterProcedureSource source name.

Constructor Summary

Constructors

Constructor	Description
FilterProcedureSource()

Method Summary

Modifier and Type	Method	Description
ProcedureSource	createService(ServiceContext context)	Creates the service.
String	getSourceName()	Name of this source.
void	listProcedures(ProcedureListContext context)	Provides the available Procedure instances for the resource.
void	loadManagedFunction(ProcedureManagedFunctionContext context)	Loads the ManagedFunction for the Procedure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.activity.procedure.spi.ManagedFunctionProcedureSource

loadMethod

Field Details

SOURCE_NAME

public static final String SOURCE_NAME

FilterProcedureSource source name.

Constructor Details

FilterProcedureSource

public FilterProcedureSource()

Method Details

createService

public ProcedureSource createService(ServiceContext context)
                              throws Throwable

Description copied from interface: ServiceFactory

Creates the service.

Specified by:

createService in interface ServiceFactory<ProcedureSource>

Parameters:

context - ServiceContext.

Returns:

Service.

Throws:

Throwable - If fails to create the service.

getSourceName

public String getSourceName()

Description copied from interface: ProcedureSource

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

Specified by:

getSourceName in interface ProcedureSource

Returns:

Name of this source.

listProcedures

public void listProcedures(ProcedureListContext context)
                    throws Exception

Description copied from interface: ProcedureSource

Provides the available Procedure instances for the resource.

Specified by:

listProcedures in interface ProcedureSource

Parameters:

context - ProcedureListContext.

Throws:

Exception - If fails to list Procedure instances.

loadManagedFunction

public void loadManagedFunction(ProcedureManagedFunctionContext context)
                         throws Exception

Description copied from interface: ManagedFunctionProcedureSource

Loads the ManagedFunction for the Procedure.

Specified by:

loadManagedFunction in interface ManagedFunctionProcedureSource

Parameters:

context - ProcedureManagedFunctionContext.

Throws:

Exception - If fails to load the ManagedFunction.