org.springframework.cloud.function.context.catalog

Class AbstractComposableFunctionRegistry

java.lang.Object

org.springframework.cloud.function.context.catalog.AbstractComposableFunctionRegistry

All Implemented Interfaces:

org.springframework.beans.factory.Aware, FunctionInspector, FunctionCatalog, FunctionRegistry, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.EnvironmentAware

Direct Known Subclasses:

InMemoryFunctionCatalog

public abstract class AbstractComposableFunctionRegistry
extends Object
implements FunctionRegistry, FunctionInspector, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.EnvironmentAware

Base implementation of FunctionRegistry which supports function composition during lookups. For example if this registry contains function 'a' and 'b' you can compose them into a single function by simply piping two names together during the lookup this.lookup(Function.class, "a|b"). Comma ',' is also supported as composition delimiter (e.g., "a,b").

Since:

2.1

Author:

Oleg Zhurakousky, Dave Syer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationEventPublisher	applicationEventPublisher

Constructor Summary

Constructors

Constructor and Description
AbstractComposableFunctionRegistry()

Method Summary

Modifier and Type	Method and Description
protected void	addFunction(String name, Function<?,?> function)
protected void	addName(Object function, String name)
protected void	addSupplier(String name, Supplier<?> supplier)
protected void	addType(String name, FunctionType functionType)
protected FunctionType	findType(FunctionRegistration<?> functionRegistration, String name)
Set<String>	getFunctionNames() Returns the names of available Functions.
FunctionType	getFunctionType(String name)
Set<String>	getNames(Class<?> type)
FunctionRegistration<?>	getRegistration(Object function)
Set<String>	getSupplierNames() Returns the names of available Suppliers.
boolean	hasFunctions()
boolean	hasSuppliers()
<T> T	lookup(Class<?> type, String name) Will look up the instance of the functional interface by name and type which can only be Supplier, Consumer or Function.
String	lookupFunctionName(Object function) A reverse lookup where one can determine the actual name of the function reference.
protected void	register(FunctionRegistration<?> registration, String key) Registers function wrapped by the provided FunctionRegistration with this FunctionRegistry.
<T> void	register(FunctionRegistration<T> functionRegistration)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setEnvironment(org.springframework.core.env.Environment environment)
int	size() The size of this catalog, which is the count of all Suppliers, Function and Consumers currently registered.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.function.context.FunctionCatalog

lookup, lookup

Methods inherited from interface org.springframework.cloud.function.context.catalog.FunctionInspector

getInputType, getInputWrapper, getName, getOutputType, getOutputWrapper, isMessage

Field Detail

applicationEventPublisher

protected org.springframework.context.ApplicationEventPublisher applicationEventPublisher

Constructor Detail

AbstractComposableFunctionRegistry

public AbstractComposableFunctionRegistry()

Method Detail

lookup

public <T> T lookup(Class<?> type,
                    String name)

Description copied from interface: FunctionCatalog

Will look up the instance of the functional interface by name and type which can only be Supplier, Consumer or Function. If type is not provided, the lookup will be made based on name only.

Specified by:

lookup in interface FunctionCatalog

Type Parameters:

T - instance type

Parameters:

type - the type of functional interface. Can be null

name - the definition of the functional interface. Must not be null;

Returns:

instance of the functional interface registered with this catalog

getNames

public Set<String> getNames(Class<?> type)

Specified by:

getNames in interface FunctionCatalog

getSupplierNames

public Set<String> getSupplierNames()

Returns the names of available Suppliers.

Returns:

immutable Set of available Supplier names.

getFunctionNames

public Set<String> getFunctionNames()

Returns the names of available Functions.

Returns:

immutable Set of available Function names.

hasSuppliers

public boolean hasSuppliers()

hasFunctions

public boolean hasFunctions()

size

public int size()

The size of this catalog, which is the count of all Suppliers, Function and Consumers currently registered.

Specified by:

size in interface FunctionCatalog

Returns:

the count of all Suppliers, Function and Consumers currently registered.

getFunctionType

public FunctionType getFunctionType(String name)

lookupFunctionName

public String lookupFunctionName(Object function)

A reverse lookup where one can determine the actual name of the function reference.

Parameters:

function - should be an instance of Supplier, Function or Consumer;

Returns:

the name of the function or null.

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

getRegistration

public FunctionRegistration<?> getRegistration(Object function)

Specified by:

getRegistration in interface FunctionInspector

register

public <T> void register(FunctionRegistration<T> functionRegistration)

Specified by:

register in interface FunctionRegistry

register

protected void register(FunctionRegistration<?> registration,
                        String key)

Registers function wrapped by the provided FunctionRegistration with this FunctionRegistry.

Parameters:

registration - instance of FunctionRegistration

key - the name of the function

findType

protected FunctionType findType(FunctionRegistration<?> functionRegistration,
                                String name)

addSupplier

protected void addSupplier(String name,
                           Supplier<?> supplier)

addFunction

protected void addFunction(String name,
                           Function<?,?> function)

addType

protected void addType(String name,
                       FunctionType functionType)

addName

protected void addName(Object function,
                       String name)