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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.springframework.beans.factory.BeanFactoryprotected FlowableWorkerContainerFactory<?>protected Stringprotected final List<FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor>protected FlowableWorkerEndpointRegistryprotected org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactoryprotected Objectprotected boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidReturn theFlowableWorkerEndpointRegistryinstance for this registrar, may benull.org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactoryReturn the customMessageHandlerMethodFactoryto use, if any.protected voidvoidregisterEndpoint(FlowableWorkerEndpoint endpoint) Register a newFlowableWorkerEndpointusing the defaultFlowableWorkerContainerFactoryto create the underlying container.voidregisterEndpoint(FlowableWorkerEndpoint endpoint, FlowableWorkerContainerFactory<?> factory) Register a newFlowableWorkerEndpointalongside theFlowableWorkerContainerFactoryto use to create the underlying container.protected FlowableWorkerContainerFactory<?>resolveContainerFactory(FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor descriptor) voidsetBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) ABeanFactoryonly needs to be available in conjunction withsetContainerFactoryBeanName(java.lang.String).voidsetContainerFactory(FlowableWorkerContainerFactory<?> containerFactory) Set theFlowableWorkerContainerFactoryto use in case aFlowableWorkerEndpointis registered with anullcontainer factory.voidsetContainerFactoryBeanName(String containerFactoryBeanName) Set the bean name of theFlowableWorkerContainerFactoryto use in case aFlowableWorkerEndpointis registered with anullcontainer factory.voidsetEndpointRegistry(FlowableWorkerEndpointRegistry endpointRegistry) Set theFlowableWorkerEndpointRegistryinstance to use.voidsetMessageHandlerMethodFactory(org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory) Set theMessageHandlerMethodFactoryto use to configure the job listener responsible to serve an endpoint detected by this processor.
-
Field Details
-
endpointRegistry
-
messageHandlerMethodFactory
protected org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory -
containerFactory
-
containerFactoryBeanName
-
beanFactory
protected org.springframework.beans.factory.BeanFactory beanFactory -
endpointDescriptors
protected final List<FlowableWorkerEndpointRegistrar.FlowableWorkerEndpointDescriptor> endpointDescriptors -
startImmediately
protected boolean startImmediately -
mutex
-
-
Constructor Details
-
FlowableWorkerEndpointRegistrar
public FlowableWorkerEndpointRegistrar()
-
-
Method Details
-
setEndpointRegistry
Set theFlowableWorkerEndpointRegistryinstance to use. -
getEndpointRegistry
Return theFlowableWorkerEndpointRegistryinstance for this registrar, may benull. -
setMessageHandlerMethodFactory
public void setMessageHandlerMethodFactory(@Nullable org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory messageHandlerMethodFactory) Set theMessageHandlerMethodFactoryto use to configure the job listener responsible to serve an endpoint detected by this processor.By default,
DefaultMessageHandlerMethodFactoryis used and it can be configured further to support additional method arguments or to customize conversion and validation support. SeeDefaultMessageHandlerMethodFactoryjavadoc for more details. -
getMessageHandlerMethodFactory
@Nullable public org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory getMessageHandlerMethodFactory()Return the customMessageHandlerMethodFactoryto use, if any. -
setContainerFactory
Set theFlowableWorkerContainerFactoryto use in case aFlowableWorkerEndpointis registered with anullcontainer factory.Alternatively, the bean name of the
FlowableWorkerContainerFactoryto use can be specified for a lazy lookup, seesetContainerFactoryBeanName(java.lang.String). -
setContainerFactoryBeanName
Set the bean name of theFlowableWorkerContainerFactoryto use in case aFlowableWorkerEndpointis registered with anullcontainer factory. Alternatively, the container factory instance can be registered directly: seesetContainerFactory(FlowableWorkerContainerFactory). -
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) ABeanFactoryonly needs to be available in conjunction withsetContainerFactoryBeanName(java.lang.String).- Specified by:
setBeanFactoryin interfaceorg.springframework.beans.factory.BeanFactoryAware
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSetin interfaceorg.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 newFlowableWorkerEndpointalongside theFlowableWorkerContainerFactoryto use to create the underlying container.The
factorymay benullif the default factory should be used for the supplied endpoint. -
registerEndpoint
Register a newFlowableWorkerEndpointusing the defaultFlowableWorkerContainerFactoryto create the underlying container.
-