au.com.onegeek.respite.controllers.support

CachingRouteSupport

trait CachingRouteSupport extends ScalatraBase with LoggingSupport with CachingSupport[Any] with FutureSupport

Automatically cache CRUD and idempotent routes plus a handy Caching DSL.

Note that use of this will automatically convert your routes into 

FutureSupport

routes as cache retrieval is asynchronous.

NOTES:

If the caching is set to 365 days or greater (including 'infinity') the Expires header is set to exactly 365 days in the future. The Cache can be set to 'auto-evict' meaning

FutureSupport }}} is asynchronous.

NOTES:

If the caching is set to 365 days or greater (including 'infinity') the Expires header is set to exactly 365 days in the future. The Cache can be set to 'auto-evict' meaning

Linear Supertypes
FutureSupport, AsyncSupport, ScalatraAsyncSupport, ServletBase, CachingSupport[Any], LoggingSupport, ScalatraBase, CookieSupport, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CachingRouteSupport
  2. FutureSupport
  3. AsyncSupport
  4. ScalatraAsyncSupport
  5. ServletBase
  6. CachingSupport
  7. LoggingSupport
  8. ScalatraBase
  9. CookieSupport
  10. DefaultImplicitConversions
  11. LowPriorityImplicitConversions
  12. LowestPriorityImplicitConversions
  13. TypeConverterSupport
  14. ScalatraParamsImplicits
  15. Initializable
  16. DynamicScope
  17. RequestResponseScope
  18. CoreDsl
  19. Control
  20. Handler
  21. ScalatraContext
  22. CookieContext
  23. SessionSupport
  24. ServletApiImplicits
  25. AnyRef
  26. Any
  1. Hide All
  2. Show all
