SwaggerUi

Value Members

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

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

5. final def ==(arg0: Any): Boolean

   Definition Classes

   Any

6. object DefaultsTo extends Action.LowPriorityDefaultsTo

   Definition Classes

   ParamAccess

7. def absUrl[T <: Action](implicit arg0: Manifest[T]): String

   Definition Classes

   Url

8. def absUrl[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String

   Definition Classes

   Url

9. def absUrl(params: (String, Any)*): String

   Definition Classes

   Url

10. lazy val absUrl: String

    Definition Classes

    Url

11. lazy val absUrlPrefix: String

    Definition Classes

    Url

12. lazy val absUrlPrefixWithoutScheme: String

    Definition Classes

    Url

13. def addConnectionClosedListener(listener: ⇒ Unit): Unit

    Definition Classes

    Action

14. def afterFilter(f: ⇒ Any): Unit

    Definition Classes

    Filter

15. lazy val antiCsrfInput: String

    Definition Classes

    Csrf

16. lazy val antiCsrfMeta: String

    Definition Classes

    Csrf

17. def antiCsrfToken: String

    Definition Classes

    Csrf

18. def apply(handlerEnv: HandlerEnv): Unit

    Definition Classes

    RequestEnv

19. def aroundFilter(f: (() ⇒ Any) ⇒ Any): Unit

    Definition Classes

    Filter

20. final def asInstanceOf[T0]: T0

    Definition Classes

    Any

21. lazy val at: At

    Definition Classes

    RequestEnv

22. def atJson(key: String): String

    Definition Classes

    RequestEnv

23. def autosetLanguage(resourceLanguages: String*): Unit

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

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

    Definition Classes

    I18n

24. 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

25. def beforeFilter(f: ⇒ Boolean): Unit

    Definition Classes

    Filter

26. lazy val bodyFileParams: FileUploadParams

    Definition Classes

    RequestEnv

27. lazy val bodyTextParams: Params

    Definition Classes

    RequestEnv

28. def browserLanguages: Array[String]

    returns

    List of languages sorted by priority from high to low

    Definition Classes

    I18n

29. def callAfterFilters(): Unit

    Called by Dispatcher

    Called by Dispatcher

    Definition Classes

    Filter

30. def callBeforeFilters(): Boolean

    Called by Dispatcher

    Called by Dispatcher

    Definition Classes

    Filter

31. def callExecuteWrappedInAroundFilters(): Unit

    Called by Dispatcher

    Called by Dispatcher

    Definition Classes

    Filter

32. lazy val channel: Channel

    Definition Classes

    RequestEnv

33. def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. def convertText[T](value: String)(implicit m: Manifest[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

35. implicit val currentAction: Action

    Definition Classes

    Action

36. def dispatchWithFailsafe(): Unit

    Definition Classes

    Action

37. final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

38. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

39. 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

    SwaggerUi → Action

40. implicit val executionContext: ExecutionContextExecutor

    Definition Classes

    Action

41. def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

42. 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

    Flash

43. def flash(msg: Any): Unit

    Definition Classes

    Flash

    See also

    jsFlash(msg).

44. def forwardTo[T <: Action]()(implicit arg0: Manifest[T]): Unit

    Tells another action to process the current request for the current action.

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

    Definition Classes

    Redirect

45. var forwarding: Boolean

    Set to true by forwardTo.

    Set to true by forwardTo.

    Definition Classes

    Redirect

46. def getActionClass[T <: Action](implicit arg0: Manifest[T]): Class[Action]

    Definition Classes

    GetActionClassDefaultsToCurrentAction

47. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

48. def getLanguage: String

    Default language is "en".

    Default language is "en".

    Definition Classes

    I18n

49. var handlerEnv: HandlerEnv

    Definition Classes

    RequestEnv

50. def hashCode(): Int

    Definition Classes

    AnyRef → Any

51. lazy val isAjax: Boolean

    Definition Classes

    Js

52. def isDoneResponding: Boolean

    Definition Classes

    Responder

53. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

54. lazy val isSsl: Boolean

    Definition Classes

    Net

55. def js$(selector: String): String

    Definition Classes

    Js

56. def js$id(id: String): String

    Definition Classes

    Js

57. def js$name(name: String): String

    Definition Classes

    Js

58. def jsAddToView(js: Any): Unit

    Definition Classes

    Js

59. lazy val jsDefaults: Group

    Definition Classes

    Js

60. 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

    Js

61. lazy val jsForView: Serializable

    Definition Classes

    Js

62. def jsRedirectTo[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): ChannelFuture

    Definition Classes

    Js

63. def jsRedirectTo(location: Any): ChannelFuture

    See http://stackoverflow.

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

    Definition Classes

    Js

64. def jsRenderFlash(): Unit

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

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

    Definition Classes

    Flash

65. def jsRenderFlash(msg: Any): Unit

    For web 2.

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

    Definition Classes

    Flash

66. def jsRespond(fragments: Any*): ChannelFuture

    Definition Classes

    Js

67. def jsRespondFlash(msg: Any): Unit

    For web 2.

    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

    Flash

68. def layout: Any

    Definition Classes

    Renderer

69. 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

70. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

71. final def notify(): Unit

    Definition Classes

    AnyRef

72. final def notifyAll(): Unit

    Definition Classes

    AnyRef

73. 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

74. def param[T](key: String, coll: Params = null)(implicit e: DefaultsTo[T, String], m: Manifest[T]): T

    Definition Classes

    ParamAccess

75. def paramo[T](key: String, coll: Params = null)(implicit e: DefaultsTo[T, String], m: Manifest[T]): Option[T]

    Definition Classes

    ParamAccess

76. def params[T](key: String, coll: Params = null)(implicit e: DefaultsTo[T, String], m: Manifest[T]): Seq[T]

    Definition Classes

    ParamAccess

77. def paramso[T](key: String, coll: Params = null)(implicit e: DefaultsTo[T, String], m: Manifest[T]): Option[Seq[T]]

    Definition Classes

    ParamAccess

78. lazy val pathParams: Params

    Definition Classes

    RequestEnv

79. def publicUrl(path: String): String

    path

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

    Definition Classes

    Url

80. lazy val queryParams: Params

    Definition Classes

    RequestEnv

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

    See also forwardTo.

    See also forwardTo.

    Definition Classes

    Redirect

82. def redirectTo(location: String, status: HttpResponseStatus = FOUND): ChannelFuture

    See also forwardTo.

    See also forwardTo.

    Definition Classes

    Redirect

83. def redirectToThis(params: (String, Any)*): ChannelFuture

    Definition Classes

    Redirect

84. lazy val remoteIp: String

    returns

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

    Definition Classes

    Net

85. def renderEventSource(data: Any, event: String = "message"): String

    Definition Classes

    Renderer

86. def renderFragment[T <: Action](fragment: String)(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

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

    Definition Classes

    Renderer

88. def renderFragment(location: Class[_ <: Action], fragment: String, options: Map[String, Any]): String

    Definition Classes

    Renderer

89. def renderInlineView(inlineView: Any): String

    Definition Classes

    Renderer

90. def renderView[T <: Action]()(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

91. def renderView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

92. def renderView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

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

    Definition Classes

    Renderer

94. def renderView(customLayout: () ⇒ Any, location: Class[_ <: Action], options: Map[String, Any]): String

    Renders the template associated with an action to "renderedTemplate", then calls the layout function.

    Renders the template associated with an action to "renderedTemplate", then calls the layout function.

    options

    specific to the configured template engine

    Definition Classes

    Renderer

95. def renderViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

96. def renderViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): String

    Definition Classes

    Renderer

97. def renderViewNoLayout(location: Class[_ <: Action], options: Map[String, Any]): String

    Definition Classes

    Renderer

98. var renderedView: Any

    Definition Classes

    Renderer

99. lazy val request: FullHttpRequest

    Definition Classes

    RequestEnv

100. def requestContentJson[T](implicit m: Manifest[T]): Option[T]

     Ex: val json = requestContentJson[Map[String, String]]

     Ex: val json = requestContentJson[Map[String, String]]

     Definition Classes

     RequestEnv

101. lazy val requestContentString: String

     Definition Classes

     RequestEnv

102. 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

     SessionEnv

103. def resourceUrl(path: String): String

     path

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

     Definition Classes

     Url

104. def respond(): ChannelFuture

     Definition Classes

     Responder

105. 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

106. 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

107. def respondDefault404Page(): ChannelFuture

     Definition Classes

     Responder

108. def respondDefault500Page(): ChannelFuture

     Definition Classes

     Responder

109. 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

110. 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/ngocdaothanh/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

111. def respondHtml(any: Any): ChannelFuture

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

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

     Definition Classes

     Responder

112. def respondInlineView(inlineView: Any): ChannelFuture

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

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

     Definition Classes

     Responder

113. def respondJs(any: Any): ChannelFuture

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

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

     Definition Classes

     Responder

114. 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

115. 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

116. 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

117. def respondJsonText(any: Any): ChannelFuture

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

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

     Definition Classes

     Responder

118. def respondLastChunk(trailingHeaders: HttpHeaders = HttpHeaders.EMPTY_HEADERS): ChannelFuture

     See setChunked.

     See setChunked.

     Definition Classes

     Responder

119. 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

120. 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

121. def respondView[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

122. def respondView[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

123. def respondView[T <: Action](customLayout: () ⇒ Any)(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

124. def respondView[T <: Action](customLayout: () ⇒ Any, options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

125. def respondView(customLayout: () ⇒ Any, location: Class[_ <: Action], options: Map[String, Any]): ChannelFuture

     options

     specific to the configured template engine

     Definition Classes

     Responder

126. def respondViewNoLayout[T <: Action]()(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

127. def respondViewNoLayout[T <: Action](options: Map[String, Any])(implicit arg0: Manifest[T]): ChannelFuture

     Definition Classes

     Responder

128. def respondViewNoLayout(location: Class[_ <: Action], options: Map[String, Any]): ChannelFuture

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

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

     Definition Classes

     Responder

129. def respondXml(any: Any): ChannelFuture

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

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

     Definition Classes

     Responder

130. lazy val response: FullHttpResponse

     Definition Classes

     RequestEnv

131. val responseCookies: ArrayBuffer[Cookie]

     Definition Classes

     SessionEnv

132. lazy val scheme: String

     Definition Classes

     Net

133. lazy val serverName: String

     Definition Classes

     Net

134. lazy val serverPort: Int

     Definition Classes

     Net

135. lazy val session: Session

     To reset session: session.

     To reset session: session.clear()

     Definition Classes

     SessionEnv

136. def sessiono[T](key: String)(implicit d: DefaultsTo[T, String]): Option[T]

     Definition Classes

     SessionEnv

137. def setChunked(): Unit

     To respond chunks (http://en.

     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

138. def setClientCacheAggressively(): Unit

     Definition Classes

     Responder

139. def setCookieAndSessionIfTouchedOnRespond(): Unit

     Definition Classes

     SessionEnv

140. def setLanguage(language: String): Unit

     Definition Classes

     I18n

141. def setNoClientCache(): Unit

     Definition Classes

     Responder

142. def sockJsAbsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String

     Definition Classes

     Url

143. def sockJsUrl[T <: SockJsAction](implicit arg0: Manifest[T]): String

     Definition Classes

     Url

144. final def synchronized[T0](arg0: ⇒ T0): T0

     Definition Classes

     AnyRef

145. def t(singular: String): String

     Definition Classes

     I18n

146. def tc(ctx: String, singular: String): String

     Definition Classes

     I18n

147. def tcf(ctx: String, singular: String, args: Any*): String

     Definition Classes

     I18n

148. def tcn(ctx: String, singular: String, plural: String, n: Long): String

     Definition Classes

     I18n

149. def tcnf(ctx: String, singular: String, plural: String, n: Long, args: Any*): String

     Definition Classes

     I18n

150. lazy val textParams: Params

     Definition Classes

     RequestEnv

151. def tf(singular: String, args: Any*): String

     Definition Classes

     I18n

152. implicit val timeout: FiniteDuration

     Definition Classes

     Action

153. def tn(singular: String, plural: String, n: Long): String

     Definition Classes

     I18n

154. def tnf(singular: String, plural: String, n: Long, args: Any*): String

     Definition Classes

     I18n

155. def toString(): String

     Definition Classes

     AnyRef → Any

156. def url[T <: Action](implicit arg0: Manifest[T]): String

     Definition Classes

     Url

157. def url[T <: Action](params: (String, Any)*)(implicit arg0: Manifest[T]): String

     Definition Classes

     Url

158. def url(params: (String, Any)*): String

     Definition Classes

     Url

159. lazy val url: String

     Definition Classes

     Url

160. lazy val urlParams: Params

     Definition Classes

     RequestEnv

161. final def wait(): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

162. final def wait(arg0: Long, arg1: Int): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

163. final def wait(arg0: Long): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

164. lazy val webSocketAbsRequestUrl: String

     Definition Classes

     Url

165. def webSocketAbsUrl[T <: WebSocketAction](implicit arg0: Manifest[T]): String

     Definition Classes

     Url

166. def webSocketAbsUrl[T <: WebSocketAction](params: (String, Any)*)(implicit arg0: Manifest[T]): String

     Definition Classes

     Url

167. def webSocketAbsUrl(params: (String, Any)*): String

     Definition Classes

     Url

168. lazy val webSocketAbsUrl: String

     Definition Classes

     Url

169. lazy val webSocketAbsUrlPrefix: String

     Definition Classes

     Url

170. lazy val webSocketScheme: String

     Definition Classes

     Net

171. lazy val xitrumCss: String

     Definition Classes

     Flash