org.eclipse.keyple.distributed.spi

Interface ObservableReaderEventFilter

public interface ObservableReaderEventFilter

SPI of the local filter associated to an observable reader event.

You must provide an implementation of this interface if you use a LocalServiceClient and you plan to observe remotely the local reader.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	afterPropagation(java.lang.Object userOutputData) Is invoked at the end of the processing of the remote service to deliver the result.
java.lang.Object	beforePropagation(org.eclipse.keyple.core.service.event.ReaderEvent event) Is invoked when a reader event occurs, before propagating it to the server.
java.lang.Class<? extends java.lang.Object>	getUserOutputDataClass() Must return the class of the user output data expected at the output of the remote service.

Method Detail

beforePropagation

java.lang.Object beforePropagation(org.eclipse.keyple.core.service.event.ReaderEvent event)

Is invoked when a reader event occurs, before propagating it to the server.

Then, you have the possibility to :

• execute a specific treatment,
• return if necessary a DTO to be transmitted to the remote service,
• stop the propagation of the event by throwing the exception DoNotPropagateEventException.

Parameters:

event - The reader event.

Returns:

The user input data of the remote service or null if you don't have any data to transmit to the server.

Throws:

DoNotPropagateEventException - if you want to stop the propagation of the event.

Since:

1.0

getUserOutputDataClass

java.lang.Class<? extends java.lang.Object> getUserOutputDataClass()

Must return the class of the user output data expected at the output of the remote service.

Is invoked in order to deserialize the user output data before to invoke the method afterPropagation(Object).

Returns:

null if there is no user output data to deserialize.

Since:

1.0

afterPropagation

void afterPropagation(java.lang.Object userOutputData)

Is invoked at the end of the processing of the remote service to deliver the result.

Parameters:

userOutputData - The user output data previously deserialized using the method getUserOutputDataClass(), or null if there is no data.

Since:

1.0