eu.baltrad.beast.router.IRouterManager Interface Reference

Manages all routes and synchronizes them with the database. More...

Inheritance diagram for eu.baltrad.beast.router.IRouterManager:

Public Member Functions
List< String >	getNames ()
	Returns a list of registered definition names.
List< RouteDefinition >	getDefinitions ()
	Gets the current routing definitions.
List< RouteDefinition >	getDefinitions (List< String > types)
	Gets the definitions with specified types.
RouteDefinition	getDefinition (String name)
	Returns the definition with specified name.
void	storeDefinition (RouteDefinition def)
	Stores a definition in the database.
void	updateDefinition (RouteDefinition def)
	Updates the definition in the database.
void	deleteDefinition (String name)
	Deletes the definition with the specified name.
RouteDefinition	create (String name, String author, boolean active, String description, List< String > recipients, IRule rule)
	Works as a factory for creating route definitions.
IRule	createRule (String type)
	Creates a rule of the specified type.

Detailed Description

Manages all routes and synchronizes them with the database.

Author

Anders Henja

Member Function Documentation

create()

RouteDefinition eu.baltrad.beast.router.IRouterManager.create	(	String	name,
		String	author,
		boolean	active,
		String	description,
		List< String >	recipients,
		IRule	rule )

Works as a factory for creating route definitions.

Parameters

name	the name of the route definition
author	the author
active	if enabled or not
description	the description
recipients	a list of recipients
rule	the rule

Returns

a routing definition

Implemented in eu.baltrad.beast.router.impl.BltRouter.

createRule()

IRule eu.baltrad.beast.router.IRouterManager.createRule

(

String

type

)

Creates a rule of the specified type.

Parameters

type	the type associated with the manager

Returns

the created rule

Implemented in eu.baltrad.beast.router.impl.BltRouter.

deleteDefinition()

void eu.baltrad.beast.router.IRouterManager.deleteDefinition

(

String

name

)

Deletes the definition with the specified name.

Parameters

name	the name of the definition to be removed.

Implemented in eu.baltrad.beast.router.impl.BltRouter.

getDefinition()

RouteDefinition eu.baltrad.beast.router.IRouterManager.getDefinition

(

String

name

)

Returns the definition with specified name.

Parameters

name	- the name

Returns

the associated definintion

Implemented in eu.baltrad.beast.router.impl.BltRouter.

getDefinitions() [1/2]

List< RouteDefinition > eu.baltrad.beast.router.IRouterManager.getDefinitions

(

)

Gets the current routing definitions.

Returns

a list of routing definitions

Implemented in eu.baltrad.beast.router.impl.BltRouter.

getDefinitions() [2/2]

List< RouteDefinition > eu.baltrad.beast.router.IRouterManager.getDefinitions

(

List< String >

types

)

Gets the definitions with specified types.

Parameters

[in]

list

of types

Returns

the definitions

Implemented in eu.baltrad.beast.router.impl.BltRouter.

getNames()

List< String > eu.baltrad.beast.router.IRouterManager.getNames

(

)

Returns a list of registered definition names.

Returns

the list of names

Implemented in eu.baltrad.beast.router.impl.BltRouter.

storeDefinition()

void eu.baltrad.beast.router.IRouterManager.storeDefinition

(

RouteDefinition

def

)

Stores a definition in the database.

Parameters

def	the definition to store

Exceptions

RuleException

if something is erroneous with the definition

Implemented in eu.baltrad.beast.router.impl.BltRouter.

updateDefinition()

void eu.baltrad.beast.router.IRouterManager.updateDefinition

(

RouteDefinition

def

)

Updates the definition in the database.

Parameters

def	the definition to update

Exceptions

RuleException

if something is erroneous with the definition

Implemented in eu.baltrad.beast.router.impl.BltRouter.

---

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

• src/eu/baltrad/beast/router/IRouterManager.java