de.fhg.aisec.ids.api.router

Interface RouteManager

public interface RouteManager

Interface of internal routing manager inside the Core Platform.

The routing manager is responsible for forwarding messages between containers. One implementation of this interface is based on Apache Camel, others might follow.

Method Summary

Modifier and Type	Method and Description
void	addRoute(@NonNull java.lang.String routeDefinition) Adds a route and starts it.
void	delRoute(@NonNull java.lang.String routeId) Removes a route from one endpoint to another.
@NonNull java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getEndpoints() List all route endpoints, i.e. all URLs to which routes exist.
@Nullable RouteObject	getRoute(@NonNull java.lang.String id) Returns a list of currently installed routes.
@NonNull java.lang.String	getRouteAsProlog(@NonNull java.lang.String routeId) Returns the given route configuration in a Prolog representation.
java.lang.String	getRouteAsString(@NonNull java.lang.String routeId) Returns the given route in its original representation of the implementing engine.
@NonNull java.util.List<java.lang.String>	getRouteInputUris(@NonNull java.lang.String routeId) Returns a List of URIs of the given route's inputs (from definitions)
@NonNull java.util.Map<java.lang.String,RouteMetrics>	getRouteMetrics() Returns aggregated runtime metrics of all installed routes.
@NonNull java.util.List<RouteObject>	getRoutes() Returns a list of currently installed routes.
@NonNull java.util.List<RouteComponent>	listComponents() List all supported components, i.e. supported endpoint protocols.
@NonNull java.util.Map<java.lang.String,java.lang.String>	listEndpoints()
@NonNull RouteObject	saveRoute(@NonNull java.lang.String routeId, @NonNull java.lang.String routeRepresentation) Save a route, replacing it with a new representation within the same context
void	startRoute(@NonNull java.lang.String routeId) Starts a route.
void	stopRoute(@NonNull java.lang.String routeId) Sends a request to stop a route.

Method Detail

getRoutes

@NonNull java.util.List<RouteObject> getRoutes()

Returns a list of currently installed routes.

Returns:

All installed rules

getRoute

@Nullable RouteObject getRoute(@NonNull java.lang.String id)

Returns a list of currently installed routes.

Returns:

The queried route or null

startRoute

void startRoute(@NonNull java.lang.String routeId)
         throws RouteException

Starts a route.

Parameters:

routeId -

Throws:

RouteException

stopRoute

void stopRoute(@NonNull java.lang.String routeId)
        throws RouteException

Sends a request to stop a route. Camel will try to gracefully shut down the route and deliver pending exchanges.

Parameters:

routeId -

Throws:

java.lang.Exception

RouteException

listComponents

@NonNull java.util.List<RouteComponent> listComponents()

List all supported components, i.e. supported endpoint protocols.

Returns:

getEndpoints

@NonNull java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getEndpoints()

List all route endpoints, i.e. all URLs to which routes exist.

Returns:

listEndpoints

@NonNull java.util.Map<java.lang.String,java.lang.String> listEndpoints()

saveRoute

@NonNull RouteObject saveRoute(@NonNull java.lang.String routeId,
                               @NonNull java.lang.String routeRepresentation)
                        throws RouteException

Save a route, replacing it with a new representation within the same context

Parameters:

routeId - ID of the route to save

routeRepresentation - The new textual representation of the route (XML etc.)

Returns:

The object representing the modified route

Throws:

RouteException - If the route does not exist or some Exception was thrown during route replacement.

addRoute

void addRoute(@NonNull java.lang.String routeDefinition)
       throws RouteException

Adds a route and starts it.

Endpoint declarations must be supported by the underlying implementation.

If the route id already exists, this method will throw a RouteException and not overwrite the existing route.

Parameters:

routeDefinition - Textual representation of the route (XML etc.)

Throws:

RouteException - if a route with the same id already exists or if any Exception is thrown during loading and starting the route.

delRoute

void delRoute(@NonNull java.lang.String routeId)

Removes a route from one endpoint to another.

The deletion becomes immediately effective.

Endpoint declarations must be supported by the underlying implementation.

Parameters:

routeId -

getRouteAsString

java.lang.String getRouteAsString(@NonNull java.lang.String routeId)

Returns the given route in its original representation of the implementing engine.

Note that this method may return null if the implementing engine does not support a textual route configuration.

For Apache Camel, this method will return the XML-based Camel DSL configuration file.

Returns:

String representation of the route

getRouteInputUris

@NonNull java.util.List<java.lang.String> getRouteInputUris(@NonNull java.lang.String routeId)

Returns a List of URIs of the given route's inputs (from definitions)

Parameters:

routeId - The identifier of the route

Returns:

The from (input) URIs of the route

getRouteMetrics

@NonNull java.util.Map<java.lang.String,RouteMetrics> getRouteMetrics()

Returns aggregated runtime metrics of all installed routes.

Returns:

map where k is a string indicating the route id.

getRouteAsProlog

@NonNull java.lang.String getRouteAsProlog(@NonNull java.lang.String routeId)

Returns the given route configuration in a Prolog representation.

Parameters:

routeId - ID of route to retrieve prolog representation for

Returns:

Route represented as prolog