Learn more about member selection
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. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

  4. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase

  2. implicit abstract def executor: ExecutionContext

    Attributes
    protected
    Definition Classes
    FutureSupport

  3. abstract def requestPath(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase

  4. abstract def routeBasePath(implicit request: HttpServletRequest): String

    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. val YEAR_IN_DAYS: Int

  7. val YEAR_IN_MINUTES: Int

  8. def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], action: ⇒ Any): Route

    Attributes
    protected
    Definition Classes
    CachingRouteSupport → ScalatraBase

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

    Attributes
    protected
    Definition Classes
    ScalatraBase

  10. def addStatusRoute(codes: Range, action: ⇒ Any): Unit

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase

  11. def after(transformers: (Route) ⇒ Route*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  12. implicit val anyToBoolean: TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

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

    Definition Classes
    LowPriorityImplicitConversions

  20. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  21. def asyncDelete(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  22. def asyncGet(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  23. def asyncOptions(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  24. def asyncPatch(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  25. def asyncPost(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  26. def asyncPut(transformers: (Route) ⇒ Route*)(block: ⇒ Any): Route

    Definition Classes
    AsyncSupport

  27. def asynchronously(f: ⇒ Any): () ⇒ Any

    Definition Classes
    FutureSupport → AsyncSupport

  28. def before(transformers: (Route) ⇒ Route*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  29. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase

  30. lazy val cache: Cache[Any]

    Definition Classes
    CachingSupport

  31. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. var config: ConfigT

    Definition Classes
    ScalatraBase

  33. implicit def configWrapper(config: ConfigT): Config { object initParameters }

    Attributes
    protected
    Definition Classes
    ServletBase → Initializable

  34. def contentType: String

    Definition Classes
    ScalatraContext

  35. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ScalatraBase

  36. def contentType_=(contentType: String): Unit

    Definition Classes
    ScalatraContext

  37. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase

  38. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext

  39. def cookies: SweetCookies

    Definition Classes
    CookieContext

  40. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraBase

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

    Definition Classes
    DefaultImplicitConversions

  42. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl

  43. var doMethodNotAllowed: (Set[HttpMethod]) ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase

  44. implicit def enrichRequest(request: HttpServletRequest): RichRequest

    Definition Classes
    ServletApiImplicits

  45. implicit def enrichResponse(response: HttpServletResponse): RichResponse

    Definition Classes
    ServletApiImplicits

  46. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

    Definition Classes
    ServletApiImplicits

  47. implicit def enrichSession(session: HttpSession): RichSession

    Definition Classes
    ServletApiImplicits

  48. def environment: String

    Definition Classes
    ScalatraBase

  49. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  50. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  51. def error(handler: ErrorHandler): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  52. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraBase

  53. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  54. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  55. def format_=(formatValue: String): Unit

    Definition Classes
    ScalatraContext

  56. def format_=(formatValue: Symbol): Unit

    Definition Classes
    ScalatraContext

  57. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase

  58. def get(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl

  59. def getCacheKey(): String

  60. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  61. def halt(result: ActionResult): Nothing

    Definition Classes
    Control

  62. def halt[T](status: Integer, body: T, headers: Map[String, String], reason: String)(implicit arg0: Manifest[T]): Nothing

    Definition Classes
    Control

  63. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Definition Classes
    ServletBase → ScalatraBase → Handler

  64. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    ScalatraBase

  66. val initialCapacity: Int

    Definition Classes
    CachingSupport

  67. def initialize(config: ConfigT): Unit

    Definition Classes
    ScalatraBase → Initializable

  68. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase

  69. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    FutureSupport → ScalatraBase

  70. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraBase

  71. def isHttps(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase

  72. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  73. val logger: Logger

    Definition Classes
    LoggingSupport

  74. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): TypeConverter[Any, T]

    Definition Classes
    LowestPriorityImplicitConversions

  75. val maxCapacity: Int

    Definition Classes
    CachingSupport

  76. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  77. def multiParams(implicit request: HttpServletRequest): MultiParams

    Definition Classes
    ScalatraBase

  78. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Definition Classes
    ScalatraBase

  79. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  80. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase

  81. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  82. final def notify(): Unit

    Definition Classes
    AnyRef

  83. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  84. def onAsyncEvent(event: AsyncEvent)(thunk: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    AsyncSupport

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

    Definition Classes
    ScalatraBase → CoreDsl

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

    Definition Classes
    ScalatraBase

  87. def params(key: Symbol)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase

  88. def params(key: String)(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase

  89. def pass(): Nothing

    Definition Classes
    Control

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

    Definition Classes
    ScalatraBase → CoreDsl

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

    Attributes
    protected
    Definition Classes
    ScalatraBase

  92. def post(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl

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

    Definition Classes
    ScalatraBase → CoreDsl

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

    Definition Classes
    ScalatraBase

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

    Attributes
    protected
    Definition Classes
    ScalatraBase

  96. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase

  97. def removeRoute(method: String, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  98. def removeRoute(method: HttpMethod, route: Route): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  99. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  100. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    ScalatraBase

  101. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    FutureSupport → ScalatraBase

  102. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  103. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope

  104. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope

  105. lazy val routes: RouteRegistry

    Definition Classes
    ScalatraBase

  106. def runFilters(filters: Traversable[Route]): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  107. def runRoutes(routes: Traversable[Route]): Stream[Any]

    Attributes
    protected
    Definition Classes
    ScalatraBase

  108. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport

  109. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport

  110. implicit def scalatraContext: ScalatraContext

    Attributes
    protected[this]
    Definition Classes
    ScalatraContext

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

    Definition Classes
    DefaultImplicitConversions

  112. implicit def seqToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicitConversions

  113. def serverHost(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase

  114. def serverPort(implicit request: HttpServletRequest): Int

    Definition Classes
    ScalatraBase

  115. def servletContext: ServletContext

    Definition Classes
    ScalatraBase → ScalatraContext

  116. def session(key: Symbol)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport

  117. def session(key: String)(implicit request: HttpServletRequest): Any

    Definition Classes
    SessionSupport

  118. implicit def session(implicit request: HttpServletRequest): HttpSession

    Definition Classes
    SessionSupport

  119. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    Definition Classes
    SessionSupport

  120. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit request: HttpServletRequest): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase

  121. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable

  122. def sortRequestParameters(): Map[String, String]

  123. def status: Int

    Definition Classes
    ScalatraContext

  124. def status_=(code: Int): Unit

    Definition Classes
    ScalatraContext

  125. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase

  126. implicit val stringToBoolean: TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicitConversions

  127. implicit val stringToByte: TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicitConversions

  128. def stringToDate(format: ⇒ String): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions

  129. def stringToDateFormat(format: ⇒ DateFormat): TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions

  130. implicit val stringToDouble: TypeConverter[String, Double]

    Definition Classes
    DefaultImplicitConversions

  131. implicit val stringToFloat: TypeConverter[String, Float]

    Definition Classes
    DefaultImplicitConversions

  132. implicit val stringToInt: TypeConverter[String, Int]

    Definition Classes
    DefaultImplicitConversions

  133. implicit val stringToLong: TypeConverter[String, Long]

    Definition Classes
    DefaultImplicitConversions

  134. implicit val stringToSelf: TypeConverter[String, String]

    Definition Classes
    DefaultImplicitConversions

  135. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions

  136. implicit val stringToShort: TypeConverter[String, Short]

    Definition Classes
    DefaultImplicitConversions

  137. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  138. val timeToIdle: Duration

    Definition Classes
    CachingSupport

  139. val timeToLive: Duration

    Definition Classes
    CachingSupport

  140. def toString(): String

    Definition Classes
    AnyRef → Any

  141. implicit def toTypedMultiParams(params: MultiParams): TypedMultiParams

    Definition Classes
    ScalatraParamsImplicits

  142. implicit def toTypedParams(params: Params): TypedParams

    Definition Classes
    ScalatraParamsImplicits

  143. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl

  144. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl

  145. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase

  146. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  147. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  148. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  149. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope

  150. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope

  151. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope

  152. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ScalatraBase

  153. def withinAsyncContext(context: AsyncContext)(thunk: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    AsyncSupport

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 asyncTimeout: Duration

    Attributes
    protected
    Definition Classes
    FutureSupport
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) Override the timeout method on a org.scalatra.AsyncResult instead.

  5. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

Inherited from FutureSupport

Inherited from AsyncSupport

Inherited from ScalatraAsyncSupport

Inherited from ServletBase

Inherited from CachingSupport[Any]

Inherited from LoggingSupport

Inherited from ScalatraBase

Inherited from CookieSupport

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