skinny.filter

SkinnyFilter

trait SkinnyFilter extends controller.SkinnyControllerBase with SkinnyFilterActivation

Skinny Filter.

For example:

class BooksController extends SkinnyController
with TxPerRequestFiler
with SkinnyFilterActivation {

// within a transaction
def changeTitle = {
  if (...) {
    throw new UnexpectedErrorException
    // rollback
  } else {
    redirect(s"/books/${id}")
    // commit
  }
}
}

If you use Scatatra's filter - before/after, be careful. It's pretty tricky. Because Scalatra's filters would be applied for all the controllers difined below in ScalatraBootstrap. Just using beforeAction/afterAction is highly recommended.

Linear Supertypes
SkinnyFilterActivation, controller.SkinnyControllerBase, ParamsPermitImplicits, ParametersGetAsImplicits, RoutesAsImplicits, ThreadLocalRequestFeature, TimeLoggingFeature, SensitiveParametersFeature, TimeLogging, JSONFeature, JSONStringOps, JacksonJsonSupport, JValueResult, JacksonJsonOutput, JsonMethods, JsonSupport[JValue], JsonOutput[JValue], JsonMethods[JValue], ApiFormats, ValidationFeature, BeforeAfterActionFeature, RequestScopeFeature, logging.Logging, LocaleFeature, SnakeCasedParamKeysFeature, ActionDefinitionFeature, ExplicitRedirectFeature, UrlGeneratorSupport, RichRouteFeature, EnvFeature, SkinnyScalatraBase, ScalatraBase, CookieSupport, DefaultImplicitConversions, LowPriorityImplicitConversions, LowestPriorityImplicitConversions, org.scalatra.util.conversion.TypeConverterSupport, ScalatraParamsImplicits, Initializable, DynamicScope, RequestResponseScope, CoreDsl, Control, Handler, ScalatraContext, CookieContext, SessionSupport, ServletApiImplicits, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SkinnyFilter
  2. SkinnyFilterActivation
  3. SkinnyControllerBase
  4. ParamsPermitImplicits
  5. ParametersGetAsImplicits
  6. RoutesAsImplicits
  7. ThreadLocalRequestFeature
  8. TimeLoggingFeature
  9. SensitiveParametersFeature
  10. TimeLogging
  11. JSONFeature
  12. JSONStringOps
  13. JacksonJsonSupport
  14. JValueResult
  15. JacksonJsonOutput
  16. JsonMethods
  17. JsonSupport
  18. JsonOutput
  19. JsonMethods
  20. ApiFormats
  21. ValidationFeature
  22. BeforeAfterActionFeature
  23. RequestScopeFeature
  24. Logging
  25. LocaleFeature
  26. SnakeCasedParamKeysFeature
  27. ActionDefinitionFeature
  28. ExplicitRedirectFeature
  29. UrlGeneratorSupport
  30. RichRouteFeature
  31. EnvFeature
  32. SkinnyScalatraBase
  33. ScalatraBase
  34. CookieSupport
  35. DefaultImplicitConversions
  36. LowPriorityImplicitConversions
  37. LowestPriorityImplicitConversions
  38. TypeConverterSupport
  39. ScalatraParamsImplicits
  40. Initializable
  41. DynamicScope
  42. RequestResponseScope
  43. CoreDsl
  44. Control
  45. Handler
  46. ScalatraContext
  47. CookieContext
  48. SessionSupport
  49. ServletApiImplicits
  50. AnyRef
  51. 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

    Definition Classes
    Initializable
  3. sealed trait RenderingRequired extends AnyRef

    Definition Classes
    SkinnyFilterActivation
  4. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  5. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Abstract Value Members

  1. implicit abstract def configWrapper(config: ConfigT): Config

    Attributes
    protected
    Definition Classes
    Initializable
  2. abstract val doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraBase
  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. object WithRendering extends (SkinnyFilterActivation.this)#RenderingRequired with Product with Serializable

    Definition Classes
    SkinnyFilterActivation
  7. object WithoutRendering extends (SkinnyFilterActivation.this)#RenderingRequired with Product with Serializable

    Definition Classes
    SkinnyFilterActivation
  8. def acceptHeader(implicit request: HttpServletRequest): List[String]

    Definition Classes
    ApiFormats
  9. def acceptedFormats(accepted: Symbol*): Boolean

    Attributes
    protected
    Definition Classes
    ApiFormats
  10. val actionDefinitions: ArrayBuffer[ActionDefinition]

    Note: Same action method name should be registered several times.

    Note: Same action method name should be registered several times. For example, put("/members/:id")(...).as('update) and patch("/members/:id")(...).as('update).

    Attributes
    protected
    Definition Classes
    ActionDefinitionFeature
  11. def addActionDefinition(actionDef: ActionDefinition): Unit

    Adds action definition

    Adds action definition

    actionDef

    action definition

    Definition Classes
    ActionDefinitionFeature
  12. def addErrorFilter(handler: ErrorHandler): Unit

    Adds error handler which doesn't return result to SkinnyController.

    Adds error handler which doesn't return result to SkinnyController.

    handler

    Definition Classes
    SkinnyFilterActivation
  13. def addMimeMapping(mime: String, extension: String): Unit

    Attributes
    protected
    Definition Classes
    ApiFormats
  14. def addParam(name: String, value: Any): Unit

    Add param to params in the request scope.

    Add param to params in the request scope.

    name

    name

    value

    value

    Definition Classes
    RequestScopeFeature
  15. def addRoute(method: HttpMethod, transformers: Seq[(Route) ⇒ Route], action: ⇒ Any): Route

    Override to append HTTP method information to Route objects.

    Override to append HTTP method information to Route objects.

    Attributes
    protected
    Definition Classes
    RichRouteFeature → ScalatraBase
  16. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

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

    Attributes
    protected[org.scalatra]
    Definition Classes
    ScalatraBase
  18. def after(transformers: (Route) ⇒ Route*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  19. def afterAction(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

    Registers afterAction to this controller.

    Registers afterAction to this controller.

    only

    this action should be applied only for these action methods

    except

    this action should not be applied for these action methods

    action

    action

    Definition Classes
    BeforeAfterActionFeature
  20. def afterFilter(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

    If you prefer #afterFilter than #afterAction, keep going!

    If you prefer #afterFilter than #afterAction, keep going!

    Definition Classes
    BeforeAfterActionFeature
  21. implicit val anyToBoolean: org.scalatra.util.conversion.TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicitConversions
  22. implicit val anyToByte: org.scalatra.util.conversion.TypeConverter[Any, Byte]

    Definition Classes
    LowPriorityImplicitConversions
  23. implicit val anyToDouble: org.scalatra.util.conversion.TypeConverter[Any, Double]

    Definition Classes
    LowPriorityImplicitConversions
  24. implicit val anyToFloat: org.scalatra.util.conversion.TypeConverter[Any, Float]

    Definition Classes
    LowPriorityImplicitConversions
  25. implicit val anyToInt: org.scalatra.util.conversion.TypeConverter[Any, Int]

    Definition Classes
    LowPriorityImplicitConversions
  26. implicit val anyToLong: org.scalatra.util.conversion.TypeConverter[Any, Long]

    Definition Classes
    LowPriorityImplicitConversions
  27. implicit val anyToShort: org.scalatra.util.conversion.TypeConverter[Any, Short]

    Definition Classes
    LowPriorityImplicitConversions
  28. implicit val anyToString: org.scalatra.util.conversion.TypeConverter[Any, String]

    Definition Classes
    LowPriorityImplicitConversions
  29. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  30. def asJValue[T](obj: T)(implicit writer: Writer[T]): JValue

    Definition Classes
    JsonMethods
  31. def before(transformers: (Route) ⇒ Route*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  32. def beforeAction(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

    Registers beforeAction to this controller.

    Registers beforeAction to this controller.

    only

    this action should be applied only for these action methods

    except

    this action should not be applied for these action methods

    action

    action

    Definition Classes
    BeforeAfterActionFeature
  33. def beforeFilter(only: Seq[Symbol] = Nil, except: Seq[Symbol] = Nil)(action: ⇒ Any): Unit

    If you prefer #beforeFilter than #beforeAction, keep going!

    If you prefer #beforeFilter than #beforeAction, keep going!

    Definition Classes
    BeforeAfterActionFeature
  34. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  35. def cacheRequestBodyAsString: Boolean

    Attributes
    protected
    Definition Classes
    JsonSupport
  36. lazy val charset: Option[String]

    Default charset.

    Default charset.

    Definition Classes
    SkinnyControllerBase
  37. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def compact(value: JValue): String

    Returns JSON string value.

    Returns JSON string value.

    value

    value

    Definition Classes
    JSONStringOps → JsonMethods → JsonMethods
  39. var config: ConfigT

    Definition Classes
    ScalatraBase
  40. def contentType: String

    Definition Classes
    ScalatraContext
  41. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats → ScalatraBase
  42. def contentType_=(contentType: String): Unit

    Definition Classes
    ScalatraContext
  43. def contextPath: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  44. implicit def convertParamsToStrongParameters(params: org.scalatra.Params): StrongParameters

    Definition Classes
    ParamsPermitImplicits
  45. implicit def convertRouteToRichRoute(route: Route)(implicit controller: controller.SkinnyControllerBase): RichRoute

    Definition Classes
    RoutesAsImplicits
  46. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  47. def cookies: SweetCookies

    Definition Classes
    CookieContext
  48. def createI18n()(implicit locale: Locale = currentLocale.orNull[Locale]): I18n

    Creates skinny.

    Creates skinny.I18n instance for current locale.

    locale

    current locale

    returns

    i18n provider

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  49. def currentActionName: Option[Symbol]

    Returns action name for this request.

    Returns action name for this request.

    returns

    action name

    Definition Classes
    ActionDefinitionFeature
  50. def currentLocale: Option[Locale]

    Returns current locale for this request.

    Returns current locale for this request.

    returns

    current locale

    Attributes
    protected
    Definition Classes
    LocaleFeature
  51. def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  52. def debug(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  53. def defaultAcceptedFormats: List[Symbol]

    Definition Classes
    ApiFormats
  54. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  55. def defaultFormat: Symbol

    Definition Classes
    ApiFormats
  56. def defaultLocale: Option[Locale]

    Returns default locale.

    Returns default locale.

    Attributes
    protected
    Definition Classes
    LocaleFeature
  57. implicit def defaultStringToSeq[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  58. def delete(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  60. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

    Definition Classes
    ServletApiImplicits
  62. implicit def enrichServletContext(servletContext: javax.servlet.ServletContext): RichServletContext

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

    Definition Classes
    ServletApiImplicits
  64. def environment: String

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

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

    Definition Classes
    AnyRef → Any
  67. def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  68. def error(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  69. def error(handler: ErrorHandler): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  70. var errorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ScalatraBase
  71. def errorMessages: Seq[String]

    Returns erorrMessages in the RequestScope.

    Returns erorrMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  72. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    SkinnyScalatraBase → ScalatraBase
  73. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  74. def format(implicit request: HttpServletRequest): String

    Definition Classes
    ApiFormats
  75. def formatForMimeTypes(mimeTypes: String*): Option[String]

    Attributes
    protected
    Definition Classes
    ApiFormats
  76. def format_=(formatValue: String): Unit

    Definition Classes
    ScalatraContext
  77. def format_=(formatValue: Symbol): Unit

    Definition Classes
    ScalatraContext
  78. val formats: Map[String, String]

    Definition Classes
    ApiFormats
  79. def fromJSONString[A](json: String, underscoreKeys: Boolean = false)(implicit mf: Manifest[A]): Option[A]

    Extracts a value from JSON string.

    Extracts a value from JSON string. NOTE: When you convert to Map objects, be aware that underscoreKeys is false by default.

    A

    type

    json

    json string

    returns

    value

    Definition Classes
    JSONStringOps
  80. def fromJValue[T](json: JValue)(implicit reader: Reader[T]): T

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

    Definition Classes
    ScalatraBase
  82. def get(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  83. final def getClass(): Class[_]

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

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

    Definition Classes
    Control
  86. def haltWithBody[A](httpStatus: Int)(implicit format: Format = Format.HTML): A

    Halts with body which responds to the specified format.

    Halts with body which responds to the specified format.

    A

    response type

    httpStatus

    http status

    format

    format (HTML,JSON,XML...)

    returns

    body if possible

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  87. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Definition Classes
    ScalatraBase → Handler
  88. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  89. def inferFromFormats: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats
  90. def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  91. def info(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  92. def initParameter(name: String): Option[String]

    Definition Classes
    ScalatraBase
  93. def initialize(config: ConfigT): Unit

    Definition Classes
    ScalatraBase → Initializable
  94. def initializeRequestScopeAttributes: Any

    Definition Classes
    RequestScopeFeature
  95. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Attributes
    protected
    Definition Classes
    JsonSupport → ScalatraBase
  96. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  97. def isDebugEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  98. def isDevelopment(): Boolean

    Predicates current env is "development" or "dev".

    Predicates current env is "development" or "dev".

    returns

    true/false

    Definition Classes
    EnvFeature
  99. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraBase
  100. def isErrorEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  101. def isHttps(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  102. def isInfoEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  103. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  104. def isProduction(): Boolean

    Predicates current env is "production" or "prod".

    Predicates current env is "production" or "prod".

    returns

    true/false

    Definition Classes
    EnvFeature
  105. def isStaging(): Boolean

    Predicates current env is "staging" or "qa".

    Predicates current env is "staging" or "qa".

    returns

    true/false

    Definition Classes
    EnvFeature
  106. def isTest(): Boolean

    Predicates current env is "test".

    Predicates current env is "test".

    returns

    true/false

    Definition Classes
    EnvFeature
  107. def isTraceEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  108. def isWarnEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  109. implicit val jsonFormats: Formats

    JSON format support implicitly.

    JSON format support implicitly.

    Attributes
    protected
    Definition Classes
    JSONStringOps
  110. lazy val jsonVulnerabilityGuard: Boolean

    Attributes
    protected
    Definition Classes
    JsonOutput
  111. def jsonpCallbackParameterNames: Iterable[String]

    Definition Classes
    JsonOutput
  112. def keyAndErrorMessages: Map[String, Seq[String]]

    Returns keyAndErrorMessages in the RequestScope.

    Returns keyAndErrorMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  113. def logger: Logger

    Attributes
    protected
    Definition Classes
    Logging
  114. def loggerName: String

    Attributes
    protected
    Definition Classes
    Logging
  115. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Any, T]

    Definition Classes
    LowestPriorityImplicitConversions
  116. def mapper: ObjectMapper

    Definition Classes
    JsonMethods
  117. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  118. val mimeTypes: Map[String, String]

    Definition Classes
    ApiFormats
  119. def mount(ctx: ServletContext): Unit

    Definition Classes
    RichRouteFeature
  120. def multiParams(implicit request: HttpServletRequest): org.scalatra.MultiParams

    Definition Classes
    ScalatraBase
  121. def multiParams(key: String)(implicit request: HttpServletRequest): Seq[String]

    Definition Classes
    ScalatraBase
  122. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  123. def needsHttps: Boolean

    Attributes
    protected
    Definition Classes
    ScalatraBase
  124. def notFound(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  125. final def notify(): Unit

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  128. def params(implicit request: HttpServletRequest): org.scalatra.Params

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

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

    Definition Classes
    ScalatraBase
  131. def parse(in: JsonInput, useBigDecimalForDouble: Boolean): JValue

    Definition Classes
    JsonMethods → JsonMethods
  132. def parseOpt(in: JsonInput, useBigDecimalForDouble: Boolean): Option[JValue]

    Definition Classes
    JsonMethods → JsonMethods
  133. def parseRequestBody(format: String)(implicit request: HttpServletRequest): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  134. def parsedBody(implicit request: HttpServletRequest): JValue

    Definition Classes
    JsonSupport
  135. def pass(): Nothing

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

    Definition Classes
    ScalatraBase → CoreDsl
  137. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  138. def post(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  139. def prefixForJSONVulnerabilityProtection: String

    the prefix for JSON Vulnerability Protection.

    the prefix for JSON Vulnerability Protection. see: https://docs.angularjs.org/api/ng/service/$http

    Attributes
    protected
    Definition Classes
    JSONStringOps
  140. def pretty(d: JValue): String

    Definition Classes
    JsonMethods → JsonMethods
  141. def put(transformers: (Route) ⇒ Route*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  142. def readJsonFromBody(bd: String): JValue

    Attributes
    protected
    Definition Classes
    JacksonJsonSupport → JsonSupport
  143. def readJsonFromStream(stream: InputStream): JValue

    Attributes
    protected
    Definition Classes
    JacksonJsonSupport → JsonSupport
  144. def readXmlFromBody(bd: String): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  145. def readXmlFromStream(stream: InputStream): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  146. def redirect(uri: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Nothing

    Definition Classes
    ScalatraBase
  147. def redirect301(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

    Responds as "301 Moved Permanently"

    Responds as "301 Moved Permanently"

    returns

    ActionResult

    Definition Classes
    ExplicitRedirectFeature
  148. def redirect302(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

    Responds as "302 Found"

    Responds as "302 Found"

    returns

    ActionResult

    Definition Classes
    ExplicitRedirectFeature
  149. def redirect303(location: String, headers: Map[String, String] = Map.empty, reason: String = ""): ActionResult

    Responds as "303 See Other"

    Responds as "303 See Other"

    returns

    ActionResult

    Definition Classes
    ExplicitRedirectFeature
  150. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  151. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ScalatraBase
  152. def removeRoute(method: String, route: Route): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  154. def render(value: JValue): JValue

    Definition Classes
    JsonMethods → JsonMethods
  155. def renderHaltException(e: HaltException): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  156. def renderPipeline: RenderPipeline

    Attributes
    protected
    Definition Classes
    JValueResult → ScalatraBase
  157. def renderResponse(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  158. def renderResponseBody(actionResult: Any): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  159. def renderWithFormat(entity: Any)(implicit format: Format = Format.HTML): String

    Renders body which responds to the specified format (JSON, XML) if possible.

    Renders body which responds to the specified format (JSON, XML) if possible.

    entity

    entity

    format

    format (HTML,JSON,XML...)

    returns

    body if possible

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  160. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope
  161. def requestScope[A](key: String): Option[A]

    Fetches value from request scope.

    Fetches value from request scope.

    A

    type

    key

    key

    returns

    value if exists

    Definition Classes
    RequestScopeFeature
  162. def requestScope(keyAndValues: Seq[(String, Any)]): RequestScopeFeature

    Set attributes to request scope.

    Set attributes to request scope.

    keyAndValues

    collection of key and value.

    returns

    self

    Definition Classes
    RequestScopeFeature
  163. def requestScope(keyAndValue: (String, Any)): RequestScopeFeature

    Set attribute to request scope.

    Set attribute to request scope.

    keyAndValue

    key and value

    returns

    self

    Definition Classes
    RequestScopeFeature
  164. def requestScope(): Map[String, Any]

    Returns whole request scope attributes.

    Returns whole request scope attributes.

    returns

    whole attributes

    Definition Classes
    RequestScopeFeature
  165. def respondTo: Seq[Format]

    Defines formats to be respond.

    Defines formats to be respond. By default, HTML, JSON, XML are available.

    returns

    formats

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  166. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope
  167. def responseAsJSON(entity: Any, charset: Option[String] = Some("utf-8"), prettify: Boolean = false, underscoreKeys: Boolean = useUnderscoreKeysForJSON)(implicit scalatraContext: ScalatraContext): String

    Returns JSON response.

    Returns JSON response.

    entity

    entity

    charset

    charset

    prettify

    prettify if true

    returns

    body

    Definition Classes
    JSONFeature
  168. def responseFormat(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ApiFormats
  169. lazy val routes: RouteRegistry

    Definition Classes
    ScalatraBase
  170. def runFilters(filters: Traversable[Route]): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  172. implicit def safe[S, T](f: (S) ⇒ T): org.scalatra.util.conversion.TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  173. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): org.scalatra.util.conversion.TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  174. implicit def scalatraContext: ScalatraContext

    Attributes
    protected[this]
    Definition Classes
    ScalatraContext
  175. def sensitiveParameterNames: Seq[String]

    Returns registered sensitive parameter names.

    Returns registered sensitive parameter names.

    Attributes
    protected
    Definition Classes
    SensitiveParametersFeature
  176. implicit def seqHead[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Seq[String], T]

    Definition Classes
    DefaultImplicitConversions
  177. implicit def seqToSeq[T](implicit elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], mf: Manifest[T]): org.scalatra.util.conversion.TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  178. def serverHost(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraBase
  179. def serverPort(implicit request: HttpServletRequest): Int

    Definition Classes
    ScalatraBase
  180. def servletContext: javax.servlet.ServletContext

    Definition Classes
    ScalatraBase → ScalatraContext
  181. def session(key: Symbol)(implicit request: HttpServletRequest): Any

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

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

    Definition Classes
    SessionSupport
  184. def sessionLocaleKey: String

    Session key to store current locale string.

    Session key to store current locale string.

    returns

    key

    Definition Classes
    LocaleFeature
  185. def sessionOption(implicit request: HttpServletRequest): Option[HttpSession]

    Definition Classes
    SessionSupport
  186. def set(keyAndValues: Seq[(String, Any)]): RequestScopeFeature

    Set attributes to request scope.

    Set attributes to request scope.

    Definition Classes
    RequestScopeFeature
  187. def set(keyAndValue: (String, Any)): RequestScopeFeature

    Set attribute to request scope.

    Set attribute to request scope.

    Definition Classes
    RequestScopeFeature
  188. def setAsParams(model: Any): Unit

    Set params which is generated from a model object using Java reflection APIs.

    Set params which is generated from a model object using Java reflection APIs.

    model

    model instance

    Definition Classes
    RequestScopeFeature
  189. def setCurrentLocale(locale: String): Unit

    Set current locale.

    Set current locale.

    locale

    locale string

    Attributes
    protected
    Definition Classes
    LocaleFeature
  190. def setI18n()(implicit locale: Locale = currentLocale.orNull[Locale]): RequestScopeFeature

    Set {{skinny.

    Set {{skinny.I18n}} object for the current request to request scope.

    locale

    current locale

    returns

    self

    Definition Classes
    RequestScopeFeature
  191. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: org.scalatra.MultiParams)(implicit request: HttpServletRequest): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  192. def setParams(): Unit

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  193. def setParamsToRequestScope(): Unit

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  194. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  195. def skinnyEnv: Option[String]

    Env string value from "skinny.

    Env string value from "skinny.env" or "org.scalatra.environment".

    returns

    env string such as "production"

    Definition Classes
    EnvFeature
  196. lazy val skinnyErrorFilters: TrieMap[RenderingRequired, ErrorHandler]

    Registered error handlers.

    Registered error handlers.

    Attributes
    protected
    Definition Classes
    SkinnyFilterActivation
  197. implicit def skinnyValidatorSafe[S, T](f: (S) ⇒ T): ParamValueTypeConverter[S, T]

    Definition Classes
    ParametersGetAsImplicits
  198. implicit def skinnyValidatorSafeOption[S, T](f: (S) ⇒ Option[T]): ParamValueTypeConverter[S, T]

    Definition Classes
    ParametersGetAsImplicits
  199. implicit def skinnyValidatorSeqHead[T](implicit elementConverter: ParamValueTypeConverter[String, T], mf: Manifest[T]): ParamValueTypeConverter[Seq[String], T]

    Definition Classes
    ParametersGetAsImplicits
  200. implicit def skinnyValidatorSeqToSeq[T](implicit elementConverter: ParamValueTypeConverter[String, T], mf: Manifest[T]): ParamValueTypeConverter[Seq[String], Seq[T]]

    Definition Classes
    ParametersGetAsImplicits
  201. implicit val skinnyValidatorStringToBoolean: ParamValueTypeConverter[String, Boolean]

    Definition Classes
    ParametersGetAsImplicits
  202. implicit val skinnyValidatorStringToByte: ParamValueTypeConverter[String, Byte]

    Definition Classes
    ParametersGetAsImplicits
  203. def skinnyValidatorStringToDate(format: ⇒ String): ParamValueTypeConverter[String, Date]

    Definition Classes
    ParametersGetAsImplicits
  204. def skinnyValidatorStringToDateFormat(format: ⇒ DateFormat): ParamValueTypeConverter[String, Date]

    Definition Classes
    ParametersGetAsImplicits
  205. implicit val skinnyValidatorStringToDouble: ParamValueTypeConverter[String, Double]

    Definition Classes
    ParametersGetAsImplicits
  206. implicit val skinnyValidatorStringToFloat: ParamValueTypeConverter[String, Float]

    Definition Classes
    ParametersGetAsImplicits
  207. implicit val skinnyValidatorStringToInt: ParamValueTypeConverter[String, Int]

    Definition Classes
    ParametersGetAsImplicits
  208. implicit val skinnyValidatorStringToLong: ParamValueTypeConverter[String, Long]

    Definition Classes
    ParametersGetAsImplicits
  209. implicit val skinnyValidatorStringToSelf: ParamValueTypeConverter[String, String]

    Definition Classes
    ParametersGetAsImplicits
  210. def skinnyValidatorStringToSeq[T](elementConverter: ParamValueTypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): ParamValueTypeConverter[String, Seq[T]]

    Definition Classes
    ParametersGetAsImplicits
  211. implicit val skinnyValidatorStringToShort: ParamValueTypeConverter[String, Short]

    Definition Classes
    ParametersGetAsImplicits
  212. implicit def skinnyValidator_defaultStringToSeq[T](implicit elementConverter: ParamValueTypeConverter[String, T], mf: Manifest[T]): ParamValueTypeConverter[String, Seq[T]]

    Definition Classes
    ParametersGetAsImplicits
  213. def stackTraceDepthForTimeLogging: Int

    Attributes
    protected
    Definition Classes
    TimeLogging
  214. def status: Int

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

    Definition Classes
    ScalatraContext
  216. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  217. implicit val stringToBoolean: org.scalatra.util.conversion.TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicitConversions
  218. implicit val stringToByte: org.scalatra.util.conversion.TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicitConversions
  219. def stringToDate(format: ⇒ String): org.scalatra.util.conversion.TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  220. def stringToDateFormat(format: ⇒ DateFormat): org.scalatra.util.conversion.TypeConverter[String, Date]

    Definition Classes
    DefaultImplicitConversions
  221. implicit val stringToDouble: org.scalatra.util.conversion.TypeConverter[String, Double]

    Definition Classes
    DefaultImplicitConversions
  222. implicit val stringToFloat: org.scalatra.util.conversion.TypeConverter[String, Float]

    Definition Classes
    DefaultImplicitConversions
  223. implicit val stringToInt: org.scalatra.util.conversion.TypeConverter[String, Int]

    Definition Classes
    DefaultImplicitConversions
  224. implicit val stringToLong: org.scalatra.util.conversion.TypeConverter[String, Long]

    Definition Classes
    DefaultImplicitConversions
  225. implicit val stringToSelf: org.scalatra.util.conversion.TypeConverter[String, String]

    Definition Classes
    DefaultImplicitConversions
  226. def stringToSeq[T](elementConverter: org.scalatra.util.conversion.TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): org.scalatra.util.conversion.TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicitConversions
  227. implicit val stringToShort: org.scalatra.util.conversion.TypeConverter[String, Short]

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

    Definition Classes
    AnyRef
  229. def toJSON(v: Any): JValue

    Converts a value to JSON value.

    Converts a value to JSON value.

    v

    value

    returns

    JValue

    Definition Classes
    JSONStringOps
  230. def toJSONString(v: Any, underscoreKeys: Boolean = useUnderscoreKeysForJSON): String

    Converts a value to JSON string.

    Converts a value to JSON string.

    v

    value

    returns

    json string

    Definition Classes
    JSONStringOps
  231. def toPrettyJSONString(v: Any, underscoreKeys: Boolean = useUnderscoreKeysForJSON): String

    Converts a value to prettified JSON string.

    Converts a value to prettified JSON string.

    v

    value

    returns

    json string

    Definition Classes
    JSONStringOps
  232. def toSnakeCase(s: String): String

    Converts string value to snake_case'd value.

    Converts string value to snake_case'd value.

    s

    string value

    returns

    snake_case'd value

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  233. def toString(): String

    Definition Classes
    AnyRef → Any
  234. implicit def toTypedMultiParams(params: org.scalatra.MultiParams): TypedMultiParams

    Definition Classes
    ScalatraParamsImplicits
  235. implicit def toTypedParams(params: org.scalatra.Params): TypedParams

    Definition Classes
    ScalatraParamsImplicits
  236. def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  237. def trace(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  238. def transformRequestBody(body: JValue): JValue

    Attributes
    protected
    Definition Classes
    JsonSupport
  239. def transformResponseBody(body: JValue): JValue

    Attributes
    protected
    Definition Classes
    JsonOutput
  240. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  241. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    CoreDsl
  242. def url(route: Route, params: Map[String, String], splats: Iterable[String])(implicit req: HttpServletRequest): String

    Definition Classes
    UrlGeneratorSupport
  243. def url(route: Route, splat: String, moreSplats: String*)(implicit req: HttpServletRequest): String

    Definition Classes
    UrlGeneratorSupport
  244. def url(route: Route, params: (String, String)*)(implicit req: HttpServletRequest): String

    Definition Classes
    UrlGeneratorSupport
  245. 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

    Definition Classes
    SkinnyScalatraBase → ScalatraBase
  246. def useJSONVulnerabilityProtection: Boolean

    Use the prefix for JSON Vulnerability Protection.

    Use the prefix for JSON Vulnerability Protection. see: https://docs.angularjs.org/api/ng/service/$http

    Attributes
    protected
    Definition Classes
    JSONStringOps
  247. def useSnakeCasedParamKeys: Boolean

    Defines use snake_case'd keys.

    Defines use snake_case'd keys.

    returns

    true if use snake_case keys (default: false)

    Attributes
    protected
    Definition Classes
    SnakeCasedParamKeysFeature
  248. def useUnderscoreKeysForJSON: Boolean

    Default key policy.

    Default key policy.

    Attributes
    protected
    Definition Classes
    JSONStringOps
  249. def validation(params: controller.Params, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

    Creates new validation form.

    Creates new validation form.

    params

    params

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  250. def validationWithParams(validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

    Creates new validation form.

    Creates new validation form.

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  251. def validationWithParamsAndPrefix(prefix: String, params: controller.Params, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

    Creates new validation form.

    Creates new validation form.

    prefix

    key prefix for error message

    params

    params

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  252. def validationWithPrefix(params: controller.Params, prefix: String, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

    Creates new validation form.

    Creates new validation form.

    params

    params

    prefix

    key prefix for error message

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  253. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  256. def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  257. def warn(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  258. def warnElapsedTime[A](millis: Long, additionalLines: ⇒ Seq[String])(action: ⇒ A): A

    Definition Classes
    TimeLogging
  259. def warnElapsedTimeWithRequest[A](millis: Long, additionalLines: Seq[String] = Nil)(action: ⇒ A)(implicit context: ScalatraContext): A

    Definition Classes
    TimeLoggingFeature
  260. def withFormat[A](format: Format)(action: ⇒ A): A

    Provides code block with format.

    Provides code block with format. If absent, halt as status 406.

    A

    response type

    format

    format

    action

    action

    returns

    result

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  261. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  262. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  263. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    DynamicScope → RequestResponseScope
  264. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ApiFormats → ScalatraBase
  265. def writeJson(json: JValue, writer: Writer): Unit

    Attributes
    protected
    Definition Classes
    JacksonJsonOutput → JsonOutput
  266. def writeJsonAsXml(json: JValue, writer: Writer): Unit

    Attributes
    protected
    Definition Classes
    JsonOutput
  267. def xmlItemName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  268. def xmlRootName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  269. lazy val xmlRootNode: Elem

    Attributes
    protected
    Definition Classes
    JsonOutput

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: javax.servlet.ServletContext

    Definition Classes
    ScalatraBase
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) Use servletContext instead

  4. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

Inherited from SkinnyFilterActivation

Inherited from ParamsPermitImplicits

Inherited from ParametersGetAsImplicits

Inherited from RoutesAsImplicits

Inherited from ThreadLocalRequestFeature

Inherited from TimeLoggingFeature

Inherited from TimeLogging

Inherited from JSONFeature

Inherited from JSONStringOps

Inherited from JacksonJsonSupport

Inherited from JValueResult

Inherited from JacksonJsonOutput

Inherited from JsonMethods

Inherited from JsonSupport[JValue]

Inherited from JsonOutput[JValue]

Inherited from JsonMethods[JValue]

Inherited from ApiFormats

Inherited from ValidationFeature

Inherited from BeforeAfterActionFeature

Inherited from RequestScopeFeature

Inherited from logging.Logging

Inherited from LocaleFeature

Inherited from ActionDefinitionFeature

Inherited from ExplicitRedirectFeature

Inherited from UrlGeneratorSupport

Inherited from RichRouteFeature

Inherited from EnvFeature

Inherited from SkinnyScalatraBase

Inherited from ScalatraBase

Inherited from CookieSupport

Inherited from DefaultImplicitConversions

Inherited from LowPriorityImplicitConversions

Inherited from LowestPriorityImplicitConversions

Inherited from org.scalatra.util.conversion.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