Package org.springframework.pulsar.config

Class GenericListenerEndpointRegistry<C extends MessageListenerContainer,E extends ListenerEndpoint<C>>

java.lang.Object

org.springframework.pulsar.config.GenericListenerEndpointRegistry<C,E>

Type Parameters:

C - listener container type.

E - listener endpoint type.

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, PulsarListenerContainerRegistry

Direct Known Subclasses:

PulsarListenerEndpointRegistry

public class GenericListenerEndpointRegistry<C extends MessageListenerContainer,E extends ListenerEndpoint<C>>
extends Object
implements PulsarListenerContainerRegistry, org.springframework.beans.factory.DisposableBean, org.springframework.context.SmartLifecycle, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

Creates the necessary container instances for the registered endpoints. Also manages the lifecycle of the listener containers, in particular within the lifecycle of the application context.

Contrary to containers created manually, listener containers managed by registry are not beans in the application context and are not candidates for autowiring. Use getListenerContainers() if you need to access this registry's listener containers for management purposes. If you need to access to a specific message listener container, use getListenerContainer(String) with the id of the endpoint.

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericListenerEndpointRegistry(Class<?> type)

Method Summary

Modifier and Type	Method	Description
protected C	createListenerContainer(E endpoint, ListenerContainerFactory<? extends C,E> factory)
void	destroy()
Collection<C>	getAllListenerContainers()	Return all listener container instances including those managed by this registry and those declared as beans in the application context.
C	getListenerContainer(String id)	Return the listener container with the specified id or null if no such container exists.
Set<String>	getListenerContainerIds()	Return the ids of the managed listener container instance(s).
Collection<C>	getListenerContainers()	Return the managed listener container instance(s).
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
void	registerListenerContainer(E endpoint, ListenerContainerFactory<? extends C,E> factory)
void	registerListenerContainer(E endpoint, ListenerContainerFactory<? extends C,E> factory, boolean startImmediately)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Constructor Details

GenericListenerEndpointRegistry

protected GenericListenerEndpointRegistry(Class<?> type)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getListenerContainer

@Nullable
public C getListenerContainer(String id)

Description copied from interface: PulsarListenerContainerRegistry

Return the listener container with the specified id or null if no such container exists.

Specified by:

getListenerContainer in interface PulsarListenerContainerRegistry

Parameters:

id - the id of the container

Returns:

the container or null if no container with that id exists

See Also:

• ListenerEndpoint.getId()
• PulsarListenerContainerRegistry.getListenerContainerIds()

getListenerContainerIds

public Set<String> getListenerContainerIds()

Description copied from interface: PulsarListenerContainerRegistry

Return the ids of the managed listener container instance(s).

Specified by:

getListenerContainerIds in interface PulsarListenerContainerRegistry

Returns:

the ids.

See Also:

• PulsarListenerContainerRegistry.getListenerContainer(String)

getListenerContainers

public Collection<C> getListenerContainers()

Description copied from interface: PulsarListenerContainerRegistry

Return the managed listener container instance(s).

Specified by:

getListenerContainers in interface PulsarListenerContainerRegistry

Returns:

the managed listener container instance(s).

See Also:

• PulsarListenerContainerRegistry.getAllListenerContainers()

getAllListenerContainers

public Collection<C> getAllListenerContainers()

Description copied from interface: PulsarListenerContainerRegistry

Return all listener container instances including those managed by this registry and those declared as beans in the application context. Prototype-scoped containers will be included. Lazy beans that have not yet been created will not be initialized by a call to this method.

Specified by:

getAllListenerContainers in interface PulsarListenerContainerRegistry

Returns:

the listener container instance(s).

See Also:

• PulsarListenerContainerRegistry.getListenerContainers()

registerListenerContainer

public void registerListenerContainer(E endpoint,
 ListenerContainerFactory<? extends C,E> factory)

registerListenerContainer

public void registerListenerContainer(E endpoint,
 ListenerContainerFactory<? extends C,E> factory,
 boolean startImmediately)

createListenerContainer

protected C createListenerContainer(E endpoint,
 ListenerContainerFactory<? extends C,E> factory)

destroy

public void destroy()
             throws Exception

Specified by:

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

Throws:

Exception

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<C extends MessageListenerContainer>