org.jrebirth.af.core.link

Class WaveHandler

java.lang.Object

org.jrebirth.af.core.link.WaveHandler

All Implemented Interfaces:

LinkMessages, MessageContainer

public class WaveHandler
extends Object
implements LinkMessages

The class WaveHandler is used to define how to manage a Wave for wave type subscribers.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private Method	defaultMethod The default method to call, will been used when annotation is put on a method, otherwise could be null.
private static JRLogger	LOGGER The class logger.
private WaveChecker	waveChecker The wave checker taht check if the wave could be handled, could be null.
private WaveReady<?>	waveReady The wave ready component that will handle the wave.

Fields inherited from interface org.jrebirth.af.core.link.LinkMessages

CALL_ANNOTATED_METHOD_ERROR, COMMAND_NOT_FOUND_ERROR, COMMAND_NOT_FOUND_MESSAGE, COMPONENT_INJECTION_FAILURE, CUSTOM_METHOD_NOT_FOUND, LISTEN_WAVE_TYPE, MODEL_NOT_FOUND_ERROR, MODEL_NOT_FOUND_MESSAGE, NO_WAVE_LISTENER, NOTIFIER_CONSUMES, SEND_WAVE, SERVICE_NOT_FOUND_ERROR, SERVICE_NOT_FOUND_MESSAGE, UNLISTEN_WAVE_TYPE, USE_DEFAULT_WAVE_HANDLER, WAVE_BEAN_CREATION_ERROR, WAVE_DISPATCH_ERROR, WAVE_HANDLING_ERROR, WAVE_LOST, WAVE_LOST_CONTEXT, WAVE_SENDING_ERROR

Constructor Summary

Constructors

Constructor and Description
WaveHandler(WaveReady<?> waveReady, WaveChecker waveChecker, Method defaultMethod) Instantiates a new wave handler.

Method Summary

Methods

Modifier and Type	Method and Description
private JRebirthRunnable	buildWaveRunnable(Wave wave, Method customMethod, RunnablePriority priority) Build the wave runnable handler that will handle the wave into the right thread.
boolean	check(Wave wave) Check the wave if the wave checker is not null anf if it returns true.
WaveReady<?>	getWaveReady() Gets the wave ready.
void	handle(Wave wave) Handle the wave into JAT for model component or into current thread for others.
private void	performHandle(Wave wave, Method method) Perform the handle independently of thread used.
private Method	retrieveCustomMethod(Wave wave) Retrieve the custom wave handler method.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final JRLogger LOGGER

The class logger.

waveReady

private final WaveReady<?> waveReady

The wave ready component that will handle the wave.

defaultMethod

private final Method defaultMethod

The default method to call, will been used when annotation is put on a method, otherwise could be null.

waveChecker

private final WaveChecker waveChecker

The wave checker taht check if the wave could be handled, could be null.

Constructor Detail

WaveHandler

public WaveHandler(WaveReady<?> waveReady,
           WaveChecker waveChecker,
           Method defaultMethod)

Instantiates a new wave handler.

Parameters:

waveReady - the wave ready component that will handle the wave

waveChecker - the wave checker, could be null

defaultMethod - the default method to call, could be null

Method Detail

check

public boolean check(Wave wave)

Check the wave if the wave checker is not null anf if it returns true.

Parameters:

wave - the wave to check

Returns:

true, if check succeeded or if wave checker is null

getWaveReady

public WaveReady<?> getWaveReady()

Gets the wave ready.

Returns:

Returns the waveReady.

handle

public void handle(Wave wave)
            throws WaveException

Handle the wave into JAT for model component or into current thread for others.

Parameters:

wave - the wave to manage

Throws:

WaveException - if an error occurred while processing the wave

buildWaveRunnable

private JRebirthRunnable buildWaveRunnable(Wave wave,
                                 Method customMethod,
                                 RunnablePriority priority)

Build the wave runnable handler that will handle the wave into the right thread.

Parameters:

wave - the wave to handle

customMethod - the custom method to call (could be null)

priority - the runnable priority to use

Returns:

the right JRebirth Runnable

retrieveCustomMethod

private Method retrieveCustomMethod(Wave wave)

Retrieve the custom wave handler method.

Parameters:

wave - the wave to be handled

Returns:

the custom handler emthod or null if none exists

performHandle

private void performHandle(Wave wave,
                 Method method)
                    throws WaveException

Perform the handle independently of thread used.

Parameters:

wave - the wave to manage

method - the handler method to call, could be null

Throws:

WaveException - if an error occurred while processing the wave