A B C D E F G H I J L M N O P R S T U V W X

A

acceptType - Variable in class org.baswell.routes.RequestedMediaType

add(Object...) - Method in class org.baswell.routes.RoutingTable

Adds to the given objects to the routing table.

AfterRoute - Annotation Type in org.baswell.routes

Callback to receive notification after HTTP requests have been routed.

ATOM - Static variable in class org.baswell.routes.MIMETypes

application/atomcat+xml

B

BAD_REQUEST - Static variable in exception org.baswell.routes.ReturnHttpResponseStatus

Shortcut for returning 400.

BasicMetaAuthenticator - Class in org.baswell.routes

A MetaAuthenticator that uses HTTP basic authentication.

BasicMetaAuthenticator() - Constructor for class org.baswell.routes.BasicMetaAuthenticator

BeforeRoute - Annotation Type in org.baswell.routes

Callback to receive notification before HTTP requests have been sent to the route method.

borrowRouteInstance(Class) - Method in class org.baswell.routes.DefaultRouteInstancePool

borrowRouteInstance(Class) - Method in interface org.baswell.routes.RouteInstancePool

Called when a route match has been made to a method in the given class and an instance is needed to process the request.

build() - Method in class org.baswell.routes.RoutingTable

Builds the routing table from the added route objects.

C

caseInsensitive - Variable in class org.baswell.routes.RoutesConfiguration

Is route path and parameter matching case insensitive? Default value: false

contains(String) - Method in class org.baswell.routes.RequestParameters

CSV - Static variable in class org.baswell.routes.MIMETypes

text/csv

D

defaultContentType - Variable in class org.baswell.routes.RoutesConfiguration

Default content type returned by all routes if not overridden.

defaultReturnedStringIsContent - Variable in class org.baswell.routes.RoutesConfiguration

If true by default strings returned from route methods are sent back as the content.

DefaultRouteInstancePool - Class in org.baswell.routes

Create a new route object each time using the default constructor and discards the object after use.

DefaultRouteInstancePool() - Constructor for class org.baswell.routes.DefaultRouteInstancePool

defineSymbol(String, Class) - Method in class org.baswell.routes.RoutesConfiguration

Defines a new regular expression whose identity is the given symbol and value is the regular expression for one of the following classes: Byte byte Short short Integer int Long long Float float Double double Boolean boolean String

defineSymbol(String, String) - Method in class org.baswell.routes.RoutesConfiguration

Defines a new regular expression whose id is the given symbol and value is the given pattern.

destroy() - Method in class org.baswell.routes.RoutesFilter

developmentMode - Variable in class org.baswell.routes.RoutesConfiguration

If true the RoutingTable will spawn a thread that rebuilds the routing table every RoutesConfiguration.developmentReloadCycleSeconds.

developmentReloadCycleSeconds - Variable in class org.baswell.routes.RoutesConfiguration

The number of seconds between development mode reloads of the RoutingTable.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.baswell.routes.RoutesFilter

E

equals(String) - Method in class org.baswell.routes.RequestPath

equals(List<String>) - Method in class org.baswell.routes.RequestPath

equals(Object) - Method in class org.baswell.routes.RequestPath

EXCEL - Static variable in class org.baswell.routes.MIMETypes

application/vnd.ms-excel

EXCEL2 - Static variable in class org.baswell.routes.MIMETypes

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

EXCEL3 - Static variable in class org.baswell.routes.MIMETypes

application/msexcel

EXCEL4 - Static variable in class org.baswell.routes.MIMETypes

application/xls

EXCEL5 - Static variable in class org.baswell.routes.MIMETypes

application/x-xls

EXCEL6 - Static variable in class org.baswell.routes.MIMETypes

application/x-ms-excel

EXCEL7 - Static variable in class org.baswell.routes.MIMETypes

application/x-excel

extension - Variable in enum org.baswell.routes.MediaType

The default file extension.

extensions - Variable in enum org.baswell.routes.MediaType

All file extensions.

F

fileExtension - Variable in class org.baswell.routes.RequestedMediaType

findFromExtension(String) - Static method in enum org.baswell.routes.MediaType

findFromMediaTypeParameter(String) - Static method in enum org.baswell.routes.MediaType

findFromMimeType(String) - Static method in enum org.baswell.routes.MediaType

FORBIDDEN - Static variable in exception org.baswell.routes.ReturnHttpResponseStatus

