org.springframework.integration.endpoint

Class AbstractEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, ExpressionCapable, NamedComponent

Direct Known Subclasses:

AbstractPollingEndpoint, EventDrivenConsumer, GatewayProxyFactoryBean, MessageProducerSupport, MessagingGatewaySupport, ReactiveStreamsConsumer

public abstract class AbstractEndpoint
extends IntegrationObjectSupport
implements org.springframework.context.SmartLifecycle, org.springframework.beans.factory.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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.Condition	lifecycleCondition
protected java.util.concurrent.locks.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 and Description
AbstractEndpoint()

Method Summary

Modifier and Type	Method and 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(java.lang.Runnable callback) Stop the component and invoke callback.
int	getPhase()
java.lang.String	getRole()
boolean	isAutoStartup()
boolean	isRunning()
protected void	onInit() Subclasses may implement this for initialization logic.
void	setAutoStartup(boolean autoStartup)
void	setPhase(int phase)
void	setRole(java.lang.String role) Specify the role for the endpoint.
void	setTaskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)
void	start()
void	stop()
void	stop(java.lang.Runnable callback)

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, toString

Methods inherited from class java.lang.Object

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

Field Detail

lifecycleLock

protected final java.util.concurrent.locks.ReentrantLock lifecycleLock

lifecycleCondition

protected final java.util.concurrent.locks.Condition lifecycleCondition

Constructor Detail

AbstractEndpoint

public AbstractEndpoint()

Method Detail

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setPhase

public void setPhase(int phase)

setRole

public void setRole(java.lang.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 java.lang.String getRole()

setTaskScheduler

public void setTaskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)

Overrides:

setTaskScheduler in class IntegrationObjectSupport

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()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

isAutoStartup

public final boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

getPhase

public final int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

isRunning

public final boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

public final void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public final void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public final void stop(java.lang.Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

doStop

protected void doStop(java.lang.Runnable callback)

Stop the component and invoke callback.

Parameters:

callback - the Runnable to invoke.

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.