skinny.micro

SkinnyMicroServlet

trait SkinnyMicroServlet extends HttpServlet with SkinnyMicroServletBase with ThreadLocalFeatures

An implementation of the SkinnyMicro DSL in a servlet. This is the recommended base trait for most SkinnyMicro applications. Use a servlet if:

$ - your SkinnyMicro routes run in a subcontext of your web application. $ - you want SkinnyMicro to have complete control of unmatched requests. $ - you think you want a filter just for serving static content with the default servlet; SkinnyMicroServlet can do this too $ - you don't know the difference

See also

SkinnyMicroFilter

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SkinnyMicroServlet
  2. ThreadLocalFeatures
  3. BeforeAfterDsl
  4. RoutingDsl
  5. RoutingDslBase
  6. MainThreadLocalEverywhere
  7. SkinnyMicroServletBase
  8. SkinnyMicroBase
  9. SessionImplicits
  10. DefaultImplicits
  11. LowPriorityImplicits
  12. LowestPriorityImplicits
  13. TypeConverterSupport
  14. SkinnyMicroParamsImplicits
  15. CookiesImplicits
  16. RouteMatcherImplicits
  17. HaltPassControl
  18. UrlGenerator
  19. ResponseStatusAccessor
  20. ResponseContentTypeAccessor
  21. RequestFormatAccessor
  22. FormParamsAccessor
  23. QueryParamsAccessor
  24. ParamsAccessor
  25. EnvAccessor
  26. ErrorHandlerAccessor
  27. RedirectionDsl
  28. AsyncSupported
  29. CoreHandler
  30. Handler
  31. LoggerProvider
  32. ServletContextAccessor
  33. RicherStringImplicits
  34. ServletApiImplicits
  35. RouteRegistryAccessor
  36. UnstableAccessValidationConfig
  37. SkinnyContextInitializer
  38. Initializable
  39. HttpServlet
  40. GenericServlet
  41. Serializable
  42. ServletConfig
  43. Servlet
  44. AnyRef
  45. 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 = ServletConfig

  3. sealed class TypedMultiParams extends AnyRef

    Definition Classes
    SkinnyMicroParamsImplicits
  4. sealed class TypedParams extends AnyRef

    Definition Classes
    SkinnyMicroParamsImplicits

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 addRoute(method: HttpMethod, transformers: Seq[RouteTransformer], action: ⇒ Any): Route

    Prepends a new route for the given HTTP method.

    Prepends a new route for the given HTTP method.

    Can be overriden so that subtraits can use their own logic. Possible examples: $ - restricting protocols $ - namespace routes based on class name $ - raising errors on overlapping entries.

    This is the method invoked by get(), post() etc.

    Attributes
    protected
    Definition Classes
    RoutingDsl
    See also

    skinny.micro.SkinnyMicroKernel#removeRoute

  7. def after(transformers: RouteTransformer*)(fun: ⇒ Any): Unit

    Adds a filter to run after the route.

    Adds a filter to run after the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

    Definition Classes
    BeforeAfterDsl
  8. implicit val anyToBoolean: TypeConverter[Any, Boolean]

    Definition Classes
    LowPriorityImplicits
  9. implicit val anyToByte: TypeConverter[Any, Byte]

    Definition Classes
    LowPriorityImplicits
  10. implicit val anyToDouble: TypeConverter[Any, Double]

    Definition Classes
    LowPriorityImplicits
  11. implicit val anyToFloat: TypeConverter[Any, Float]

    Definition Classes
    LowPriorityImplicits
  12. implicit val anyToInt: TypeConverter[Any, Int]

    Definition Classes
    LowPriorityImplicits
  13. implicit val anyToLong: TypeConverter[Any, Long]

    Definition Classes
    LowPriorityImplicits
  14. implicit val anyToShort: TypeConverter[Any, Short]

    Definition Classes
    LowPriorityImplicits
  15. implicit val anyToString: TypeConverter[Any, String]

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

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

    Adds a filter to run before the route.

    Adds a filter to run before the route. The filter only runs if each routeMatcher returns Some. If the routeMatchers list is empty, the filter runs for all routes.

    Definition Classes
    BeforeAfterDsl
  18. implicit def booleanBlock2RouteMatcher(block: ⇒ Boolean): RouteMatcher

    Converts a boolean expression to a route matcher.

    Converts a boolean expression to a route matcher.

    block

    a block that evaluates to a boolean

    returns

    a route matcher based on block. The route matcher should return Some if the block is true and None if the block is false.

    Attributes
    protected
    Definition Classes
    RouteMatcherImplicits
    See also

    BooleanBlockRouteMatcher

  19. lazy val charset: Option[String]

    Default charset.

    Default charset.

    Definition Classes
    SkinnyMicroBase
  20. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. var config: ConfigT

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

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

    Attributes
    protected
    Definition Classes
    ServletContextAccessorInitializable
  23. def contentType(implicit ctx: SkinnyContext = context): String

    Gets the content type of the current response.

    Gets the content type of the current response.

    Definition Classes
    ResponseContentTypeAccessor
  24. def contentTypeInferrer: ContentTypeInferrer

    A partial function to infer the content type from the action result.

    A partial function to infer the content type from the action result.

    $ - "text/plain" for String $ - "application/octet-stream" for a byte array $ - "text/html" for any other result

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  25. def contentType_=(contentType: String)(implicit ctx: SkinnyContext = context): Unit

    Sets the content type of the current response.

    Sets the content type of the current response.

    Definition Classes
    ResponseContentTypeAccessor
  26. def context: SkinnyContext

    Definition Classes
    SkinnyContextInitializer
  27. def contextPath: String

    Definition Classes
    ServletContextAccessor
  28. implicit def cookieOptions(implicit ctx: SkinnyContext): cookie.CookieOptions

    Definition Classes
    CookiesImplicits
  29. def cookies(implicit ctx: SkinnyContext): SweetCookies

    Definition Classes
    CookiesImplicits
  30. def currentErrorHandler: ErrorHandler

    Current error handler.

    Current error handler.

    Attributes
    protected
    Definition Classes
    ErrorHandlerAccessor
  31. val defaultCharacterEncoding: String

    The default character encoding for requests and responses.

    The default character encoding for requests and responses.

    Attributes
    protected
    Definition Classes
    CoreHandler
  32. implicit def defaultStringToSeq[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[String, Seq[T]]

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

    Definition Classes
    RoutingDsl
  34. def destroy(): Unit

    Definition Classes
    SkinnyMicroServletBase → GenericServlet → Servlet
  35. def detectTooManyErrorFilterRegistrationAsAnErrorAtSkinnyMicroBase: Boolean

    Detects error filter leak issue as an error.

    Detects error filter leak issue as an error.

    Attributes
    protected
    Definition Classes
    ErrorHandlerAccessor
  36. def doDelete(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  37. def doGet(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  38. def doHead(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  39. var doNotFound: () ⇒ Any

    Invoked when no route matches.

    Invoked when no route matches. By default, calls serveStaticResource(), and if that fails, calls resourceNotFound().

    This action can be overridden by a notFound block.

    Attributes
    protected
    Definition Classes
    SkinnyMicroServletBaseSkinnyMicroBase
  40. def doOptions(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  41. def doPost(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  42. def doPut(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  43. def doTrace(arg0: HttpServletRequest, arg1: HttpServletResponse): Unit

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  44. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

    Definition Classes
    ServletApiImplicits
  46. implicit def enrichServletContext(servletContext: ServletContext): RichServletContext

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

    Definition Classes
    ServletApiImplicits
  48. final def eq(arg0: AnyRef): Boolean

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

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

    Definition Classes
    ErrorHandlerAccessor
  51. def executeRoutes(request: HttpServletRequest, response: HttpServletResponse): Unit

    Executes routes in the context of the current request and response.

    Executes routes in the context of the current request and response.

    $ 1. Executes each before filter with runFilters.

    $ 2. Executes the routes in the route registry with runRoutes for the request's method.

    1. The result of runRoutes becomes the _action result_. b. If no route matches the requested method, but matches are found for other methods, then the doMethodNotAllowed hook is run with each matching method. c. If no route matches any method, then the doNotFound hook is run, and its return value becomes the action result.

    $ 3. If an exception is thrown during the before filters or the route actions, then it is passed to the errorHandler function, and its result becomes the action result.

    $ 4. Executes the after filters with runFilters.

    $ 5. The action result is passed to renderResponse.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBaseCoreHandler
  52. implicit def executionContext: ExecutionContext

    ExecutionContext implicit value for this web controller.

    ExecutionContext implicit value for this web controller.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  53. def finalize(): Unit

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

    Returns query string multi parameters as a Map value.

    Returns query string multi parameters as a Map value.

    Definition Classes
    FormParamsAccessor
  55. def formParams(implicit ctx: SkinnyContext): Params

    Returns query string parameters as a Map value.

    Returns query string parameters as a Map value.

    Definition Classes
    FormParamsAccessor
  56. def format_=(formatValue: String)(implicit ctx: SkinnyContext = context): Unit

    Explicitly sets the request-scoped format.

    Explicitly sets the request-scoped format. This takes precedence over whatever was inferred from the request.

    Definition Classes
    RequestFormatAccessor
  57. def fullUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, withSessionId: Boolean = true)(implicit ctx: SkinnyContext): String

    Builds a full URL from the given relative path.

    Builds a full URL from the given relative path. Takes into account the port configuration, https, ...

    path

    a relative path

    returns

    the full URL

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

    The SkinnyMicro DSL core methods take a list of skinny.micro.routing.RouteMatcher and a block as the action body.

    The SkinnyMicro DSL core methods take a list of skinny.micro.routing.RouteMatcher and a block as the action body. The return value of the block is rendered through the pipeline and sent to the client as the response body.

    See SkinnyMicroBase#renderResponseBody for the detailed behaviour and how to handle your response body more explicitly, and see how different return types are handled.

    The block is executed in the context of a CoreDsl instance, so all the methods defined in this trait are also available inside the block.

    get("/") {
      <form action="/echo">
        <label>Enter your name</label>
        <input type="text" name="name"/>
      </form>
    }
    
    post("/echo") {
      "hello {params('name)}!"
    }

    SkinnyMicroKernel provides implicit transformation from boolean blocks, strings and regular expressions to skinny.micro.routing.RouteMatcher, so you can write code naturally.

    get("/", request.getRemoteHost == "127.0.0.1") { "Hello localhost!" }
    Definition Classes
    RoutingDsl
  59. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  60. def getInitParameter(arg0: String): String

    Definition Classes
    GenericServlet → ServletConfig
  61. def getInitParameterNames(): Enumeration[String]

    Definition Classes
    GenericServlet → ServletConfig
  62. def getLastModified(arg0: HttpServletRequest): Long

    Attributes
    protected[javax.servlet.http]
    Definition Classes
    HttpServlet
  63. def getServletConfig(): ServletConfig

    Definition Classes
    GenericServlet → Servlet
  64. def getServletContext(): ServletContext

    Definition Classes
    GenericServlet → ServletConfig
  65. def getServletInfo(): String

    Definition Classes
    GenericServlet → Servlet
  66. def getServletName(): String

    Definition Classes
    GenericServlet → ServletConfig
  67. def halt(result: response.ActionResult): Nothing

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

    Immediately halts processing of a request.

    Immediately halts processing of a request. Can be called from either a before filter or a route.

    status

    the status to set on the response, or null to leave the status unchanged.

    body

    a result to render through the render pipeline as the body

    headers

    headers to add to the response

    reason

    the HTTP status reason to set, or null to leave unchanged.

    Definition Classes
    HaltPassControl
  69. def handle(request: HttpServletRequest, response: HttpServletResponse): Unit

    Handles a request and renders a response.

    Handles a request and renders a response.

    $ 1. If the request lacks a character encoding, defaultCharacterEncoding is set to the request.

    $ 2. Sets the response's character encoding to defaultCharacterEncoding.

    $ 3. Binds the current request, response, and multiParams, and calls executeRoutes().

    Definition Classes
    CoreHandlerHandler
  70. def hashCode(): Int

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

    Definition Classes
    RoutingDsl
  72. def init(config: ServletConfig): Unit

    Definition Classes
    SkinnyMicroServletBase → GenericServlet → Servlet
  73. def init(): Unit

    Definition Classes
    GenericServlet
    Annotations
    @throws( ... )
  74. def initParameter(name: String): Option[String]

    Gets an init parameter from the config.

    Gets an init parameter from the config.

    name

    the name of the key

    returns

    an option containing the value of the parameter if defined, or None if the parameter is not set.

    Definition Classes
    ServletContextAccessor
  75. def initialize(config: ServletConfig): Unit

    Initializes the kernel.

    Initializes the kernel. Used to provide context that is unavailable when the instance is constructed, for example the servlet lifecycle. Should set the config variable to the parameter.

    config

    the configuration.

    Definition Classes
    SkinnyMicroServletBaseServletContextAccessorInitializable
  76. def invoke(matchedRoute: MatchedRoute): Option[Any]

    Invokes a route or filter.

    Invokes a route or filter. The multiParams gathered from the route matchers are merged into the existing route params, and then the action is run.

    matchedRoute

    the matched route to execute

    returns

    the result of the matched route's action wrapped in Some, or None if the action calls pass.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  77. def isAsyncExecutable(result: Any): Boolean

    true if async supported

    true if async supported

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  78. def isDevelopment(): Boolean

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

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

    returns

    true/false

    Attributes
    protected
    Definition Classes
    EnvAccessor
  79. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  80. def isProduction(): Boolean

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

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

    returns

    true/false

    Attributes
    protected
    Definition Classes
    EnvAccessor
  81. def isStaging(): Boolean

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

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

    returns

    true/false

    Attributes
    protected
    Definition Classes
    EnvAccessor
  82. def isTest(): Boolean

    Predicates current env is "test".

    Predicates current env is "test".

    returns

    true/false

    Attributes
    protected
    Definition Classes
    EnvAccessor
  83. def log(arg0: String, arg1: Throwable): Unit

    Definition Classes
    GenericServlet
  84. def log(arg0: String): Unit

    Definition Classes
    GenericServlet
  85. def logger: Logger

    Attributes
    protected
    Definition Classes
    LoggerProvider
  86. def loggerName: String

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

    Definition Classes
    LowestPriorityImplicits
  88. def maxDurationToAwaitAsyncFilters: Duration

    Max duration to await async filters

    Max duration to await async filters

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  89. def methodNotAllowed(f: (Set[HttpMethod]) ⇒ Any): Unit

    Definition Classes
    SkinnyMicroBase
  90. def mount(ctx: ServletContext): Unit

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

    Definition Classes
    ParamsAccessor
  92. def multiParams(implicit ctx: SkinnyContext): MultiParams

    The current multi params.

    The current multi params.

    Multi params are a result of merging the standard request params (query string or post params) with the route parameters extracted from the route matchers of the current route. The default value for an unknown param is the empty sequence. Invalid outside handle.

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

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

    Definition Classes
    SkinnyMicroBase
  95. final def notify(): Unit

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

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

    Definition Classes
    RoutingDsl
  98. def params(implicit ctx: SkinnyContext): Params

    Definition Classes
    ParamsAccessor
  99. def params(key: Symbol)(implicit ctx: SkinnyContext): String

    Definition Classes
    ParamsAccessor
  100. def params(key: String)(implicit ctx: SkinnyContext): String

    Definition Classes
    ParamsAccessor
  101. def pass(): Nothing

    Immediately exits from the current route.

    Immediately exits from the current route.

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

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

    Path pattern is decoupled from requests.

    Path pattern is decoupled from requests. This adapts the PathPattern to a RouteMatcher by supplying the request path.

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

    Definition Classes
    RoutingDsl
  105. def put(transformers: RouteTransformer*)(action: ⇒ Any): Route

    Definition Classes
    RoutingDsl
  106. def queryMultiParams(implicit ctx: SkinnyContext): MultiParams

    Returns query string multi parameters as a Map value.

    Returns query string multi parameters as a Map value.

    Definition Classes
    QueryParamsAccessor
  107. def queryParams(implicit ctx: SkinnyContext): Params

    Returns query string parameters as a Map value.

    Returns query string parameters as a Map value.

    Definition Classes
    QueryParamsAccessor
  108. def redirect(uri: String)(implicit ctx: SkinnyContext): ActionResult

    Sends a redirect response and immediately halts the current action.

    Sends a redirect response and immediately halts the current action.

    Definition Classes
    RedirectionDsl
  109. def redirect301(location: String, headers: Map[String, String] = Map.empty)(implicit ctx: SkinnyContext = context): ActionResult

    Responds as "301 Moved Permanently"

    Responds as "301 Moved Permanently"

    returns

    ActionResult

    Definition Classes
    RedirectionDsl
  110. def redirect302(location: String, headers: Map[String, String] = Map.empty)(implicit ctx: SkinnyContext = context): ActionResult

    Responds as "302 Found"

    Responds as "302 Found"

    returns

    ActionResult

    Definition Classes
    RedirectionDsl
  111. def redirect303(location: String, headers: Map[String, String] = Map.empty)(implicit ctx: SkinnyContext = context): ActionResult

    Responds as "303 See Other"

    Responds as "303 See Other"

    returns

    ActionResult

    Definition Classes
    RedirectionDsl
  112. implicit def regex2RouteMatcher(regex: Regex): RouteMatcher

    Converts a regular expression to a route matcher.

    Converts a regular expression to a route matcher.

    regex

    the regular expression

    returns

    a route matcher based on regex

    Attributes
    protected
    Definition Classes
    RouteMatcherImplicits
    See also

    RegexRouteMatcher

  113. def relativeUrl(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true)(implicit ctx: SkinnyContext): String

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

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

    Removes _all_ the actions of a given route for a given HTTP method.

    Removes _all_ the actions of a given route for a given HTTP method. If addRoute is overridden then this should probably be overriden too.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  116. def renderResponse(actionResult: Any)(implicit ctx: SkinnyContext): Unit

    Renders the action result to the response.

    Renders the action result to the response.

    $ - If the content type is still null, call the contentTypeInferrer. $ - Call the render pipeline on the result.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  117. def renderResponseBody(actionResult: Any)(implicit ctx: SkinnyContext): Unit

    Renders the action result to the response body via the render pipeline.

    Renders the action result to the response body via the render pipeline.

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
    See also

    #renderPipeline

  118. def renderUncaughtException(e: Throwable)(implicit ctx: SkinnyContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  119. def request(implicit ctx: SkinnyContext): HttpServletRequest

    Definition Classes
    SkinnyContextInitializer
  120. def requestPath(implicit ctx: SkinnyContext): String

    Defines the request path to be matched by routers.

    Defines the request path to be matched by routers. The default definition is optimized for path mapped servlets (i.e., servlet mapping ends in /*). The route should match everything matched by the /*. In the event that the request URI equals the servlet path with no trailing slash (e.g., mapping = /admin/*, request URI = '/admin'), a '/' is returned.

    All other servlet mappings likely want to return request.getServletPath. Custom implementations are allowed for unusual cases.

    Definition Classes
    SkinnyMicroServletBaseSkinnyMicroBase
  121. def resourceNotFound()(implicit ctx: SkinnyContext): Any

    Called by default notFound if no routes matched and no static resource could be found.

    Called by default notFound if no routes matched and no static resource could be found.

    Attributes
    protected
    Definition Classes
    SkinnyMicroServletBase
  122. 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
    Handler
  123. def response(implicit ctx: SkinnyContext): HttpServletResponse

    Definition Classes
    SkinnyContextInitializer
  124. def routeBasePath(implicit ctx: SkinnyContext): String

    Returns rout base path.

    Returns rout base path.

    Attributes
    protected
    Definition Classes
    SkinnyMicroServletBaseSkinnyMicroBase
  125. val routes: RouteRegistry

    The routes registered in this kernel.

    The routes registered in this kernel.

    Attributes
    protected
    Definition Classes
    RouteRegistryAccessor
  126. implicit def safe[S, T](f: (S) ⇒ T): TypeConverter[S, T]

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

    Implicit convert a (String) => Option[T] function into a TypeConverter[T]

    Implicit convert a (String) => Option[T] function into a TypeConverter[T]

    Definition Classes
    TypeConverterSupport
  128. implicit def seqHead[T](implicit elementConverter: TypeConverter[String, T], mf: Manifest[T]): TypeConverter[Seq[String], T]

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

    Definition Classes
    DefaultImplicits
  130. def serveStaticResource()(implicit ctx: SkinnyContext): Option[Any]

    Attempts to find a static resource matching the request path.

    Attempts to find a static resource matching the request path. Override to return None to stop this.

    Attributes
    protected
    Definition Classes
    SkinnyMicroServletBase
  131. def serverAuthority(implicit ctx: SkinnyContext): String

    Attributes
    protected
    Definition Classes
    ServletContextAccessor
  132. def serverHost(implicit ctx: SkinnyContext): String

    Definition Classes
    ServletContextAccessor
  133. def serverPort(implicit ctx: SkinnyContext): Int

    Definition Classes
    ServletContextAccessor
  134. def service(request: HttpServletRequest, response: HttpServletResponse): Unit

    Definition Classes
    SkinnyMicroServletBase → HttpServlet
  135. def service(arg0: ServletRequest, arg1: ServletResponse): Unit

    Definition Classes
    HttpServlet → GenericServlet → Servlet
    Annotations
    @throws( classOf[java.io.IOException] ) @throws( ... )
  136. implicit def servletContext: ServletContext

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ServletContextAccessor
  137. def session(key: Symbol)(implicit ctx: SkinnyContext): Any

    Definition Classes
    SessionImplicits
  138. def session(key: String)(implicit ctx: SkinnyContext): Any

    Definition Classes
    SessionImplicits
  139. implicit def session(implicit ctx: SkinnyContext): HttpSession

    The current session.

    The current session. Creates a session if none exists.

    Definition Classes
    SessionImplicits
  140. def sessionOption(implicit ctx: SkinnyContext): Option[HttpSession]

    The current session.

    The current session. If none exists, None is returned.

    Definition Classes
    SessionImplicits
  141. def setMultiparams[S](matchedRoute: Option[MatchedRoute], originalParams: MultiParams)(implicit ctx: SkinnyContext): Unit

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase
  142. def shutdown(): Unit

    A hook to shutdown the class.

    A hook to shutdown the class. Bridges the gap between servlet's destroy and filter's destroy.

    Attributes
    protected
    Definition Classes
    Initializable
  143. implicit def skinnyContext(implicit ctx: ServletContext): SkinnyContext

    Skinny Micro Context

    Skinny Micro Context

    Definition Classes
    MainThreadLocalEverywhereSkinnyContextInitializer
  144. 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"

    Attributes
    protected
    Definition Classes
    EnvAccessor
  145. def skipHaltingWhenRedirection: Boolean

    The default value is false to keep backward compatibility.

    The default value is false to keep backward compatibility.

    Attributes
    protected
    Definition Classes
    RedirectionDsl
  146. def status(implicit ctx: SkinnyContext = context): Int

    Gets the status code of the current response.

    Gets the status code of the current response.

    Definition Classes
    ResponseStatusAccessor
  147. def status_=(code: Int)(implicit ctx: SkinnyContext = context): Unit

    Sets the status code of the current response.

    Sets the status code of the current response.

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

    Pluggable way to convert a path expression to a route matcher.

    Pluggable way to convert a path expression to a route matcher. The default implementation is compatible with Sinatra's route syntax.

    path

    a path expression

    returns

    a route matcher based on path

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

    Definition Classes
    DefaultImplicits
  150. implicit val stringToByte: TypeConverter[String, Byte]

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

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

    Definition Classes
    DefaultImplicits
  153. implicit val stringToDouble: TypeConverter[String, Double]

    Definition Classes
    DefaultImplicits
  154. implicit val stringToFloat: TypeConverter[String, Float]

    Definition Classes
    DefaultImplicits
  155. implicit val stringToInt: TypeConverter[String, Int]

    Definition Classes
    DefaultImplicits
  156. implicit val stringToLong: TypeConverter[String, Long]

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

    Definition Classes
    RicherStringImplicits
  158. implicit val stringToSelf: TypeConverter[String, String]

    Definition Classes
    DefaultImplicits
  159. def stringToSeq[T](elementConverter: TypeConverter[String, T], separator: String = ",")(implicit arg0: Manifest[T]): TypeConverter[String, Seq[T]]

    Definition Classes
    DefaultImplicits
  160. implicit val stringToShort: TypeConverter[String, Short]

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

    Definition Classes
    AnyRef
  162. def toString(): String

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

    Definition Classes
    SkinnyMicroParamsImplicits
  164. implicit def toTypedParams(params: Params): TypedParams

    Definition Classes
    SkinnyMicroParamsImplicits
  165. def trap(code: Int)(block: ⇒ Any): Unit

    Definition Classes
    RoutingDsl
    See also

    trap

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

    Error handler for HTTP response status code range.

    Error handler for HTTP response status code range. You can intercept every response code previously specified with #status or even generic 404 error.

    trap(403) {
       "You are not authorized"
      }
    }*

    }}

    Definition Classes
    RoutingDsl
  167. def unstableAccessValidationEnabled: Boolean

    Enables unstable access validation.

    Enables unstable access validation.

    Attributes
    protected
    Definition Classes
    UnstableAccessValidationConfig
  168. def url(path: String, params: Iterable[(String, Any)] = Iterable.empty, includeContextPath: Boolean = true, includeServletPath: Boolean = true, absolutize: Boolean = true)(implicit ctx: SkinnyContext): String

    Returns a context-relative, session-aware URL for a path and specified parameters.

    Returns a context-relative, session-aware URL for a path and specified parameters. Finally, the result is run through response.encodeURL for a session ID, if necessary.

    path

    the base path. If a path begins with '/', then the context path will be prepended to the result

    params

    params, to be appended in the form of a query string

    returns

    the path plus the query string, if any. The path is run through response.encodeURL to add any necessary session tracking parameters.

    Definition Classes
    UrlGenerator
  169. def useMostlyStableHttpSession: Boolean

    Enables mostly stable Servlet HttpSession implementation instead.

    Enables mostly stable Servlet HttpSession implementation instead.

    Attributes
    protected
    Definition Classes
    UnstableAccessValidationConfig
  170. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  173. def withRequest[A](request: HttpServletRequest)(f: ⇒ A): A

    Executes the block with the given request bound to the request method.

    Executes the block with the given request bound to the request method.

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

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

    Executes the block with the given response bound to the response method.

    Executes the block with the given response bound to the response method.

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

    Attributes
    protected
    Definition Classes
    SkinnyMicroBase

Inherited from ThreadLocalFeatures

Inherited from BeforeAfterDsl

Inherited from RoutingDsl

Inherited from RoutingDslBase

Inherited from MainThreadLocalEverywhere

Inherited from SkinnyMicroServletBase

Inherited from SkinnyMicroBase

Inherited from SessionImplicits

Inherited from DefaultImplicits

Inherited from LowPriorityImplicits

Inherited from LowestPriorityImplicits

Inherited from TypeConverterSupport

Inherited from CookiesImplicits

Inherited from RouteMatcherImplicits

Inherited from HaltPassControl

Inherited from UrlGenerator

Inherited from ResponseStatusAccessor

Inherited from RequestFormatAccessor

Inherited from FormParamsAccessor

Inherited from QueryParamsAccessor

Inherited from ParamsAccessor

Inherited from EnvAccessor

Inherited from ErrorHandlerAccessor

Inherited from RedirectionDsl

Inherited from AsyncSupported

Inherited from CoreHandler

Inherited from Handler

Inherited from LoggerProvider

Inherited from ServletContextAccessor

Inherited from RicherStringImplicits

Inherited from ServletApiImplicits

Inherited from RouteRegistryAccessor

Inherited from SkinnyContextInitializer

Inherited from Initializable

Inherited from HttpServlet

Inherited from GenericServlet

Inherited from Serializable

Inherited from ServletConfig

Inherited from Servlet

Inherited from AnyRef

Inherited from Any

Ungrouped