package scalatra

  1. Public
  2. All

Type Members

  1. type Action = () ⇒ Any

    Definition Classes
  2. case class ActionResult(status: ResponseStatus, body: Any, headers: Map[String, String]) extends Product with Serializable

  3. trait ApiFormats extends ScalatraBase

    Adds support for mapping and inferring formats to content types.

  4. abstract class AsyncResult extends ScalatraContext

  5. final class BooleanBlockRouteMatcher extends RouteMatcher

    A route matcher on a boolean condition.

  6. type ContentTypeInferrer = PartialFunction[Any, String]

    Definition Classes
  7. trait Control extends AnyRef

    A collection of methods that affect the control flow of routes.

  8. case class Cookie(name: String, value: String, cookieOptions: CookieOptions) extends Product with Serializable

  9. trait CookieContext extends AnyRef

  10. case class CookieOptions(domain: String, path: String, maxAge: Int, secure: Boolean, comment: String, httpOnly: Boolean, version: Int, encoding: String) extends Product with Serializable

  11. trait CoreDsl extends Handler with Control with ScalatraContext with ServletApiImplicits

    The core Scalatra DSL.

  12. type CoreStack = CorsSupport with FutureSupport with FlashMapSupport

    Definition Classes
  13. type CoreStackNoFlash = CorsSupport with FutureSupport

    Definition Classes
  14. type CoreStackNoFlashWithCsrf = CoreStackNoFlash with CsrfTokenSupport

    Definition Classes
  15. type CoreStackNoFlashWithXsrf = CoreStackNoFlash with XsrfTokenSupport

    Definition Classes
  16. type CoreStackWithCsrf = CoreStack with CsrfTokenSupport

    Definition Classes
  17. type CoreStackWithXsrf = CoreStack with XsrfTokenSupport

    Definition Classes
  18. trait CorsSupport extends Handler with Initializable

  19. trait CsrfTokenSupport extends AnyRef

    Provides cross-site request forgery protection.

  20. trait DefaultValue[Z] extends AnyRef

    A DefaultValue in type Z provides a default value for a given type Z

  21. trait DefaultValueImplicits extends AnyRef

  22. trait DefaultValueMethods extends AnyRef

  23. trait DefaultValues extends DefaultValueMethods with DefaultValueImplicits

  24. trait DynamicScope extends RequestResponseScope

    The Scalatra DSL requires a dynamically scoped request and response.

  25. type ErrorHandler = PartialFunction[Throwable, Any]

    Definition Classes
  26. case class ExtensionMethod(name: String) extends HttpMethod with Product with Serializable

  27. type FileUploadStack = FutureSupport with FlashMapSupport with FileUploadSupport

    Definition Classes
  28. class FlashMap extends MutableMapWithIndifferentAccess[Any] with Serializable

    A FlashMap is the data structure used by FlashMapSupport to allow passing temporary values between sequential actions.

  29. trait FlashMapSupport extends Handler

    Allows an action to set key-value pairs in a transient state that is accessible only to the next action and is expired immediately after that.

  30. type FullCoreStack = CoreStack with FileUploadSupport

    Definition Classes
  31. trait FutureSupport extends AsyncSupport

  32. type FuturesAndFlashStack = FutureSupport with FlashMapSupport

    Definition Classes
  33. type FuturesAndFlashStackWithCsrf = FuturesAndFlashStack with CsrfTokenSupport

    Definition Classes
  34. type FuturesAndFlashStackWithXsrf = FuturesAndFlashStack with XsrfTokenSupport

    Definition Classes
  35. trait GZipSupport extends Handler

    Scalatra handler for gzipped responses.

  36. trait Handler extends AnyRef

    A Handler is the Scalatra abstraction for an object that operates on a request/response pair.

  37. sealed trait HttpMethod extends AnyRef

  38. abstract class HttpVersion extends Ordered[HttpVersion]

  39. trait Initializable extends AnyRef

    Trait representing an object that can't be fully initialized by its constructor.

  40. trait LifeCycle extends ServletApiImplicits

  41. case class MatchedRoute(action: () ⇒ Any, multiParams: MultiParams) extends Product with Serializable

    An action and the multi-map of route parameters to invoke it with.

  42. trait MethodOverride extends Handler with ServletApiImplicits

    Mixin for clients that only support a limited set of HTTP verbs.

  43. type MultiParams = MultiMap

    Definition Classes
  44. type Params = MultiMapHeadView[String, String] with MapWithIndifferentAccess[String]

    Definition Classes
  45. case class PathPattern(regex: Regex, captureGroupNames: List[String]) extends Product with Serializable

    A path pattern optionally matches a request path and extracts path parameters.

  46. trait PathPatternParser extends AnyRef

    Parses a string into a path pattern for routing.

  47. final class PathPatternRouteMatcher extends RouteMatcher

  48. class RailsPathPatternParser extends RegexPathPatternParser

    Path pattern parser based on Rack::Mount::Strexp, which is used by Rails.

  49. final class RailsRouteMatcher extends RouteMatcher with ReversibleRouteMatcher

    An implementation of Rails' path pattern syntax

  50. trait RegexPathPatternParser extends PathPatternParser with RegexParsers

  51. final class RegexRouteMatcher extends RouteMatcher

    A route matcher for regular expressions.

  52. type RenderPipeline = PartialFunction[Any, Any]

    Definition Classes
  53. trait RequestResponseScope extends AnyRef

  54. case class ResponseStatus(code: Int, message: String) extends Ordered[ResponseStatus] with Product with Serializable

  55. trait ReversibleRouteMatcher extends AnyRef

    A route matcher from which a URI can be generated from route parameters.

  56. case class Route(routeMatchers: Seq[RouteMatcher], action: () ⇒ Any, contextPath: () ⇒ String, metadata: Map[Symbol, Any]) extends Product with Serializable

    A route is a set of matchers and an action.

  57. trait RouteMatcher extends (Route) ⇒ Route

    A route matcher is evaluated in the context it was created and returns a a (possibly empty) multi-map of parameters if the route is deemed to match.

  58. class RouteRegistry extends AnyRef

  59. type RouteTransformer = (Route) ⇒ Route

    Definition Classes
  60. trait ScalatraBase extends ScalatraContext with CoreDsl with DynamicScope with Initializable with ServletApiImplicits with ScalatraParamsImplicits with DefaultImplicitConversions with SessionSupport with CookieSupport

    The base implementation of the Scalatra DSL.

  61. trait ScalatraContext extends ServletApiImplicits with SessionSupport with CookieContext

  62. class ScalatraException extends Exception

  63. trait ScalatraFilter extends Filter with ServletBase

    An implementation of the Scalatra DSL in a filter.

  64. class ScalatraParams extends MultiMapHeadView[String, String] with MapWithIndifferentAccess[String]

  65. trait ScalatraParamsImplicits extends AnyRef

    Add some implicits

  66. abstract class ScalatraServlet extends HttpServlet with ServletBase with Initializable

    An implementation of the Scalatra DSL in a servlet.

  67. sealed trait Scheme extends AnyRef

  68. trait SessionSupport extends AnyRef

    This trait provides session support for stateful applications.

  69. class SinatraPathPatternParser extends RegexPathPatternParser

    A Sinatra-compatible route path pattern parser.

  70. final class SinatraRouteMatcher extends RouteMatcher with ReversibleRouteMatcher

    An implementation of Sinatra's path pattern syntax.

  71. trait SslRequirement extends Handler with ServletApiImplicits

    Redirects unsecured requests to the corresponding secure URL.

  72. final class StatusCodeRouteMatcher extends RouteMatcher

  73. class SweetCookies extends ServletApiImplicits

  74. trait UrlGeneratorSupport extends AnyRef

    Adds support for generating URIs from routes and their params.

  75. trait XsrfTokenSupport extends AnyRef

  76. trait CookieSupport extends AnyRef


    (Since version 2.2) You can remove this mixin, it's included in core by default

  77. trait GetResponseStatusSupport extends AnyRef


    (Since version 2.1.0) No longer necessary after upgrade to Servlet 3.0

  78. type ScalatraKernel = ServletBase

    Definition Classes

    (Since version 2.1.0) Use org.scalatra.servlet.ServletBase if you depend on the Servlet API, or org.scalatra.ScalatraBase if you don't.

  79. trait TypedParamSupport extends ScalatraBase


    (Since version 2.2) This got folded into core, so you can remove the TypeParamSupport trait safely.

  80. trait UrlSupport extends AnyRef

    Provides utility methods for the creation of URL strings.

