skinny.controller

SkinnyApiController

trait SkinnyApiController extends SkinnyControllerBase with SkinnyEngineFilter

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
SkinnyEngineFilter, SkinnyEngineFilterBase, Filter, SkinnyControllerBase, ThreadLocalFeatures, RoutingDsl, MainThreadLocalEverywhere, SkinnyControllerCommonBase, SkinnyFilterActivation, ParamsPermitImplicits, ParametersGetAsImplicits, RoutesAsImplicits, XContentTypeOptionsNosniffHeaderFeature, ThreadLocalRequestFeature, TimeLoggingFeature, SensitiveParametersFeature, TimeLogging, ValidationFeature, JSONFeature, EngineJSONStringOps, JSONStringOpsConfig, JSONStringOps, BeforeAfterActionFeature, ChunkedResponseFeature, RequestScopeFeature, LocaleFeature, SnakeCasedParamKeysFeature, BeforeAfterDsl, ActionDefinitionFeature, ExplicitRedirectFeature, UrlGeneratorSupport, FormParamsFeature, QueryParamsFeature, EnvFeature, ApiFormats, SkinnyEngineBase, SessionImplicits, DefaultImplicits, LowPriorityImplicits, LowestPriorityImplicits, engine.implicits.TypeConverterSupport, EngineParamsImplicits, CookiesImplicits, RouteMatcherImplicits, HaltPassControl, UrlGenerator, ResponseStatusAccessor, ResponseContentTypeAccessor, RequestFormatAccessor, ParamsAccessor, EnvironmentAccessor, ErrorHandlerAccessor, AsyncSupported, CoreHandler, Handler, logging.LoggerProvider, ServletContextAccessor, RicherStringImplicits, ServletApiImplicits, RouteRegistryAccessor, UnstableAccessValidationConfig, SkinnyEngineContextInitializer, Initializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SkinnyApiController
  2. SkinnyEngineFilter
  3. SkinnyEngineFilterBase
  4. Filter
  5. SkinnyControllerBase
  6. ThreadLocalFeatures
  7. RoutingDsl
  8. MainThreadLocalEverywhere
  9. SkinnyControllerCommonBase
  10. SkinnyFilterActivation
  11. ParamsPermitImplicits
  12. ParametersGetAsImplicits
  13. RoutesAsImplicits
  14. XContentTypeOptionsNosniffHeaderFeature
  15. ThreadLocalRequestFeature
  16. TimeLoggingFeature
  17. SensitiveParametersFeature
  18. TimeLogging
  19. ValidationFeature
  20. JSONFeature
  21. EngineJSONStringOps
  22. JSONStringOpsConfig
  23. JSONStringOps
  24. BeforeAfterActionFeature
  25. ChunkedResponseFeature
  26. RequestScopeFeature
  27. LocaleFeature
  28. SnakeCasedParamKeysFeature
  29. BeforeAfterDsl
  30. ActionDefinitionFeature
  31. ExplicitRedirectFeature
  32. UrlGeneratorSupport
  33. FormParamsFeature
  34. QueryParamsFeature
  35. EnvFeature
  36. ApiFormats
  37. SkinnyEngineBase
  38. SessionImplicits
  39. DefaultImplicits
  40. LowPriorityImplicits
  41. LowestPriorityImplicits
  42. TypeConverterSupport
  43. EngineParamsImplicits
  44. CookiesImplicits
  45. RouteMatcherImplicits
  46. HaltPassControl
  47. UrlGenerator
  48. ResponseStatusAccessor
  49. ResponseContentTypeAccessor
  50. RequestFormatAccessor
  51. ParamsAccessor
  52. EnvironmentAccessor
  53. ErrorHandlerAccessor
  54. AsyncSupported
  55. CoreHandler
  56. Handler
  57. LoggerProvider
  58. ServletContextAccessor
  59. RicherStringImplicits
  60. ServletApiImplicits
  61. RouteRegistryAccessor
  62. UnstableAccessValidationConfig
  63. SkinnyEngineContextInitializer
  64. Initializable
  65. AnyRef
  66. 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
    SkinnyEngineFilterBase → ServletContextAccessor → Initializable
  3. sealed trait RenderingRequired extends AnyRef

    Definition Classes
    SkinnyFilterActivation
  4. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    EngineParamsImplicits
  5. sealed class TypedParams extends AnyRef

    Definition Classes
    EngineParamsImplicits

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 controller.feature.SkinnyControllerCommonBase.RenderingRequired with Product with Serializable

    Definition Classes
    SkinnyFilterActivation
  7. object WithoutRendering extends controller.feature.SkinnyControllerCommonBase.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)(implicit ctx: SkinnyEngineContext = context): 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[RouteTransformer], action: ⇒ Any): Route

    Attributes
    protected
    Definition Classes
    RoutingDsl
  16. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Definition Classes
    BeforeAfterDsl
  17. 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
  18. 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
  19. implicit val anyToBoolean: engine.implicits.TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicits
  20. implicit val anyToByte: engine.implicits.TypeConverter[Any, Byte]

    Definition Classes
    LowPriorityImplicits
  21. implicit val anyToDouble: engine.implicits.TypeConverter[Any, Double]

    Definition Classes
    LowPriorityImplicits
  22. implicit val anyToFloat: engine.implicits.TypeConverter[Any, Float]

    Definition Classes
    LowPriorityImplicits
  23. implicit val anyToInt: engine.implicits.TypeConverter[Any, Int]

    Definition Classes
    LowPriorityImplicits
  24. implicit val anyToLong: engine.implicits.TypeConverter[Any, Long]

    Definition Classes
    LowPriorityImplicits
  25. implicit val anyToShort: engine.implicits.TypeConverter[Any, Short]

    Definition Classes
    LowPriorityImplicits
  26. implicit val anyToString: engine.implicits.TypeConverter[Any, String]

    Definition Classes
    LowPriorityImplicits
  27. final def asInstanceOf[T0]: T0

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

    Definition Classes
    JSONStringOps
  29. def before(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Definition Classes
    BeforeAfterDsl
  30. 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
  31. 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
  32. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

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

    Definition Classes
    SkinnyEngineBase
  34. def clone(): AnyRef

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

    Definition Classes
    JSONStringOps
  36. var config: ConfigT

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

    Attributes
    protected
    Definition Classes
    ServletContextAccessor → Initializable
  38. def contentType(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ResponseContentTypeAccessor
  39. def contentTypeInferrer: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats → SkinnyEngineBase
  40. def contentType_=(contentType: String)(implicit ctx: SkinnyEngineContext): Unit

    Definition Classes
    ResponseContentTypeAccessor
  41. def context: SkinnyEngineContext

    Definition Classes
    SkinnyEngineContextInitializer
  42. def contextPath: String

    Definition Classes
    ServletContextAccessor
  43. implicit def convertParamsToStrongParameters(params: engine.Params): StrongParameters

    Definition Classes
    ParamsPermitImplicits
  44. implicit def convertRouteToRichRoute(route: Route)(implicit controller: SkinnyControllerCommonBase): RichRoute

    Definition Classes
    RoutesAsImplicits
  45. implicit def cookieOptions(implicit ctx: SkinnyEngineContext): CookieOptions

    Definition Classes
    CookiesImplicits
  46. def cookies(implicit ctx: SkinnyEngineContext): SweetCookies

    Definition Classes
    CookiesImplicits
  47. def createI18n()(implicit locale: Locale = ...): I18n

    Creates skinny.

    Creates skinny.I18n instance for current locale.

    locale

    current locale

    returns

    i18n provider

    Attributes
    protected
    Definition Classes
    SkinnyControllerCommonBase
  48. def currentActionName(implicit cxt: SkinnyEngineContext = context): Option[Symbol]

    Returns action name for this request.

    Returns action name for this request.

    returns

    action name

    Definition Classes
    ActionDefinitionFeature
  49. def currentErrorHandler: ErrorHandler

    Attributes
    protected
    Definition Classes
    ErrorHandlerAccessor
  50. def currentLocale(implicit ctx: SkinnyEngineContext): Option[Locale]

    Returns current locale for this request.

    Returns current locale for this request.

    returns

    current locale

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

    Definition Classes
    ApiFormats
  52. val defaultCharacterEncoding: String

    Attributes
    protected
    Definition Classes
    CoreHandler
  53. def defaultFormat: Symbol

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

    Returns default locale.

    Returns default locale.

    Attributes
    protected
    Definition Classes
    LocaleFeature
  55. def defaultObjectMapper: ObjectMapper

    Definition Classes
    JSONStringOps
  56. implicit def defaultStringToSeq[T](implicit elementConverter: engine.implicits.TypeConverter[String, T], mf: Manifest[T]): engine.implicits.TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicits
  57. def delete(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    RoutingDsl
  58. def destroy(): Unit

    Definition Classes
    SkinnyEngineFilterBase
  59. def detectTooManyErrorFilterRegistrationAsAnErrorAtSkinnyEngineBase: Boolean

    Attributes
    protected
    Definition Classes
    ErrorHandlerAccessor
  60. def doFilter(request: ServletRequest, response: ServletResponse, chain: FilterChain): Unit

    Definition Classes
    SkinnyEngineFilterBase
  61. var doNotFound: () ⇒ Any

    Attributes
    protected
    Definition Classes
    SkinnyEngineFilterBase → SkinnyEngineBase
  62. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

    Definition Classes
    ServletApiImplicits
  65. implicit def enrichSession(session: HttpSession): RichHttpServletSession

    Definition Classes
    ServletApiImplicits
  66. def environment: String

    Definition Classes
    EnvironmentAccessor
  67. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    ErrorHandlerAccessor
  70. def errorMessages(implicit ctx: SkinnyEngineContext = context): Seq[String]

    Returns errorMessages in the RequestScope.

    Returns errorMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  71. def executeRoutes(request: HttpServletRequest, response: HttpServletResponse): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase → CoreHandler
  72. implicit def executionContext: ExecutionContext

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  73. def extractStatusCode(e: HaltException): Int

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  74. def filterChain: FilterChain

    Attributes
    protected
    Definition Classes
    SkinnyEngineFilterBase
  75. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  76. def formMultiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

    Returns query string multi parameters as a Map value.

    Returns query string multi parameters as a Map value.

    Definition Classes
    FormParamsFeature
  77. def formParams(implicit ctx: SkinnyEngineContext): engine.Params

    Returns query string parameters as a Map value.

    Returns query string parameters as a Map value.

    Definition Classes
    FormParamsFeature
  78. def format(implicit ctx: SkinnyEngineContext): String

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

    Attributes
    protected
    Definition Classes
    ApiFormats
  80. def format_=(formatValue: String)(implicit ctx: SkinnyEngineContext): Unit

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

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

    Definition Classes
    JSONStringOps
  83. def fromJSONStringAsIs[A](json: String)(implicit mf: Manifest[A]): Option[A]

    Definition Classes
    JSONStringOps
  84. def fromJSONStringToJValue(json: String, underscoreKeys: Boolean, asIs: Boolean): Option[JValue]

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

    Definition Classes
    JSONStringOps
  86. def fullUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, withSessionId: Boolean)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGenerator
  87. def get(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    RoutingDsl
  88. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  89. def getFromRequestScope[A](key: String)(implicit ctx: SkinnyEngineContext = context): Option[A]

    Fetches value from request scope.

    Fetches value from request scope.

    A

    type

    key

    key

    returns

    value if exists

    Definition Classes
    RequestScopeFeature
  90. def halt(result: ActionResult): Nothing

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

    Definition Classes
    HaltPassControl
  92. def haltWithBody[A](httpStatus: Int)(implicit ctx: SkinnyEngineContext, format: engine.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
    SkinnyControllerCommonBase
  93. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Definition Classes
    CoreHandler → Handler
  94. def hashCode(): Int

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

    Definition Classes
    RoutingDsl
  96. def inferFromFormats: ContentTypeInferrer

    Attributes
    protected
    Definition Classes
    ApiFormats
  97. def init(filterConfig: FilterConfig): Unit

    Definition Classes
    SkinnyEngineFilterBase
  98. def initParameter(name: String): Option[String]

    Definition Classes
    ServletContextAccessor
  99. def initialize(config: ConfigT): Unit

    Definition Classes
    ServletContextAccessor → Initializable
  100. def initializeRequestScopeAttributes(implicit ctx: SkinnyEngineContext = context): Any

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

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  102. def isAsyncExecutable(result: Any): Boolean

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  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

    Replaces Scalatra's development mode with SkinnyEnv.

    Replaces Scalatra's development mode with SkinnyEnv.

    Definition Classes
    EnvFeature → EnvironmentAccessor
  105. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  106. def isProduction(): Boolean

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

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

    returns

    true/false

    Definition Classes
    EnvFeature
  107. def isStaging(): Boolean

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

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

    returns

    true/false

    Definition Classes
    EnvFeature
  108. def isTest(): Boolean

    Predicates current env is "test".

    Predicates current env is "test".

    returns

    true/false

    Definition Classes
    EnvFeature
  109. implicit val jsonFormats: Formats

    Attributes
    protected
    Definition Classes
    JSONStringOpsConfig
  110. def keyAndErrorMessages(implicit ctx: SkinnyEngineContext = context): Map[String, Seq[String]]

    Returns keyAndErrorMessages in the RequestScope.

    Returns keyAndErrorMessages in the RequestScope.

    Definition Classes
    RequestScopeFeature
  111. def logger: Logger

    Attributes
    protected
    Definition Classes
    LoggerProvider
  112. def loggerName: String

    Attributes
    protected
    Definition Classes
    LoggerProvider
  113. implicit def lowestPriorityAny2T[T](implicit arg0: Manifest[T]): engine.implicits.TypeConverter[Any, T]

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

    Definition Classes
    SkinnyEngineBase
  115. val mimeTypes: Map[String, String]

    Definition Classes
    ApiFormats
  116. def mount(ctx: javax.servlet.ServletContext): Unit

    Definition Classes
    Handler
  117. def multiParams(key: String)(implicit ctx: SkinnyEngineContext): Seq[String]

    Definition Classes
    ParamsAccessor
  118. def multiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

    Definition Classes
    ParamsAccessor
  119. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    SkinnyEngineBase
  121. final def notify(): Unit

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

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

    Definition Classes
    RoutingDsl
  124. def params(implicit ctx: SkinnyEngineContext): engine.Params

    Definition Classes
    ParamsAccessor
  125. def params(key: Symbol)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ParamsAccessor
  126. def params(key: String)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ParamsAccessor
  127. def pass(): Nothing

    Definition Classes
    HaltPassControl
  128. def patch(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    RoutingDsl
  129. implicit def pathPatternParser2RouteMatcher(pattern: PathPattern): RouteMatcher

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

    Definition Classes
    RoutingDsl
  131. def prefixForJSONVulnerabilityProtection: String

    Attributes
    protected
    Definition Classes
    JSONStringOpsConfig
  132. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    RoutingDsl
  133. def queryMultiParams(implicit ctx: SkinnyEngineContext): engine.MultiParams

    Returns query string multi parameters as a Map value.

    Returns query string multi parameters as a Map value.

    Definition Classes
    QueryParamsFeature
  134. def queryParams(implicit ctx: SkinnyEngineContext): engine.Params

    Returns query string parameters as a Map value.

    Returns query string parameters as a Map value.

    Definition Classes
    QueryParamsFeature
  135. def redirect(uri: String)(implicit ctx: SkinnyEngineContext): Nothing

    Definition Classes
    SkinnyEngineBase
  136. def redirect301(location: String, headers: Map[String, String] = Map.empty, reason: String = "")(implicit ctx: SkinnyEngineContext = context): ActionResult

    Responds as "301 Moved Permanently"

    Responds as "301 Moved Permanently"

    returns

    ActionResult

    Definition Classes
    ExplicitRedirectFeature
  137. def redirect302(location: String, headers: Map[String, String] = Map.empty, reason: String = "")(implicit ctx: SkinnyEngineContext = context): ActionResult

    Responds as "302 Found"

    Responds as "302 Found"

    returns

    ActionResult

    Definition Classes
    ExplicitRedirectFeature
  138. def redirect303(location: String, headers: Map[String, String] = Map.empty, reason: String = "")(implicit ctx: SkinnyEngineContext = context): ActionResult

    Responds as "303 See Other"

    Responds as "303 See Other"

    returns

    ActionResult

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

    Attributes
    protected
    Definition Classes
    RouteMatcherImplicits
  140. def relativeUrl(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGenerator
  141. def removeRoute(method: String, route: Route): Unit

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

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  143. def renderHaltException(e: HaltException)(implicit ctx: SkinnyEngineContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  144. def renderPipeline(implicit ctx: SkinnyEngineContext): RenderPipeline

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  145. def renderResponse(actionResult: Any)(implicit ctx: SkinnyEngineContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  146. def renderResponseBody(actionResult: Any)(implicit ctx: SkinnyEngineContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  147. def renderUncaughtException(e: Throwable)(implicit ctx: SkinnyEngineContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  148. def renderWithFormat(entity: Any)(implicit format: engine.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
    SkinnyControllerCommonBase
  149. def request(implicit ctx: SkinnyEngineContext): HttpServletRequest

    Definition Classes
    SkinnyEngineContextInitializer
  150. def requestFormat(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ApiFormats
  151. def requestPath(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    SkinnyEngineFilterBase → SkinnyEngineBase
  152. def requestScope(keyAndValues: Seq[(String, Any)])(implicit ctx: SkinnyEngineContext): RequestScopeFeature

    Set attributes to request scope.

    Set attributes to request scope.

    keyAndValues

    collection of key and value.

    returns

    self

    Definition Classes
    RequestScopeFeature
  153. def requestScope(keyAndValue: (String, Any))(implicit ctx: SkinnyEngineContext): RequestScopeFeature

    Set attribute to request scope.

    Set attribute to request scope.

    keyAndValue

    key and value

    returns

    self

    Definition Classes
    RequestScopeFeature
  154. def requestScope(implicit ctx: SkinnyEngineContext = context): Map[String, Any]

    Returns whole request scope attributes.

    Returns whole request scope attributes.

    returns

    whole attributes

    Definition Classes
    RequestScopeFeature
  155. def respondTo: Seq[engine.Format]

    Attributes
    protected
    Definition Classes
    Handler
  156. def response(implicit ctx: SkinnyEngineContext): HttpServletResponse

    Definition Classes
    SkinnyEngineContextInitializer
  157. def responseAsJSON(entity: Any, charset: Option[String], prettify: Boolean, underscoreKeys: Boolean)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    EngineJSONStringOps
  158. def routeBasePath(implicit ctx: SkinnyEngineContext): String

    Attributes
    protected
    Definition Classes
    SkinnyEngineFilterBase → SkinnyEngineBase
  159. val routes: RouteRegistry

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

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  161. implicit def safe[S, T](f: (S) ⇒ T): engine.implicits.TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  162. implicit def safeOption[S, T](f: (S) ⇒ Option[T]): engine.implicits.TypeConverter[S, T]

    Definition Classes
    TypeConverterSupport
  163. def sensitiveParameterNames: Seq[String]

    Returns registered sensitive parameter names.

    Returns registered sensitive parameter names.

    Attributes
    protected
    Definition Classes
    SensitiveParametersFeature
  164. implicit def seqHead[T](implicit elementConverter: engine.implicits.TypeConverter[String, T], mf: Manifest[T]): engine.implicits.TypeConverter[Seq[String], T]

    Definition Classes
    DefaultImplicits
  165. implicit def seqToSeq[T](implicit elementConverter: engine.implicits.TypeConverter[String, T], mf: Manifest[T]): engine.implicits.TypeConverter[Seq[String], Seq[T]]

    Definition Classes
    DefaultImplicits
  166. def serverAuthority(implicit ctx: SkinnyEngineContext): String

    Attributes
    protected
    Definition Classes
    ServletContextAccessor
  167. def serverHost(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ServletContextAccessor
  168. def serverPort(implicit ctx: SkinnyEngineContext): Int

    Definition Classes
    ServletContextAccessor
  169. implicit def servletContext: javax.servlet.ServletContext

    Definition Classes
    ServletContextAccessor
  170. def session(key: Symbol)(implicit ctx: SkinnyEngineContext): Any

    Definition Classes
    SessionImplicits
  171. def session(key: String)(implicit ctx: SkinnyEngineContext): Any

    Definition Classes
    SessionImplicits
  172. implicit def session(implicit ctx: SkinnyEngineContext): HttpSession

    Definition Classes
    SessionImplicits
  173. def sessionLocaleKey: String

    Session key to store current locale string.

    Session key to store current locale string.

    returns

    key

    Definition Classes
    LocaleFeature
  174. def sessionOption(implicit ctx: SkinnyEngineContext): Option[HttpSession]

    Definition Classes
    SessionImplicits
  175. def set(keyAndValues: Seq[(String, Any)])(implicit ctx: SkinnyEngineContext): RequestScopeFeature

    Set attributes to request scope.

    Set attributes to request scope.

    Definition Classes
    RequestScopeFeature
  176. def set(keyAndValue: (String, Any))(implicit ctx: SkinnyEngineContext): RequestScopeFeature

    Set attribute to request scope.

    Set attribute to request scope.

    Definition Classes
    RequestScopeFeature
  177. def setAsParams(model: Any)(implicit ctx: SkinnyEngineContext = context): 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
  178. def setContentTypeIfAbsent()(implicit format: engine.Format = Format.HTML): Unit

    Set Content-Type for the format if absent.

    Set Content-Type for the format if absent.

    format

    format

    Attributes
    protected
    Definition Classes
    SkinnyControllerCommonBase
  179. def setCurrentLocale(locale: String)(implicit ctx: SkinnyEngineContext): Unit

    Set current locale.

    Set current locale.

    locale

    locale string

    Attributes
    protected
    Definition Classes
    LocaleFeature
  180. def setI18n(implicit ctx: SkinnyEngineContext = context): RequestScopeFeature

    Set {{skinny.

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

    ctx

    context

    returns

    self

    Definition Classes
    RequestScopeFeature
  181. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: engine.MultiParams)(implicit ctx: SkinnyEngineContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyEngineBase
  182. def setParams(implicit ctx: SkinnyEngineContext = context): Unit

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  183. def setParamsToRequestScope(implicit ctx: SkinnyEngineContext = context): Unit

    Set params to request scope.

    Set params to request scope.

    Definition Classes
    RequestScopeFeature
  184. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  185. implicit def skinnyEngineContext(implicit ctx: javax.servlet.ServletContext): SkinnyEngineContext

    Definition Classes
    MainThreadLocalEverywhere → SkinnyEngineContextInitializer
  186. 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
  187. lazy val skinnyErrorFilters: TrieMap[RenderingRequired, Seq[ErrorHandler]]

    Registered error handlers.

    Registered error handlers.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    ParametersGetAsImplicits
  204. def stackTraceDepthForTimeLogging: Int

    Attributes
    protected
    Definition Classes
    TimeLogging
  205. def status(implicit ctx: SkinnyEngineContext): Int

    Definition Classes
    ResponseStatusAccessor
  206. def status_=(code: Int)(implicit ctx: SkinnyEngineContext): Unit

    Definition Classes
    ResponseStatusAccessor
  207. implicit def string2RouteMatcher(path: String): RouteMatcher

    Attributes
    protected
    Definition Classes
    RouteMatcherImplicits
  208. implicit val stringToBoolean: engine.implicits.TypeConverter[String, Boolean]

    Definition Classes
    DefaultImplicits
  209. implicit val stringToByte: engine.implicits.TypeConverter[String, Byte]

    Definition Classes
    DefaultImplicits
  210. def stringToDate(format: ⇒ String): engine.implicits.TypeConverter[String, Date]

    Definition Classes
    DefaultImplicits
  211. def stringToDateFormat(format: ⇒ DateFormat): engine.implicits.TypeConverter[String, Date]

    Definition Classes
    DefaultImplicits
  212. implicit val stringToDouble: engine.implicits.TypeConverter[String, Double]

    Definition Classes
    DefaultImplicits
  213. implicit val stringToFloat: engine.implicits.TypeConverter[String, Float]

    Definition Classes
    DefaultImplicits
  214. implicit val stringToInt: engine.implicits.TypeConverter[String, Int]

    Definition Classes
    DefaultImplicits
  215. implicit val stringToLong: engine.implicits.TypeConverter[String, Long]

    Definition Classes
    DefaultImplicits
  216. implicit def stringToRicherString(s: String): RicherString

    Definition Classes
    RicherStringImplicits
  217. implicit val stringToSelf: engine.implicits.TypeConverter[String, String]

    Definition Classes
    DefaultImplicits
  218. def stringToSeq[T](elementConverter: engine.implicits.TypeConverter[String, T], separator: String)(implicit arg0: Manifest[T]): engine.implicits.TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicits
  219. implicit val stringToShort: engine.implicits.TypeConverter[String, Short]

    Definition Classes
    DefaultImplicits
  220. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Definition Classes
    JSONStringOps
  222. def toJSONString(v: Any, underscoreKeys: Boolean): String

    Definition Classes
    JSONStringOps
  223. def toJSONStringAsIs(v: Any): String

    Definition Classes
    JSONStringOps
  224. def toPrettyJSONString(v: Any, underscoreKeys: Boolean): String

    Definition Classes
    JSONStringOps
  225. def toPrettyJSONStringAsIs(v: Any): String

    Definition Classes
    JSONStringOps
  226. 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
    SkinnyControllerCommonBase
  227. def toString(): String

    Definition Classes
    AnyRef → Any
  228. implicit def toTypedMultiParams(params: engine.MultiParams): TypedMultiParams

    Definition Classes
    EngineParamsImplicits
  229. implicit def toTypedParams(params: engine.Params): TypedParams

    Definition Classes
    EngineParamsImplicits
  230. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    RoutingDsl
  231. def trap(codes: Range)(block: ⇒ Any): Unit

    Definition Classes
    RoutingDsl
  232. def unstableAccessValidationEnabled: Boolean

    Attributes
    protected
    Definition Classes
    UnstableAccessValidationConfig
  233. def url(route: Route, params: Map[String, String], splats: Iterable[String])(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGeneratorSupport
  234. def url(route: Route, splat: String, moreSplats: String*)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGeneratorSupport
  235. def url(route: Route, params: (String, String)*)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGeneratorSupport
  236. def url(path: String, params: Iterable[(String, Any)], includeContextPath: Boolean, includeServletPath: Boolean, absolutize: Boolean, withSessionId: Boolean)(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    UrlGenerator
  237. def useJSONVulnerabilityProtection: Boolean

    Attributes
    protected
    Definition Classes
    JSONStringOpsConfig
  238. 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
  239. def useUnderscoreKeysForJSON: Boolean

    Attributes
    protected
    Definition Classes
    JSONStringOpsConfig
  240. def validation(params: Params, validations: NewValidation*)(implicit locale: Locale = ...): MapValidator

    Creates new validation form.

    Creates new validation form.

    params

    params

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  241. def validationWithParams(validations: NewValidation*)(implicit locale: Locale = ...): MapValidator

    Creates new validation form.

    Creates new validation form.

    validations

    validations

    locale

    current locale

    returns

    validator

    Definition Classes
    ValidationFeature
  242. def validationWithParamsAndPrefix(prefix: String, params: Params, validations: NewValidation*)(implicit locale: 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
  243. def validationWithPrefix(params: Params, prefix: String, validations: NewValidation*)(implicit ctx: SkinnyEngineContext): MapValidator

    Creates new validation form.

    Creates new validation form.

    params

    params

    prefix

    key prefix for error message

    validations

    validations

    returns

    validator

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  247. def warnElapsedTime[A](millis: Long, additionalLines: ⇒ Seq[String])(action: ⇒ A): A

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

    Definition Classes
    TimeLoggingFeature
  249. def withFormat[A](format: engine.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
    SkinnyControllerCommonBase
  250. def withOutputStream(f: (ServletOutputStream) ⇒ Unit): Unit

    Definition Classes
    ChunkedResponseFeature
  251. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    SkinnyEngineContextInitializer
  252. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    SkinnyEngineContextInitializer
  253. def withResponse[A](response: HttpServletResponse)(f: ⇒ A): A

    Attributes
    protected
    Definition Classes
    SkinnyEngineContextInitializer
  254. def withRouteMultiParams[S](matchedRoute: Option[MatchedRoute])(thunk: ⇒ S): S

    Attributes
    protected
    Definition Classes
    ApiFormats → SkinnyEngineBase
  255. def writeChunk(chunk: Array[Byte])(implicit stream: ServletOutputStream = response.getOutputStream): Unit

    Definition Classes
    ChunkedResponseFeature
  256. def xmlItemName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerCommonBase
  257. def xmlRootName: String

    Attributes
    protected
    Definition Classes
    SkinnyControllerCommonBase

Deprecated Value Members

  1. def responseFormat(implicit ctx: SkinnyEngineContext): String

    Definition Classes
    ApiFormats
    Annotations
    @deprecated
    Deprecated

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

Inherited from SkinnyEngineFilter

Inherited from SkinnyEngineFilterBase

Inherited from Filter

Inherited from SkinnyControllerBase

Inherited from ThreadLocalFeatures

Inherited from RoutingDsl

Inherited from MainThreadLocalEverywhere

Inherited from SkinnyFilterActivation

Inherited from ParamsPermitImplicits

Inherited from ParametersGetAsImplicits

Inherited from RoutesAsImplicits

Inherited from ThreadLocalRequestFeature

Inherited from TimeLoggingFeature

Inherited from TimeLogging

Inherited from ValidationFeature

Inherited from JSONFeature

Inherited from EngineJSONStringOps

Inherited from JSONStringOpsConfig

Inherited from JSONStringOps

Inherited from BeforeAfterActionFeature

Inherited from ChunkedResponseFeature

Inherited from RequestScopeFeature

Inherited from LocaleFeature

Inherited from BeforeAfterDsl

Inherited from ActionDefinitionFeature

Inherited from ExplicitRedirectFeature

Inherited from UrlGeneratorSupport

Inherited from FormParamsFeature

Inherited from QueryParamsFeature

Inherited from EnvFeature

Inherited from ApiFormats

Inherited from SkinnyEngineBase

Inherited from SessionImplicits

Inherited from DefaultImplicits

Inherited from LowPriorityImplicits

Inherited from LowestPriorityImplicits

Inherited from engine.implicits.TypeConverterSupport

Inherited from EngineParamsImplicits

Inherited from CookiesImplicits

Inherited from RouteMatcherImplicits

Inherited from HaltPassControl

Inherited from UrlGenerator

Inherited from ResponseStatusAccessor

Inherited from ResponseContentTypeAccessor

Inherited from RequestFormatAccessor

Inherited from ParamsAccessor

Inherited from EnvironmentAccessor

Inherited from ErrorHandlerAccessor

Inherited from AsyncSupported

Inherited from CoreHandler

Inherited from Handler

Inherited from logging.LoggerProvider

Inherited from ServletContextAccessor

Inherited from RicherStringImplicits

Inherited from ServletApiImplicits

Inherited from RouteRegistryAccessor

Inherited from UnstableAccessValidationConfig

Inherited from SkinnyEngineContextInitializer

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped