Class HTTPServer.BaseRoutePrioritizer

java.lang.Object

ch.autumo.beetroot.server.HTTPServer.BaseRoutePrioritizer

All Implemented Interfaces:

HTTPServer.IRoutePrioritizer

Direct Known Subclasses:

HTTPServer.DefaultRoutePrioritizer, HTTPServer.InsertionOrderRoutePrioritizer, HTTPServer.ProvidedPriorityRoutePrioritizer

Enclosing class:

HTTPServer

public abstract static class HTTPServer.BaseRoutePrioritizer
extends Object
implements HTTPServer.IRoutePrioritizer

Base implementation of a route prioritizer that owns the route mappings.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Collection<HTTPServer.UriResource>	mappings	Routes registered with this prioritizer.
protected Class<?>	notImplemented	Handler used for routes without an implementation.

Constructor Summary

Constructors

Constructor	Description
BaseRoutePrioritizer()	Creates the prioritizer with the default not-implemented handler.

Method Summary

Modifier and Type	Method	Description
void	addRoute(String url, int priority, Class<?> handler, Object... initParameter)	Adds a route.
Collection<HTTPServer.UriResource>	getPrioritizedRoutes()	Returns all routes in processing order.
protected abstract Collection<HTTPServer.UriResource>	newMappingCollection()	Creates the collection that holds the routes.
void	removeRoute(String url)	Removes the route with the given URI pattern.
void	setNotImplemented(Class<?> handler)	Sets the handler used for routes without an implementation.

Methods inherited from class Object

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

Field Details

notImplemented

protected Class<?> notImplemented

Handler used for routes without an implementation.

mappings

protected final Collection<HTTPServer.UriResource> mappings

Routes registered with this prioritizer.

Constructor Details

BaseRoutePrioritizer

public BaseRoutePrioritizer()

Creates the prioritizer with the default not-implemented handler.

Method Details

addRoute

public void addRoute(String url,
 int priority,
 Class<?> handler,
 Object... initParameter)

Adds a route. If no handler is given, the not-implemented handler is used.

Specified by:

addRoute in interface HTTPServer.IRoutePrioritizer

Parameters:

url - the URI pattern

priority - the route priority

handler - the handler class, may be null

initParameter - constructor parameters for the handler

removeRoute

public void removeRoute(String url)

Removes the route with the given URI pattern.

Specified by:

removeRoute in interface HTTPServer.IRoutePrioritizer

Parameters:

url - the URI pattern

getPrioritizedRoutes

public Collection<HTTPServer.UriResource> getPrioritizedRoutes()

Returns all routes in processing order.

Specified by:

getPrioritizedRoutes in interface HTTPServer.IRoutePrioritizer

Returns:

an unmodifiable view of the routes

setNotImplemented

public void setNotImplemented(Class<?> handler)

Sets the handler used for routes without an implementation.

Specified by:

setNotImplemented in interface HTTPServer.IRoutePrioritizer

Parameters:

handler - the handler class

newMappingCollection

protected abstract Collection<HTTPServer.UriResource> newMappingCollection()

Creates the collection that holds the routes.

Returns:

a new, empty route collection