org.springframework.cloud.function.context.catalog

Class BeanFactoryAwareFunctionRegistry

java.lang.Object

org.springframework.cloud.function.context.catalog.BeanFactoryAwareFunctionRegistry

All Implemented Interfaces:

org.springframework.beans.factory.Aware, FunctionInspector, FunctionCatalog, FunctionRegistry, org.springframework.context.ApplicationContextAware

public class BeanFactoryAwareFunctionRegistry
extends Object
implements FunctionRegistry, FunctionInspector, org.springframework.context.ApplicationContextAware

Implementation of FunctionRegistry and FunctionCatalog which is aware of the underlying BeanFactory to access available functions. Functions that are registered via register(FunctionRegistration) operation are stored/cached locally.

Since:

3.0

Author:

Oleg Zhurakousky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BeanFactoryAwareFunctionRegistry.FunctionInvocationWrapper Single wrapper for all Suppliers, Functions and Consumers managed by this catalog.

Constructor Summary

Constructors

Constructor and Description
BeanFactoryAwareFunctionRegistry(org.springframework.core.convert.ConversionService conversionService, org.springframework.messaging.converter.CompositeMessageConverter messageConverter)

Method Summary

Modifier and Type	Method and Description
FunctionType	getFunctionType(String name)
Set<String>	getNames(Class<?> type)
FunctionRegistration<?>	getRegistration(Object function)
<T> T	lookup(Class<?> type, String definition) Will look up the instance of the functional interface by name and type which can only be Supplier, Consumer or Function.
<T> T	lookup(String definition, String... acceptedOutputTypes) Will look up the instance of the functional interface by name only.
<T> void	register(FunctionRegistration<T> registration)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
int	size() Return the count of functions registered in this catalog.

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

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

getInputType, getInputWrapper, getName, getOutputType, getOutputWrapper, isMessage

Constructor Detail

BeanFactoryAwareFunctionRegistry

public BeanFactoryAwareFunctionRegistry(org.springframework.core.convert.ConversionService conversionService,
                                        @Nullable
                                        org.springframework.messaging.converter.CompositeMessageConverter messageConverter)

Method Detail

lookup

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

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

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

Returns:

instance of the functional interface registered with this catalog

size

public int size()

Description copied from interface: FunctionCatalog

Return the count of functions registered in this catalog.

Specified by:

size in interface FunctionCatalog

Returns:

the count of functions registered in this catalog

lookup

public <T> T lookup(String definition,
                    String... acceptedOutputTypes)

Description copied from interface: FunctionCatalog

Will look up the instance of the functional interface by name only. This lookup method assumes a very specific semantics which are: function sub-type(s) expected to be Message<byte[]>.
For example,

Function<Message<byte[]>, Message<byte[]>> or
Function<Flux<Message<byte[]>>, Flux<Message<byte[]>>> or
Consumer<Flux<Message<Flux<Message<byte[]>>> etc. . .

The acceptedOutputMimeTypes are the string representation of MimeType where each mime-type in the provided array would correspond to the output with the same index (for cases of functions with multiple outputs) and is used to convert such output back to Message<byte[]>. If you need to provide several accepted types per specific output you can simply delimit them with comma (e.g., application/json,text/plain...).

Specified by:

lookup in interface FunctionCatalog

Type Parameters:

T - instance type which should be one of Supplier, Function or Consumer.

Parameters:

definition - the definition of a function (e.g., 'foo' or 'foo|bar')

acceptedOutputTypes - acceptedOutputMimeTypes array of string representation of MimeTypes used to convert function output back to Message<byte[]>.

Returns:

instance of the functional interface registered with this catalog

getNames

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

Specified by:

getNames in interface FunctionCatalog

register

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

Specified by:

register in interface FunctionRegistry

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getRegistration

public FunctionRegistration<?> getRegistration(Object function)

Specified by:

getRegistration in interface FunctionInspector

getFunctionType

public FunctionType getFunctionType(String name)