Package org.flowable.external.worker.config

Class FlowableWorkerEndpointRegistrar

java.lang.Object

org.flowable.external.worker.config.FlowableWorkerEndpointRegistrar

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean

public class FlowableWorkerEndpointRegistrar
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean

Helper bean for registering FlowableWorkerEndpoint with a FlowableWorkerEndpointRegistry.

Author:

Filip Hrisafov

See Also:

• FlowableWorkerConfigurer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.beans.factory.BeanFactory	beanFactory
protected FlowableWorkerContainerFactory<?>	containerFactory
protected String	containerFactoryBeanName
protected final List<FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor>	endpointDescriptors
protected FlowableWorkerEndpointRegistry	endpointRegistry
protected org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory	messageHandlerMethodFactory
protected Object	mutex
protected boolean	startImmediately

Constructor Summary

Constructors

Constructor	Description
FlowableWorkerEndpointRegistrar()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
FlowableWorkerEndpointRegistry	getEndpointRegistry()	Return the FlowableWorkerEndpointRegistry instance for this registrar, may be null.
org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory	getMessageHandlerMethodFactory()	Return the custom MessageHandlerMethodFactory to use, if any.
protected void	registerAllEndpoints()
void	registerEndpoint(FlowableWorkerEndpoint endpoint)	Register a new FlowableWorkerEndpoint using the default FlowableWorkerContainerFactory to create the underlying container.
void	registerEndpoint(FlowableWorkerEndpoint endpoint, FlowableWorkerContainerFactory<?> factory)	Register a new FlowableWorkerEndpoint alongside the FlowableWorkerContainerFactory to use to create the underlying container.
protected FlowableWorkerContainerFactory<?>	resolveContainerFactory(FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor descriptor)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)	A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).
void	setContainerFactory(FlowableWorkerContainerFactory<?> containerFactory)	Set the FlowableWorkerContainerFactory to use in case a FlowableWorkerEndpoint is registered with a null container factory.
void	setContainerFactoryBeanName(String containerFactoryBeanName)	Set the bean name of the FlowableWorkerContainerFactory to use in case a FlowableWorkerEndpoint is registered with a null container factory.
void	setEndpointRegistry(FlowableWorkerEndpointRegistry endpointRegistry)	Set the FlowableWorkerEndpointRegistry instance to use.
void	setMessageHandlerMethodFactory(org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory)	Set the MessageHandlerMethodFactory to use to configure the job listener responsible to serve an endpoint detected by this processor.

Methods inherited from class java.lang.Object

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

Field Details

endpointRegistry

protected FlowableWorkerEndpointRegistry endpointRegistry

messageHandlerMethodFactory

protected org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory

containerFactory

protected FlowableWorkerContainerFactory<?> containerFactory

containerFactoryBeanName

protected String containerFactoryBeanName

beanFactory

protected org.springframework.beans.factory.BeanFactory beanFactory

endpointDescriptors

protected final List<FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor> endpointDescriptors

startImmediately

protected boolean startImmediately

mutex

protected Object mutex

Constructor Details

FlowableWorkerEndpointRegistrar

public FlowableWorkerEndpointRegistrar()

Method Details

setEndpointRegistry

public void setEndpointRegistry(FlowableWorkerEndpointRegistry endpointRegistry)

Set the FlowableWorkerEndpointRegistry instance to use.

getEndpointRegistry

public FlowableWorkerEndpointRegistry getEndpointRegistry()

Return the FlowableWorkerEndpointRegistry instance for this registrar, may be null.

setMessageHandlerMethodFactory

public void setMessageHandlerMethodFactory(@Nullable
 org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory)

Set the MessageHandlerMethodFactory to use to configure the job listener responsible to serve an endpoint detected by this processor.

By default, DefaultMessageHandlerMethodFactory is used and it can be configured further to support additional method arguments or to customize conversion and validation support. See DefaultMessageHandlerMethodFactory javadoc for more details.

getMessageHandlerMethodFactory

@Nullable
public org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory getMessageHandlerMethodFactory()

Return the custom MessageHandlerMethodFactory to use, if any.

setContainerFactory

public void setContainerFactory(FlowableWorkerContainerFactory<?> containerFactory)

Set the FlowableWorkerContainerFactory to use in case a FlowableWorkerEndpoint is registered with a null container factory.

Alternatively, the bean name of the FlowableWorkerContainerFactory to use can be specified for a lazy lookup, see setContainerFactoryBeanName(java.lang.String).

setContainerFactoryBeanName

public void setContainerFactoryBeanName(String containerFactoryBeanName)

Set the bean name of the FlowableWorkerContainerFactory to use in case a FlowableWorkerEndpoint is registered with a null container factory. Alternatively, the container factory instance can be registered directly: see setContainerFactory(FlowableWorkerContainerFactory).

See Also:

• setBeanFactory(org.springframework.beans.factory.BeanFactory)

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

A BeanFactory only needs to be available in conjunction with setContainerFactoryBeanName(java.lang.String).

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

registerAllEndpoints

protected void registerAllEndpoints()

resolveContainerFactory

protected FlowableWorkerContainerFactory<?> resolveContainerFactory(FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor descriptor)

registerEndpoint

public void registerEndpoint(FlowableWorkerEndpoint endpoint,
 @Nullable
 FlowableWorkerContainerFactory<?> factory)

Register a new FlowableWorkerEndpoint alongside the FlowableWorkerContainerFactory to use to create the underlying container.

The factory may be null if the default factory should be used for the supplied endpoint.

registerEndpoint

public void registerEndpoint(FlowableWorkerEndpoint endpoint)

Register a new FlowableWorkerEndpoint using the default FlowableWorkerContainerFactory to create the underlying container.

See Also:

• setContainerFactory(FlowableWorkerContainerFactory)
• registerEndpoint(FlowableWorkerEndpoint, FlowableWorkerContainerFactory)