JournalingInterceptor (synapse-core 0.21.5 API)

java.lang.Object
- de.otto.synapse.journal.JournalingInterceptor

All Implemented Interfaces:

MessageInterceptor
```
public class JournalingInterceptor
extends java.lang.Object
implements MessageInterceptor
```
Interceptor used to add the messages of event-sourced entities to a Journal.

Constructor Summary

Constructors
Constructor	Description
`JournalingInterceptor(java.lang.String channelName, Journal journal)`	Creates a `JournalingInterceptor` for a channel, using the given `Journal`.

Method Summary

Modifier and Type	Method	Description
`Journal`	`getJournal()`
`TextMessage`	`intercept(TextMessage message)`	Intercept a message and return the same message, a modified version of the incoming message, or null, if the message should be filtered out and dropped by the `AbstractMessageEndpoint`

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

- Constructor Detail
  - JournalingInterceptor
```
public JournalingInterceptor(@Nonnull
                             java.lang.String channelName,
                             @Nonnull
                             Journal journal)
```
    Creates a JournalingInterceptor for a channel, using the given Journal.
    
    Parameters:
    
    channelName - the name of the journaled channel
    
    journal - the Journal used to record messages for the channel
    
    Throws:
    
    java.lang.IllegalStateException - if the Journal's MessageStore does not provide an Index.JOURNAL_KEY
- Method Detail
  - intercept
```
@Nonnull
public TextMessage intercept(@Nonnull
                             TextMessage message)
```
    Description copied from interface: MessageInterceptor
    
    Intercept a message and return the same message, a modified version of the incoming message, or null, if the message should be filtered out and dropped by the AbstractMessageEndpoint
    
    Specified by:
    
    intercept in interface MessageInterceptor
    
    Parameters:
    
    message - the channel-layer message with payload-type beeing a String
    
    Returns:
    
    intercepted version of the message, or null if the message should be dropped.
  - getJournal
```
public Journal getJournal()
```