Shortcut for returning 403.

fromServletMethod(String) - Static method in enum org.baswell.routes.HttpMethod

G

get() - Method in class org.baswell.routes.RequestContent

get(String) - Method in class org.baswell.routes.RequestParameters

get(String, String) - Method in class org.baswell.routes.RequestParameters

get(int) - Method in class org.baswell.routes.RequestPath

get(HttpMethod, RequestedMediaType, RequestPath, RequestParameters) - Method in interface org.baswell.routes.RoutesCache

Retrieve the cached route instance or null on a cache miss.

get(HttpMethod, RequestedMediaType, RequestPath, RequestParameters) - Method in class org.baswell.routes.SimpleRoutesCache

getBoolean(String) - Method in class org.baswell.routes.RequestParameters

getBoolean(String, Boolean) - Method in class org.baswell.routes.RequestParameters

getBoolean(int) - Method in class org.baswell.routes.RequestPath

getBooleans(String) - Method in class org.baswell.routes.RequestParameters

getByte(String) - Method in class org.baswell.routes.RequestParameters

getByte(String, Byte) - Method in class org.baswell.routes.RequestParameters

getByte(int) - Method in class org.baswell.routes.RequestPath

getBytes(String) - Method in class org.baswell.routes.RequestParameters

getCharacter(String) - Method in class org.baswell.routes.RequestParameters

getCharacter(String, Character) - Method in class org.baswell.routes.RequestParameters

getCharacter(int) - Method in class org.baswell.routes.RequestPath

getCharacters(String) - Method in class org.baswell.routes.RequestParameters

getDouble(String) - Method in class org.baswell.routes.RequestParameters

getDouble(String, Double) - Method in class org.baswell.routes.RequestParameters

getDouble(int) - Method in class org.baswell.routes.RequestPath

getDoubles(String) - Method in class org.baswell.routes.RequestParameters

getFileExtension() - Method in class org.baswell.routes.RequestPath

If this path contains a file name this method returns the text to the right of the last '.' in the file name.

getFileName() - Method in class org.baswell.routes.RequestPath

If the last segment in this path has a '.' then the full (last) segment will be returned.

getFloat(String) - Method in class org.baswell.routes.RequestParameters

getFloat(String, Float) - Method in class org.baswell.routes.RequestParameters

getFloat(int) - Method in class org.baswell.routes.RequestPath

getFloats(String) - Method in class org.baswell.routes.RequestParameters

getInt(String, Integer) - Method in class org.baswell.routes.RequestParameters

getInteger(String) - Method in class org.baswell.routes.RequestParameters

getInteger(int) - Method in class org.baswell.routes.RequestPath

getIntegers(String) - Method in class org.baswell.routes.RequestParameters

getKey(HttpMethod, RequestedMediaType, RequestPath, RequestParameters) - Method in class org.baswell.routes.SimpleRoutesCache

getLong(String) - Method in class org.baswell.routes.RequestParameters

getLong(String, Long) - Method in class org.baswell.routes.RequestParameters

getLong(int) - Method in class org.baswell.routes.RequestPath

getLongs(String) - Method in class org.baswell.routes.RequestParameters

getParameterListMap() - Method in class org.baswell.routes.RequestParameters

getParameterMap() - Method in class org.baswell.routes.RequestParameters

Parameters with multiple values will only contain one value in this map.

getShort(String) - Method in class org.baswell.routes.RequestParameters

getShort(String, Short) - Method in class org.baswell.routes.RequestParameters

getShort(int) - Method in class org.baswell.routes.RequestPath

getShorts(String) - Method in class org.baswell.routes.RequestParameters

getValues(String) - Method in class org.baswell.routes.RequestParameters

GSONBridge - Class in org.baswell.routes

GSONBridge() - Constructor for class org.baswell.routes.GSONBridge

H

hasParameters() - Method in class org.baswell.routes.RequestParameters

HTML - Static variable in class org.baswell.routes.MIMETypes

text/html

HTML2 - Static variable in class org.baswell.routes.MIMETypes

application/xhtml+xml

HttpMethod - Enum in org.baswell.routes

I

ICS - Static variable in class org.baswell.routes.MIMETypes

text/calendar

init(FilterConfig) - Method in class org.baswell.routes.RoutesFilter

INTERNAL_SERVER_ERROR - Static variable in exception org.baswell.routes.ReturnHttpResponseStatus

