Packages

c

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, BaseController, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebJarAssets
  2. AssetsBuilder
  3. BaseController
  4. Rendering
  5. RequestExtractors
  6. AcceptExtractors
  7. ContentTypes
  8. HeaderNames
  9. Status
  10. HttpProtocol
  11. Results
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebJarAssets(errorHandler: HttpErrorHandler, meta: AssetsMetadata, configuration: Configuration, environment: Environment)
    Annotations
    @Inject()

Type Members

  1. class Status extends Result
    Definition Classes
    Results

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. val ACCEPT: String
    Definition Classes
    HeaderNames
  5. val ACCEPTED: Int
    Definition Classes
    Status
  6. val ACCEPT_CHARSET: String
    Definition Classes
    HeaderNames
  7. val ACCEPT_ENCODING: String
    Definition Classes
    HeaderNames
  8. val ACCEPT_LANGUAGE: String
    Definition Classes
    HeaderNames
  9. val ACCEPT_RANGES: String
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_ALLOW_HEADERS: String
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_METHODS: String
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_ORIGIN: String
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_EXPOSE_HEADERS: String
    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_MAX_AGE: String
    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_REQUEST_HEADERS: String
    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_REQUEST_METHOD: String
    Definition Classes
    HeaderNames
  18. val AGE: String
    Definition Classes
    HeaderNames
  19. val ALLOW: String
    Definition Classes
    HeaderNames
  20. val AUTHORIZATION: String
    Definition Classes
    HeaderNames
  21. val Accepted: Status
    Definition Classes
    Results
  22. val BAD_GATEWAY: Int
    Definition Classes
    Status
  23. val BAD_REQUEST: Int
    Definition Classes
    Status
  24. val BINARY: String
    Definition Classes
    ContentTypes
  25. val BadGateway: Status
    Definition Classes
    Results
  26. val BadRequest: Status
    Definition Classes
    Results
  27. val CACHE_CONTROL: String
    Definition Classes
    HeaderNames
  28. val CACHE_MANIFEST: String
    Definition Classes
    ContentTypes
  29. val CHUNKED: String
    Definition Classes
    HttpProtocol
  30. val CONFLICT: Int
    Definition Classes
    Status
  31. val CONNECTION: String
    Definition Classes
    HeaderNames
  32. val CONTENT_DISPOSITION: String
    Definition Classes
    HeaderNames
  33. val CONTENT_ENCODING: String
    Definition Classes
    HeaderNames
  34. val CONTENT_LANGUAGE: String
    Definition Classes
    HeaderNames
  35. val CONTENT_LENGTH: String
    Definition Classes
    HeaderNames
  36. val CONTENT_LOCATION: String
    Definition Classes
    HeaderNames
  37. val CONTENT_MD5: String
    Definition Classes
    HeaderNames
  38. val CONTENT_RANGE: String
    Definition Classes
    HeaderNames
  39. val CONTENT_TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  40. val CONTENT_TYPE: String
    Definition Classes
    HeaderNames
  41. val CONTINUE: Int
    Definition Classes
    Status
  42. val COOKIE: String
    Definition Classes
    HeaderNames
  43. val CREATED: Int
    Definition Classes
    Status
  44. def CSS(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  45. val Conflict: Status
    Definition Classes
    Results
  46. val Continue: Result
    Definition Classes
    Results
  47. val Created: Status
    Definition Classes
    Results
  48. val DATE: String
    Definition Classes
    HeaderNames
  49. val ETAG: String
    Definition Classes
    HeaderNames
  50. def EVENT_STREAM(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  51. val EXPECT: String
    Definition Classes
    HeaderNames
  52. val EXPECTATION_FAILED: Int
    Definition Classes
    Status
  53. val EXPIRES: String
    Definition Classes
    HeaderNames
  54. val EntityTooLarge: Status
    Definition Classes
    Results
  55. val ExpectationFailed: Status
    Definition Classes
    Results
  56. val FAILED_DEPENDENCY: Int
    Definition Classes
    Status
  57. val FORBIDDEN: Int
    Definition Classes
    Status
  58. val FORM: String
    Definition Classes
    ContentTypes
  59. val FORWARDED: String
    Definition Classes
    HeaderNames
  60. val FOUND: Int
    Definition Classes
    Status
  61. val FROM: String
    Definition Classes
    HeaderNames
  62. val FailedDependency: Status
    Definition Classes
    Results
  63. val Forbidden: Status
    Definition Classes
    Results
  64. def Found(url: String): Result
    Definition Classes
    Results
  65. val GATEWAY_TIMEOUT: Int
    Definition Classes
    Status
  66. val GONE: Int
    Definition Classes
    Status
  67. val GatewayTimeout: Status
    Definition Classes
    Results
  68. val Gone: Status
    Definition Classes
    Results
  69. val HOST: String
    Definition Classes
    HeaderNames
  70. def HTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  71. val HTTP_1_0: String
    Definition Classes
    HttpProtocol
  72. val HTTP_1_1: String
    Definition Classes
    HttpProtocol
  73. val HTTP_VERSION_NOT_SUPPORTED: Int
    Definition Classes
    Status
  74. val HttpVersionNotSupported: Status
    Definition Classes
    Results
  75. val IF_MATCH: String
    Definition Classes
    HeaderNames
  76. val IF_MODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  77. val IF_NONE_MATCH: String
    Definition Classes
    HeaderNames
  78. val IF_RANGE: String
    Definition Classes
    HeaderNames
  79. val IF_UNMODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  80. val INSUFFICIENT_STORAGE: Int
    Definition Classes
    Status
  81. val INTERNAL_SERVER_ERROR: Int
    Definition Classes
    Status
  82. val InsufficientStorage: Status
    Definition Classes
    Results
  83. val InternalServerError: Status
    Definition Classes
    Results
  84. def JAVASCRIPT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  85. val JSON: String
    Definition Classes
    ContentTypes
  86. val LAST_MODIFIED: String
    Definition Classes
    HeaderNames
  87. val LENGTH_REQUIRED: Int
    Definition Classes
    Status
  88. val LINK: String
    Definition Classes
    HeaderNames
  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 PERMANENT_REDIRECT: Int
    Definition Classes
    Status
  118. val PRAGMA: String
    Definition Classes
    HeaderNames
  119. val PRECONDITION_FAILED: Int
    Definition Classes
    Status
  120. val PROXY_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  121. val PROXY_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  122. val PROXY_AUTHORIZATION: String
    Definition Classes
    HeaderNames
  123. val PartialContent: Status
    Definition Classes
    Results
  124. val PaymentRequired: Status
    Definition Classes
    Results
  125. def PermanentRedirect(url: String): Result
    Definition Classes
    Results
  126. val PreconditionFailed: Status
    Definition Classes
    Results
  127. val RANGE: String
    Definition Classes
    HeaderNames
  128. val REFERER: String
    Definition Classes
    HeaderNames
  129. val REQUESTED_RANGE_NOT_SATISFIABLE: Int
    Definition Classes
    Status
  130. val REQUEST_ENTITY_TOO_LARGE: Int
    Definition Classes
    Status
  131. val REQUEST_TIMEOUT: Int
    Definition Classes
    Status
  132. val REQUEST_URI_TOO_LONG: Int
    Definition Classes
    Status
  133. val RESET_CONTENT: Int
    Definition Classes
    Status
  134. val RETRY_AFTER: String
    Definition Classes
    HeaderNames
  135. def Redirect(call: Call, status: Int): Result
    Definition Classes
    Results
  136. def Redirect(call: Call): Result
    Definition Classes
    Results
  137. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result
    Definition Classes
    Results
  138. def Redirect(url: String, status: Int): Result
    Definition Classes
    Results
  139. val RequestTimeout: Status
    Definition Classes
    Results
  140. val ResetContent: Result
    Definition Classes
    Results
  141. val SEE_OTHER: Int
    Definition Classes
    Status
  142. val SERVER: String
    Definition Classes
    HeaderNames
  143. val SERVICE_UNAVAILABLE: Int
    Definition Classes
    Status
  144. val SET_COOKIE: String
    Definition Classes
    HeaderNames
  145. val SET_COOKIE2: String
    Definition Classes
    HeaderNames
  146. val SWITCHING_PROTOCOLS: Int
    Definition Classes
    Status
  147. def SeeOther(url: String): Result
    Definition Classes
    Results
  148. val ServiceUnavailable: Status
    Definition Classes
    Results
  149. def Status(code: Int): Status
    Definition Classes
    Results
  150. val SwitchingProtocols: Result
    Definition Classes
    Results
  151. val TE: String
    Definition Classes
    HeaderNames
  152. val TEMPORARY_REDIRECT: Int
    Definition Classes
    Status
  153. def TEXT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  154. val TOO_MANY_REQUESTS: Int
    Definition Classes
    Status
  155. val TRAILER: String
    Definition Classes
    HeaderNames
  156. val TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  157. def TemporaryRedirect(url: String): Result
    Definition Classes
    Results
  158. val TooManyRequests: Status
    Definition Classes
    Results
  159. val UNAUTHORIZED: Int
    Definition Classes
    Status
  160. val UNPROCESSABLE_ENTITY: Int
    Definition Classes
    Status
  161. val UNSUPPORTED_MEDIA_TYPE: Int
    Definition Classes
    Status
  162. val UPGRADE: String
    Definition Classes
    HeaderNames
  163. val UPGRADE_REQUIRED: Int
    Definition Classes
    Status
  164. val USER_AGENT: String
    Definition Classes
    HeaderNames
  165. val USE_PROXY: Int
    Definition Classes
    Status
  166. val Unauthorized: Status
    Definition Classes
    Results
  167. val UnprocessableEntity: Status
    Definition Classes
    Results
  168. val UnsupportedMediaType: Status
    Definition Classes
    Results
  169. val UriTooLong: Status
    Definition Classes
    Results
  170. val VARY: String
    Definition Classes
    HeaderNames
  171. val VIA: String
    Definition Classes
    HeaderNames
  172. val WARNING: String
    Definition Classes
    HeaderNames
  173. val WWW_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  174. val WebjarFilterExprDefault: String
  175. val WebjarFilterExprProp: String
  176. def XML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  177. val X_FORWARDED_FOR: String
    Definition Classes
    HeaderNames
  178. val X_FORWARDED_HOST: String
    Definition Classes
    HeaderNames
  179. val X_FORWARDED_PORT: String
    Definition Classes
    HeaderNames
  180. val X_FORWARDED_PROTO: String
    Definition Classes
    HeaderNames
  181. val X_REQUESTED_WITH: String
    Definition Classes
    HeaderNames
  182. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  183. 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

    Definition Classes
    WebJarAssets → AssetsBuilder
  184. def at(path: String, file: String, aggressiveCaching: Boolean): Action[AnyContent]
    Definition Classes
    AssetsBuilder
  185. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  186. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  187. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  188. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  189. 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

  190. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  191. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  192. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  193. 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)

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

  195. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  196. final def notify(): Unit
    Definition Classes
    AnyRef
  197. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  198. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  199. def toString(): String
    Definition Classes
    AnyRef → Any
  200. def versioned(path: String, file: Asset): Action[AnyContent]
    Definition Classes
    AssetsBuilder
  201. def versioned(file: String): Action[AnyContent]
    Definition Classes
    AssetsBuilder
  202. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  203. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  204. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  205. def withCharset(mimeType: String)(implicit codec: Codec): String
    Definition Classes
    ContentTypes

Deprecated Value Members

  1. val TOO_MANY_REQUEST: Int
    Definition Classes
    Status
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TOO_MANY_REQUESTS instead

  2. val TooManyRequest: Status
    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TooManyRequests instead

Inherited from AssetsBuilder

Inherited from BaseController

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 Results

Inherited from AnyRef

Inherited from Any

Ungrouped