org.scalatra.scalate

ScalateSupport

trait ScalateSupport extends ServletBase

ScalateSupport creates and configures a template engine and provides helper methods and bindings to integrate with the ScalatraKernel.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ScalateSupport
  2. ServletBase
  3. ScalatraBase
  4. CookieSupport
  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
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

  2. abstract type ConfigT <: AnyRef { ... /* 3 definitions in type refinement */ }

    Definition Classes
    ServletBaseInitializable
  3. trait ScalatraTemplateEngine extends AnyRef

    A TemplateEngine integrated with Scalatra.

  4. sealed class TypedMultiParams extends AnyRef

  5. sealed class TypedParams extends AnyRef

Abstract Value Members

  1. abstract val doNotFound: () ⇒ Any

    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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], 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

  7. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  8. def addStatusRoute(codes: Range, action: ⇒ Any): Unit

    Attributes
    protected[scalatra]
    Definition Classes
    ScalatraBase
  9. def after(transformers: (Route) ⇒ Route*)(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
  10. implicit val anyToBoolean: TypeConverter[Any, Boolean]

  11. implicit val anyToByte: TypeConverter[Any, Byte]

  12. implicit val anyToDouble: TypeConverter[Any, Double]

  13. implicit val anyToFloat: TypeConverter[Any, Float]

  14. implicit val anyToInt: TypeConverter[Any, Int]

  15. implicit val anyToLong: TypeConverter[Any, Long]

  16. implicit val anyToShort: TypeConverter[Any, Short]

  17. implicit val anyToString: TypeConverter[Any, String]

  18. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  19. def before(transformers: (Route) ⇒ Route*)(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
  20. 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

    BooleanBlockRouteMatcher

  21. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  22. var config: ConfigT

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

    Definition Classes
    ScalatraBase
  23. implicit def configWrapper(config: ConfigT): Config { final object initParameters extends object this.initParameters }

    Attributes
    protected
    Definition Classes
    ServletBaseInitializable
  24. def contentType: String

    Gets the content type of the current response.

    Gets the content type of the current response.

    Definition Classes
    ScalatraContext
  25. 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.

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

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

    Sets the content type of the current response.

    Sets the content type of the current response.

    Definition Classes
    ScalatraContext
  27. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  28. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  29. def cookies: SweetCookies

    Definition Classes
    CookieContext
  30. def createRenderContext(req: HttpServletRequest = request, resp: HttpServletResponse = response, out: PrintWriter = response.getWriter): RenderContext

    Creates a render context to be used by default in the template engine.

    Creates a render context to be used by default in the template engine.

    Returns a ScalatraRenderContext by default in order to bind some other framework variables (e.g., multiParams, flash). ScalatraTemplateEngine assumes this returns ScalatraRenderContext in its binding of "context". If you return something other than a ScalatraRenderContext, you will also want to redefine that binding.

    Attributes
    protected
  31. def createTemplateEngine(config: ConfigT): TemplateEngine

    Creates the templateEngine from the config.

    Creates the templateEngine from the config. There is little reason to override this unless you have created a ScalatraKernel extension outside an HttpServlet or Filter.

    Attributes
    protected
  32. val defaultCharacterEncoding: String

    The default character encoding for requests and responses.

    The default character encoding for requests and responses.

    Attributes
    protected
    Definition Classes
    ScalatraBase
  33. def defaultIndexName: String

    The default index page when the path is a directory.

    The default index page when the path is a directory.

    Attributes
    protected
  34. def defaultLayoutPath: Option[String]

    The default path to search for templates.

    The default path to search for templates. Left as a def so it can be read from the servletContext in initialize, but you probably want a constant.

    Defaults to: - /WEB-INF/views (recommended) - /WEB-INF/scalate/templates (used by previous Scalatra quickstarts)

    Attributes
    protected
  35. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  36. def defaultTemplateFormat: String

    The default template format.

    The default template format.

    Attributes
    protected
  37. def defaultTemplatePath: List[String]

    The default path to search for templates.

    The default path to search for templates. Left as a def so it can be read from the servletContext in initialize, but you probably want a constant.

    Defaults to: - /WEB-INF/views (recommended) - /WEB-INF/scalate/templates (used by previous Scalatra quickstarts)

    Attributes
    protected
  38. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  39. var 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
  40. implicit def enrichRequest(request: HttpServletRequest): RichRequest

    Definition Classes
    ServletApiImplicits
  41. implicit def enrichResponse(response: HttpServletResponse): RichResponse

    Definition Classes
    ServletApiImplicits
  42. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

    Definition Classes
    ServletApiImplicits
  43. implicit def enrichSession(session: HttpSession): RichSession

    Definition Classes
    ServletApiImplicits
  44. def environment: String

    A free form string representing the environment.

    A free form string representing the environment. org.scalatra.Environment is looked up as a system property, and if absent, and init parameter. The default value is development.

    Definition Classes
    ScalatraBase
  45. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  46. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  47. 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
  48. var 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
  49. 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
  50. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  51. def findTemplate(path: String, extensionSet: Set[String] = templateEngine.extensions): Option[String]

    Finds a template for a path.

    Finds a template for a path. Delegates to a TemplateFinder, and if that fails, tries again with /defaultIndexName appended.

    Attributes
    protected
  52. 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
  53. 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
  54. def fullUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: 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
  55. def get(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

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

    The Scalatra DSL core methods take a list of 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 RouteMatcher, so you can write code naturally.

      get("/", request.getRemoteHost == "127.0.0.1") { "Hello localhost!" }
    
    Definition Classes
    ScalatraBaseCoreDsl
  56. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  57. def halt(result: ActionResult): Nothing

    Definition Classes
    Control
  58. 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.

    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
  59. 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
    ScalateSupportServletBaseScalatraBaseHandler
  60. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  61. 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
  62. def initialize(config: ConfigT): 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
    ScalateSupportScalatraBaseInitializable
  63. 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
  64. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  65. 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
  66. def isHttps(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  67. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  68. def isScalateErrorPageEnabled: Boolean

    Flag whether the Scalate error page is enabled.

    Flag whether the Scalate error page is enabled. If true, uncaught exceptions will be caught and rendered by the Scalate error page.

    The default is true.

    Attributes
    protected
  69. def jade(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Convenience method for layoutTemplateAs("jade").

    Convenience method for layoutTemplateAs("jade").

    Attributes
    protected
  70. def layoutTemplate(path: String, attributes: (String, Any)*): String

    Finds and renders a template with the current layout strategy, looking for all known extensions, returning the result.

    Finds and renders a template with the current layout strategy, looking for all known extensions, returning the result.

    path

    The path of the template, passed to findTemplate.

    attributes

    Attributes to path to the render context. Disable layouts by passing layout -> "".

    Attributes
    protected
  71. def layoutTemplateAs(ext: Set[String])(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Finds and renders a template with the current layout strategy, returning the result.

    Finds and renders a template with the current layout strategy, returning the result.

    ext

    The extensions to look for a template.

    path

    The path of the template, passed to findTemplate.

    attributes

    Attributes to path to the render context. Disable layouts by passing layout -> "".

    Attributes
    protected
  72. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

  73. 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
  74. 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
  75. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Definition Classes
    ScalatraBase
  76. def mustache(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Convenience method for layoutTemplateAs("mustache").

    Convenience method for layoutTemplateAs("mustache").

    Attributes
    protected
  77. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  78. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  79. 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
  80. final def notify(): Unit

    Definition Classes
    AnyRef
  81. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  82. def options(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  83. def params(implicit request: HttpServletRequest): Params

    Definition Classes
    ScalatraBase
  84. def params(key: Symbol)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  85. def params(key: String)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  86. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    patch

  88. 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
  89. def post(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

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

    Definition Classes
    ScalatraBaseCoreDsl
    See also

    get

  91. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Sends a redirect response and immediately halts the current action.

    Sends a redirect response and immediately halts the current action.

    Definition Classes
    ScalatraBase
  92. 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

    RegexRouteMatcher

  93. 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
  94. def removeRoute(method: String, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  95. 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

  96. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  97. 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
  98. 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
  99. 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

  100. implicit def request: HttpServletRequest

    The currently scoped request.

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

    Definition Classes
    DynamicScopeRequestResponseScope
  101. implicit def response: HttpServletResponse

    The currently scoped response.

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

    Definition Classes
    DynamicScopeRequestResponseScope
  102. lazy val routes: RouteRegistry

    The routes registered in this kernel.

    The routes registered in this kernel.

    Definition Classes
    ScalatraBase
  103. 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
  104. 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
  105. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  106. 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
  107. implicit def scalatraContext: ScalatraContext

    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  108. def scaml(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Convenience method for layoutTemplateAs("scaml").

    Convenience method for layoutTemplateAs("scaml").

    Attributes
    protected
  109. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

    Definition Classes
    DefaultImplicitConversions
  110. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  111. def serverHost: String

    Definition Classes
    ScalatraBase
  112. def serverPort: Int

    Definition Classes
    ScalatraBase
  113. def servletContext: ServletContext

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ScalatraBaseScalatraContext
  114. def session(key: Symbol)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  115. def session(key: String)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport
  116. implicit def session(implicit request: HttpServletRequest): HttpSession

    The current session.

    The current session. Creates a session if none exists.

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

    The current session.

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

    Definition Classes
    SessionSupport
  118. 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.

    Definition Classes
    ScalateSupportInitializable
  119. def ssp(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Convenience method for layoutTemplateAs("ssp").

    Convenience method for layoutTemplateAs("ssp").

    Attributes
    protected
  120. def status: Int

    Gets the status code of the current response.

    Gets the status code of the current response.

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

    Sets the status code of the current response.

    Sets the status code of the current response.

    Definition Classes
    ScalatraContext
  122. 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
  123. implicit val stringToBoolean: TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicitConversions
  124. implicit val stringToByte: TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicitConversions
  125. def stringToDate(format: ⇒ String): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  126. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  127. implicit val stringToDouble: TypeConverter[String, Double]

    Definition Classes
    DefaultImplicitConversions
  128. implicit val stringToFloat: TypeConverter[String, Float]

    Definition Classes
    DefaultImplicitConversions
  129. implicit val stringToInt: TypeConverter[String, Int]

    Definition Classes
    DefaultImplicitConversions
  130. implicit val stringToLong: TypeConverter[String, Long]

    Definition Classes
    DefaultImplicitConversions
  131. implicit val stringToSelf: TypeConverter[String, String]

    Definition Classes
    DefaultImplicitConversions
  132. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  133. implicit val stringToShort: TypeConverter[String, Short]

    Definition Classes
    DefaultImplicitConversions
  134. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  135. def templateAttributes(key: String)(implicit request: HttpServletRequest): Any

    Attributes
    protected
  136. def templateAttributes(implicit request: HttpServletRequest): Map[String, Any]

    A request-scoped map of attributes to pass to the template.

    A request-scoped map of attributes to pass to the template. This map will be set to any render context created with the createRenderContext method.

    Attributes
    protected
  137. var templateEngine: TemplateEngine

    The template engine used by the methods in this support class.

    The template engine used by the methods in this support class. It provides a lower-level interface to Scalate and may be used directly to circumvent the conventions imposed by the helpers in this class. For instance, paths passed directly to the template engine are not run through findTemplate.

    Attributes
    protected[scalatra]
  138. def toString(): String

    Definition Classes
    AnyRef → Any
  139. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

    Definition Classes
    ScalatraParamsImplicits
  140. implicit def toTypedParams(params: Params): TypedParams

    Definition Classes
    ScalatraParamsImplicits
  141. 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
  142. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    See also

    error

  143. def url(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, absolutize: 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
  144. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  145. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  146. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  147. 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
  148. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScopeRequestResponseScope
  149. 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
  150. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    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 renderTemplate(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Creates a render context and renders directly to that.

    Creates a render context and renders directly to that. No template search is performed, and the layout strategy is circumvented. Clients are urged to consider layoutTemplate instead.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) not idiomatic Scalate; consider layoutTemplate instead

  5. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

Inherited from ServletBase

Inherited from ScalatraBase

Inherited from CookieSupport

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