org.scalatra.scalate

ScalateUrlGeneratorSupport

trait ScalateUrlGeneratorSupport extends ScalateSupport

Linear Supertypes
ScalateSupport, ScalatraKernel, ServletApiImplicits, Initializable, CoreDsl, Handler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalateUrlGeneratorSupport
  2. ScalateSupport
  3. ScalatraKernel
  4. ServletApiImplicits
  5. Initializable
  6. CoreDsl
  7. Handler
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Config

    Definition Classes
    Initializable
  2. case class HaltException extends Throwable with ControlThrowable with Product with Serializable

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  3. class PassException extends Throwable with ControlThrowable

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraKernel
  4. trait ScalatraTemplateEngine extends AnyRef

    A TemplateEngine integrated with Scalatra.

Abstract Value Members

  1. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  2. abstract def requestPath: String

    Definition Classes
    ScalatraKernel
  3. abstract def routeBasePath: String

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  4. abstract def servletContext: ServletContext

    Definition Classes
    ScalatraKernel → CoreDsl

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. val _params: MultiMapHeadView[String, String] with MapWithIndifferentAccess[String]

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  7. val _request: DynamicVariable[HttpServletRequest]

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  8. val _response: DynamicVariable[HttpServletResponse]

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  9. def addRoute(method: HttpMethod, routeMatchers: Iterable[RouteMatcher], action: ⇒ Any): Route

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  10. def after(routeMatchers: RouteMatcher*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraKernel → CoreDsl
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def before(routeMatchers: RouteMatcher*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraKernel → CoreDsl
  13. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def contentType: String

    Definition Classes
    CoreDsl
  16. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  17. def contentType_=(contentType: String): Unit

    Definition Classes
    CoreDsl
  18. def createRenderContext(req: HttpServletRequest = request, res: 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
    Definition Classes
    ScalateUrlGeneratorSupportScalateSupport
  19. def createTemplateEngine(config: Config): 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
    Definition Classes
    ScalateUrlGeneratorSupportScalateSupport
  20. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  21. 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
    Definition Classes
    ScalateSupport
  22. def defaultLayoutPath: 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
    Definition Classes
    ScalateSupport
  23. def defaultTemplateFormat: String

    The default template format.

    The default template format.

    Attributes
    protected
    Definition Classes
    ScalateSupport
  24. 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
    Definition Classes
    ScalateSupport
  25. def delete(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  26. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  27. def environment: String

    Definition Classes
    ScalatraKernel
  28. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  30. def error(handler: ErrorHandler): Unit

    Definition Classes
    ScalatraKernel → CoreDsl
  31. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  32. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  33. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. 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
    Definition Classes
    ScalateSupport
  35. def get(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  36. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  37. def halt[T](status: Integer, body: T, headers: Map[String, String], reason: String)(implicit arg0: Manifest[T]): Nothing

    Definition Classes
    ScalatraKernel → CoreDsl
  38. def handle(req: HttpServletRequest, res: HttpServletResponse): Unit

    Definition Classes
    ScalateSupport → ScalatraKernel → Handler
  39. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  40. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraKernel
  41. def initialize(config: Config): Unit

    Definition Classes
    ScalateSupport → ScalatraKernel → Initializable
  42. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  43. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraKernel
  44. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  45. 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
    Definition Classes
    ScalateSupport
  46. def jade(path: String, attributes: (String, Any)*): String

    Convenience method for layoutTemplateAs("jade").

    Convenience method for layoutTemplateAs("jade").

    Attributes
    protected
    Definition Classes
    ScalateSupport
  47. 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
    Definition Classes
    ScalateSupport
  48. def layoutTemplateAs(ext: Set[String])(path: String, attributes: (String, Any)*): 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
    Definition Classes
    ScalateSupport
  49. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    ScalatraKernel → CoreDsl
  50. def multiParams: MultiParams

    Definition Classes
    ScalatraKernel → CoreDsl
  51. def mustache(path: String, attributes: (String, Any)*): String

    Convenience method for layoutTemplateAs("mustache").

    Convenience method for layoutTemplateAs("mustache").

    Attributes
    protected
    Definition Classes
    ScalateSupport
  52. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  53. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraKernel → CoreDsl
  54. final def notify(): Unit

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

    Definition Classes
    AnyRef
  56. def options(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  57. def params: MultiMapHeadView[String, String] with MapWithIndifferentAccess[String]

    Definition Classes
    ScalatraKernel → CoreDsl
  58. def pass(): Nothing

    Definition Classes
    ScalatraKernel → CoreDsl
  59. def patch(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  60. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  61. def post(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  62. def put(routeMatchers: RouteMatcher*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraKernel → CoreDsl
  63. def redirect(uri: String): Unit

    Definition Classes
    CoreDsl
  64. lazy val reflectRoutes: Map[String, Route]

  65. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  66. def removeRoute(method: String, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  67. def removeRoute(method: HttpMethod, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  68. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  69. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  70. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  71. implicit def request: HttpServletRequest

    Definition Classes
    ScalatraKernel → CoreDsl
  72. implicit def requestWrapper(r: HttpServletRequest): RichRequest

    Definition Classes
    ServletApiImplicits
  73. implicit def response: HttpServletResponse

    Definition Classes
    ScalatraKernel → CoreDsl
  74. lazy val routes: RouteRegistry

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  75. def runFilters(filters: Traversable[Route]): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  77. def scaml(path: String, attributes: (String, Any)*): String

    Convenience method for layoutTemplateAs("scaml").

    Convenience method for layoutTemplateAs("scaml").

    Attributes
    protected
    Definition Classes
    ScalateSupport
  78. implicit def servletContextWrapper(sc: ServletContext): RichServletContext

    Definition Classes
    ServletApiImplicits
  79. implicit def session: HttpSession

    Definition Classes
    CoreDsl
  80. def sessionOption: Option[HttpSession]

    Definition Classes
    CoreDsl
  81. implicit def sessionWrapper(s: HttpSession): RichSession

    Definition Classes
    ServletApiImplicits
  82. def ssp(path: String, attributes: (String, Any)*): String

    Convenience method for layoutTemplateAs("ssp").

    Convenience method for layoutTemplateAs("ssp").

    Attributes
    protected
    Definition Classes
    ScalateSupport
  83. def status(code: Int): Unit

    Definition Classes
    CoreDsl
  84. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraKernel
  85. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  86. 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[org.scalatra]
    Definition Classes
    ScalateSupport
  87. def toString(): String

    Definition Classes
    AnyRef → Any
  88. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  91. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ScalatraKernel

Deprecated Value Members

  1. def addRoute(verb: String, routeMatchers: Iterable[RouteMatcher], action: ⇒ Any): Route

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraKernel
    Annotations
    @deprecated
    Deprecated

    Use addRoute(HttpMethod, Iterable[RouteMatcher], =>Any)

  2. final def afterAll(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

    Use after() { ... }

  3. final def afterSome(routeMatchers: RouteMatcher*)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

    Use after(RouteMatcher*) { ... }

  4. final def beforeAll(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

    Use before() { ... }

  5. final def beforeSome(routeMatchers: RouteMatcher*)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
    Annotations
    @deprecated
    Deprecated

    Use before(RouteMatcher*) { ... }

  6. def renderTemplate(path: String, attributes: (String, Any)*): 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.

    Definition Classes
    ScalateSupport
    Annotations
    @deprecated
    Deprecated

    not idiomatic Scalate; consider layoutTemplate instead

Inherited from ScalateSupport

Inherited from ScalatraKernel

Inherited from ServletApiImplicits

Inherited from Initializable

Inherited from CoreDsl

Inherited from Handler

Inherited from AnyRef

Inherited from Any

Ungrouped