com.epimorphics.lda.routing

Interface Router

All Known Implementing Classes:

DefaultRouter

public interface Router

Abstraction for the dispatch part of the API. Supports dynamic registration of URI templates against API instances. Could be implemented directly by a servlet, via Restlet or via JAX-RS. Initially assume JAX-RS, just need to work out how.

Version:

$Revision: $

Author:

Dave Reynolds

Method Summary

Methods

Modifier and Type	Method and Description
int	countTemplates() Return the number of URI templates served by this Router.
String	findItemURIPath(String context, URI requestURI, String itemPath) Return the URI template of an endpoint in this Router which has an ItemEndpoint matching the itemPath.
Match	getMatch(String path, MultiMap<String,String> queryParams) Match the request path to the known endpoints and return a Match object (giving the APIEndpoint and any template bindings) or null if the request does not match.
void	register(String context, String URITemplate, APIEndpoint api) Register a new API instance.
List<String>	templates() Return a list of URI templates registered with this Router.
void	unregister(String context, String URITemplate) Remove a registered api

Method Detail

register

void register(String context,
            String URITemplate,
            APIEndpoint api)

Register a new API instance.

Parameters:

URITemplate - the path template, relative server root

api - the api implementation

unregister

void unregister(String context,
              String URITemplate)

Remove a registered api

getMatch

Match getMatch(String path,
             MultiMap<String,String> queryParams)

Match the request path to the known endpoints and return a Match object (giving the APIEndpoint and any template bindings) or null if the request does not match.

templates

List<String> templates()

Return a list of URI templates registered with this Router.

findItemURIPath

String findItemURIPath(String context,
                     URI requestURI,
                     String itemPath)

Return the URI template of an endpoint in this Router which has an ItemEndpoint matching the itemPath.

countTemplates

int countTemplates()

Return the number of URI templates served by this Router.