Trait

skinny.micro.routing

RoutingDslBase

Related Doc: package routing

Permalink

trait RoutingDslBase extends HaltPassControl with RouteRegistryAccessor with SkinnyContextInitializer with UnstableAccessValidationConfig with ServletContextAccessor with ServletApiImplicits

The core SkinnyMicro DSL.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RoutingDslBase
  2. ServletContextAccessor
  3. RicherStringImplicits
  4. ServletApiImplicits
  5. Initializable
  6. UnstableAccessValidationConfig
  7. SkinnyContextInitializer
  8. RouteRegistryAccessor
  9. HaltPassControl
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

    Permalink
    Definition Classes
    Initializable
  2. abstract type ConfigT <: AnyRef { ... /* 3 definitions in type refinement */ }

    Permalink
    Definition Classes
    ServletContextAccessorInitializable

Abstract Value Members

  1. abstract def error(handler: ErrorHandler): Unit

    Permalink

    Defines an error handler for exceptions thrown in either the before block or a route action.

    Defines an error handler for exceptions thrown in either the before block or a route action.

    If the error handler does not match, the result falls through to the previously defined error handler. The default error handler simply rethrows the exception.

    The error handler is run before the after filters, and the result is rendered like a standard response. It is the error handler's responsibility to set any appropriate status code.

  2. abstract def methodNotAllowed(block: (Set[HttpMethod]) ⇒ Any): Unit

    Permalink

    Defines a block to run if matching routes are found only for other methods.

    Defines a block to run if matching routes are found only for other methods. The set of matching methods is passed to the block.

  3. abstract def notFound(block: ⇒ Any): Unit

    Permalink

    Defines a block to run if no matching routes are found, or if all matching routes pass.

  4. abstract def routeBasePath(implicit ctx: SkinnyContext): String

    Permalink

    The base path for URL generation

    The base path for URL generation

    Attributes
    protected

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink

    The configuration, typically a ServletConfig or FilterConfig.

    The configuration, typically a ServletConfig or FilterConfig.

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

    Permalink
    Attributes
    protected
    Definition Classes
    ServletContextAccessorInitializable
  8. def context: SkinnyContext

    Permalink
    Definition Classes
    SkinnyContextInitializer
  9. def contextPath: String

    Permalink
    Definition Classes
    ServletContextAccessor
  10. implicit def enrichRequest(request: HttpServletRequest): RichRequest

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def halt(result: response.ActionResult): Nothing

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

    Permalink

    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
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def initParameter(name: String): Option[String]

    Permalink

    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
  22. def initialize(config: ConfigT): Unit

    Permalink

    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
    ServletContextAccessorInitializable
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def pass(): Nothing

    Permalink

    Immediately exits from the current route.

    Immediately exits from the current route.

    Definition Classes
    HaltPassControl
  28. def request(implicit ctx: SkinnyContext): HttpServletRequest

    Permalink
    Definition Classes
    SkinnyContextInitializer
  29. def response(implicit ctx: SkinnyContext): HttpServletResponse

    Permalink
    Definition Classes
    SkinnyContextInitializer
  30. lazy val routes: RouteRegistry

    Permalink

    The routes registered in this kernel.

    The routes registered in this kernel.

    Definition Classes
    RouteRegistryAccessor
  31. def serverAuthority(implicit ctx: SkinnyContext): String

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

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

    Permalink
    Definition Classes
    ServletContextAccessor
  34. implicit def servletContext: ServletContext

    Permalink

    The servlet context in which this kernel runs.

    The servlet context in which this kernel runs.

    Definition Classes
    ServletContextAccessor
  35. def shutdown(): Unit

    Permalink

    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
  36. def skinnyContext(implicit ctx: ServletContext): SkinnyContext

    Permalink

    Skinny Micro Context

    Skinny Micro Context

    Definition Classes
    SkinnyContextInitializer
  37. implicit def stringToRicherString(s: String): RicherString

    Permalink
    Definition Classes
    RicherStringImplicits
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. def unstableAccessValidationEnabled: Boolean

    Permalink

    Enables unstable access validation.

    Enables unstable access validation.

    Attributes
    protected
    Definition Classes
    UnstableAccessValidationConfig
  41. def useMostlyStableHttpSession: Boolean

    Permalink

    Enables mostly stable Servlet HttpSession implementation instead.

    Enables mostly stable Servlet HttpSession implementation instead.

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

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

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

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

    Permalink

    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
  46. def withRequestResponse[A](request: HttpServletRequest, response: HttpServletResponse)(f: ⇒ A): A

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

    Permalink

    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

Inherited from ServletContextAccessor

Inherited from RicherStringImplicits

Inherited from ServletApiImplicits

Inherited from Initializable

Inherited from SkinnyContextInitializer

Inherited from RouteRegistryAccessor

Inherited from HaltPassControl

Inherited from AnyRef

Inherited from Any

Ungrouped