Shortcut for returning 500.

J

JacksonBridge - Class in org.baswell.routes

JacksonBridge() - Constructor for class org.baswell.routes.JacksonBridge

JAVASCRIPT - Static variable in class org.baswell.routes.MIMETypes

application/javascript

JAVASCRIPT2 - Static variable in class org.baswell.routes.MIMETypes

application/x-javascript

JAVASCRIPT3 - Static variable in class org.baswell.routes.MIMETypes

text/javascript

JDOMBridge - Class in org.baswell.routes

JDOMBridge() - Constructor for class org.baswell.routes.JDOMBridge

JSON - Static variable in class org.baswell.routes.MIMETypes

application/json

JSON2 - Static variable in class org.baswell.routes.MIMETypes

text/x-json

L

logError(String) - Method in interface org.baswell.routes.RoutesLogger

logError(Exception) - Method in interface org.baswell.routes.RoutesLogger

logError(String, Exception) - Method in interface org.baswell.routes.RoutesLogger

logError(String) - Method in class org.baswell.routes.SystemErrLogger

logError(Exception) - Method in class org.baswell.routes.SystemErrLogger

logError(String, Exception) - Method in class org.baswell.routes.SystemErrLogger

logger - Variable in class org.baswell.routes.RoutesConfiguration

Logger Routes uses for error messages.

M

MediaType - Enum in org.baswell.routes

Media types that Routes is aware of.

mediaType - Variable in class org.baswell.routes.RequestedMediaType

MetaAuthenticator - Interface in org.baswell.routes

Authentication implementation for Routes meta page.

metaAuthenticator - Variable in class org.baswell.routes.RoutesConfiguration

The authentication mechanism for the Routes meta page.

metaRequestAuthenticated(HttpServletRequest, HttpServletResponse) - Method in class org.baswell.routes.BasicMetaAuthenticator

metaRequestAuthenticated(HttpServletRequest, HttpServletResponse) - Method in interface org.baswell.routes.MetaAuthenticator

Called when the current HTTP request matches RoutesConfiguration.routesMetaPath.

mimeType - Variable in enum org.baswell.routes.MediaType

The default mime type.

mimeTypes - Variable in enum org.baswell.routes.MediaType

All mime types.

MIMETypes - Class in org.baswell.routes

Mime type constants that Routes is aware of.

MIMETypes() - Constructor for class org.baswell.routes.MIMETypes

N

NOT_FOUND - Static variable in exception org.baswell.routes.ReturnHttpResponseStatus

Shortcut for returning 404.

O

org.baswell.routes - package org.baswell.routes

P

PDF - Static variable in class org.baswell.routes.MIMETypes

application/pdf

pop(int) - Method in class org.baswell.routes.RequestPath

Returns a new RequestPath with the given number of segments removed from the start of the path.

pop() - Method in class org.baswell.routes.RequestPath

Same as pop(1).

process(HttpServletRequest, HttpServletResponse) - Method in class org.baswell.routes.RoutesEngine

Looks for route matches for the given HTTP request.

put(Object, HttpMethod, RequestedMediaType, RequestPath, RequestParameters) - Method in interface org.baswell.routes.RoutesCache

Called after a request has been processed by the given routeNode.

put(Object, HttpMethod, RequestedMediaType, RequestPath, RequestParameters) - Method in class org.baswell.routes.SimpleRoutesCache

R

RedirectTo - Exception in org.baswell.routes

When thrown from BeforeRoute or Route methods the current request will immediately (no further processing) be redirected to the given redirectUrl.

RedirectTo(String) - Constructor for exception org.baswell.routes.RedirectTo

If redirectUrl is not a fully qualified URL then it will be considered relative from the current HTTP request.

RedirectTo(URL) - Constructor for exception org.baswell.routes.RedirectTo

redirectUrl - Variable in exception org.baswell.routes.RedirectTo

removeHttpMethodsFromName(Method) - Method in class org.baswell.routes.RouteByHttpMethodNameConvention

Removes any of the HTTP method names GET, POST, PUT, DELETE, HEAD (case insensitive) from the beginning of this method name if the given method does not have a Route.respondsToMethods() specified.

removeRoutesControllerHandlerFromName(Class) - Method in class org.baswell.routes.RouteByHttpMethodNameConvention

Removes any of the following words from the very end of the given class name.

RequestContent<ContentType> - Class in org.baswell.routes

Convenience class for accessing the content of a request.

