net.engio.mbassy.bus.config

Interface IBusConfiguration

All Known Implementing Classes:

BusConfiguration

public interface IBusConfiguration

The configuration of message bus instances is feature driven, e.g. configuration parameters are grouped into Feature. Features can be added to a bus configuration to be used later in the instantiation process of the message bus. Each bus will look for the features it requires and configure them according to the provided configuration. If a required feature is not found the bus will publish a ConfigurationError to the ConfigurationErrorHandler

Author:

bennidi.

Method Summary

Methods

Modifier and Type	Method and Description
IBusConfiguration	addConfigurationErrorHandler(ConfigurationErrorHandler handler) Add a handler that is called when a misconfiguration is detected.
IBusConfiguration	addFeature(Feature feature) Add a feature to the given configuration, replacing any existing feature of the same type.
BusConfiguration	addPublicationErrorHandler(IPublicationErrorHandler handler)
<T extends Feature> T	getFeature(Class<T> feature) Get a registered feature by its type (class).
<T> T	getProperty(String name, T defaultValue) Read a property from this configuration.
Collection<IPublicationErrorHandler>	getRegisteredPublicationErrorHandlers()
void	handleError(ConfigurationError error) Calls all ConfigurationErrorHandlers
boolean	hasProperty(String name) Check whether a property has been set.
IBusConfiguration	setProperty(String name, Object value) Set a property which will be read by the message bus constructor.

Method Detail

setProperty

IBusConfiguration setProperty(String name,
                            Object value)

Set a property which will be read by the message bus constructor. Existing value will be overwritten. Null values are supported (checking for existence of property will return true even if set to null).

Parameters:

name - The name of the property. Note: Each implementation may support different properties.

value - The value of the property.

Returns:

A reference to this bus configuration.

getProperty

<T> T getProperty(String name,
                T defaultValue)

Read a property from this configuration.

Type Parameters:

T - The type of property

Parameters:

name - The name of the property to be read.

defaultValue - The value to be returned if property was not found

Returns:

The value associated with the given property name or defaultValue if not present

hasProperty

boolean hasProperty(String name)

Check whether a property has been set.

Returns:

true if property was set (even if set to null) false otherwise

getFeature

<T extends Feature> T getFeature(Class<T> feature)

Get a registered feature by its type (class).

addFeature

IBusConfiguration addFeature(Feature feature)

Add a feature to the given configuration, replacing any existing feature of the same type.

Parameters:

feature - The feature to add

Returns:

A reference to this bus configuration.

addConfigurationErrorHandler

IBusConfiguration addConfigurationErrorHandler(ConfigurationErrorHandler handler)

Add a handler that is called when a misconfiguration is detected. Note: Not fully implemented, yet.

handleError

void handleError(ConfigurationError error)

Calls all ConfigurationErrorHandlers

addPublicationErrorHandler

BusConfiguration addPublicationErrorHandler(IPublicationErrorHandler handler)

getRegisteredPublicationErrorHandlers

Collection<IPublicationErrorHandler> getRegisteredPublicationErrorHandlers()