ScalatraFilter

The effective path against which routes are matched. The definition varies between servlets and filters.

The base path for URL generation

Adds a filter to run after the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

Adds a filter to run before the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

Gets the content type of the current response.

Sets the content type of the current response.

Defines an error handler for exceptions thrown in either the before block or a route action.

If the error handler does not match, the result falls through to the previously defined error handler. The default error handler simply rethrows the exception.

The error handler is run before the after filters, and the result is rendered like a standard response. It is the error handler's responsibility to set any appropriate status code.

Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.

Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.

Builds a full URL from the given relative path. Takes into account the port configuration, https, ...

The Scalatra DSL core methods take a list of org.scalatra.RouteMatcher and a block as the action body. The return value of the block is rendered through the pipeline and sent to the client as the response body.

See org.scalatra.ScalatraBase#renderResponseBody for the detailed behaviour and how to handle your response body more explicitly, and see how different return types are handled.

The block is executed in the context of a CoreDsl instance, so all the methods defined in this trait are also available inside the block.

 get("/") {
   <form action="/echo">
     <label>Enter your name</label>
     <input type="text" name="name"/>
   </form>
 }

 post("/echo") {
   "hello {params('name)}!"
 }

ScalatraKernel provides implicit transformation from boolean blocks, strings and regular expressions to org.scalatra.RouteMatcher, so you can write code naturally.

 get("/", request.getRemoteHost == "127.0.0.1") { "Hello localhost!" }

Immediately halts processing of a request. Can be called from either a before filter or a route.

Handles a request and renders a response.

$ 1. If the request lacks a character encoding, defaultCharacterEncoding is set to the request.

$ 2. Sets the response's character encoding to defaultCharacterEncoding.

$ 3. Binds the current request, response, and multiParams, and calls executeRoutes().

Gets an init parameter from the config.

Initializes the kernel. Used to provide context that is unavailable when the instance is constructed, for example the servlet lifecycle. Should set the config variable to the parameter.

A boolean flag representing whether the kernel is in development mode. The default is true if the environment begins with "dev", case-insensitive.

Defines a block to run if matching routes are found only for other methods. The set of matching methods is passed to the block.

The current multiparams. Multiparams are a result of merging the standard request params (query string or post params) with the route parameters extracted from the route matchers of the current route. The default value for an unknown param is the empty sequence. Invalid outside handle.

Defines a block to run if no matching routes are found, or if all matching routes pass.

Immediately exits from the current route.

Sends a redirect response and immediately halts the current action.

The servlet context in which this kernel runs.

The current session. If none exists, None is returned.

A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

Gets the status code of the current response.

Sets the status code of the current response.

Error handler for HTTP response status code range. You can intercept every response code previously specified with #status or even generic 404 error.

 trap(403) {
  "You are not authorized"
 }
}* 

}}

Returns a context-relative, session-aware URL for a path and specified parameters. Finally, the result is run through response.encodeURL for a session ID, if necessary.

Executes the block with the given request bound to the request method.

Executes the block with the given response bound to the response method.

Called if no route matches the current request for any method. The default implementation varies between servlet and filter.

The configuration, typically a ServletConfig or FilterConfig.

The routes registered in this kernel.

The currently scoped request. Valid only inside the handle method.

The currently scoped response. Valid only inside the handle method.

Implicit convert a (String) => Option[T] function into a TypeConverter[T]

The current session. Creates a session if none exists.