Packages

  • package root
    Definition Classes
    root
  • package xitrum

    Things that are usually used by application developers are put in this package for convenience, because when they want to use XXX, they can simply write:

    Things that are usually used by application developers are put in this package for convenience, because when they want to use XXX, they can simply write:

    import xitrum.XXX

    To avoid polluting this namespace, things that are utilities should be put in package xitrum.util, not here.

    Annotations and validators are put to package xitrum.annation and xitrum.validator because there are many of them. It's better for application developers to write:

    import xitrum.annotation._
import xitrum.validator._
    Definition Classes
    root
  • package scope
    Definition Classes
    xitrum
  • package request
    Definition Classes
    scope
  • At
  • ParamAccess
  • PathInfo
  • RequestEnv

trait RequestEnv extends ParamAccess

All core state variables for a request are here. All other variables in Helper and Controller can be inferred from these variables.

Self Type
Action
Linear Supertypes
ParamAccess, AnyRef, Any
Known Subclasses
Action, ActorAction, Component, FutureAction, SockJsAction, WebSocketAction, js, MetricsViewer, XitrumMetricsChannel, XitrumMetricsViewer, SwaggerJson, SwaggerUi
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestEnv
  2. ParamAccess
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(handlerEnv: HandlerEnv): Unit
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val at: At
  7. def atJson(key: String): String
  8. lazy val bodyFileParams: FileUploadParams

    File params in request body.

  9. lazy val bodyTextParams: Params

    Params in request body.

  10. lazy val channel: Channel
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def convertTextParam[T](value: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): T

    Applications may override this method to convert to more types.

    Applications may override this method to convert to more types.

    Definition Classes
    ParamAccess
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. val handlerEnv: HandlerEnv
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. def param[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T
    Definition Classes
    ParamAccess
  24. def param[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T
    Definition Classes
    ParamAccess
  25. def paramo[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]
    Definition Classes
    ParamAccess
  26. def paramo[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]
    Definition Classes
    ParamAccess
  27. def params[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]
    Definition Classes
    ParamAccess
  28. def params[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]
    Definition Classes
    ParamAccess
  29. lazy val pathParams: Params

    Params embedded in the path.

    Params embedded in the path. Ex: /articles/:id

  30. lazy val queryParams: Params

    Params after the question mark of the URL.

    Params after the question mark of the URL. Ex: /search?q=xitrum

  31. lazy val request: FullHttpRequest
  32. lazy val requestContentJValue: JValue

    The whole request body parsed as JSON4S JValue.

    The whole request body parsed as JSON4S JValue. You can use SeriDeseri.fromJValue to convert this to Scala object (case class, Map, Seq etc.).

  33. lazy val requestContentString: String

    The whole request body as String.

  34. lazy val response: FullHttpResponse
  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. lazy val textParams: Params

    The merge of all text params (queryParams, bodyParams, and pathParams), as contrast to file upload (bodyFileParams).

  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. lazy val urlParams: Params

    The merge of queryParams and pathParams, things that appear in the request URL.

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

Inherited from ParamAccess

Inherited from AnyRef

Inherited from Any

Ungrouped