trait FileUploadSupport extends ServletBase with HasMultipartConfig

FileUploadSupport can be mixed into a org.scalatra.ScalatraFilter or org.scalatra.ScalatraServlet to provide easy access to data submitted as part of a multipart HTTP request. Commonly this is used for retrieving uploaded files.

Once the trait has been mixed into your handler, you need to enable multipart configuration in your web.xml or by using @MultipartConfig annotation. To configure in web.xml add <multipart-config /> to your <servlet> element. If you prefer annotations instead, place @MultipartConfig to your handler. Both ways provide some further configuration options, such as specifying the max total request size and max size for invidual files in the request. You might want to set these to prevent users from uploading too large files.

When the configuration has been done, you can access any files using fileParams("myFile") where myFile is the name of the parameter used to upload the file being retrieved. If you are expecting multiple files with the same name, you can use fileMultiParams("files[]") to access them all.

To handle any errors that are caused by multipart handling, you need to configure an error handler to your handler class:

import org.scalatra.servlet.SizeLimitExceededException
import org.scalatra.servlet.FileUploadSupport

@MultipartConfig(maxFileSize=1024*1024)
class FileEaterServlet extends ScalatraServlet with FileUploadSupport {
  error {
    case e: SizeConstrainttExceededException => "Oh, too much! Can't take it all."
    case e: IOException                      => "Server denied me my meal, thanks anyway."
  }

  post("/eatfile") {
    "Thanks! You just provided me " + fileParams("lunch").size + " bytes for a lunch."
  }
}

}}* @note Once any handler with FileUploadSupport has accessed the request, the fileParams returned by FileUploadSupport will remain fixed for the lifetime of the request.

Note

Will not work on Jetty versions prior to 8.1.3. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=376324. The old scalatra-fileupload module still works for earlier versions of Jetty.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileUploadSupport
  2. HasMultipartConfig
  3. ServletBase
  4. ScalatraBase
  5. DefaultImplicitConversions
  6. LowPriorityImplicitConversions
  7. LowestPriorityImplicitConversions
  8. TypeConverterSupport
  9. ScalatraParamsImplicits
  10. Initializable
  11. DynamicScope
  12. RequestResponseScope
  13. CoreDsl
  14. Control
  15. Handler
  16. ScalatraContext
  17. CookieContext
  18. SessionSupport
  19. ServletApiImplicits
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. sealed class TypedMultiParams extends AnyRef
    Definition Classes
    ScalatraParamsImplicits
  3. sealed class TypedParams extends AnyRef
    Definition Classes
    ScalatraParamsImplicits
  4. abstract type ConfigT <: AnyRef { ... /* 3 definitions in type refinement */ }
    Definition Classes
    ServletBaseInitializable

