Packages

t

org.scalatra

ScalatraServlet

trait ScalatraServlet extends HttpServlet with ServletBase with Initializable

An implementation of the Scalatra DSL in a servlet. This is the recommended base trait 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

Linear Supertypes
ServletBase, ScalatraBase, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, HttpServlet, GenericServlet, Serializable, ServletConfig, Servlet, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalatraServlet
  2. ServletBase
  3. ScalatraBase
  4. DefaultImplicitConversions
  5. LowPriorityImplicitConversions
  6. LowestPriorityImplicitConversions
  7. TypeConverterSupport
  8. ScalatraParamsImplicits
  9. Initializable
  10. DynamicScope
  11. RequestResponseScope
  12. CoreDsl
  13. Control
  14. Handler
  15. ScalatraContext
  16. CookieContext
  17. SessionSupport
  18. ServletApiImplicits
  19. HttpServlet
  20. GenericServlet
  21. Serializable
  22. ServletConfig
  23. Servlet
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. type ConfigT = ServletConfig
    Definition Classes
    ScalatraServlet → ServletBase → Initializable

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. val RequestPathKey: String

    Defines the request path to be matched by routers.

    Defines the request path to be matched by routers. The default definition is optimized for path mapped servlets (i.e., servlet mapping ends in /*). The route should match everything matched by the /*. In the event that the request URI equals the servlet path with no trailing slash (e.g., mapping = /admin/*, request URI = '/admin'), a '/' is returned.

    All other servlet mappings likely want to return request.getServletPath. Custom implementations are allowed for unusual cases.

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

  6. def addSessionId(uri: String)(implicit response: HttpServletResponse): String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  7. def addStatusRoute(codes: Range, action: => Any): Unit
    Attributes
    protected[scalatra]
    Definition Classes
    ScalatraBase
  8. 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
    ScalatraBase → CoreDsl
  9. implicit val anyToBoolean: TypeConverter[Any, Boolean]
    Definition Classes
    LowPriorityImplicitConversions
  10. implicit val anyToByte: TypeConverter[Any, Byte]
    Definition Classes
    LowPriorityImplicitConversions
  11. implicit val anyToDouble: TypeConverter[Any, Double]
    Definition Classes
    LowPriorityImplicitConversions
  12. implicit val anyToFloat: TypeConverter[Any, Float]
    Definition Classes
    LowPriorityImplicitConversions
  13. implicit val anyToInt: TypeConverter[Any, Int]
    Definition Classes
    LowPriorityImplicitConversions
  14. implicit val anyToLong: TypeConverter[Any, Long]
    Definition Classes
    LowPriorityImplicitConversions
  15. implicit val anyToShort: TypeConverter[Any, Short]
    Definition Classes
    LowPriorityImplicitConversions
  16. implicit val anyToString: TypeConverter[Any, String]
    Definition Classes
    LowPriorityImplicitConversions
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. 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
    ScalatraBase → CoreDsl
  19. 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

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

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

    Definition Classes
    ScalatraBase
  22. implicit def configWrapper(config: ConfigT): Config
    Attributes
    protected
    Definition Classes
    ServletBase → Initializable
  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 decodePercentEncodedPath: Boolean

    Set whether to decode when the path returned by the requestPath method is Percent-Eoconding.

    Set whether to decode when the path returned by the requestPath method is Percent-Eoconding. Default is decode (true).

    Attributes
    protected
    Definition Classes
    ScalatraBase
  30. val defaultCharacterEncoding: String

    The default character encoding for requests and responses.

    The default character encoding for requests and responses.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  31. implicit def defaultStringToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  32. def delete(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    get

  33. def destroy(): Unit
    Definition Classes
    ScalatraServlet → GenericServlet → Servlet
  34. def doDelete(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  35. def doGet(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  36. def doHead(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  37. 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
  38. val doNotFound: Action

    Invoked when no route matches.

    Invoked when no route matches. By default, calls serveStaticResource(), and if that fails, calls resourceNotFound().

    This action can be overridden by a notFound block.

    Attributes
    protected
    Definition Classes
    ScalatraServlet → ScalatraBase
  39. def doOptions(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  40. def doPost(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  41. def doPut(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  42. def doTrace(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  43. implicit def enrichRequest(request: HttpServletRequest): RichRequest
    Definition Classes
    ServletApiImplicits
  44. implicit def enrichResponse(response: HttpServletResponse): RichResponse
    Definition Classes
    ServletApiImplicits
  45. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext
    Definition Classes
    ServletApiImplicits
  46. implicit def enrichSession(session: HttpSession): RichSession
    Definition Classes
    ServletApiImplicits
  47. def environment: String
    Definition Classes
    ScalatraBase
  48. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  50. 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
    ScalatraBase → CoreDsl
  51. 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
  52. 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
  53. def extractStatusCode(e: HaltException): Int
    Attributes
    protected
    Definition Classes
    ScalatraBase
  54. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  55. 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
  56. 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
  57. 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
  58. 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
    ScalatraBase → CoreDsl
  59. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  60. def getInitParameter(arg0: String): String
    Definition Classes
    GenericServlet → ServletConfig
  61. def getInitParameterNames(): Enumeration[String]
    Definition Classes
    GenericServlet → ServletConfig
  62. def getLastModified(arg0: HttpServletRequest): Long
    Attributes
    protected[http]
    Definition Classes
    HttpServlet
  63. def getServletConfig(): ServletConfig
    Definition Classes
    GenericServlet → Servlet
  64. def getServletContext(): ServletContext
    Definition Classes
    GenericServlet → ServletConfig
  65. def getServletInfo(): String
    Definition Classes
    GenericServlet → Servlet
  66. def getServletName(): String
    Definition Classes
    GenericServlet → ServletConfig
  67. def halt(result: ActionResult): Nothing
    Definition Classes
    Control
  68. def halt[T](status: Integer = null, body: T = (), headers: Map[String, String] = Map.empty): 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

    Definition Classes
    Control
  69. def handle(request: HttpServletRequest, response: 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
    ServletBase → ScalatraBase → Handler
  70. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  71. def head(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    head

  72. def init(config: ServletConfig): Unit
    Definition Classes
    ScalatraServlet → GenericServlet → Servlet
  73. def init(): Unit
    Definition Classes
    GenericServlet
    Annotations
    @throws(classOf[javax.servlet.ServletException])
  74. 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
  75. def initialize(config: ServletConfig): Unit

    Initializes the kernel.

    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.

    config

    the configuration.

    Definition Classes
    ScalatraServlet → ScalatraBase → Initializable
  76. 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
  77. def isAsyncExecutable(result: Any): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  78. 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
  79. def isHttps(implicit request: HttpServletRequest): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  80. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  81. def log(arg0: String, arg1: Throwable): Unit
    Definition Classes
    GenericServlet
  82. def log(arg0: String): Unit
    Definition Classes
    GenericServlet
  83. implicit def lowestPriorityAny2T[T](implicit arg0: ClassTag[T]): TypeConverter[Any, T]
    Definition Classes
    LowestPriorityImplicitConversions
  84. 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
    ScalatraBase → CoreDsl
  85. 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
  86. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]
    Definition Classes
    ScalatraBase
  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. def needsHttps: Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  89. 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
    ScalatraBase → CoreDsl
  90. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  91. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  92. def options(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    get

  93. def params(implicit request: HttpServletRequest): Params
    Definition Classes
    ScalatraBase
  94. def params(key: String)(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  95. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

    Definition Classes
    Control
  96. def patch(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    patch

  97. 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
  98. def post(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    get

  99. def put(transformers: RouteTransformer*)(action: => Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
    See also

    get

  100. 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
  101. 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

  102. 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
  103. def removeRoute(method: String, route: Route): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  104. 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

  105. def renderHaltException(e: HaltException): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  106. 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
  107. 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
  108. 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

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

    The currently scoped request.

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

    Definition Classes
    DynamicScope → RequestResponseScope
  111. def requestPath(uri: String, idx: Int): String
  112. 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
    ScalatraServlet → ScalatraBase
  113. def resourceNotFound()(implicit request: HttpServletRequest, response: HttpServletResponse): Any

    Called by default notFound if no routes matched and no static resource could be found.

    Called by default notFound if no routes matched and no static resource could be found.

    Attributes
    protected
  114. implicit def response: HttpServletResponse

    The currently scoped response.

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

    Definition Classes
    DynamicScope → RequestResponseScope
  115. def routeBasePath(implicit request: HttpServletRequest): String

    The base path for URL generation

    The base path for URL generation

    Attributes
    protected
    Definition Classes
    ScalatraServlet → ScalatraBase
  116. lazy val routes: RouteRegistry

    The routes registered in this kernel.

    The routes registered in this kernel.

    Definition Classes
    ScalatraBase
  117. def runFilters(filters: Iterable[Route]): Unit

    Invokes each filters with invoke.

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  118. def runRoutes(routes: Iterable[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
  119. implicit def safe[S, T](f: (S) => T): TypeConverter[S, T]
    Definition Classes
    TypeConverterSupport
  120. 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
  121. implicit def scalatraContext: ScalatraContext
    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  122. implicit def seqHead[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], T]
    Definition Classes
    DefaultImplicitConversions
  123. implicit def seqToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  124. def serveStaticResource()(implicit request: HttpServletRequest, response: HttpServletResponse): Option[Any]

    Attempts to find a static resource matching the request path.

    Attempts to find a static resource matching the request path. Override to return None to stop this.

    Attributes
    protected
  125. def serverHost(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  126. def serverPort(implicit request: HttpServletRequest): Int
    Definition Classes
    ScalatraBase
  127. def service(request: HttpServletRequest, response: HttpServletResponse): Unit
    Definition Classes
    ScalatraServlet → HttpServlet
  128. def service(arg0: ServletRequest, arg1: ServletResponse): Unit
    Definition Classes
    HttpServlet → GenericServlet → Servlet
    Annotations
    @throws(classOf[javax.servlet.ServletException]) @throws(classOf[java.io.IOException])
  129. def servletContext: ServletContext

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ScalatraBase → ScalatraContext
  130. def session(key: String)(implicit request: HttpServletRequest): Any
    Definition Classes
    SessionSupport
  131. implicit def session(implicit request: HttpServletRequest): HttpSession

    The current session.

    The current session. Creates a session if none exists.

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

    The current session.

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

    Definition Classes
    SessionSupport
  133. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  134. def shutdown(): Unit
    Attributes
    protected
    Definition Classes
    Initializable
  135. def status: Int

    Gets the status code of the current response.

    Gets the status code of the current response.

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

    Sets the status code of the current response.

    Sets the status code of the current response.

    Definition Classes
    ScalatraContext
  137. 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
  138. implicit val stringToBoolean: TypeConverter[String, Boolean]
    Definition Classes
    DefaultImplicitConversions
  139. implicit val stringToByte: TypeConverter[String, Byte]
    Definition Classes
    DefaultImplicitConversions
  140. def stringToDate(format: => String): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  141. def stringToDateFormat(format: => DateFormat): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  142. implicit val stringToDouble: TypeConverter[String, Double]
    Definition Classes
    DefaultImplicitConversions
  143. implicit val stringToFloat: TypeConverter[String, Float]
    Definition Classes
    DefaultImplicitConversions
  144. implicit val stringToInt: TypeConverter[String, Int]
    Definition Classes
    DefaultImplicitConversions
  145. implicit val stringToLong: TypeConverter[String, Long]
    Definition Classes
    DefaultImplicitConversions
  146. implicit val stringToSelf: TypeConverter[String, String]
    Definition Classes
    DefaultImplicitConversions
  147. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String = ",")(implicit arg0: ClassTag[T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  148. implicit val stringToShort: TypeConverter[String, Short]
    Definition Classes
    DefaultImplicitConversions
  149. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  150. def toString(): String
    Definition Classes
    AnyRef → Any
  151. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams
    Definition Classes
    ScalatraParamsImplicits
  152. implicit def toTypedParams(params: Params): TypedParams
    Definition Classes
    ScalatraParamsImplicits
  153. 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
    ScalatraBase → CoreDsl
  154. def trap(code: Int)(block: => Any): Unit

    Definition Classes
    CoreDsl
    See also

    error

  155. 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
  156. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  157. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  158. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  159. 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
    DynamicScope → RequestResponseScope
  160. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: => A): A
    Attributes
    protected[scalatra]
    Definition Classes
    DynamicScope → RequestResponseScope
  161. 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
    DynamicScope → RequestResponseScope
  162. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: => S)(implicit request: HttpServletRequest): S
    Attributes
    protected[scalatra]
    Definition Classes
    ScalatraBase

Inherited from ServletBase

Inherited from ScalatraBase

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

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 HttpServlet

Inherited from GenericServlet

Inherited from Serializable

Inherited from ServletConfig

Inherited from Servlet

Inherited from AnyRef

Inherited from Any

Ungrouped