Trait

be.wegenenverkeer.atomium.play

FeedSupport

Related Doc: package play

Permalink

trait FeedSupport[T] extends Results with HeaderNames with Rendering with AcceptExtractors

trait supporting serving of feed pages: sets correct caching headers sets ETag and Last-Modified response headers and responds with Not-Modified if needed to reduce bandwidth supports content-negotiation and responds with either JSON or XML depending on registered marshallers

T

the type of the feed entries²

Linear Supertypes
AcceptExtractors, Rendering, HeaderNames, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FeedSupport
  2. AcceptExtractors
  3. Rendering
  4. HeaderNames
  5. Results
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Status extends Result

    Permalink
    Definition Classes
    Results

Abstract Value Members

  1. abstract def marshallers: PartialFunction[MediaRange, FeedPageCodec[T, Array[Byte]]]

    Permalink

    Define the PartialFunction that will map acceptable content types to FeedMarshallers.

    Define the PartialFunction that will map acceptable content types to FeedMarshallers.

    For instance:

    // supports XML and JSON and used predefined FeedMarshallers
    override def marshallers = {
      case Accepts.Xml()  => JaxbFeedMarshaller[String]()
      case Accepts.Json() => PlayJsonFeedMarshaller[String]()
    }

    or in case a specifc content types is need...

    // supports XML and JSON and used predefined FeedMarshallers
    override def marshallers = {
      case Accepts.Xml()  => JaxbFeedMarshaller[String]("application/my-api-v1.0+xml")
      case Accepts.Json() => PlayJsonFeedMarshaller[String]("application/my-api-v1.0+json")
    }
    returns

    PartialFunction[MediaRange, FeedMarshaller]

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val ACCEPT: String

    Permalink
    Definition Classes
    HeaderNames
  5. val ACCEPT_CHARSET: String

    Permalink
    Definition Classes
    HeaderNames
  6. val ACCEPT_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  7. val ACCEPT_LANGUAGE: String

    Permalink
    Definition Classes
    HeaderNames
  8. val ACCEPT_RANGES: String

    Permalink
    Definition Classes
    HeaderNames
  9. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Permalink
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_ALLOW_METHODS: String

    Permalink
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Permalink
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_MAX_AGE: String

    Permalink
    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Permalink
    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_REQUEST_METHOD: String

    Permalink
    Definition Classes
    HeaderNames
  17. val AGE: String

    Permalink
    Definition Classes
    HeaderNames
  18. val ALLOW: String

    Permalink
    Definition Classes
    HeaderNames
  19. val AUTHORIZATION: String

    Permalink
    Definition Classes
    HeaderNames
  20. val Accepted: Status

    Permalink
    Definition Classes
    Results
  21. val BadGateway: Status

    Permalink
    Definition Classes
    Results
  22. val BadRequest: Status

    Permalink
    Definition Classes
    Results
  23. val CACHE_CONTROL: String

    Permalink
    Definition Classes
    HeaderNames
  24. val CONNECTION: String

    Permalink
    Definition Classes
    HeaderNames
  25. val CONTENT_DISPOSITION: String

    Permalink
    Definition Classes
    HeaderNames
  26. val CONTENT_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  27. val CONTENT_LANGUAGE: String

    Permalink
    Definition Classes
    HeaderNames
  28. val CONTENT_LENGTH: String

    Permalink
    Definition Classes
    HeaderNames
  29. val CONTENT_LOCATION: String

    Permalink
    Definition Classes
    HeaderNames
  30. val CONTENT_MD5: String

    Permalink
    Definition Classes
    HeaderNames
  31. val CONTENT_RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  32. val CONTENT_TRANSFER_ENCODING: String

    Permalink
    Definition Classes
    HeaderNames
  33. val CONTENT_TYPE: String

    Permalink
    Definition Classes
    HeaderNames
  34. val COOKIE: String

    Permalink
    Definition Classes
    HeaderNames
  35. val Conflict: Status

    Permalink
    Definition Classes
    Results
  36. val Created: Status

    Permalink
    Definition Classes
    Results
  37. val DATE: String

    Permalink
    Definition Classes
    HeaderNames
  38. val ETAG: String

    Permalink
    Definition Classes
    HeaderNames
  39. val EXPECT: String

    Permalink
    Definition Classes
    HeaderNames
  40. val EXPIRES: String

    Permalink
    Definition Classes
    HeaderNames
  41. val EntityTooLarge: Status

    Permalink
    Definition Classes
    Results
  42. val ExpectationFailed: Status

    Permalink
    Definition Classes
    Results
  43. val FORWARDED: String

    Permalink
    Definition Classes
    HeaderNames
  44. val FROM: String

    Permalink
    Definition Classes
    HeaderNames
  45. val FailedDependency: Status

    Permalink
    Definition Classes
    Results
  46. val Forbidden: Status

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

    Permalink
    Definition Classes
    Results
  48. val GatewayTimeout: Status

    Permalink
    Definition Classes
    Results
  49. val Gone: Status

    Permalink
    Definition Classes
    Results
  50. val HOST: String

    Permalink
    Definition Classes
    HeaderNames
  51. val HttpVersionNotSupported: Status

    Permalink
    Definition Classes
    Results
  52. val IF_MATCH: String

    Permalink
    Definition Classes
    HeaderNames
  53. val IF_MODIFIED_SINCE: String

    Permalink
    Definition Classes
    HeaderNames
  54. val IF_NONE_MATCH: String

    Permalink
    Definition Classes
    HeaderNames
  55. val IF_RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  56. val IF_UNMODIFIED_SINCE: String

    Permalink
    Definition Classes
    HeaderNames
  57. val InsufficientStorage: Status

    Permalink
    Definition Classes
    Results
  58. val InternalServerError: Status

    Permalink
    Definition Classes
    Results
  59. val LAST_MODIFIED: String

    Permalink
    Definition Classes
    HeaderNames
  60. val LOCATION: String

    Permalink
    Definition Classes
    HeaderNames
  61. val Locked: Status

    Permalink
    Definition Classes
    Results
  62. val MAX_FORWARDS: String

    Permalink
    Definition Classes
    HeaderNames
  63. val MethodNotAllowed: Status

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

    Permalink
    Definition Classes
    Results
  65. val MultiStatus: Status

    Permalink
    Definition Classes
    Results
  66. val NoContent: Result

    Permalink
    Definition Classes
    Results
  67. val NonAuthoritativeInformation: Status

    Permalink
    Definition Classes
    Results
  68. val NotAcceptable: Status

    Permalink
    Definition Classes
    Results
  69. val NotFound: Status

    Permalink
    Definition Classes
    Results
  70. val NotImplemented: Status

    Permalink
    Definition Classes
    Results
  71. val NotModified: Result

    Permalink
    Definition Classes
    Results
  72. val ORIGIN: String

    Permalink
    Definition Classes
    HeaderNames
  73. val Ok: Status

    Permalink
    Definition Classes
    Results
  74. val PRAGMA: String

    Permalink
    Definition Classes
    HeaderNames
  75. val PROXY_AUTHENTICATE: String

    Permalink
    Definition Classes
    HeaderNames
  76. val PROXY_AUTHORIZATION: String

    Permalink
    Definition Classes
    HeaderNames
  77. val PartialContent: Status

    Permalink
    Definition Classes
    Results
  78. val PaymentRequired: Status

    Permalink
    Definition Classes
    Results
  79. def PermanentRedirect(url: String): Result

    Permalink
    Definition Classes
    Results
  80. val PreconditionFailed: Status

    Permalink
    Definition Classes
    Results
  81. val RANGE: String

    Permalink
    Definition Classes
    HeaderNames
  82. val REFERER: String

    Permalink
    Definition Classes
    HeaderNames
  83. val RETRY_AFTER: String

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

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

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

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

    Permalink
    Definition Classes
    Results
  88. val RequestTimeout: Status

    Permalink
    Definition Classes
    Results
  89. val ResetContent: Result

    Permalink
    Definition Classes
    Results
  90. val SERVER: String

    Permalink
    Definition Classes
    HeaderNames
  91. val SET_COOKIE: String

    Permalink
    Definition Classes
    HeaderNames
  92. val SET_COOKIE2: String

    Permalink
    Definition Classes
    HeaderNames
  93. def SeeOther(url: String): Result

    Permalink
    Definition Classes
    Results
  94. val ServiceUnavailable: Status

    Permalink
    Definition Classes
    Results
  95. def Status(code: Int): Status

    Permalink
    Definition Classes
    Results
  96. val TE: String

    Permalink
    Definition Classes
    HeaderNames
  97. val TRAILER: String

    Permalink
    Definition Classes
    HeaderNames
  98. val TRANSFER_ENCODING: String

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

    Permalink
    Definition Classes
    Results
  100. val TooManyRequests: Status

    Permalink
    Definition Classes
    Results
  101. val UPGRADE: String

    Permalink
    Definition Classes
    HeaderNames
  102. val USER_AGENT: String

    Permalink
    Definition Classes
    HeaderNames
  103. val Unauthorized: Status

    Permalink
    Definition Classes
    Results
  104. val UnprocessableEntity: Status

    Permalink
    Definition Classes
    Results
  105. val UnsupportedMediaType: Status

    Permalink
    Definition Classes
    Results
  106. val UriTooLong: Status

    Permalink
    Definition Classes
    Results
  107. val VARY: String

    Permalink
    Definition Classes
    HeaderNames
  108. val VIA: String

    Permalink
    Definition Classes
    HeaderNames
  109. val WARNING: String

    Permalink
    Definition Classes
    HeaderNames
  110. val WWW_AUTHENTICATE: String

    Permalink
    Definition Classes
    HeaderNames
  111. val X_FORWARDED_FOR: String

    Permalink
    Definition Classes
    HeaderNames
  112. val X_FORWARDED_HOST: String

    Permalink
    Definition Classes
    HeaderNames
  113. val X_FORWARDED_PORT: String

    Permalink
    Definition Classes
    HeaderNames
  114. val X_FORWARDED_PROTO: String

    Permalink
    Definition Classes
    HeaderNames
  115. val X_REQUESTED_WITH: String

    Permalink
    Definition Classes
    HeaderNames
  116. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  117. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  121. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  124. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  125. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  126. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  127. def processFeedPage(page: Option[FeedPage[T]])(implicit codec: Codec): Action[AnyContent]

    Permalink
  128. def processFeedPage(page: Future[Option[FeedPage[T]]])(implicit codec: Codec): Action[AnyContent]

    Permalink

    marshall the feed and set correct headers

    marshall the feed and set correct headers

    page

    the optional page of the feed

    codec

    the implicit codec

    returns

    the response

  129. object render

    Permalink
    Definition Classes
    Rendering
  130. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  131. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  132. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. val TooManyRequest: Status

    Permalink
    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TooManyRequests instead

Inherited from AcceptExtractors

Inherited from Rendering

Inherited from HeaderNames

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped