org

scalatra

package scalatra

Linear Supertypes
Control, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. scalatra
  2. Control
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Action = () ⇒ Any

  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.

    Adds support for mapping and inferring formats to content types.

    $ - Provides a request-scoped format variable $ - Maps formats to content types and vice versa $ - Augments the content-type inferrer to use the format

  4. abstract class AsyncResult extends ScalatraContext

  5. final class BooleanBlockRouteMatcher extends RouteMatcher

    A route matcher on a boolean condition.

    A route matcher on a boolean condition. Does not extract any route parameters.

  6. type ContentTypeInferrer = PartialFunction[Any, String]

  7. trait Control extends AnyRef

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

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

  9. trait CookieContext extends AnyRef

  10. case class CookieOptions(domain: String = "", path: String = "", maxAge: Int = 1, secure: Boolean = false, comment: String = "", httpOnly: Boolean = false, version: Int = 0, encoding: String = "UTF-8") 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

  13. type CoreStackNoFlash = CorsSupport with FutureSupport

  14. type CoreStackNoFlashWithCsrf = CoreStackNoFlash with CsrfTokenSupport

  15. type CoreStackNoFlashWithXsrf = CoreStackNoFlash with XsrfTokenSupport

  16. type CoreStackWithCsrf = CoreStack with CsrfTokenSupport

  17. type CoreStackWithXsrf = CoreStack with XsrfTokenSupport

  18. trait CorsSupport extends Handler with Initializable

  19. trait CsrfTokenSupport extends AnyRef

    Provides cross-site request forgery protection.

    Provides cross-site request forgery protection.

    Adds a before filter. If a request is determined to be forged, the handleForgery() hook is invoked. Otherwise, a token for the next request is prepared with prepareCsrfToken.

  20. trait DefaultValue[Z] extends AnyRef

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

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

    Annotations
    @implicitNotFound( ... )
  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.

    The Scalatra DSL requires a dynamically scoped request and response. This trick is explained in greater detail in Gabriele Renzi's blog post about Step, out of which Scalatra grew:

    http://www.riffraff.info/2009/4/11/step-a-scala-web-picoframework

  25. type ErrorHandler = PartialFunction[Throwable, Any]

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

  27. type FileUploadStack = FutureSupport with FlashMapSupport with FileUploadSupport

  28. class FlashMap extends MutableMapWithIndifferentAccess[Any] with Serializable

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

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

    FlashMap behaves like org.scalatra.util.MapWithIndifferentAccess. By default, anything placed in the map is available to the current request and next request, and is then discarded.

    See also

    FlashMapSupport

  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.

    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. This is especially useful when using the POST-REDIRECT-GET pattern to trace the result of an operation.

    post("/article/create") {
      // create session
      flash("notice") = "article created succesfully"
      redirect("/home")
    }
    get("/home") {
      // this will access the value set in previous action
      stuff_with(flash("notice"))
    }
    See also

    FlashMap

  30. type FullCoreStack = CoreStack with FileUploadSupport

  31. trait FutureSupport extends AsyncSupport

  32. type FuturesAndFlashStack = FutureSupport with FlashMapSupport

  33. type FuturesAndFlashStackWithCsrf = FuturesAndFlashStack with CsrfTokenSupport

  34. type FuturesAndFlashStackWithXsrf = FuturesAndFlashStack with XsrfTokenSupport

  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.

    Trait representing an object that can't be fully initialized by its constructor. Useful for unifying the initialization process of an HttpServlet and a Filter.

  40. trait LifeCycle extends ServletApiImplicits

  41. case class MatchedRoute(action: Action, 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.

    Mixin for clients that only support a limited set of HTTP verbs. If the request is a POST and the _method request parameter is set, the value of the _method parameter is treated as the request's method.

  43. type MultiParams = MultiMap

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

  45. case class PathPattern(regex: Regex, captureGroupNames: List[String] = Nil) 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.

    A route matcher for regular expressions. Useful for cases that are more complex than are supported by Sinatra- or Rails-style routes.

  52. type RenderPipeline = PartialFunction[Any, Any]

  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] = Seq.empty, action: Action, contextPath: (HttpServletRequest) ⇒ String = _ => "", metadata: Map[Symbol, Any] = Map.empty) extends Product with Serializable

    A route is a set of matchers and an action.

    A route is a set of matchers and an action. A route is considered to match if all of its route matchers return Some. If a route matches, its action may be invoked. The route parameters extracted by the matchers are made available to the action.

  57. trait RouteMatcher extends RouteTransformer

    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. trait RouteTransformer extends AnyRef

  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.

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

  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.

    An implementation of the Scalatra DSL in a filter. You may prefer a filter to a ScalatraServlet if:

    $ - you are sharing a URL space with another servlet or filter and want to delegate unmatched requests. This is very useful when migrating legacy applications one page or resource at a time.

    Unlike a ScalatraServlet, does not send 404 or 405 errors on non-matching routes. Instead, it delegates to the filter chain.

    If in doubt, extend ScalatraServlet instead.

    See also

    ScalatraServlet

  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.

    An implementation of the Scalatra DSL in a servlet. This is the recommended base class for most Scalatra applications. Use a servlet if:

    $ - your Scalatra routes run in a subcontext of your web application. $ - you want Scalatra to have complete control of unmatched requests. $ - you think you want a filter just for serving static content with the default servlet; ScalatraServlet can do this too $ - you don't know the difference

    See also

    ScalatraFilter

  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

    Annotations
    @deprecated
    Deprecated

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

  77. trait GetResponseStatusSupport extends AnyRef

    Annotations
    @deprecated
    Deprecated

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

  78. type ScalatraKernel = ServletBase

    Annotations
    @deprecated
    Deprecated

    (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

    Annotations
    @deprecated
    Deprecated

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

    Provides utility methods for the creation of URL strings. Supports context-relative and session-aware URLs. Should behave similarly to JSTL's <c:url> tag.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This functionality has been subsumed by ScalatraBase.

Value Members

  1. object Accepted

  2. object AlreadyReported

  3. object ApiFormats

  4. object BadGateway

  5. object BadRequest

  6. object Conflict

  7. object Connect extends HttpMethod with Product with Serializable

  8. object Cookie extends Serializable

  9. object CookieSupport

  10. object CorsSupport

  11. object Created

  12. object CsrfTokenSupport

  13. object DefaultValueMethods extends DefaultValueMethods

  14. object DefaultValues extends DefaultValues

  15. object Delete extends HttpMethod with Product with Serializable

  16. val EnvironmentKey: String

  17. object ExpectationFailed

  18. object FailedDependency

  19. object FlashMapSupport

  20. object Forbidden

  21. object Found

  22. object GatewayTimeout

  23. object GenerateId

  24. object Get extends HttpMethod with Product with Serializable

  25. object Gone

  26. object HTTPVersionNotSupported

  27. object Head extends HttpMethod with Product with Serializable

  28. object Http extends Scheme with Product with Serializable

  29. object Http10 extends HttpVersion

  30. object Http11 extends HttpVersion

  31. object HttpMethod

  32. object Https extends Scheme with Product with Serializable

  33. object IMUsed

  34. object InsufficientStorage

  35. object InternalServerError

  36. object LengthRequired

  37. object Locked

  38. object LoopDetected

  39. object MethodNotAllowed

  40. object MethodOverride

  41. object MovedPermanently

  42. val MultiParamsKey: String

  43. object MultiStatus

  44. object MultipleChoices

  45. object NetworkAuthenticationRequired

  46. object NoContent

  47. object NonAuthoritativeInformation

  48. object NotAcceptable

  49. object NotExtended

  50. object NotFound

  51. object NotImplemented

  52. object NotModified

  53. object Ok

  54. object Options extends HttpMethod with Product with Serializable

  55. object PartialContent

  56. object Patch extends HttpMethod with Product with Serializable

  57. object PathPatternParser

  58. object PaymentRequired

  59. object PermanentRedirect

  60. object Post extends HttpMethod with Product with Serializable

  61. object PreconditionFailed

  62. object PreconditionRequired

  63. object ProxyAuthenticationRequired

  64. object Put extends HttpMethod with Product with Serializable

  65. object RailsPathPatternParser

  66. object RequestEntityTooLarge

  67. object RequestHeaderFieldsTooLarge

  68. object RequestTimeout

  69. object RequestURITooLong

  70. object RequestedRangeNotSatisfiable

  71. object ResetContent

  72. object ResponseStatus extends Serializable

  73. object Route extends Serializable

  74. object RouteTransformer

  75. object ScalatraBase

  76. object ScalatraContext

  77. object ScalatraKernel

  78. object ScalatraParamsImplicits extends ScalatraParamsImplicits with DefaultImplicitConversions

  79. object ScalatraServlet extends Serializable

  80. object SeeOther

  81. object ServiceUnavailable

  82. object SinatraPathPatternParser

  83. object TemporaryRedirect

  84. object TooManyRequests

  85. object Trace extends HttpMethod with Product with Serializable

  86. object Unauthorized

  87. object UnprocessableEntity

  88. object UnsupportedMediaType

  89. object UpgradeRequired

  90. object UriDecoder

  91. object UrlGenerator extends UrlGeneratorSupport

  92. object UseProxy

  93. object VariantAlsoNegotiates

  94. object XsrfTokenSupport

  95. package akka

  96. package atmosphere

  97. package auth

  98. package commands

  99. package fileupload

  100. def halt(result: ActionResult): Nothing

    Definition Classes
    Control
  101. def halt[T](status: Integer = null, body: T = (), headers: Map[String, String] = Map.empty, reason: String = null)(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.

    status

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

    body

    a result to render through the render pipeline as the body

    headers

    headers to add to the response

    reason

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

    Definition Classes
    Control
  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
    Control
  106. package scalate

  107. package servlet

  108. package slf4j

  109. package spring

  110. package swagger

  111. package test

  112. package util

  113. package validation

Inherited from Control

Inherited from AnyRef

Inherited from Any

Ungrouped