eu.baltrad.beast.adaptor.IBltAdaptorManager Interface Reference

Inheritance diagram for eu.baltrad.beast.adaptor.IBltAdaptorManager:

Public Member Functions
IAdaptor	register (IAdaptorConfiguration configuration)
	Stores an adaptor of specified in the database.
IAdaptor	reregister (IAdaptorConfiguration configuration)
	Re-registers an existing adaptor in the database.
void	unregister (String name)
	Unregisters the adaptor with the specified name (and will also remove it from the database).
List< IAdaptor >	getRegisteredAdaptors ()
	Returns the list of registered adaptors.
List< String >	getAvailableTypes ()
	Returns a sorted list of available types.
IAdaptorConfiguration	createConfiguration (String type, String name)
	Creates an adaptor configuration of the specified type.
List< String >	getAdaptorNames ()
	Returns a sorted list of available adaptor names.
IAdaptor	getAdaptor (String name)
	Returns the adaptor with the specified name.
void	handle (IMultiRoutedMessage message)
	Handles a multi routed message.
void	handle (IRoutedMessage message)
	Sends a message to destination given by the message.
void	handle (IRoutedMessage message, IAdaptorCallback callback)
	Same as handle(IRoutedMessage) but it also gives the possibility to get the result back to the callback.

Detailed Description

Author

Anders Henja

Member Function Documentation

createConfiguration()

IAdaptorConfiguration eu.baltrad.beast.adaptor.IBltAdaptorManager.createConfiguration	(	String	type,
		String	name )

Creates an adaptor configuration of the specified type.

Parameters

type	the type
name	the name of the configuration

Returns

the configuration

Exceptions

AdaptorException

on failure

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

getAdaptor()

IAdaptor eu.baltrad.beast.adaptor.IBltAdaptorManager.getAdaptor

(

String

name

)

Returns the adaptor with the specified name.

Parameters

name	the name of the requested adaptor

Returns

the adaptor (or null if there is none)

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

getAdaptorNames()

List< String > eu.baltrad.beast.adaptor.IBltAdaptorManager.getAdaptorNames

(

)

Returns a sorted list of available adaptor names.

Returns

a list of available adaptors

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

getAvailableTypes()

List< String > eu.baltrad.beast.adaptor.IBltAdaptorManager.getAvailableTypes

(

)

Returns a sorted list of available types.

Returns

a sorted list of available types.

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

getRegisteredAdaptors()

List< IAdaptor > eu.baltrad.beast.adaptor.IBltAdaptorManager.getRegisteredAdaptors

(

)

Returns the list of registered adaptors.

Returns

a list of registered adaptors

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

handle() [1/3]

void eu.baltrad.beast.adaptor.IBltAdaptorManager.handle

(

IMultiRoutedMessage

message

)

Handles a multi routed message.

If the message not can be sent to a specified destination, this must be ignored and the next destination should get the message.

Parameters

message

the routed message to handle

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

handle() [2/3]

void eu.baltrad.beast.adaptor.IBltAdaptorManager.handle

(

IRoutedMessage

message

)

Sends a message to destination given by the message.

Parameters

message

the message

Exceptions

AdaptorException

if the message not could be passed on to the adaptor

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

handle() [3/3]

void eu.baltrad.beast.adaptor.IBltAdaptorManager.handle	(	IRoutedMessage	message,
		IAdaptorCallback	callback )

Same as handle(IRoutedMessage) but it also gives the possibility to get the result back to the callback.

Parameters

message	the routed message
callback	the callback

Exceptions

AdaptorException

if the message not could be passed on to the adaptor

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

register()

IAdaptor eu.baltrad.beast.adaptor.IBltAdaptorManager.register

(

IAdaptorConfiguration

configuration

)

Stores an adaptor of specified in the database.

Note, the adaptor itself will not be stored, this should be done by the caller of this function.

Parameters

configuration

- the configuration

Returns

the created adaptor on success

Exceptions

AdaptorException

on failure

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

reregister()

IAdaptor eu.baltrad.beast.adaptor.IBltAdaptorManager.reregister

(

IAdaptorConfiguration

configuration

)

Re-registers an existing adaptor in the database.

If the previous configuration type is different from the provided configuration type, then the adaptor specific configuration will be modifed as well.

Parameters

configuration

the new configuration

Returns

the configured adaptor

Exceptions

AdaptorException

on error

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

unregister()

void eu.baltrad.beast.adaptor.IBltAdaptorManager.unregister

(

String

name

)

Unregisters the adaptor with the specified name (and will also remove it from the database).

Parameters

name	the name of the adaptor to unregister

Exceptions

AdaptorException

on failure

Implemented in eu.baltrad.beast.adaptor.BltAdaptorManager.

---

The documentation for this interface was generated from the following file:

• src/eu/baltrad/beast/adaptor/IBltAdaptorManager.java