Class AbstractEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ComponentSourceAware, ExpressionCapable, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle

Direct Known Subclasses:

AbstractPollingEndpoint, EventDrivenConsumer, GatewayProxyFactoryBean, MessageProducerSupport, MessagingGatewaySupport, ReactiveStreamsConsumer

@IntegrationManagedResource
public abstract class AbstractEndpoint
extends IntegrationObjectSupport
implements ManageableSmartLifecycle, DisposableBean

The base class for Message Endpoint implementations.

This class implements Lifecycle and provides an autoStartup property. If true, the endpoint will start automatically upon initialization. Otherwise, it will require an explicit invocation of its start() method. The default value is true. To require explicit startup, provide a value of false to the setAutoStartup(boolean) method.

Author:

Mark Fisher, Kris Jacyna, Gary Russell, Artem Bilan, Trung Pham

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReentrantLock	lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
AbstractEndpoint()

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected abstract void	doStart()	Subclasses must implement this method with the start behavior.
protected abstract void	doStop()	Subclasses must implement this method with the stop behavior.
protected void	doStop(Runnable callback)	Stop the component and invoke callback.
final int	getPhase()
String	getRole()
boolean	isActive()
final boolean	isAutoStartup()
final boolean	isRunning()
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setAutoStartup(boolean autoStartup)
void	setPhase(int phase)
void	setRole(String role)	Specify the role for the endpoint.
final void	start()
final void	stop()
final void	stop(Runnable callback)

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getComponentType, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Field Details

lifecycleLock

protected final ReentrantLock lifecycleLock

Constructor Details

AbstractEndpoint

public AbstractEndpoint()

Method Details

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setPhase

public void setPhase(int phase)

setRole

public void setRole(String role)

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

Parameters:

role - the role for this endpoint.

Since:

5.0

See Also:

• SmartLifecycle
• SmartLifecycleRoleController

getRole

public String getRole()

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

isAutoStartup

public final boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

getPhase

public final int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface Lifecycle

Specified by:

isRunning in interface ManageableLifecycle

start

public final void start()

Specified by:

start in interface Lifecycle

Specified by:

start in interface ManageableLifecycle

stop

public final void stop()

Specified by:

stop in interface Lifecycle

Specified by:

stop in interface ManageableLifecycle

stop

public final void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

doStop

protected void doStop(Runnable callback)

Stop the component and invoke callback.

Parameters:

callback - the Runnable to invoke.

isActive

public boolean isActive()

doStart

protected abstract void doStart()

Subclasses must implement this method with the start behavior. This method will be invoked while holding the lifecycleLock.

doStop

protected abstract void doStop()

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the lifecycleLock.