skinny.controller

SkinnyApiController

trait SkinnyApiController extends SkinnyControllerBase with ScalatraFilter

SkinnyController as a Servlet for REST APIs.

NOTICE: If you'd like to disable Set-Cookie header for session id, configure in web.xml

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

    Definition Classes
    ScalatraFilter → ServletBase → Initializable
  3. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Definition Classes
    ScalatraParamsImplicits

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

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

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

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

    Definition Classes
    Any
  6. def acceptHeader(implicit request: HttpServletRequest): List[String]

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

    Attributes
    protected
    Definition Classes
    ApiFormats
  8. 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
  9. def addActionDefinition(actionDef: ActionDefinition): Unit

    Adds action definition

    Adds action definition

    actionDef

    action definition

    Definition Classes
    ActionDefinitionFeature
  10. def addMimeMapping(mime: String, extension: String): Unit

    Attributes
    protected
    Definition Classes
    ApiFormats
  11. 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
  12. def addRoute(method: HttpMethod, transformers: Seq[RouteTransformer], 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
  13. def addSessionId(uri: String)(implicit response: HttpServletResponse): String

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  16. 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
  17. 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
  18. implicit val anyToBoolean: org.scalatra.util.conversion.TypeConverter[Any, Boolean]

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

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

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

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

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

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

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

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

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

    Definition Classes
    JsonMethods
  28. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Definition Classes
    ScalatraBase → CoreDsl
  29. 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
  30. 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
  31. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Attributes
    protected
    Definition Classes
    ScalatraBase
  32. def cacheRequestBodyAsString: Boolean

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

    Default charset.

    Default charset.

    Definition Classes
    SkinnyControllerBase
  34. def clone(): AnyRef

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

    Returns JSON string value.

    Returns JSON string value.

    value

    value

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

    Definition Classes
    ScalatraBase
  37. implicit def configWrapper(config: ConfigT): Config { object initParameters }

    Attributes
    protected
    Definition Classes
    ServletBase → Initializable
  38. def contentType: String

    Definition Classes
    ScalatraContext
  39. def contentTypeInferrer: ContentTypeInferrer

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

    Definition Classes
    ScalatraContext
  41. def contextPath: String

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

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

    Definition Classes
    RoutesAsImplicits
  44. implicit def cookieOptions: CookieOptions

    Definition Classes
    CookieContext
  45. def cookies: SweetCookies

    Definition Classes
    CookieContext
  46. 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
  47. def currentActionName: Option[Symbol]

    Returns action name for this request.

    Returns action name for this request.

    returns

    action name

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

    Returns current locale for this request.

    Returns current locale for this request.

    returns

    current locale

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

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

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

    Definition Classes
    ApiFormats
  52. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    ScalatraBase
  53. def defaultFormat: Symbol

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

    Returns default locale.

    Returns default locale.

    Attributes
    protected
    Definition Classes
    LocaleFeature
  55. 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
  56. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  57. def destroy(): Unit

    Definition Classes
    ScalatraFilter → Filter
  58. def doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain): Unit

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  60. var doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    ScalatraFilter → ScalatraBase
  61. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

    Definition Classes
    ServletApiImplicits
  65. def environment: String

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

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

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

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  71. var errorHandler: ErrorHandler

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

    Returns erorrMessages in the RequestScope.

    Returns erorrMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  73. def executeRoutes(): Unit

    Attributes
    protected
    Definition Classes
    SkinnyScalatraBase → ScalatraBase
  74. def extractStatusCode(e: HaltException): Int

    Attributes
    protected
    Definition Classes
    ScalatraBase
  75. def filterChain: FilterChain

    Attributes
    protected
    Definition Classes
    ScalatraFilter
  76. def finalize(): Unit

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

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

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

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

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

    Definition Classes
    ApiFormats
  82. 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
  83. def fromJValue[T](json: JValue)(implicit reader: Reader[T]): T

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

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

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

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

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

    Definition Classes
    Control
  89. 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
  90. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

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

    Definition Classes
    AnyRef → Any
  92. def head(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    ScalatraBase → CoreDsl
  93. def inferFromFormats: ContentTypeInferrer

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

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

    Attributes
    protected
    Definition Classes
    Logging
  96. def init(filterConfig: FilterConfig): Unit

    Definition Classes
    ScalatraFilter → Filter
  97. def initParameter(name: String): Option[String]

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

    Definition Classes
    ScalatraBase → Initializable
  99. def initializeRequestScopeAttributes: Any

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  102. def isDebugEnabled: Boolean

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

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

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

    returns

    true/false

    Definition Classes
    EnvFeature
  104. def isDevelopmentMode: Boolean

    Definition Classes
    ScalatraBase
  105. def isErrorEnabled: Boolean

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  107. def isInfoEnabled: Boolean

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

    Definition Classes
    Any
  109. def isProduction(): Boolean

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

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

    returns

    true/false

    Definition Classes
    EnvFeature
  110. def isStaging(): Boolean

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

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

    returns

    true/false

    Definition Classes
    EnvFeature
  111. def isTest(): Boolean

    Predicates current env is "test".

    Predicates current env is "test".

    returns

    true/false

    Definition Classes
    EnvFeature
  112. def isTraceEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  113. def isWarnEnabled: Boolean

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

    JSON format support implicitly.

    JSON format support implicitly.

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

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

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

    Returns keyAndErrorMessages in the RequestScope.

    Returns keyAndErrorMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  118. def logger: Logger

    Attributes
    protected
    Definition Classes
    Logging
  119. def loggerName: String

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

    Definition Classes
    LowestPriorityImplicitConversions
  121. def mapper: ObjectMapper

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

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

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

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

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

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

    Definition Classes
    AnyRef
  128. def needsHttps: Boolean

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    JsonSupport
  140. def pass(): Nothing

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

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

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

    Definition Classes
    ScalatraBase → CoreDsl
  144. 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
  145. def pretty(d: JValue): String

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

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

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

    Attributes
    protected
    Definition Classes
    JsonSupport
  149. def readJsonFromStreamWithCharset(stream: InputStream, charset: String): JValue

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

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

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

    Definition Classes
    ScalatraBase
  153. 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
  154. 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
  155. 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
  156. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  162. def renderPipeline: RenderPipeline

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

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

    Attributes
    protected
    Definition Classes
    ScalatraBase
  165. def renderUncaughtException(e: Throwable)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Attributes
    protected
    Definition Classes
    ScalatraBase
  166. 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
  167. implicit def request: HttpServletRequest

    Definition Classes
    DynamicScope → RequestResponseScope
  168. def requestFormat(implicit request: HttpServletRequest): String

    Definition Classes
    ApiFormats
  169. def requestPath(implicit request: HttpServletRequest): String

    Definition Classes
    ScalatraFilter → ScalatraBase
  170. 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
  171. 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
  172. 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
  173. def requestScope(): Map[String, Any]

    Returns whole request scope attributes.

    Returns whole request scope attributes.

    returns

    whole attributes

    Definition Classes
    RequestScopeFeature
  174. 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
  175. implicit def response: HttpServletResponse

    Definition Classes
    DynamicScope → RequestResponseScope
  176. 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
  177. def routeBasePath(implicit request: HttpServletRequest): String

    Attributes
    protected
    Definition Classes
    ScalatraFilter → ScalatraBase
  178. lazy val routes: RouteRegistry

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

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

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

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

    Definition Classes
    TypeConverterSupport
  183. implicit def scalatraContext: ScalatraContext

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

    Returns registered sensitive parameter names.

    Returns registered sensitive parameter names.

    Attributes
    protected
    Definition Classes
    SensitiveParametersFeature
  185. 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
  186. 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
  187. def serverHost(implicit request: HttpServletRequest): String

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

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

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

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

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

    Definition Classes
    SessionSupport
  193. def sessionLocaleKey: String

    Session key to store current locale string.

    Session key to store current locale string.

    returns

    key

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

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

    Set attributes to request scope.

    Set attributes to request scope.

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

    Set attribute to request scope.

    Set attribute to request scope.

    Definition Classes
    RequestScopeFeature
  197. 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
  198. def setCurrentLocale(locale: String): Unit

    Set current locale.

    Set current locale.

    locale

    locale string

    Attributes
    protected
    Definition Classes
    LocaleFeature
  199. 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
  200. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: org.scalatra.MultiParams)(implicit request: HttpServletRequest): Unit

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

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  202. def setParamsToRequestScope(): Unit

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  203. def shouldParseBody(fmt: String)(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    JsonSupport
  204. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  205. 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
  206. implicit def skinnyValidatorSafe[S, T](f: (S) ⇒ T): ParamValueTypeConverter[S, T]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    ParametersGetAsImplicits
  222. def stackTraceDepthForTimeLogging: Int

    Attributes
    protected
    Definition Classes
    TimeLogging
  223. def status: Int

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    DefaultImplicitConversions
  235. 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
  236. implicit val stringToShort: org.scalatra.util.conversion.TypeConverter[String, Short]

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

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

    Converts a value to JSON value.

    Converts a value to JSON value.

    v

    value

    returns

    JValue

    Definition Classes
    JSONStringOps
  239. 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
  240. 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
  241. 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
  242. def toString(): String

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    UrlGeneratorSupport
  254. def url(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, absolutize: Boolean = true, withSessionId: Boolean = true)(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    SkinnyScalatraBase → ScalatraBase
  255. 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
  256. 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
  257. def useUnderscoreKeysForJSON: Boolean

    Default key policy.

    Default key policy.

    Attributes
    protected
    Definition Classes
    JSONStringOps
  258. def validation(params: 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
  259. 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
  260. def validationWithParamsAndPrefix(prefix: String, params: 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
  261. def validationWithPrefix(params: 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
  262. final def wait(): Unit

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

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

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

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

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

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

    Definition Classes
    TimeLoggingFeature
  269. 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
  270. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    JsonOutput
  276. def xmlItemName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  277. def xmlRootName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerBase
  278. 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 responseFormat(implicit request: HttpServletRequest, response: HttpServletResponse): String

    Definition Classes
    ApiFormats
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) format now means the same as responseFormat, responseFormat will be removed eventually

  5. def status(code: Int): Unit

    Definition Classes
    ScalatraContext
    Annotations
    @deprecated
    Deprecated

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

Inherited from ScalatraFilter

Inherited from ServletBase

Inherited from Filter

Inherited from SkinnyControllerBase

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