RequestedMediaType - Class in org.baswell.routes

The requested media type of an HTTP request.

RequestParameters - Class in org.baswell.routes

The parameters from an HTTP request.

RequestPath - Class in org.baswell.routes

Details of the HTTP request path (minus the application's context path).

respondsToMethods(Method) - Method in interface org.baswell.routes.RouteByConvention

The HTTP methods this route method responds to when Route.respondsToMethods() is not specified.

respondsToMethods(Method) - Method in class org.baswell.routes.RouteByHttpMethodNameConvention

The HTTP method names are taken from the beginning of the method name.

ReturnHttpResponseStatus - Exception in org.baswell.routes

When thrown from BeforeRoute or Route methods will be set with the status of this exception and no further processing will continue.

ReturnHttpResponseStatus(int) - Constructor for exception org.baswell.routes.ReturnHttpResponseStatus

returnRouteInstance(Object) - Method in class org.baswell.routes.DefaultRouteInstancePool

returnRouteInstance(Object) - Method in interface org.baswell.routes.RouteInstancePool

The Routes engine is done using this route instance.

rootForwardPath - Variable in class org.baswell.routes.RoutesConfiguration

The root directory prepended to all file resource forward paths.

rootPath - Variable in class org.baswell.routes.RoutesConfiguration

The global path prepended to all route paths.

Route - Annotation Type in org.baswell.routes

Route metadata for a route method.

RouteByCamelCaseConvention - Class in org.baswell.routes

Uses camel case convention of method names to create new path segments.

RouteByCamelCaseConvention() - Constructor for class org.baswell.routes.RouteByCamelCaseConvention

RouteByConvention - Interface in org.baswell.routes

Convention for mapping routes where annotations aren't explicitly provided.

routeByConvention - Variable in class org.baswell.routes.RoutesConfiguration

The scheme for mapping route methods to HTTP methods and HTTP paths when not explicitly set by the Route annotation.

RouteByHttpMethodNameConvention - Class in org.baswell.routes

Base class RouteByConvention that provides an implementation for respondsToMethods.

RouteByHttpMethodNameConvention() - Constructor for class org.baswell.routes.RouteByHttpMethodNameConvention

RouteByLowercaseConvention - Class in org.baswell.routes

Default convention used by Routes.

RouteByLowercaseConvention() - Constructor for class org.baswell.routes.RouteByLowercaseConvention

RouteInstanceBorrowException - Exception in org.baswell.routes

Thrown when a route instance cannot be borrowed from RouteInstancePool for any reason.

RouteInstanceBorrowException(String) - Constructor for exception org.baswell.routes.RouteInstanceBorrowException

RouteInstanceBorrowException(Throwable) - Constructor for exception org.baswell.routes.RouteInstanceBorrowException

RouteInstanceBorrowException(String, Throwable) - Constructor for exception org.baswell.routes.RouteInstanceBorrowException

RouteInstancePool - Interface in org.baswell.routes

When routes are added to RoutingTable as class objects, a route instance must be used each time to process a HTTP request.

routeInstancePool - Variable in class org.baswell.routes.RoutesConfiguration

The factory for creating new route instances to process HTTP requests.

routePath(Method) - Method in class org.baswell.routes.RouteByCamelCaseConvention

routePath(Method) - Method in interface org.baswell.routes.RouteByConvention

The generated route path from a route method with no Route.value().

routePath(Method) - Method in class org.baswell.routes.RouteByLowercaseConvention

Routes - Annotation Type in org.baswell.routes

Route metadata for all route methods within the class.

RoutesCache - Interface in org.baswell.routes

By default the Routes engine will sequential check each route method until a match is found.

routesCache - Variable in class org.baswell.routes.RoutesConfiguration

The routes cache implementation.

RoutesConfiguration - Class in org.baswell.routes

Global route configuration.

RoutesConfiguration() - Constructor for class org.baswell.routes.RoutesConfiguration

RoutesEngine - Class in org.baswell.routes

Routes process engine.

RoutesEngine(RoutingTable) - Constructor for class org.baswell.routes.RoutesEngine

If the routingTable has not already been built the RoutingTable.build() method will be called on the first request received.

RoutesException - Exception in org.baswell.routes

General exception thrown when Routes are configured incorrectly.

RoutesException(String) - Constructor for exception org.baswell.routes.RoutesException

RoutesException(String, Throwable) - Constructor for exception org.baswell.routes.RoutesException

RoutesFilter - Class in org.baswell.routes

An entry point for mapping HTTP servlet requests to route methods.

RoutesFilter() - Constructor for class org.baswell.routes.RoutesFilter

RoutesLogger - Interface in org.baswell.routes

Routes will only log error statements using this interface.

routesMetaPath - Variable in class org.baswell.routes.RoutesConfiguration

The path (relative to context path) to access the Routes meta page.

routesPathPrefix(Class) - Method in class org.baswell.routes.RouteByCamelCaseConvention

routesPathPrefix(Class) - Method in interface org.baswell.routes.RouteByConvention

The generated root path of a routes class when Routes.value() is not specified.

routesPathPrefix(Class) - Method in class org.baswell.routes.RouteByLowercaseConvention

RoutesServlet - Class in org.baswell.routes

An entry point for mapping HTTP servlet requests to route methods.

RoutesServlet() - Constructor for class org.baswell.routes.RoutesServlet

routeUnannotatedPublicMethods - Variable in class org.baswell.routes.RoutesConfiguration

Default value for determining if public methods be candidates for HTTP routes if they aren't annotated with Route? If true only unannotated, public methods of the immediate class will be used.

RoutingTable - Class in org.baswell.routes

Hub for all routes.

RoutingTable() - Constructor for class org.baswell.routes.RoutingTable

The default RoutesConfiguration will be used.

RoutingTable(RoutesConfiguration) - Constructor for class org.baswell.routes.RoutingTable

RSS - Static variable in class org.baswell.routes.MIMETypes

application/rss+xml

S

service(HttpServletRequest, HttpServletResponse) - Method in class org.baswell.routes.RoutesServlet

setRoutes(List<Object>) - Method in class org.baswell.routes.RoutingTable

Calls RoutingTable.add(java.lang.Object...) for each object in the given list.

SimpleMetaAuthenticator - Class in org.baswell.routes

A simple MetaAuthenticator that uses a static user name and password (provided at construction) and Basic authentication to determine if access to the Routes meta page is allowed.

SimpleMetaAuthenticator(String, String) - Constructor for class org.baswell.routes.SimpleMetaAuthenticator

SimpleRoutesCache - Class in org.baswell.routes

A very simple in memory cache implementation.

SimpleRoutesCache(int, int, boolean) - Constructor for class org.baswell.routes.SimpleRoutesCache

size() - Method in class org.baswell.routes.RequestParameters

size(String) - Method in class org.baswell.routes.RequestParameters

size() - Method in class org.baswell.routes.RequestPath

startsWith(String) - Method in class org.baswell.routes.RequestPath

startsWith(List<String>) - Method in class org.baswell.routes.RequestPath

status - Variable in exception org.baswell.routes.ReturnHttpResponseStatus

The HTTP status to return.

streamBufferSize - Variable in class org.baswell.routes.RoutesConfiguration

The buffer size for streaming back content.

substring(int) - Method in class org.baswell.routes.RequestPath

SystemErrLogger - Class in org.baswell.routes

The default Routes logger.

SystemErrLogger() - Constructor for class org.baswell.routes.SystemErrLogger

T

TEXT - Static variable in class org.baswell.routes.MIMETypes

text/plain

toString() - Method in class org.baswell.routes.RequestedMediaType

toString() - Method in class org.baswell.routes.RequestParameters

toString() - Method in class org.baswell.routes.RequestPath

U

UNAUTHORIZED - Static variable in exception org.baswell.routes.ReturnHttpResponseStatus

Shortcut for returning 401.

V

validCredentials(String, String) - Method in class org.baswell.routes.BasicMetaAuthenticator

validCredentials(String, String) - Method in class org.baswell.routes.SimpleMetaAuthenticator

valueOf(String) - Static method in enum org.baswell.routes.HttpMethod

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.baswell.routes.MediaType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.baswell.routes.HttpMethod

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.baswell.routes.MediaType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WORD - Static variable in class org.baswell.routes.MIMETypes

application/msword

WORD2 - Static variable in class org.baswell.routes.MIMETypes

application/vnd.openxmlformats-officedocument.wordprocessingml.document

X

XML - Static variable in class org.baswell.routes.MIMETypes

application/xml

XML2 - Static variable in class org.baswell.routes.MIMETypes

text/xml

A B C D E F G H I J L M N O P R S T U V W X