ScalatraBase

org.scalatra.ScalatraBase

See theScalatraBase companion object

trait ScalatraBase extends ScalatraContext, CoreDsl, DynamicScope, Initializable, ServletApiImplicits, ScalatraParamsImplicits, DefaultImplicitConversions, SessionSupport

The base implementation of the Scalatra DSL. Intended to be portable to all supported backends.

Attributes

Companion: object
Graph
Supertypes: trait DefaultImplicitConversions

trait LowPriorityImplicitConversions

trait LowestPriorityImplicitConversions

trait TypeConverterSupport

trait ScalatraParamsImplicits

trait Initializable

trait DynamicScope

trait RequestResponseScope

trait CoreDsl

trait Control

trait Handler

trait ScalatraContext

trait CookieContext

trait SessionSupport

trait ServletApiImplicits

class Object

trait Matchable

class Any
Show all
Known subtypes: trait ServletBase

trait AsyncSupport

trait FutureSupport

trait FileUploadSupport

trait ScalatraFilter

trait ScalatraServlet

trait RequestLogging

trait ApiFormats
Show all

Members list

Type members

Inherited classlikes

Attributes

Inherited from:: Initializable
Supertypes: class Object

trait Matchable

class Any

Inherited types

Attributes

Inherited from:: Initializable

Value members

Abstract methods

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

Attributes

Concrete methods

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.

Attributes

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.

Attributes

See also: get

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.

Attributes

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

Value parameters

path: a relative path

Attributes

Returns: the full URL

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!" }

Attributes

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

Attributes

Definition Classes: Handler

Attributes

See also: head

Gets an init parameter from the config.

Value parameters

name: the name of the key

Attributes

Returns: an option containing the value of the parameter if defined, or None if the parameter is not set.

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.

Value parameters

config: the configuration.

Attributes

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

Attributes

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

Attributes

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.

Attributes

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

Attributes

See also: get

Attributes

See also: patch

Attributes

See also: get

Attributes

See also: get

Sends a redirect response and immediately halts the current action.

Attributes

The servlet context in which this kernel runs.

Attributes

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"
 }
}*

}}

Attributes

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.

Value parameters

params: params, to be appended in the form of a query string
path: the base path. If a path begins with '/', then the context path will be prepended to the result

Attributes

Returns: the path plus the query string, if any. The path is run through response.encodeURL to add any necessary session tracking parameters.

Inherited methods

Gets the content type of the current response.

Attributes

Inherited from:: ScalatraContext

Sets the content type of the current response.

Attributes

Inherited from:: ScalatraContext

Attributes

Inherited from:: CookieContext

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

Attributes

Inherited from:: ScalatraContext

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

Attributes

Inherited from:: ScalatraContext

Attributes

Inherited from:: Control

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

Value parameters

body: a result to render through the render pipeline as the body
headers: headers to add to the response
status: the status to set on the response, or null to leave the status unchanged.