Class EndpointSpec<S extends EndpointSpec<S,F,H>,F extends BeanNameAware & FactoryBean<? extends AbstractEndpoint>,H>

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>

org.springframework.integration.dsl.EndpointSpec<S,F,H>

Type Parameters:

S - the target ConsumerEndpointSpec implementation type.

F - the target BeanNameAware implementation type.

H - the target MessageHandler implementation type.

All Implemented Interfaces:

DisposableBean, FactoryBean<reactor.util.function.Tuple2<F,H>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

Direct Known Subclasses:

ConsumerEndpointSpec, SourcePollingChannelAdapterSpec

public abstract class EndpointSpec<S extends EndpointSpec<S,F,H>,F extends BeanNameAware & FactoryBean<? extends AbstractEndpoint>,H>
extends IntegrationComponentSpec<S,reactor.util.function.Tuple2<F,H>>
implements ComponentsRegistration

An IntegrationComponentSpec for endpoints.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Object,String>	componentsToRegister
protected final F	endpointFactoryBean
protected H	handler

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EndpointSpec(H handler, F endpointFactoryBean)

Method Summary

Modifier and Type	Method	Description
protected void	assertHandler()
abstract S	autoStartup(boolean autoStartup)
protected reactor.util.function.Tuple2<F,H>	doGet()
Map<Object,String>	getComponentsToRegister()
S	id(String id)	Configure the component identifier.
protected MessageChannel	obtainInputChannelFromFlow(IntegrationFlow subFlow)	Try to get a MessageChannel as an input for the provided IntegrationFlow or create one and wrap the provided flow to a new one.
protected MessageChannel	obtainInputChannelFromFlow(IntegrationFlow subFlow, boolean evaluateInternalBuilder)	Try to get a MessageChannel as an input for the provided IntegrationFlow or create one and wrap the provided flow to a new one.
abstract S	phase(int phase)
S	poller(Function<PollerFactory,PollerSpec> pollers)
S	poller(PollerSpec pollerMetadataSpec)
abstract S	poller(PollerMetadata pollerMetadata)
abstract S	role(String role)	Specify the role for the endpoint.

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, getId, getObject, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Field Details

componentsToRegister

protected final Map<Object,String> componentsToRegister

endpointFactoryBean

protected final F extends BeanNameAware & FactoryBean<? extends AbstractEndpoint> endpointFactoryBean

handler

protected H handler

Constructor Details

EndpointSpec

protected EndpointSpec(@Nullable
 H handler,
 F endpointFactoryBean)

Method Details

id

public S id(@Nullable
 String id)

Description copied from class: IntegrationComponentSpec

Configure the component identifier. Used as the beanName to register the bean in the application context for this component.

Overrides:

id in class IntegrationComponentSpec<S extends EndpointSpec<S,F,H>,reactor.util.function.Tuple2<F extends BeanNameAware & FactoryBean<? extends AbstractEndpoint>,H>>

Parameters:

id - the id.

Returns:

the spec.

poller

public S poller(Function<PollerFactory,PollerSpec> pollers)

Parameters:

pollers - the pollers

Returns:

the endpoint spec.

See Also:

• AbstractPollingEndpoint
• PollerFactory

poller

public S poller(PollerSpec pollerMetadataSpec)

Parameters:

pollerMetadataSpec - the pollerMetadataSpec

Returns:

the endpoint spec.

See Also:

• AbstractPollingEndpoint
• PollerSpec

poller

public abstract S poller(PollerMetadata pollerMetadata)

Parameters:

pollerMetadata - the pollerMetadata

Returns:

the endpoint spec.

See Also:

• AbstractPollingEndpoint

phase

public abstract S phase(int phase)

Parameters:

phase - the phase.

Returns:

the endpoint spec.

See Also:

• SmartLifecycle

autoStartup

public abstract S autoStartup(boolean autoStartup)

Parameters:

autoStartup - the autoStartup.

Returns:

the endpoint spec

See Also:

• SmartLifecycle

role

public abstract S role(String role)

Specify the role for the endpoint. Such endpoints can be started/stopped as a group.

Parameters:

role - the role for this endpoint.

Returns:

the endpoint spec

See Also:

• SmartLifecycle
• SmartLifecycleRoleController

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration

doGet

protected reactor.util.function.Tuple2<F,H> doGet()

Overrides:

doGet in class IntegrationComponentSpec<S extends EndpointSpec<S,F,H>,reactor.util.function.Tuple2<F extends BeanNameAware & FactoryBean<? extends AbstractEndpoint>,H>>

assertHandler

protected void assertHandler()

obtainInputChannelFromFlow

protected MessageChannel obtainInputChannelFromFlow(IntegrationFlow subFlow)

Try to get a MessageChannel as an input for the provided IntegrationFlow or create one and wrap the provided flow to a new one.

Parameters:

subFlow - the IntegrationFlow to extract input channel.

Returns:

the input channel of the flow of create one

Since:

5.0.4

obtainInputChannelFromFlow

protected MessageChannel obtainInputChannelFromFlow(IntegrationFlow subFlow,
 boolean evaluateInternalBuilder)

Try to get a MessageChannel as an input for the provided IntegrationFlow or create one and wrap the provided flow to a new one.

Parameters:

subFlow - the IntegrationFlow to extract input channel.

evaluateInternalBuilder - true if an internal IntegrationFlowDefinition should be evaluated to an IntegrationFlow component or left as a builder in the componentsToRegister for future use-case. For example the builder is used for router configurations to retain beans registration order for parent-child dependencies.

Returns:

the input channel of the flow of create one

Since:

5.0.4