Packages

t

xitrum

Component

trait Component extends Action

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Component
  2. Action
  3. I18n
  4. JsResponder
  5. JsRenderer
  6. FlashResponder
  7. FlashRenderer
  8. ViewResponder
  9. Responder
  10. ViewRenderer
  11. GetActionClassDefaultsToCurrentAction
  12. Renderer
  13. Url
  14. Redirect
  15. BasicAuth
  16. Filter
  17. Net
  18. Log
  19. SessionEnv
  20. Csrf
  21. RequestEnv
  22. ParamAccess
  23. AnyRef
  24. 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 absSockJsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  5. def absUrl[T <: Action](implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  6. def absUrl[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  7. def absUrl(params: (String, Any)*): String
    Definition Classes
    Url
  8. lazy val absUrl: String
    Definition Classes
    Url
  9. lazy val absUrlPrefix: String
    Definition Classes
    Url
  10. lazy val absUrlPrefixWithoutScheme: String
    Definition Classes
    Url
  11. lazy val absWebSocketRequestUrl: String
    Definition Classes
    Url
  12. def absWebSocketUrl[T <: WebSocketAction](implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  13. def absWebSocketUrl[T <: WebSocketAction](params: (String, Any)*)(implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  14. def absWebSocketUrl(params: (String, Any)*): String
    Definition Classes
    Url
  15. lazy val absWebSocketUrl: String
    Definition Classes
    Url
  16. lazy val absWebSocketUrlPrefix: String
    Definition Classes
    Url
  17. def addConnectionClosedListener(listener: ⇒ Unit): Unit
    Definition Classes
    Action
  18. def afterFilter(f: ⇒ Any): Unit
    Definition Classes
    Filter
  19. lazy val antiCsrfInput: Elem
    Definition Classes
    Csrf
  20. lazy val antiCsrfMeta: Elem
    Definition Classes
    Csrf
  21. def antiCsrfToken: String
    Definition Classes
    Csrf
  22. def apply(action: Action): Unit
  23. def apply(handlerEnv: HandlerEnv): Unit
    Definition Classes
    RequestEnv
  24. def aroundFilter(f: (() ⇒ Any) ⇒ Any): Unit
    Definition Classes
    Filter
  25. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  26. lazy val at: At
    Definition Classes
    ComponentRequestEnv
  27. def atJson(key: String): String
    Definition Classes
    RequestEnv
  28. def autosetLanguage(availableLanguages: String*): Unit

    Sets current language automatically based on the matching of the "Accept-Language" header against the list of given languages.

    Sets current language automatically based on the matching of the "Accept-Language" header against the list of given languages. The languages should have corresponding files i18n/language.po in classpath (the language should be in IETF BCP 47 format).

    If there's no match, the language is still the default "en".

    Definition Classes
    I18n
  29. def badRequestMessageInvalidInput(message: String): String

    Applications may override this method to modify the default message: Validation error: + message

    Applications may override this method to modify the default message: Validation error: + message

    Attributes
    protected
    Definition Classes
    Action
  30. def badRequestMessageMissingParam(param: String): String

    Applications may override this method to modify the default message: Missing param: + param

    Applications may override this method to modify the default message: Missing param: + param

    Attributes
    protected
    Definition Classes
    Action
  31. def badRequestMessageSessionExpired: String

    Applications may override this method to modify the default message: Session expired. Please refresh your browser.

    Applications may override this method to modify the default message: Session expired. Please refresh your browser.

    Attributes
    protected
    Definition Classes
    Action
  32. def basicAuth(realm: String)(authenticator: (String, String) ⇒ Boolean): Boolean

    authenticator

    takes username and password, returns true if it want to let the user in.

    Definition Classes
    BasicAuth
  33. def beforeFilter(f: ⇒ Any): Unit

    Adds a before filter.

    Adds a before filter.

    Definition Classes
    Filter
  34. lazy val bodyFileParams: FileUploadParams

    File params in request body.

    File params in request body.

    Definition Classes
    RequestEnv
  35. lazy val bodyTextParams: Params

    Params in request body.

    Params in request body.

    Definition Classes
    RequestEnv
  36. lazy val browserLanguages: List[LanguageRange]

    returns

    List of Locale.LanguageRange sorted by priority from high to low

    Definition Classes
    ComponentI18n
  37. def callAfterFilters(): Unit

    Called by Dispatcher.

    Called by Dispatcher. Calls all after filters.

    Definition Classes
    Filter
  38. def callBeforeFilters(): Boolean

    Called by Dispatcher.

    Called by Dispatcher. Calls all before filters until a filter has responded something.

    returns

    false if a before filter has responded something and later before filters and the action's "execute" method should not be called

    Definition Classes
    Filter
  39. def callExecuteWrappedInAroundFilters(): Unit

    Called by Dispatcher

    Called by Dispatcher

    Definition Classes
    Filter
  40. lazy val channel: Channel
    Definition Classes
    RequestEnv
  41. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. 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
  43. implicit val currentAction: Action

    This is convenient, for example, when you want to get the current action in view templates.

    This is convenient, for example, when you want to get the current action in view templates.

    Definition Classes
    Action
  44. def dispatchWithFailsafe(skipCsrfCheck: Boolean): Unit
    Definition Classes
    Action
  45. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  47. def execute(): Unit

    Called when the HTTP request comes in.

    Called when the HTTP request comes in. Actions have to implement this method.

    Definition Classes
    ComponentAction
  48. implicit val executionContext: ExecutionContextExecutor

    This is convenient, for example, when you use scala.concurrent.Future.

    This is convenient, for example, when you use scala.concurrent.Future.

    Definition Classes
    Action
  49. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  50. def flash(): String

    Returns the current content in flash, and clears the flash.

    Returns the current content in flash, and clears the flash.

    Definition Classes
    FlashRenderer
  51. def flash(msg: Any): Unit

    Definition Classes
    FlashRenderer
    See also

    jsFlash(msg).

  52. def forwardTo(actionClass: Class[_ <: Action]): Unit
    Definition Classes
    Redirect
  53. def forwardTo[T <: Action]()(implicit arg0: Manifest[T]): Unit

    Example: forwardTo[AnotherActionClass]()

    Example: forwardTo[AnotherActionClass]()

    Tells another action to process the current request for the current action. See also redirectTo.

    Definition Classes
    Redirect
  54. val forwarding: Boolean

    Set to true by forwardTo.

    Set to true by forwardTo.

    Definition Classes
    Redirect
  55. def getActionClass[T <: Action](implicit arg0: Manifest[T]): Class[Action]
  56. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  57. val handlerEnv: HandlerEnv
    Definition Classes
    RequestEnv
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  59. lazy val isAjax: Boolean
    Definition Classes
    JsResponder
  60. def isDoneResponding: Boolean
    Definition Classes
    Responder
  61. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  62. lazy val isSsl: Boolean
    Definition Classes
    ComponentNet
  63. def js$(selector: String): String
    Definition Classes
    JsRenderer
  64. def js$id(id: String): String
    Definition Classes
    JsRenderer
  65. def js$name(name: String): String
    Definition Classes
    JsRenderer
  66. def jsAddToView(js: Any): Unit

    You can use this method to add dynamic JS snippets to a buffer, then use method jsForView to take out that buffer to embed the snippets to view template.

    You can use this method to add dynamic JS snippets to a buffer, then use method jsForView to take out that buffer to embed the snippets to view template.

    Definition Classes
    ComponentJsRenderer
  67. lazy val jsDefaults: Group
    Definition Classes
    JsRenderer
  68. def jsEscape(string: Any): String

    Do not use this to escape JSON, because they are different! For example JSON does not escape ' character, while JavaScript does.

    Do not use this to escape JSON, because they are different! For example JSON does not escape ' character, while JavaScript does. To escape JSON, use xitrum.util.SeriDeseri.toJson(Seq(string)).

    org.apache.commons.lang3.StringEscapeUtils is used internally.

    Definition Classes
    JsRenderer
  69. def jsFlashCall(msg: Any): String
    Attributes
    protected
    Definition Classes
    FlashRenderer
  70. lazy val jsForView: Serializable

    See jsAddToView.

    See jsAddToView.

    Definition Classes
    JsRenderer
  71. def jsRedirectTo[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    JsResponder
  72. def jsRedirectTo(location: Any): ChannelFuture

    See http://stackoverflow.com/questions/503093/how-can-i-make-a-redirect-page-in-jquery

    See http://stackoverflow.com/questions/503093/how-can-i-make-a-redirect-page-in-jquery

    Definition Classes
    JsResponder
  73. def jsRenderFlash(): Unit

    Like jsRenderFlash(msg), but uses the current flash.

    Like jsRenderFlash(msg), but uses the current flash.

    Definition Classes
    FlashRenderer
  74. def jsRenderFlash(msg: Any): Unit

    For web 2.0 style application.

    For web 2.0 style application. Used in application layout to display the flash message right after a view is loaded.

    Definition Classes
    FlashRenderer
  75. def jsRespond(fragments: Any*): ChannelFuture
    Definition Classes
    JsResponder
  76. def jsRespondFlash(msg: Any): Unit

    For web 2.0 style application.

    For web 2.0 style application. Used in Ajax request handling to respond a message and have the browser render it to the flash area right away.

    Definition Classes
    FlashResponder
  77. def language: String

    Default language is "en".

    Default language is "en".

    Definition Classes
    ComponentI18n
  78. def language_=(language: String): Unit

    Sets current language manually.

    Sets current language manually. The language should have a corresponding file i18n/language.po in classpath (the language should be in IETF BCP 47 format).

    Definition Classes
    ComponentI18n
  79. def layout: Any
    Definition Classes
    ViewRenderer
  80. def locale: Locale

    The locale corresponding to the language.

    The locale corresponding to the language. It will be updated automatically when you update language.

    Definition Classes
    ComponentI18n
  81. lazy val log: Logger

    Log name is inferred from name of the class extending this trait.

    Log name is inferred from name of the class extending this trait.

    Definition Classes
    Log
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. def newComponent[T <: Component]()(implicit arg0: Manifest[T]): T
    Definition Classes
    Action
  84. final def notify(): Unit
    Definition Classes
    AnyRef
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  86. def onDoneResponding(): Unit

    Called when the response or the last chunk (in case of chunked response) has been sent to the client.

    Called when the response or the last chunk (in case of chunked response) has been sent to the client.

    Definition Classes
    Responder
  87. def param[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T
    Definition Classes
    ParamAccess
  88. def param[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): T
    Definition Classes
    ParamAccess
  89. def paramo[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]
    Definition Classes
    ParamAccess
  90. def paramo[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Option[T]
    Definition Classes
    ParamAccess
  91. def params[T](key: String, coll: Params)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]
    Definition Classes
    ParamAccess
  92. def params[T](key: String)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T], d: DefaultsTo[T, String]): Seq[T]
    Definition Classes
    ParamAccess
  93. lazy val pathParams: Params

    Params embedded in the path.

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

    Definition Classes
    RequestEnv
  94. def publicUrl(directory: String, devFile: String, prodFile: String): String

    Ex: publicUrl("jquery/3.1.1/dist", "jquery.js", "jquery.min.js")

    Ex: publicUrl("jquery/3.1.1/dist", "jquery.js", "jquery.min.js")

    directory

    Relative to the "public" directory, without leading "/"

    devFile

    File in the directory to use in development mode

    prodFile

    File in the directory to use in production mode

    Definition Classes
    Url
  95. def publicUrl(devPath: String, prodPath: String): String

    Ex: publicUrl("jquery/3.1.1/dist/jquery.js", "jquery/3.1.1/dist/jquery.min.js")

    Ex: publicUrl("jquery/3.1.1/dist/jquery.js", "jquery/3.1.1/dist/jquery.min.js")

    devPath

    File path to use in development mode, relative to the "public" directory, without leading "/"

    prodPath

    File path to use in production mode, relative to the "public" directory, without leading "/"

    Definition Classes
    Url
  96. def publicUrl(path: String): String

    Ex: publicUrl("jquery/3.1.1/dist/jquery.js")

    Ex: publicUrl("jquery/3.1.1/dist/jquery.js")

    path

    Relative to the "public" directory, without leading "/"

    Definition Classes
    Url
  97. lazy val queryParams: Params

    Params after the question mark of the URL.

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

    Definition Classes
    RequestEnv
  98. def redirectTo[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): ChannelFuture

    Example: redirectTo[AnotherActionClass]()

    Example: redirectTo[AnotherActionClass]()

    Example: redirectTo[AnotherActionClass]("param1" -> value1, "param2" -> value2)

    See also forwardTo.

    Definition Classes
    Redirect
  99. def redirectTo(location: String, status: HttpResponseStatus = HttpResponseStatus.FOUND): ChannelFuture

    Example: redirectTo("https://google.com/"); status will be 302 FOUND

    Example: redirectTo("https://google.com/"); status will be 302 FOUND

    Example: redirectTo("https://google.com/", HttpResponseStatus.MOVED_PERMANENTLY)

    See also forwardTo.

    Definition Classes
    Redirect
  100. def redirectToThis(params: (String, Any)*): ChannelFuture

    Example: redirectToThis()

    Example: redirectToThis()

    Example: redirectToThis("param1" -> value1, "param2" -> value2)

    Redirects back to the current action. See also forwardTo.

    Definition Classes
    Redirect
  101. lazy val remoteIp: String

    returns

    IPv4 or IPv6 of the original remote HTTP client (not the proxy), X-Forwarded-For is supported

    Definition Classes
    ComponentNet
  102. def renderEventSource(data: Any, event: String = "message"): String
    Definition Classes
    Renderer
  103. def renderFragment[T <: Action](fragment: String)(implicit arg0: Manifest[T]): String

    Renders the template fragment at the directory associated with the action.

    Renders the template fragment at the directory associated with the action.

    Definition Classes
    ViewRenderer
  104. def renderFragment[T <: Action](fragment: String, options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Renders the template fragment at the directory associated with the action.

    Renders the template fragment at the directory associated with the action.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  105. def renderFragment(actionClass: Class[_ <: Action], fragment: String): String

    Renders the template fragment at the directory associated with the action.

    Renders the template fragment at the directory associated with the action.

    Definition Classes
    ViewRenderer
  106. def renderFragment(actionClass: Class[_ <: Action], fragment: String, options: Map[String, Any]): String

    Renders the template fragment at the directory associated with the action.

    Renders the template fragment at the directory associated with the action.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  107. def renderFragment(directoryUri: String, fragment: String): String

    Renders the template fragment at the directory.

    Renders the template fragment at the directory.

    Definition Classes
    ViewRenderer
  108. def renderFragment(directoryUri: String, fragment: String, options: Map[String, Any]): String

    Renders the template fragment at the directory.

    Renders the template fragment at the directory.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  109. def renderInlineView(inlineView: Any): String

    Sets renderedView and call layout.

    Sets renderedView and call layout.

    Definition Classes
    ViewRenderer
  110. def renderTemplate(uri: String): String

    Renders the template at uri (renderedView is not affected).

    Renders the template at uri (renderedView is not affected).

    Definition Classes
    ViewRenderer
  111. def renderTemplate(uri: String, options: Map[String, Any]): String

    Renders the template at uri (renderedView is not affected).

    Renders the template at uri (renderedView is not affected).

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  112. def renderView[T <: Action]()(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView, then calls layout.

    Renders the template associated with the action to renderedView, then calls layout.

    Definition Classes
    ViewRenderer
  113. def renderView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView, then calls layout.

    Renders the template associated with the action to renderedView, then calls layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  114. def renderView(actionClass: Class[_ <: Action]): String

    Renders the template associated with the action to renderedView, then calls layout.

    Renders the template associated with the action to renderedView, then calls layout.

    Definition Classes
    ViewRenderer
  115. def renderView(actionClass: Class[_ <: Action], options: Map[String, Any]): String

    Renders the template associated with the action to renderedView, then calls layout.

    Renders the template associated with the action to renderedView, then calls layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  116. def renderView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Definition Classes
    ViewRenderer
  117. def renderView[T <: Action](customLayout: () ⇒ Any, options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Renders the template associated with the action to renderedView, then calls the custom layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  118. def renderView(customLayout: () ⇒ Any, actionClass: Class[_ <: Action]): String

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Definition Classes
    ViewRenderer
  119. def renderView(customLayout: () ⇒ Any, actionClass: Class[_ <: Action], options: Map[String, Any]): String

    Renders the template associated with the action to renderedView, then calls the custom layout.

    Renders the template associated with the action to renderedView, then calls the custom layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  120. def renderView(uri: String): String

    Renders the template at uri to renderedView, then calls layout.

    Renders the template at uri to renderedView, then calls layout.

    Definition Classes
    ViewRenderer
  121. def renderView(uri: String, options: Map[String, Any]): String

    Renders the template at uri to renderedView, then calls layout.

    Renders the template at uri to renderedView, then calls layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  122. def renderView(customLayout: () ⇒ Any, uri: String): String

    Renders the template at uri to renderedView, then calls the custom layout.

    Renders the template at uri to renderedView, then calls the custom layout.

    Definition Classes
    ViewRenderer
  123. def renderView(customLayout: () ⇒ Any, uri: String, options: Map[String, Any]): String

    Renders the template at uri to renderedView, then calls the custom layout.

    Renders the template at uri to renderedView, then calls the custom layout.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  124. def renderViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView.

    Renders the template associated with the action to renderedView.

    Definition Classes
    ViewRenderer
  125. def renderViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Renders the template associated with the action to renderedView.

    Renders the template associated with the action to renderedView.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  126. def renderViewNoLayout(actionClass: Class[_ <: Action]): String

    Renders the template associated with the action to renderedView.

    Renders the template associated with the action to renderedView.

    Definition Classes
    ViewRenderer
  127. def renderViewNoLayout(actionClass: Class[_ <: Action], options: Map[String, Any]): String

    Renders the template associated with the action to renderedView.

    Renders the template associated with the action to renderedView.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  128. def renderViewNoLayout(uri: String): String

    Renders the template at uri to renderedView.

    Renders the template at uri to renderedView.

    Definition Classes
    ViewRenderer
  129. def renderViewNoLayout(uri: String, options: Map[String, Any]): String

    Renders the template at uri to renderedView.

    Renders the template at uri to renderedView.

    options

    specific to the configured template engine

    Definition Classes
    ViewRenderer
  130. val renderedView: Any
    Definition Classes
    ViewRenderer
  131. lazy val request: FullHttpRequest
    Definition Classes
    RequestEnv
  132. 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.).

    Definition Classes
    RequestEnv
  133. lazy val requestContentString: String

    The whole request body as String.

    The whole request body as String.

    Definition Classes
    RequestEnv
  134. lazy val requestCookies: Map[String, String]

    Browsers will not send cookie attributes back to the server.

    Browsers will not send cookie attributes back to the server. They will only send the cookie (name-value pairs). http://en.wikipedia.org/wiki/HTTP_cookie#Cookie_attributes

    Definition Classes
    ComponentSessionEnv
  135. def respond(): ChannelFuture
    Definition Classes
    Responder
  136. def respond404Page(): Unit
    Definition Classes
    Responder
  137. def respond500Page(): Unit
    Definition Classes
    Responder
  138. def respondBinary(byteBuf: ByteBuf): ChannelFuture

    If Content-Type header is not set, it is set to "application/octet-stream".

    If Content-Type header is not set, it is set to "application/octet-stream".

    byteBuf

    Will be released

    Definition Classes
    Responder
  139. def respondBinary(bytes: Array[Byte]): ChannelFuture

    If Content-Type header is not set, it is set to "application/octet-stream".

    If Content-Type header is not set, it is set to "application/octet-stream".

    Definition Classes
    Responder
  140. def respondDefault404Page(): ChannelFuture
    Definition Classes
    Responder
  141. def respondDefault500Page(): ChannelFuture
    Definition Classes
    Responder
  142. def respondEventSource(data: Any, event: String = "message"): ChannelFuture

    To respond event source, call this method as many time as you want.

    To respond event source, call this method as many time as you want. Event Source response is a special kind of chunked response, data must be UTF-8. See: - http://sockjs.github.com/sockjs-protocol/sockjs-protocol-0.3.3.html#section-94 - http://dev.w3.org/html5/eventsource/

    No need to call setChunked() before calling this method.

    Definition Classes
    Responder
  143. def respondFile(path: String): ChannelFuture

    Sends a file using X-SendFile.

    Sends a file using X-SendFile. If Content-Type header is not set, it is guessed from the file name.

    path

    absolute or relative to the current working directory In some cases, the current working directory is not always the root directory of the project (https://github.com/xitrum-framework/xitrum/issues/47), you may need to use xitrum.Config.root to calculate the correct absolute path from a relative path. To sanitize the path, use xitrum.util.PathSanitizer.

    Definition Classes
    Responder
  144. def respondHtml(any: Any): ChannelFuture

    Content-Type header is set to "text/html".

    Content-Type header is set to "text/html".

    Definition Classes
    Responder
  145. def respondInlineView(inlineView: Any): ChannelFuture
    Definition Classes
    ViewResponder
  146. def respondJs(any: Any): ChannelFuture

    Content-Type header is set to "application/javascript".

    Content-Type header is set to "application/javascript".

    Definition Classes
    Responder
  147. def respondJson(ref: AnyRef): ChannelFuture

    Converts the given Scala object to JSON object, and responds it.

    Converts the given Scala object to JSON object, and responds it. If you just want to respond a text with "application/json" as content type, use respondJsonText(text).

    Content-Type header is set to "application/json". "text/json" would make the browser download instead of displaying the content. It makes debugging a pain.

    Definition Classes
    Responder
  148. def respondJsonP(ref: AnyRef, function: String): ChannelFuture

    Converts the given Scala object to JSON object, wraps it with the given JavaScript function name, and responds.

    Converts the given Scala object to JSON object, wraps it with the given JavaScript function name, and responds. If you already have a JSON text, thus no conversion is needed, use respondJsonPText.

    Content-Type header is set to "application/javascript".

    Definition Classes
    Responder
  149. def respondJsonPText(text: Any, function: String): ChannelFuture

    Wraps the text with the given JavaScript function name, and responds.

    Wraps the text with the given JavaScript function name, and responds.

    Content-Type header is set to "application/javascript".

    Definition Classes
    Responder
  150. def respondJsonText(any: Any): ChannelFuture

    Content-Type header is set to "application/json".

    Content-Type header is set to "application/json".

    Definition Classes
    Responder
  151. def respondLastChunk(trailingHeaders: HttpHeaders = EmptyHttpHeaders.INSTANCE): ChannelFuture

    See setChunked.

    See setChunked.

    Definition Classes
    Responder
  152. def respondResource(path: String): ChannelFuture

    Sends a file from public directory in one of the entry (may be a JAR file) in classpath.

    Sends a file from public directory in one of the entry (may be a JAR file) in classpath. If Content-Type header is not set, it is guessed from the file name.

    path

    Relative to an entry in classpath, without leading "/"

    Definition Classes
    Responder
  153. def respondTemplate(uri: String): ChannelFuture
    Definition Classes
    ViewResponder
  154. def respondTemplate(uri: String, options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  155. def respondText(text: Any, fallbackContentType: String = null, convertXmlToXhtml: Boolean = true): ChannelFuture

    fallbackContentType

    Only used if Content-Type header has not been set. If not given and Content-Type header is not set, it is set to "application/xml" if text param is Node or NodeSeq, otherwise it is set to "text/plain".

    convertXmlToXhtml


    .toString by default returns

    which is rendered as 2
    tags on some browsers! Set to false if you really want XML, not XHTML. See http://www.scala-lang.org/node/492 and http://www.ne.jp/asahi/hishidama/home/tech/scala/xml.html

    Definition Classes
    Responder
  156. def respondView[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  157. def respondView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  158. def respondView(actionClass: Class[_ <: Action]): ChannelFuture
    Definition Classes
    ViewResponder
  159. def respondView(actionClass: Class[_ <: Action], options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  160. def respondView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  161. def respondView[T <: Action](customLayout: () ⇒ Any, options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  162. def respondView(customLayout: () ⇒ Any, actionClass: Class[_ <: Action]): ChannelFuture
    Definition Classes
    ViewResponder
  163. def respondView(customLayout: () ⇒ Any, actionClass: Class[_ <: Action], options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  164. def respondView(uri: String): ChannelFuture
    Definition Classes
    ViewResponder
  165. def respondView(uri: String, options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  166. def respondView(customLayout: () ⇒ Any, uri: String): ChannelFuture
    Definition Classes
    ViewResponder
  167. def respondView(customLayout: () ⇒ Any, uri: String, options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  168. def respondViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  169. def respondViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture
    Definition Classes
    ViewResponder
  170. def respondViewNoLayout(actionClass: Class[_ <: Action]): ChannelFuture
    Definition Classes
    ViewResponder
  171. def respondViewNoLayout(actionClass: Class[_ <: Action], options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  172. def respondViewNoLayout(uri: String): ChannelFuture
    Definition Classes
    ViewResponder
  173. def respondViewNoLayout(uri: String, options: Map[String, Any]): ChannelFuture
    Definition Classes
    ViewResponder
  174. def respondXml(any: Any): ChannelFuture

    Content-Type header is set to "application/xml".

    Content-Type header is set to "application/xml".

    Definition Classes
    Responder
  175. lazy val response: FullHttpResponse
    Definition Classes
    RequestEnv
  176. lazy val responseCookies: ArrayBuffer[Cookie]
    Definition Classes
    ComponentSessionEnv
  177. lazy val scheme: String
    Definition Classes
    Net
  178. lazy val serverName: String
    Definition Classes
    ComponentNet
  179. lazy val serverPort: Int
    Definition Classes
    ComponentNet
  180. lazy val session: Session

    To reset session: session.clear()

    To reset session: session.clear()

    Definition Classes
    ComponentSessionEnv
  181. def sessiono[T](key: String)(implicit d: DefaultsTo[T, String]): Option[T]
    Definition Classes
    SessionEnv
  182. def setChunked(): Unit

    To respond chunks (http://en.wikipedia.org/wiki/Chunked_transfer_encoding): 1.

    To respond chunks (http://en.wikipedia.org/wiki/Chunked_transfer_encoding): 1. Call setChunked() to mark that the response will be chunked 2. Call respondXXX as normal, but as many times as you want 3. Lastly, call respondLastChunk()

    If Content-Type header is not set, it is set to "application/octet-stream".

    Definition Classes
    Responder
  183. def setClientCacheAggressively(): Unit

    Tells the browser to cache static files for a long time.

    Tells the browser to cache static files for a long time. This works well even when this is a cluster of web servers behind a load balancer because the URL created by urlForResource is in the form: resource?etag

    Don't worry that browsers do not pick up new files after you modified them, see the doc about static files.

    Google recommends 1 year: http://code.google.com/speed/page-speed/docs/caching.html

    Both Max-age and Expires header are set because IEs use Expires, not max-age: http://mrcoles.com/blog/cookies-max-age-vs-expires/

    Definition Classes
    Responder
  184. def setCookieAndSessionIfTouchedOnRespond(): Unit
    Definition Classes
    SessionEnv
  185. def setNoClientCache(): Unit

    Prevents client cache.

    Prevents client cache. Note that "pragma: no-cache" is linked to requests, not responses: http://palizine.plynt.com/issues/2008Jul/cache-control-attributes/

    Definition Classes
    Responder
  186. def sockJsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  187. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  188. def t(singular: String, args: Any*): String

    formatLocal using the current locale.

    formatLocal using the current locale.

    Definition Classes
    I18n
  189. def t(singular: String): String
    Definition Classes
    I18n
  190. def tc(ctx: String, singular: String, args: Any*): String

    formatLocal using the current locale.

    formatLocal using the current locale.

    Definition Classes
    I18n
  191. def tc(ctx: String, singular: String): String
    Definition Classes
    I18n
  192. def tcn(ctx: String, singular: String, plural: String, n: Long, args: Any*): String

    formatLocal using the current locale.

    formatLocal using the current locale.

    Definition Classes
    I18n
  193. def tcn(ctx: String, singular: String, plural: String, n: Long): String
    Definition Classes
    I18n
  194. lazy val textParams: Params

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

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

    Definition Classes
    RequestEnv
  195. implicit val timeout: FiniteDuration

    This is convenient, for example, when you use scala.concurrent.Await.

    This is convenient, for example, when you use scala.concurrent.Await.

    Definition Classes
    Action
  196. def tn(singular: String, plural: String, n: Long, args: Any*): String

    formatLocal using the current locale.

    formatLocal using the current locale.

    Definition Classes
    I18n
  197. def tn(singular: String, plural: String, n: Long): String
    Definition Classes
    I18n
  198. def toString(): String
    Definition Classes
    AnyRef → Any
  199. def url[T <: Action](implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  200. def url[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String
    Definition Classes
    Url
  201. def url(params: (String, Any)*): String
    Definition Classes
    Url
  202. lazy val url: String
    Definition Classes
    Url
  203. lazy val urlParams: Params

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

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

    Definition Classes
    RequestEnv
  204. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  205. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  206. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  207. def webJarsUrl(directory: String, devFile: String, prodFile: String): String

    Ex: webJarsUrl("jquery/3.1.1/dist", "jquery.js", "jquery.min.js")

    Ex: webJarsUrl("jquery/3.1.1/dist", "jquery.js", "jquery.min.js")

    devFile

    File in the directory to use in development mode

    prodFile

    File in the directory to use in production mode

    Definition Classes
    Url
  208. def webJarsUrl(devPath: String, prodPath: String): String

    Ex: webJarsUrl("jquery/3.1.1/dist/jquery.js", "jquery/3.1.1/dist/jquery.min.js")

    Ex: webJarsUrl("jquery/3.1.1/dist/jquery.js", "jquery/3.1.1/dist/jquery.min.js")

    devPath

    File path to use in development mode

    prodPath

    File path to use in production mode

    Definition Classes
    Url
  209. def webJarsUrl(path: String): String

    path

    Use "myapp/foo.js" to specify "META-INF/resources/webjars/myapp/foo.js"

    Definition Classes
    Url
  210. lazy val webSocketScheme: String
    Definition Classes
    Net
  211. lazy val xitrumCss: Elem
    Definition Classes
    FlashRenderer

Inherited from Action

Inherited from I18n

Inherited from JsResponder

Inherited from JsRenderer

Inherited from FlashResponder

Inherited from FlashRenderer

Inherited from ViewResponder

Inherited from Responder

Inherited from ViewRenderer

Inherited from Renderer

Inherited from Url

Inherited from Redirect

Inherited from BasicAuth

Inherited from Filter

Inherited from Net

Inherited from Log

Inherited from SessionEnv

Inherited from Csrf

Inherited from RequestEnv

Inherited from ParamAccess

Inherited from AnyRef

Inherited from Any

Ungrouped