Abstract Value Members

  1. abstract val doNotFound: Action

    Called if no route matches the current request for any method.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  2. abstract def requestPath(implicit request: HttpServletRequest): String

    The effective path against which routes are matched.

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

    Definition Classes
    ScalatraBase
  3. abstract def routeBasePath(implicit request: HttpServletRequest): String

    The base path for URL generation

    The base path for URL generation

    Attributes
    protected
    Definition Classes
    ScalatraBase

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addRoute(method: HttpMethod, transformers: Seq[RouteTransformer], action: ⇒ Any): Route

    Prepends a new route for the given HTTP method.

    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.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.ScalatraKernel#removeRoute

  5. def addSessionId(uri: String)(implicit response: HttpServletResponse): String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  6. def addStatusRoute(codes: Range, action: ⇒ Any): Unit
    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase
  7. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Adds a filter to run after the route.

    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.

    Definition Classes
    ScalatraBaseCoreDsl
  8. implicit val anyToBoolean: TypeConverter[Any, Boolean]
  9. implicit val anyToByte: TypeConverter[Any, Byte]
  10. implicit val anyToDouble: TypeConverter[Any, Double]
  11. implicit val anyToFloat: TypeConverter[Any, Float]
  12. implicit val anyToInt: TypeConverter[Any, Int]
  13. implicit val anyToLong: TypeConverter[Any, Long]
  14. implicit val anyToShort: TypeConverter[Any, Short]
  15. implicit val anyToString: TypeConverter[Any, String]
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Adds a filter to run before the route.

    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.

    Definition Classes
    ScalatraBaseCoreDsl
  18. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Converts a boolean expression to a route matcher.

    Converts a boolean expression to a route matcher.

    block

    a block that evaluates to a boolean

    returns

    a route matcher based on block. The route matcher should return Some if the block is true and None if the block is false.

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.BooleanBlockRouteMatcher

  19. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. val config: ConfigT

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

    Definition Classes
    ScalatraBase
  21. implicit def configWrapper(config: ConfigT): Config { object initParameters }
    Attributes
    protected
    Definition Classes
    ServletBaseInitializable
  22. def configureMultipartHandling(config: MultipartConfig): Unit
    Definition Classes
    HasMultipartConfig
  23. def contentType: String

    Gets the content type of the current response.

    Gets the content type of the current response.

    Definition Classes
    ScalatraContext
  24. def contentTypeInferrer: ContentTypeInferrer

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

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

    returns

    $ - "text/plain" for String $ - "application/octet-stream" for a byte array $ - "text/html" for any other result

    Attributes
    protected
    Definition Classes
    ScalatraBase
  25. def contentType_=(contentType: String): Unit

    Sets the content type of the current response.

    Sets the content type of the current response.

    Definition Classes
    ScalatraContext
  26. def contextPath: String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  27. implicit def cookieOptions: CookieOptions
    Definition Classes
    CookieContext
  28. def cookies(implicit request: HttpServletRequest): SweetCookies
    Definition Classes
    CookieContext
  29. val defaultCharacterEncoding: String

    The default character encoding for requests and responses.

    The default character encoding for requests and responses.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  30. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  31. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  32. val doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Called if no route matches the current request method, but routes match for other methods.

    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.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  33. implicit def enrichRequest(request: HttpServletRequest): RichRequest
    Definition Classes
    ServletApiImplicits
  34. implicit def enrichResponse(response: HttpServletResponse): RichResponse
    Definition Classes
    ServletApiImplicits
  35. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext
    Definition Classes
    ServletApiImplicits
  36. implicit def enrichSession(session: HttpSession): RichSession
    Definition Classes
    ServletApiImplicits
  37. def environment: String
    Definition Classes
    ScalatraBase
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  40. def error(handler: ErrorHandler): Unit

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

    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.

    Definition Classes
    ScalatraBaseCoreDsl
  41. val errorHandler: ErrorHandler

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  42. def executeRoutes(): Unit

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

    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.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  43. def extractStatusCode(e: HaltException): Int
    Attributes
    protected
    Definition Classes
    ScalatraBase
  44. def fileMultiParams(key: String)(implicit request: HttpServletRequest): Seq[FileItem]
  45. def fileMultiParams(implicit request: HttpServletRequest): FileMultiParams
  46. def fileParams(key: String)(implicit request: HttpServletRequest): FileItem
  47. def fileParams(implicit request: HttpServletRequest): MultiMapHeadView[String, FileItem]

    returns

    a Map, keyed on the names of multipart file upload parameters, of all multipart files submitted with the request

  48. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  49. def format_=(formatValue: String): Unit

    Explicitly sets the request-scoped format.

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

    Definition Classes
    ScalatraContext
  50. def format_=(formatValue: Symbol): Unit

    Explicitly sets the request-scoped format.

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

    Definition Classes
    ScalatraContext
  51. def fullUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, withSessionId: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Builds a full URL from the given relative path.

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

    path

    a relative path

    returns

    the full URL

    Definition Classes
    ScalatraBase
  52. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route

    The Scalatra DSL core methods take a list of org.scalatra.RouteMatcher and a block as the action body.

    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!" }
    Definition Classes
    ScalatraBaseCoreDsl
  53. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  54. def halt(result: ActionResult): Nothing
    Definition Classes
    Control
  55. 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
  56. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

    Handles a request and renders a response.

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

    Definition Classes
    FileUploadSupportServletBaseScalatraBaseHandler
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  58. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    head

  59. def initParameter(name: String): Option[String]

    Gets an init paramter from the config.

    Gets an init paramter from the config.

    name

    the name of the key

    returns

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

    Definition Classes
    ScalatraBase
  60. def initialize(config: ConfigT): Unit

    A hook to initialize the class with some configuration after it has been constructed.

    A hook to initialize the class with some configuration after it has been constructed.

    Not called init because GenericServlet doesn't override it, and then we get into https://lampsvn.epfl.ch/trac/scala/ticket/2497.

    Definition Classes
    HasMultipartConfigInitializable
  61. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Invokes a route or filter.

    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.

    matchedRoute

    the matched route to execute

    returns

    the result of the matched route's action wrapped in Some, or None if the action calls pass.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  62. def isAsyncExecutable(result: Any): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  63. def isDevelopmentMode: Boolean

    A boolean flag representing whether the kernel is in development mode.

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

    Definition Classes
    ScalatraBase
  64. def isHttps(implicit request: HttpServletRequest): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  65. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  66. def isSizeConstraintException(e: Exception): Boolean
    Attributes
    protected
  67. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]
  68. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Defines a block to run if matching routes are found only for other methods.

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

    Definition Classes
    ScalatraBaseCoreDsl
  69. def multiParams(implicit request: HttpServletRequest): MultiParams

    The current multiparams.

    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.

    Definition Classes
    ScalatraBase
  70. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]
    Definition Classes
    ScalatraBase
  71. def multipartConfig: MultipartConfig
    Definition Classes
    HasMultipartConfig
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. def needsHttps: Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  74. def notFound(fun: ⇒ Any): Unit

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

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

    Definition Classes
    ScalatraBaseCoreDsl
  75. final def notify(): Unit
    Definition Classes
    AnyRef
  76. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  77. def options(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  78. def params(implicit request: HttpServletRequest): Params
    Definition Classes
    ScalatraBase
  79. def params(key: Symbol)(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  80. def params(key: String)(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  81. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

    Definition Classes
    Control
  82. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    patch

  83. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Path pattern is decoupled from requests.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  84. def post(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  85. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  86. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Sends a redirect response and immediately halts the current action.

    Sends a redirect response and immediately halts the current action.

    Definition Classes
    ScalatraBase
  87. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Converts a regular expression to a route matcher.

    Converts a regular expression to a route matcher.

    regex

    the regular expression

    returns

    a route matcher based on regex

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.RegexRouteMatcher

  88. def relativeUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String
    Definition Classes
    ScalatraBase
  89. def removeRoute(method: String, route: Route): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  90. def removeRoute(method: HttpMethod, route: Route): Unit

    Removes _all_ the actions of a given route for a given HTTP method.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    org.scalatra.ScalatraKernel#addRoute

  91. def renderHaltException(e: HaltException): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  92. def renderPipeline: RenderPipeline

    The render pipeline is a partial function of Any => Any.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  93. def renderResponse(actionResult: Any): Unit

    Renders the action result to the response.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  94. def renderResponseBody(actionResult: Any): Unit

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
    See also

    #renderPipeline

  95. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  96. implicit def request: HttpServletRequest

    The currently scoped request.

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

    Definition Classes
    DynamicScopeRequestResponseScope
  97. implicit def response: HttpServletResponse

    The currently scoped response.

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

    Definition Classes
    DynamicScopeRequestResponseScope
  98. lazy val routes: RouteRegistry

    The routes registered in this kernel.

    The routes registered in this kernel.

    Definition Classes
    ScalatraBase
  99. def runFilters(filters: Traversable[Route]): Unit

    Invokes each filters with invoke.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  100. def runRoutes(routes: Traversable[Route]): Stream[Any]

    Lazily invokes routes with invoke.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  101. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]
    Definition Classes
    TypeConverterSupport
  102. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

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

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

    Definition Classes
    TypeConverterSupport
  103. implicit def scalatraContext: ScalatraContext
    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  104. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]
    Definition Classes
    DefaultImplicitConversions
  105. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  106. def serverHost(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  107. def serverPort(implicit request: HttpServletRequest): Int
    Definition Classes
    ScalatraBase
  108. def servletContext: ServletContext

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ScalatraBaseScalatraContext
  109. def session(key: Symbol)(implicit request: HttpServletRequest): Any
    Definition Classes
    SessionSupport
  110. def session(key: String)(implicit request: HttpServletRequest): Any
    Definition Classes
    SessionSupport
  111. implicit def session(implicit request: HttpServletRequest): HttpSession

    The current session.

    The current session. Creates a session if none exists.

    Definition Classes
    SessionSupport
  112. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    The current session.

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

    Definition Classes
    SessionSupport
  113. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  114. def shutdown(): Unit

    A hook to shutdown the class.

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

    Attributes
    protected
    Definition Classes
    Initializable
  115. def status: Int

    Gets the status code of the current response.

    Gets the status code of the current response.

    Definition Classes
    ScalatraContext
  116. def status_=(code: Int): Unit

    Sets the status code of the current response.

    Sets the status code of the current response.

    Definition Classes
    ScalatraContext
  117. implicit def string2RouteMatcher(path: String): RouteMatcher

    Pluggable way to convert a path expression to a route matcher.

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

    path

    a path expression

    returns

    a route matcher based on path

    Attributes
    protected
    Definition Classes
    ScalatraBase
  118. implicit val stringToBoolean: TypeConverter[String, Boolean]
    Definition Classes
    DefaultImplicitConversions
  119. implicit val stringToByte: TypeConverter[String, Byte]
    Definition Classes
    DefaultImplicitConversions
  120. def stringToDate(format: ⇒ String): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  121. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  122. implicit val stringToDouble: TypeConverter[String, Double]
    Definition Classes
    DefaultImplicitConversions
  123. implicit val stringToFloat: TypeConverter[String, Float]
    Definition Classes
    DefaultImplicitConversions
  124. implicit val stringToInt: TypeConverter[String, Int]
    Definition Classes
    DefaultImplicitConversions
  125. implicit val stringToLong: TypeConverter[String, Long]
    Definition Classes
    DefaultImplicitConversions
  126. implicit val stringToSelf: TypeConverter[String, String]
    Definition Classes
    DefaultImplicitConversions
  127. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String = ",")(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  128. implicit val stringToShort: TypeConverter[String, Short]
    Definition Classes
    DefaultImplicitConversions
  129. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  130. def toString(): String
    Definition Classes
    AnyRef → Any
  131. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams
    Definition Classes
    ScalatraParamsImplicits
  132. implicit def toTypedParams(params: Params): TypedParams
    Definition Classes
    ScalatraParamsImplicits
  133. def trap(codes: Range)(block: ⇒ Any): Unit

    Error handler for HTTP response status code range.

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

    }}

    Definition Classes
    ScalatraBaseCoreDsl
  134. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    See also

    error

  135. def url(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, absolutize: Boolean = true, withSessionId: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Returns a context-relative, session-aware URL for a path and specified parameters.

    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.

    path

    the base path. If a path begins with '/', then the context path will be prepended to the result

    params

    params, to be appended in the form of a query string

    returns

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

    Definition Classes
    ScalatraBase
  136. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  139. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

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

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

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  140. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A
    Attributes
    protected[org.scalatra]
    Definition Classes
    DynamicScopeRequestResponseScope
  141. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

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

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

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  142. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S)(implicit request: HttpServletRequest): S
    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

Deprecated Value Members

  1. def _request: DynamicVariable[HttpServletRequest]
    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withRequest to change the binding, or request to get the value

  2. def _response: DynamicVariable[HttpServletResponse]
    Attributes
    protected
    Definition Classes
    DynamicScope
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Do not invoke directly. Use withResponse to change the binding, or response to get the value

  3. def applicationContext: ServletContext
    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def status(code: Int): Unit
    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use status_=(Int) instead

Inherited from HasMultipartConfig

Inherited from ServletBase

Inherited from ScalatraBase

Inherited from TypeConverterSupport

Inherited from ScalatraParamsImplicits

Inherited from Initializable

Inherited from DynamicScope

Inherited from RequestResponseScope

Inherited from CoreDsl

Inherited from Control

Inherited from Handler

Inherited from ScalatraContext

Inherited from CookieContext

Inherited from SessionSupport

Inherited from ServletApiImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped