controllers

WebJarAssets

class WebJarAssets extends AssetsBuilder

A Play framework controller that is able to resolve WebJar paths.

org.webjars.play.webJarFilterExpr can be used to declare a regex for the files that should be looked for when searching within WebJars. By default all files are searched for.

Annotations
@Singleton()
Linear Supertypes
AssetsBuilder, Controller, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, BodyParsers, Results, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WebJarAssets
  2. AssetsBuilder
  3. Controller
  4. Rendering
  5. RequestExtractors
  6. AcceptExtractors
  7. ContentTypes
  8. HeaderNames
  9. Status
  10. HttpProtocol
  11. BodyParsers
  12. Results
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebJarAssets(errorHandler: HttpErrorHandler, configuration: Configuration, environment: Environment)

    Annotations
    @Inject()

Type Members

  1. class Status extends Result

    Definition Classes
    Results

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. val ACCEPT: String

    Definition Classes
    HeaderNames
  7. val ACCEPTED: Int

    Definition Classes
    Status
  8. val ACCEPT_CHARSET: String

    Definition Classes
    HeaderNames
  9. val ACCEPT_ENCODING: String

    Definition Classes
    HeaderNames
  10. val ACCEPT_LANGUAGE: String

    Definition Classes
    HeaderNames
  11. val ACCEPT_RANGES: String

    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_ALLOW_METHODS: String

    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_MAX_AGE: String

    Definition Classes
    HeaderNames
  18. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Definition Classes
    HeaderNames
  19. val ACCESS_CONTROL_REQUEST_METHOD: String

    Definition Classes
    HeaderNames
  20. val AGE: String

    Definition Classes
    HeaderNames
  21. val ALLOW: String

    Definition Classes
    HeaderNames
  22. val AUTHORIZATION: String

    Definition Classes
    HeaderNames
  23. val Accepted: Status

    Definition Classes
    Results
  24. val BAD_GATEWAY: Int

    Definition Classes
    Status
  25. val BAD_REQUEST: Int

    Definition Classes
    Status
  26. val BINARY: String

    Definition Classes
    ContentTypes
  27. val BadGateway: Status

    Definition Classes
    Results
  28. val BadRequest: Status

    Definition Classes
    Results
  29. val CACHE_CONTROL: String

    Definition Classes
    HeaderNames
  30. val CACHE_MANIFEST: String

    Definition Classes
    ContentTypes
  31. val CHUNKED: String

    Definition Classes
    HttpProtocol
  32. val CONFLICT: Int

    Definition Classes
    Status
  33. val CONNECTION: String

    Definition Classes
    HeaderNames
  34. val CONTENT_DISPOSITION: String

    Definition Classes
    HeaderNames
  35. val CONTENT_ENCODING: String

    Definition Classes
    HeaderNames
  36. val CONTENT_LANGUAGE: String

    Definition Classes
    HeaderNames
  37. val CONTENT_LENGTH: String

    Definition Classes
    HeaderNames
  38. val CONTENT_LOCATION: String

    Definition Classes
    HeaderNames
  39. val CONTENT_MD5: String

    Definition Classes
    HeaderNames
  40. val CONTENT_RANGE: String

    Definition Classes
    HeaderNames
  41. val CONTENT_TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  42. val CONTENT_TYPE: String

    Definition Classes
    HeaderNames
  43. val CONTINUE: Int

    Definition Classes
    Status
  44. val COOKIE: String

    Definition Classes
    HeaderNames
  45. val CREATED: Int

    Definition Classes
    Status
  46. def CSS(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  47. val Conflict: Status

    Definition Classes
    Results
  48. val Created: Status

    Definition Classes
    Results
  49. val DATE: String

    Definition Classes
    HeaderNames
  50. val ETAG: String

    Definition Classes
    HeaderNames
  51. def EVENT_STREAM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  52. val EXPECT: String

    Definition Classes
    HeaderNames
  53. val EXPECTATION_FAILED: Int

    Definition Classes
    Status
  54. val EXPIRES: String

    Definition Classes
    HeaderNames
  55. val EntityTooLarge: Status

    Definition Classes
    Results
  56. val ExpectationFailed: Status

    Definition Classes
    Results
  57. val FAILED_DEPENDENCY: Int

    Definition Classes
    Status
  58. val FORBIDDEN: Int

    Definition Classes
    Status
  59. def FORM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  60. val FORWARDED: String

    Definition Classes
    HeaderNames
  61. val FOUND: Int

    Definition Classes
    Status
  62. val FROM: String

    Definition Classes
    HeaderNames
  63. val FailedDependency: Status

    Definition Classes
    Results
  64. val Forbidden: Status

    Definition Classes
    Results
  65. def Found(url: String): Result

    Definition Classes
    Results
  66. val GATEWAY_TIMEOUT: Int

    Definition Classes
    Status
  67. val GONE: Int

    Definition Classes
    Status
  68. val GatewayTimeout: Status

    Definition Classes
    Results
  69. val Gone: Status

    Definition Classes
    Results
  70. val HOST: String

    Definition Classes
    HeaderNames
  71. def HTML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  72. val HTTP_1_0: String

    Definition Classes
    HttpProtocol
  73. val HTTP_1_1: String

    Definition Classes
    HttpProtocol
  74. val HTTP_VERSION_NOT_SUPPORTED: Int

    Definition Classes
    Status
  75. val HttpVersionNotSupported: Status

    Definition Classes
    Results
  76. val IF_MATCH: String

    Definition Classes
    HeaderNames
  77. val IF_MODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  78. val IF_NONE_MATCH: String

    Definition Classes
    HeaderNames
  79. val IF_RANGE: String

    Definition Classes
    HeaderNames
  80. val IF_UNMODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  81. val INSUFFICIENT_STORAGE: Int

    Definition Classes
    Status
  82. val INTERNAL_SERVER_ERROR: Int

    Definition Classes
    Status
  83. val InsufficientStorage: Status

    Definition Classes
    Results
  84. val InternalServerError: Status

    Definition Classes
    Results
  85. def JAVASCRIPT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  86. def JSON(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  87. val LAST_MODIFIED: String

    Definition Classes
    HeaderNames
  88. val LENGTH_REQUIRED: Int

    Definition Classes
    Status
  89. val LOCATION: String

    Definition Classes
    HeaderNames
  90. val LOCKED: Int

    Definition Classes
    Status
  91. val Locked: Status

    Definition Classes
    Results
  92. val MAX_FORWARDS: String

    Definition Classes
    HeaderNames
  93. val METHOD_NOT_ALLOWED: Int

    Definition Classes
    Status
  94. val MOVED_PERMANENTLY: Int

    Definition Classes
    Status
  95. val MULTIPLE_CHOICES: Int

    Definition Classes
    Status
  96. val MULTI_STATUS: Int

    Definition Classes
    Status
  97. val MethodNotAllowed: Status

    Definition Classes
    Results
  98. def MovedPermanently(url: String): Result

    Definition Classes
    Results
  99. val MultiStatus: Status

    Definition Classes
    Results
  100. val NON_AUTHORITATIVE_INFORMATION: Int

    Definition Classes
    Status
  101. val NOT_ACCEPTABLE: Int

    Definition Classes
    Status
  102. val NOT_FOUND: Int

    Definition Classes
    Status
  103. val NOT_IMPLEMENTED: Int

    Definition Classes
    Status
  104. val NOT_MODIFIED: Int

    Definition Classes
    Status
  105. val NO_CONTENT: Int

    Definition Classes
    Status
  106. val NoContent: Result

    Definition Classes
    Results
  107. val NonAuthoritativeInformation: Status

    Definition Classes
    Results
  108. val NotAcceptable: Status

    Definition Classes
    Results
  109. val NotFound: Status

    Definition Classes
    Results
  110. val NotImplemented: Status

    Definition Classes
    Results
  111. val NotModified: Result

    Definition Classes
    Results
  112. val OK: Int

    Definition Classes
    Status
  113. val ORIGIN: String

    Definition Classes
    HeaderNames
  114. val Ok: Status

    Definition Classes
    Results
  115. val PARTIAL_CONTENT: Int

    Definition Classes
    Status
  116. val PAYMENT_REQUIRED: Int

    Definition Classes
    Status
  117. val PRAGMA: String

    Definition Classes
    HeaderNames
  118. val PRECONDITION_FAILED: Int

    Definition Classes
    Status
  119. val PROXY_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  120. val PROXY_AUTHENTICATION_REQUIRED: Int

    Definition Classes
    Status
  121. val PROXY_AUTHORIZATION: String

    Definition Classes
    HeaderNames
  122. val PartialContent: Status

    Definition Classes
    Results
  123. val PaymentRequired: Status

    Definition Classes
    Results
  124. val PreconditionFailed: Status

    Definition Classes
    Results
  125. val RANGE: String

    Definition Classes
    HeaderNames
  126. val REFERER: String

    Definition Classes
    HeaderNames
  127. val REQUESTED_RANGE_NOT_SATISFIABLE: Int

    Definition Classes
    Status
  128. val REQUEST_ENTITY_TOO_LARGE: Int

    Definition Classes
    Status
  129. val REQUEST_TIMEOUT: Int

    Definition Classes
    Status
  130. val REQUEST_URI_TOO_LONG: Int

    Definition Classes
    Status
  131. val RESET_CONTENT: Int

    Definition Classes
    Status
  132. val RETRY_AFTER: String

    Definition Classes
    HeaderNames
  133. def Redirect(call: Call, status: Int): Result

    Definition Classes
    Results
  134. def Redirect(call: Call): Result

    Definition Classes
    Results
  135. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result

    Definition Classes
    Results
  136. def Redirect(url: String, status: Int): Result

    Definition Classes
    Results
  137. val RequestTimeout: Status

    Definition Classes
    Results
  138. val ResetContent: Result

    Definition Classes
    Results
  139. val SEE_OTHER: Int

    Definition Classes
    Status
  140. val SERVER: String

    Definition Classes
    HeaderNames
  141. val SERVICE_UNAVAILABLE: Int

    Definition Classes
    Status
  142. val SET_COOKIE: String

    Definition Classes
    HeaderNames
  143. val SET_COOKIE2: String

    Definition Classes
    HeaderNames
  144. val SWITCHING_PROTOCOLS: Int

    Definition Classes
    Status
  145. def SeeOther(url: String): Result

    Definition Classes
    Results
  146. val ServiceUnavailable: Status

    Definition Classes
    Results
  147. def Status(code: Int): Status

    Definition Classes
    Results
  148. val TE: String

    Definition Classes
    HeaderNames
  149. val TEMPORARY_REDIRECT: Int

    Definition Classes
    Status
  150. def TEXT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  151. val TODO: Action[AnyContent]

    Definition Classes
    Controller
  152. val TOO_MANY_REQUEST: Int

    Definition Classes
    Status
  153. val TRAILER: String

    Definition Classes
    HeaderNames
  154. val TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  155. def TemporaryRedirect(url: String): Result

    Definition Classes
    Results
  156. val TooManyRequest: Status

    Definition Classes
    Results
  157. val UNAUTHORIZED: Int

    Definition Classes
    Status
  158. val UNPROCESSABLE_ENTITY: Int

    Definition Classes
    Status
  159. val UNSUPPORTED_MEDIA_TYPE: Int

    Definition Classes
    Status
  160. val UPGRADE: String

    Definition Classes
    HeaderNames
  161. val USER_AGENT: String

    Definition Classes
    HeaderNames
  162. val USE_PROXY: Int

    Definition Classes
    Status
  163. val Unauthorized: Status

    Definition Classes
    Results
  164. val UnprocessableEntity: Status

    Definition Classes
    Results
  165. val UnsupportedMediaType: Status

    Definition Classes
    Results
  166. val UriTooLong: Status

    Definition Classes
    Results
  167. val VARY: String

    Definition Classes
    HeaderNames
  168. val VIA: String

    Definition Classes
    HeaderNames
  169. val WARNING: String

    Definition Classes
    HeaderNames
  170. val WWW_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  171. val WebjarFilterExprDefault: String

  172. val WebjarFilterExprProp: String

  173. def XML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  174. val X_FORWARDED_FOR: String

    Definition Classes
    HeaderNames
  175. val X_FORWARDED_HOST: String

    Definition Classes
    HeaderNames
  176. val X_FORWARDED_PORT: String

    Definition Classes
    HeaderNames
  177. val X_FORWARDED_PROTO: String

    Definition Classes
    HeaderNames
  178. val X_REQUESTED_WITH: String

    Definition Classes
    HeaderNames
  179. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  180. def at(file: String): Action[AnyContent]

    Controller Method to serve a WebJar asset

    Controller Method to serve a WebJar asset

    file

    the file to serve

    returns

    the Action that serves the file

  181. def at(path: String, file: String, aggressiveCaching: Boolean): Action[AnyContent]

    Definition Classes
    AssetsBuilder
  182. def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]]): Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  183. def chunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  184. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  185. def dechunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  186. def dechunkWithTrailers: Enumeratee[Array[Byte], Either[Array[Byte], Seq[(String, String)]]]

    Definition Classes
    Results
  187. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  190. def fullPath(webjar: String, path: String): String

    Get the full path to a file in a WebJar without validating that the file actually exists

    Get the full path to a file in a WebJar without validating that the file actually exists

    webjar

    the WebJar artifactId

    path

    the full path to a file in the WebJar

    returns

    the path to the file (sans-the webjars prefix)

    Example:
    1. Calling fullPath("react", "react.js") will return the full path to the file in the WebJar because react.js exists at the root of the WebJar

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

    Definition Classes
    AnyRef → Any
  192. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  193. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  194. def locate(webjar: String, file: String): String

    Locate a file in a WebJar

    Locate a file in a WebJar

    webjar

    the WebJar artifactId

    file

    the file or partial path to find

    returns

    the path to the file (sans-the webjars prefix)

  195. def locate(file: String): String

    Locate a file in a WebJar

    Locate a file in a WebJar

    file

    the file or partial path to find

    returns

    the path to the file (sans-the webjars prefix)

    Example:
    1. Passing in jquery.min.js will return jquery/1.8.2/jquery.min.js assuming the jquery WebJar version 1.8.2 is on the classpath

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

    Definition Classes
    AnyRef
  197. final def notify(): Unit

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

    Definition Classes
    AnyRef
  199. implicit def request2flash(implicit request: RequestHeader): Flash

    Definition Classes
    Controller
  200. implicit def request2lang(implicit request: RequestHeader): Lang

    Definition Classes
    Controller
  201. implicit def request2session(implicit request: RequestHeader): Session

    Definition Classes
    Controller
  202. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  203. def toString(): String

    Definition Classes
    AnyRef → Any
  204. def versioned(path: String, file: Asset): Action[AnyContent]

    Definition Classes
    AssetsBuilder
  205. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  208. val webJarAssetLocator: WebJarAssetLocator

  209. lazy val webJarFilterExpr: String

  210. def withCharset(mimeType: String)(implicit codec: Codec): String

    Definition Classes
    ContentTypes

Inherited from AssetsBuilder

Inherited from Controller

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from play.api.http.Status

Inherited from HttpProtocol

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped