Packages

trait ScalateSupport extends ServletBase

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

Linear Supertypes
ServletBase, ScalatraBase, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, AnyRef, Any
Known Subclasses
ScalateI18nSupport, ScalateUrlGeneratorSupport
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalateSupport
  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. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef
    Definition Classes
    Initializable
  2. abstract type ConfigT <: AnyRef { ... /* 3 definitions in type refinement */ }
    Definition Classes
    ServletBase → Initializable
  3. trait ScalatraTemplateEngine extends AnyRef

    A TemplateEngine integrated with Scalatra.

    A TemplateEngine integrated with Scalatra.

    A ScalatraTemplateEngine looks for layouts in /WEB-INF/templates/layouts before searching in /WEB-INF/layouts and /WEB-INF/scalate/layouts.

Abstract Value Members

  1. abstract val doNotFound: Action
    Attributes
    protected
    Definition Classes
    ScalatraBase
  2. abstract def requestPath(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  3. abstract def routeBasePath(implicit request: HttpServletRequest): String
    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
    Attributes
    protected
    Definition Classes
    ScalatraBase
  5. def addSessionId(uri: String)(implicit response: HttpServletResponse): String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  6. def addStatusRoute(codes: Range, action: ⇒ Any): Unit
    Attributes
    protected[scalatra]
    Definition Classes
    ScalatraBase
  7. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  8. implicit val anyToBoolean: TypeConverter[Any, Boolean]
    Definition Classes
    LowPriorityImplicitConversions
  9. implicit val anyToByte: TypeConverter[Any, Byte]
    Definition Classes
    LowPriorityImplicitConversions
  10. implicit val anyToDouble: TypeConverter[Any, Double]
    Definition Classes
    LowPriorityImplicitConversions
  11. implicit val anyToFloat: TypeConverter[Any, Float]
    Definition Classes
    LowPriorityImplicitConversions
  12. implicit val anyToInt: TypeConverter[Any, Int]
    Definition Classes
    LowPriorityImplicitConversions
  13. implicit val anyToLong: TypeConverter[Any, Long]
    Definition Classes
    LowPriorityImplicitConversions
  14. implicit val anyToShort: TypeConverter[Any, Short]
    Definition Classes
    LowPriorityImplicitConversions
  15. implicit val anyToString: TypeConverter[Any, String]
    Definition Classes
    LowPriorityImplicitConversions
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  18. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher
    Attributes
    protected
    Definition Classes
    ScalatraBase
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. val config: ConfigT
    Definition Classes
    ScalatraBase
  21. implicit def configWrapper(config: ConfigT): Config
    Attributes
    protected
    Definition Classes
    ServletBase → Initializable
  22. def contentType: String
    Definition Classes
    ScalatraContext
  23. def contentTypeInferrer: ContentTypeInferrer
    Attributes
    protected
    Definition Classes
    ScalatraBase
  24. def contentType_=(contentType: String): Unit
    Definition Classes
    ScalatraContext
  25. def contextPath: String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  26. implicit def cookieOptions: CookieOptions
    Definition Classes
    CookieContext
  27. def cookies(implicit request: HttpServletRequest): SweetCookies
    Definition Classes
    CookieContext
  28. def createRenderContext(out: PrintWriter)(implicit request: HttpServletRequest, response: HttpServletResponse): 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
  29. 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 ServletBase extension outside an HttpServlet or Filter.

    Attributes
    protected
  30. val decodePercentEncodedPath: Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  31. val defaultCharacterEncoding: String
    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. 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
  33. 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/templates/views (recommended) - /WEB-INF/views (used by previous Scalatra quickstarts) - /WEB-INF/scalate/templates (used by previous Scalatra quickstarts)

    Attributes
    protected
  34. implicit def defaultStringToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  35. def defaultTemplateFormat: String

    The default template format.

    The default template format.

    Attributes
    protected
  36. 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/templates/views (recommended) - /WEB-INF/views (used by previous Scalatra quickstarts) - /WEB-INF/scalate/templates (used by previous Scalatra quickstarts)

    Attributes
    protected
  37. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  38. val doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any
    Attributes
    protected
    Definition Classes
    ScalatraBase
  39. implicit def enrichRequest(request: HttpServletRequest): RichRequest
    Definition Classes
    ServletApiImplicits
  40. implicit def enrichResponse(response: HttpServletResponse): RichResponse
    Definition Classes
    ServletApiImplicits
  41. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext
    Definition Classes
    ServletApiImplicits
  42. implicit def enrichSession(session: HttpSession): RichSession
    Definition Classes
    ServletApiImplicits
  43. def environment: String
    Definition Classes
    ScalatraBase
  44. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  46. def error(handler: ErrorHandler): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  47. val errorHandler: ErrorHandler
    Attributes
    protected
    Definition Classes
    ScalatraBase
  48. def executeRoutes(): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  49. def extractStatusCode(e: HaltException): Int
    Attributes
    protected
    Definition Classes
    ScalatraBase
  50. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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
    Definition Classes
    ScalatraContext
  53. def format_=(formatValue: Symbol): Unit
    Definition Classes
    ScalatraContext
  54. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String
    Definition Classes
    ScalatraBase
  55. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. def halt(result: ActionResult): Nothing
    Definition Classes
    Control
  58. def halt[T](status: Integer, body: T, headers: Map[String, String]): Nothing
    Definition Classes
    Control
  59. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit
    Definition Classes
    ScalateSupport → ServletBase → ScalatraBase → Handler
  60. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  62. def initParameter(name: String): Option[String]
    Definition Classes
    ScalatraBase
  63. def initialize(config: ConfigT): Unit
    Definition Classes
    ScalateSupport → ScalatraBase → Initializable
  64. def invoke(matchedRoute: MatchedRoute): Option[Any]
    Attributes
    protected
    Definition Classes
    ScalatraBase
  65. def isAsyncExecutable(result: Any): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  66. def isDevelopmentMode: Boolean
    Definition Classes
    ScalatraBase
  67. def isHttps(implicit request: HttpServletRequest): Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. 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
  70. 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
  71. def layoutTemplate(path: String, attributes: (String, Any)*)(implicit request: HttpServletRequest, response: HttpServletResponse): 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
  72. 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
  73. implicit def lowestPriorityAny2T[T](implicit arg0: ClassTag[T]): TypeConverter[Any, T]
    Definition Classes
    LowestPriorityImplicitConversions
  74. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  75. def multiParams(implicit request: HttpServletRequest): MultiParams
    Definition Classes
    ScalatraBase
  76. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]
    Definition Classes
    ScalatraBase
  77. 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
  78. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  79. def needsHttps: Boolean
    Attributes
    protected
    Definition Classes
    ScalatraBase
  80. def notFound(fun: ⇒ Any): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  81. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. def options(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  84. def params(implicit request: HttpServletRequest): Params
    Definition Classes
    ScalatraBase
  85. def params(key: String)(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  86. def pass(): Nothing
    Definition Classes
    Control
  87. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  88. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher
    Attributes
    protected
    Definition Classes
    ScalatraBase
  89. def post(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  90. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route
    Definition Classes
    ScalatraBase → CoreDsl
  91. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing
    Definition Classes
    ScalatraBase
  92. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher
    Attributes
    protected
    Definition Classes
    ScalatraBase
  93. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(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
    Attributes
    protected
    Definition Classes
    ScalatraBase
  96. def renderHaltException(e: HaltException): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  97. def renderPipeline: RenderPipeline
    Attributes
    protected
    Definition Classes
    ScalatraBase
  98. def renderResponse(actionResult: Any): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  99. def renderResponseBody(actionResult: Any): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  100. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
    Attributes
    protected
    Definition Classes
    ScalateSupport → ScalatraBase
  101. implicit def request: HttpServletRequest
    Definition Classes
    DynamicScope → RequestResponseScope
  102. implicit def response: HttpServletResponse
    Definition Classes
    DynamicScope → RequestResponseScope
  103. lazy val routes: RouteRegistry
    Definition Classes
    ScalatraBase
  104. def runFilters(filters: Iterable[Route]): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  105. def runRoutes(routes: Iterable[Route]): Stream[Any]
    Attributes
    protected
    Definition Classes
    ScalatraBase
  106. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]
    Definition Classes
    TypeConverterSupport
  107. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]
    Definition Classes
    TypeConverterSupport
  108. implicit def scalatraContext: ScalatraContext
    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  109. 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
  110. implicit def seqHead[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], T]
    Definition Classes
    DefaultImplicitConversions
  111. implicit def seqToSeq[T](implicit arg0: ClassTag[T], elementConverter: TypeConverter[String, T]): TypeConverter[Seq[String], Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  112. def serverHost(implicit request: HttpServletRequest): String
    Definition Classes
    ScalatraBase
  113. def serverPort(implicit request: HttpServletRequest): Int
    Definition Classes
    ScalatraBase
  114. def servletContext: ServletContext
    Definition Classes
    ScalatraBase → ScalatraContext
  115. def session(key: String)(implicit request: HttpServletRequest): Any
    Definition Classes
    SessionSupport
  116. implicit def session(implicit request: HttpServletRequest): HttpSession
    Definition Classes
    SessionSupport
  117. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]
    Definition Classes
    SessionSupport
  118. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit
    Attributes
    protected
    Definition Classes
    ScalatraBase
  119. def shutdown(): Unit
    Definition Classes
    ScalateSupport → Initializable
  120. 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
  121. def status: Int
    Definition Classes
    ScalatraContext
  122. def status_=(code: Int): Unit
    Definition Classes
    ScalatraContext
  123. implicit def string2RouteMatcher(path: String): RouteMatcher
    Attributes
    protected
    Definition Classes
    ScalatraBase
  124. implicit val stringToBoolean: TypeConverter[String, Boolean]
    Definition Classes
    DefaultImplicitConversions
  125. implicit val stringToByte: TypeConverter[String, Byte]
    Definition Classes
    DefaultImplicitConversions
  126. def stringToDate(format: ⇒ String): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  127. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]
    Definition Classes
    DefaultImplicitConversions
  128. implicit val stringToDouble: TypeConverter[String, Double]
    Definition Classes
    DefaultImplicitConversions
  129. implicit val stringToFloat: TypeConverter[String, Float]
    Definition Classes
    DefaultImplicitConversions
  130. implicit val stringToInt: TypeConverter[String, Int]
    Definition Classes
    DefaultImplicitConversions
  131. implicit val stringToLong: TypeConverter[String, Long]
    Definition Classes
    DefaultImplicitConversions
  132. implicit val stringToSelf: TypeConverter[String, String]
    Definition Classes
    DefaultImplicitConversions
  133. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: ClassTag[T]): TypeConverter[String, Seq[T]]
    Definition Classes
    DefaultImplicitConversions
  134. implicit val stringToShort: TypeConverter[String, Short]
    Definition Classes
    DefaultImplicitConversions
  135. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  136. def templateAttributes(key: String)(implicit request: HttpServletRequest): Any
    Attributes
    protected
  137. 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
  138. val 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]
  139. def toString(): String
    Definition Classes
    AnyRef → Any
  140. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams
    Definition Classes
    ScalatraParamsImplicits
  141. implicit def toTypedParams(params: Params): TypedParams
    Definition Classes
    ScalatraParamsImplicits
  142. def trap(codes: Range)(block: ⇒ Any): Unit
    Definition Classes
    ScalatraBase → CoreDsl
  143. def trap(code: Int)(block: ⇒ Any): Unit
    Definition Classes
    CoreDsl
  144. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String
    Definition Classes
    ScalatraBase
  145. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  146. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  147. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  148. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A
    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  149. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A
    Attributes
    protected[scalatra]
    Definition Classes
    DynamicScope → RequestResponseScope
  150. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A
    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  151. 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 AnyRef

Inherited from Any

Ungrouped