Interface ListenerContainerRegistry

All Known Implementing Classes:

KafkaListenerEndpointRegistry

public interface ListenerContainerRegistry

A registry for listener containers.

Since:

2.7

Author:

Gary Russell, Joo Hyuk Kim

Method Summary

Modifier and Type	Method	Description
Collection<MessageListenerContainer>	getAllListenerContainers()	Return all MessageListenerContainer instances including those managed by this registry and those declared as beans in the application context.
@Nullable MessageListenerContainer	getListenerContainer(String id)	Return the MessageListenerContainer with the specified id or null if no such container exists.
Set<String>	getListenerContainerIds()	Return the ids of the managed MessageListenerContainer instance(s).
Collection<MessageListenerContainer>	getListenerContainers()	Return the managed MessageListenerContainer instance(s).
Collection<MessageListenerContainer>	getListenerContainersMatching(BiPredicate<String, MessageListenerContainer> idAndContainerMatcher)	Return all MessageListenerContainer instances that satisfy the given bi-predicate.
Collection<MessageListenerContainer>	getListenerContainersMatching(Predicate<String> idMatcher)	Return all MessageListenerContainer instances with id matching the predicate or empty Collection if no such container exists.
@Nullable MessageListenerContainer	getUnregisteredListenerContainer(String id)	Return the MessageListenerContainer with the specified id or null if no such container exists.

Method Details

getListenerContainer

@Nullable MessageListenerContainer getListenerContainer(String id)

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

Parameters:

id - the id of the container

Returns:

the container or null if no container with that id exists

See Also:

• KafkaListenerEndpoint.getId()
• getListenerContainerIds()

getListenerContainersMatching

Collection<MessageListenerContainer> getListenerContainersMatching(Predicate<String> idMatcher)

Return all MessageListenerContainer instances with id matching the predicate or empty Collection if no such container exists.

Parameters:

idMatcher - the predicate to match the container id with

Returns:

the containers or empty Collection if no container with that id exists

Since:

3.2

See Also:

• getListenerContainerIds()
• getListenerContainer(String)

getListenerContainersMatching

Collection<MessageListenerContainer> getListenerContainersMatching(BiPredicate<String, MessageListenerContainer> idAndContainerMatcher)

Return all MessageListenerContainer instances that satisfy the given bi-predicate. The BiPredicate<String, MessageListenerContainer> takes the container id and the container itself as arguments. This allows for more sophisticated filtering, including properties or state of the container itself.

Parameters:

idAndContainerMatcher - the bi-predicate to match the container id and the container

Returns:

the containers that match the bi-predicate criteria or an empty Collection if no matching containers exist

Since:

3.2

See Also:

• getListenerContainerIds()
• getListenerContainersMatching(Predicate)

getUnregisteredListenerContainer

@Nullable MessageListenerContainer getUnregisteredListenerContainer(String id)

Return the MessageListenerContainer with the specified id or null if no such container exists. Returns containers that are not registered with the registry, but exist in the application context.

Parameters:

id - the id of the container

Returns:

the container or null if no container with that id exists

See Also:

• getListenerContainerIds()

getListenerContainerIds

Set<String> getListenerContainerIds()

Return the ids of the managed MessageListenerContainer instance(s).

Returns:

the ids.

See Also:

• getListenerContainer(String)

getListenerContainers

Collection<MessageListenerContainer> getListenerContainers()

Return the managed MessageListenerContainer instance(s).

Returns:

the managed MessageListenerContainer instance(s).

See Also:

• getAllListenerContainers()

getAllListenerContainers

Collection<MessageListenerContainer> getAllListenerContainers()

Return all MessageListenerContainer 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.

Returns:

the MessageListenerContainer instance(s).

See Also:

• getListenerContainers()