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

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

The base path for URL generation

Returns the Swagger instance responsible for generating the resource and operation listings.

Prepends a new route for the given HTTP method.

Can be overriden so that subtraits can use their own logic. Possible examples: $ - restricting protocols $ - namespace routes based on class name $ - raising errors on overlapping entries.

This is the method invoked by get(), post() etc.

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.

Converts a boolean expression to a route matcher.

The configuration, typically a ServletConfig or FilterConfig.

Gets the content type of the current response.

A partial function to infer the content type from the action result.

Sets the content type of the current response.

The default character encoding for requests and responses.

Called if no route matches the current request method, but routes match for other methods. By default, sends an HTTP status of 405 and an Allow header containing a comma-delimited list of the allowed methods.

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.

The error handler function, called if an exception is thrown during before filters or the routes.

Executes routes in the context of the current request and response.

$ 1. Executes each before filter with runFilters. $ 2. Executes the routes in the route registry with runRoutes for the request's method. a. The result of runRoutes becomes the _action result_. b. If no route matches the requested method, but matches are found for other methods, then the doMethodNotAllowed hook is run with each matching method. c. If no route matches any method, then the doNotFound hook is run, and its return value becomes the action result. $ 3. If an exception is thrown during the before filters or the route $ actions, then it is passed to the errorHandler function, and its $ result becomes the action result. $ 4. Executes the after filters with runFilters. $ 5. The action result is passed to renderResponse.

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().

Whether to include the format parameter in the index listing for swagger defaults to false, the format parameter will not be present but is still optional.

The name of the route to use when getting the index listing for swagger defaults to optional resources.:format or /

Gets an init paramter 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.

Invokes a route or filter. The multiParams gathered from the route matchers are merged into the existing route params, and then the action is run.

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.

Path pattern is decoupled from requests. This adapts the PathPattern to a RouteMatcher by supplying the request path.

Sends a redirect response and immediately halts the current action.

Converts a regular expression to a route matcher.

Removes _all_ the actions of a given route for a given HTTP method. If addRoute is overridden then this should probably be overriden too.

The render pipeline is a partial function of Any => Any. It is called recursively until it returns (). () indicates that the response has been rendered.

Renders the action result to the response. $ - If the content type is still null, call the contentTypeInferrer. $ - Call the render pipeline on the result.

Renders the action result to the response body via the render pipeline.

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

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

The routes registered in this kernel.

Invokes each filters with invoke. The results of the filters are discarded.

Lazily invokes routes with invoke. The results of the routes are returned as a stream.

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

The servlet context in which this kernel runs.

The current session. Creates a session if none exists.

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.

Pluggable way to convert a path expression to a route matcher. The default implementation is compatible with Sinatra's route syntax.

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.