AbstractBrokerMessageHandler (spring-messaging 4.0.1.RELEASE API)

java.lang.Object
- org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, MessageHandler

Direct Known Subclasses:

SimpleBrokerMessageHandler, StompBrokerRelayMessageHandler
```
public abstract class AbstractBrokerMessageHandler
extends Object
implements MessageHandler, org.springframework.context.SmartLifecycle, org.springframework.context.ApplicationEventPublisherAware
```
Abstract base class for a MessageHandler that manages subscriptions and propagates messages to subscribers.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields
Modifier and Type Field and Description

protected Log logger

Fields
Modifier and Type	Field and Description
`protected Log`	`logger`

Constructor Summary

Constructors
Constructor and Description

AbstractBrokerMessageHandler(Collection<String> destinationPrefixes)

Constructors
Constructor and Description
`AbstractBrokerMessageHandler(Collection<String> destinationPrefixes)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkDestinationPrefix(String destination)`
`org.springframework.context.ApplicationEventPublisher`	`getApplicationEventPublisher()`
`Collection<String>`	`getDestinationPrefixes()`
`int`	`getPhase()`
`void`	`handleMessage(Message<?> message)` Handle the given message.
`protected abstract void`	`handleMessageInternal(Message<?> message)`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`protected void`	`publishBrokerAvailableEvent()`
`protected void`	`publishBrokerUnavailableEvent()`
`void`	`setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher publisher)`
`void`	`setAutoStartup(boolean autoStartup)`
`void`	`start()`
`protected void`	`startInternal()`
`void`	`stop()`
`void`	`stop(Runnable callback)`
`protected void`	`stopInternal()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final Log logger
```
- Constructor Detail
  - AbstractBrokerMessageHandler
```
public AbstractBrokerMessageHandler(Collection<String> destinationPrefixes)
```
- Method Detail
  - getDestinationPrefixes
```
public Collection<String> getDestinationPrefixes()
```
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher publisher)
```
    Specified by:
    
    setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware
  - getApplicationEventPublisher
```
public org.springframework.context.ApplicationEventPublisher getApplicationEventPublisher()
```
  - setAutoStartup
```
public void setAutoStartup(boolean autoStartup)
```
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
  - 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
  - startInternal
```
protected void startInternal()
```
  - stop
```
public final void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - stopInternal
```
protected void stopInternal()
```
  - stop
```
public final void stop(Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - handleMessage
```
public final void handleMessage(Message<?> message)
```
    Description copied from interface: MessageHandler
    
    Handle the given message.
    
    Specified by:
    
    handleMessage in interface MessageHandler
    
    Parameters:
    
    message - the message to be handled
  - handleMessageInternal
```
protected abstract void handleMessageInternal(Message<?> message)
```
  - checkDestinationPrefix
```
protected boolean checkDestinationPrefix(String destination)
```
  - publishBrokerAvailableEvent
```
protected void publishBrokerAvailableEvent()
```
  - publishBrokerUnavailableEvent
```
protected void publishBrokerUnavailableEvent()
```

Class AbstractBrokerMessageHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

AbstractBrokerMessageHandler

Method Detail

getDestinationPrefixes

setApplicationEventPublisher

getApplicationEventPublisher

setAutoStartup

isAutoStartup

getPhase

isRunning

start

startInternal

stop

stopInternal

stop

handleMessage

handleMessageInternal

checkDestinationPrefix

publishBrokerAvailableEvent

publishBrokerUnavailableEvent