Value Members

  1. object Accepted extends AnyRef

  2. object AlreadyReported extends AnyRef

  3. object ApiFormats extends AnyRef

  4. object AsyncResult extends AnyRef

  5. object BadGateway extends AnyRef

  6. object BadRequest extends AnyRef

  7. object Conflict extends AnyRef

  8. object Connect extends HttpMethod with Product with Serializable

  9. object Cookie extends Serializable

  10. object CookieSupport extends AnyRef

  11. object CorsSupport extends AnyRef

  12. object Created extends AnyRef

  13. object CsrfTokenSupport extends AnyRef

  14. object DefaultValueMethods extends DefaultValueMethods

  15. object DefaultValues extends DefaultValues

  16. object Delete extends HttpMethod with Product with Serializable

  17. val EnvironmentKey: String

    Definition Classes
  18. object ExpectationFailed extends AnyRef

  19. object FailedDependency extends AnyRef

  20. object FlashMapSupport extends AnyRef

  21. object Forbidden extends AnyRef

  22. object Found extends AnyRef

  23. object GatewayTimeout extends AnyRef

  24. object GenerateId extends AnyRef

  25. object Get extends HttpMethod with Product with Serializable

  26. object Gone extends AnyRef

  27. object HTTPVersionNotSupported extends AnyRef

  28. object Head extends HttpMethod with Product with Serializable

  29. object Http extends Scheme with Product with Serializable

  30. object Http10 extends HttpVersion

  31. object Http11 extends HttpVersion

  32. object HttpMethod extends AnyRef

  33. object Https extends Scheme with Product with Serializable

  34. object IMUsed extends AnyRef

  35. object InsufficientStorage extends AnyRef

  36. object InternalServerError extends AnyRef

  37. object LengthRequired extends AnyRef

  38. object Locked extends AnyRef

  39. object LoopDetected extends AnyRef

  40. object MethodNotAllowed extends AnyRef

  41. object MethodOverride extends AnyRef

  42. object MovedPermanently extends AnyRef

  43. val MultiParamsKey: String

    Definition Classes
  44. object MultiStatus extends AnyRef

  45. object MultipleChoices extends AnyRef

  46. object NetworkAuthenticationRequired extends AnyRef

  47. object NoContent extends AnyRef

  48. object NonAuthoritativeInformation extends AnyRef

  49. object NotAcceptable extends AnyRef

  50. object NotExtended extends AnyRef

  51. object NotFound extends AnyRef

  52. object NotImplemented extends AnyRef

  53. object NotModified extends AnyRef

  54. object Ok extends AnyRef

  55. object Options extends HttpMethod with Product with Serializable

  56. object PartialContent extends AnyRef

  57. object Patch extends HttpMethod with Product with Serializable

  58. object PathPatternParser extends AnyRef

  59. object PaymentRequired extends AnyRef

  60. object PermanentRedirect extends AnyRef

  61. object Post extends HttpMethod with Product with Serializable

  62. object PreconditionFailed extends AnyRef

  63. object PreconditionRequired extends AnyRef

  64. object ProxyAuthenticationRequired extends AnyRef

  65. object Put extends HttpMethod with Product with Serializable

  66. object RailsPathPatternParser extends AnyRef

  67. object RequestEntityTooLarge extends AnyRef

  68. object RequestHeaderFieldsTooLarge extends AnyRef

  69. object RequestTimeout extends AnyRef

  70. object RequestURITooLong extends AnyRef

  71. object RequestedRangeNotSatisfiable extends AnyRef

  72. object ResetContent extends AnyRef

  73. object ResponseStatus extends Serializable

  74. object Route extends Serializable

  75. object ScalatraBase extends AnyRef

  76. object ScalatraContext extends AnyRef

  77. object ScalatraKernel extends AnyRef

  78. object ScalatraParamsImplicits extends ScalatraParamsImplicits with DefaultImplicitConversions

  79. object ScalatraServlet extends Serializable

  80. object SeeOther extends AnyRef

  81. object ServiceUnavailable extends AnyRef

  82. object SinatraPathPatternParser extends AnyRef

  83. object TemporaryRedirect extends AnyRef

  84. object TooManyRequests extends AnyRef

  85. object Trace extends HttpMethod with Product with Serializable

  86. object Unauthorized extends AnyRef

  87. object UnprocessableEntity extends AnyRef

  88. object UnsupportedMediaType extends AnyRef

  89. object UpgradeRequired extends AnyRef

  90. object UriDecoder extends AnyRef

  91. object UrlGenerator extends UrlGeneratorSupport

  92. object UseProxy extends AnyRef

  93. object VariantAlsoNegotiates extends AnyRef

  94. object XsrfTokenSupport extends AnyRef

  95. package akka

  96. package atmosphere

  97. package auth

  98. package commands

  99. package fileupload

  100. def halt(result: ActionResult): Nothing

    Definition Classes
  101. def halt[T](status: Integer, body: T, headers: Map[String, String], reason: String)(implicit arg0: Manifest[T]): Nothing

    Immediately halts processing of a request.

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


    the status to set on the response, or null to leave the status unchanged.


    a result to render through the render pipeline as the body


    headers to add to the response


    the HTTP status reason to set, or null to leave unchanged.

    Definition Classes
  102. package i18n

  103. package jetty

  104. package json

  105. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

    Definition Classes
  106. package scalate

  107. package servlet

  108. package slf4j

  109. package swagger

  110. package test

  111. package util

  112. package validation