c

controllers.publix

GeneralMultipleGroupChannel

class GeneralMultipleGroupChannel extends GroupChannel[GeneralMultipleWorker]

Annotations
@Singleton()
Linear Supertypes
GroupChannel[GeneralMultipleWorker], AbstractController, BaseController, BaseControllerHelpers, ControllerHelpers, RequestImplicits, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralMultipleGroupChannel
  2. GroupChannel
  3. AbstractController
  4. BaseController
  5. BaseControllerHelpers
  6. ControllerHelpers
  7. RequestImplicits
  8. Rendering
  9. RequestExtractors
  10. AcceptExtractors
  11. ContentTypes
  12. HeaderNames
  13. Status
  14. HttpProtocol
  15. Results
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GeneralMultipleGroupChannel(components: ControllerComponents, publixUtils: PublixUtils, studyAuthorisation: GeneralMultipleStudyAuthorisation)
    Annotations
    @Inject()

Type Members

  1. class Status extends Result
    Definition Classes
    Results

Value Members

  1. val ACCEPT: String
    Definition Classes
    HeaderNames
  2. val ACCEPTED: Int
    Definition Classes
    Status
  3. val ACCEPT_CHARSET: String
    Definition Classes
    HeaderNames
  4. val ACCEPT_ENCODING: String
    Definition Classes
    HeaderNames
  5. val ACCEPT_LANGUAGE: String
    Definition Classes
    HeaderNames
  6. val ACCEPT_RANGES: String
    Definition Classes
    HeaderNames
  7. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String
    Definition Classes
    HeaderNames
  8. val ACCESS_CONTROL_ALLOW_HEADERS: String
    Definition Classes
    HeaderNames
  9. val ACCESS_CONTROL_ALLOW_METHODS: String
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_ORIGIN: String
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_EXPOSE_HEADERS: String
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_MAX_AGE: String
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_REQUEST_HEADERS: String
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_REQUEST_METHOD: String
    Definition Classes
    HeaderNames
  15. val AGE: String
    Definition Classes
    HeaderNames
  16. val ALLOW: String
    Definition Classes
    HeaderNames
  17. val AUTHORIZATION: String
    Definition Classes
    HeaderNames
  18. val Accepted: Status
    Definition Classes
    Results
  19. def Action: ActionBuilder[Request, AnyContent]
    Definition Classes
    BaseController
  20. val BAD_GATEWAY: Int
    Definition Classes
    Status
  21. val BAD_REQUEST: Int
    Definition Classes
    Status
  22. val BINARY: String
    Definition Classes
    ContentTypes
  23. val BadGateway: Status
    Definition Classes
    Results
  24. val BadRequest: Status
    Definition Classes
    Results
  25. val CACHE_CONTROL: String
    Definition Classes
    HeaderNames
  26. val CACHE_MANIFEST: String
    Definition Classes
    ContentTypes
  27. val CHUNKED: String
    Definition Classes
    HttpProtocol
  28. val CONFLICT: Int
    Definition Classes
    Status
  29. val CONNECTION: String
    Definition Classes
    HeaderNames
  30. val CONTENT_DISPOSITION: String
    Definition Classes
    HeaderNames
  31. val CONTENT_ENCODING: String
    Definition Classes
    HeaderNames
  32. val CONTENT_LANGUAGE: String
    Definition Classes
    HeaderNames
  33. val CONTENT_LENGTH: String
    Definition Classes
    HeaderNames
  34. val CONTENT_LOCATION: String
    Definition Classes
    HeaderNames
  35. val CONTENT_MD5: String
    Definition Classes
    HeaderNames
  36. val CONTENT_RANGE: String
    Definition Classes
    HeaderNames
  37. val CONTENT_SECURITY_POLICY: String
    Definition Classes
    HeaderNames
  38. val CONTENT_SECURITY_POLICY_REPORT_ONLY: 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 IM_A_TEAPOT: Int
    Definition Classes
    Status
  81. val INSUFFICIENT_STORAGE: Int
    Definition Classes
    Status
  82. val INTERNAL_SERVER_ERROR: Int
    Definition Classes
    Status
  83. val ImATeapot: Status
    Definition Classes
    Results
  84. val InsufficientStorage: Status
    Definition Classes
    Results
  85. val InternalServerError: Status
    Definition Classes
    Results
  86. def JAVASCRIPT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  87. val JSON: String
    Definition Classes
    ContentTypes
  88. val LAST_MODIFIED: String
    Definition Classes
    HeaderNames
  89. val LENGTH_REQUIRED: Int
    Definition Classes
    Status
  90. val LINK: String
    Definition Classes
    HeaderNames
  91. val LOCATION: String
    Definition Classes
    HeaderNames
  92. val LOCKED: Int
    Definition Classes
    Status
  93. val Locked: Status
    Definition Classes
    Results
  94. val MAX_FORWARDS: String
    Definition Classes
    HeaderNames
  95. val METHOD_NOT_ALLOWED: Int
    Definition Classes
    Status
  96. val MOVED_PERMANENTLY: Int
    Definition Classes
    Status
  97. val MULTIPLE_CHOICES: Int
    Definition Classes
    Status
  98. val MULTI_STATUS: Int
    Definition Classes
    Status
  99. val MethodNotAllowed: Status
    Definition Classes
    Results
  100. def MovedPermanently(url: String): Result
    Definition Classes
    Results
  101. val MultiStatus: Status
    Definition Classes
    Results
  102. val NETWORK_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  103. val NON_AUTHORITATIVE_INFORMATION: Int
    Definition Classes
    Status
  104. val NOT_ACCEPTABLE: Int
    Definition Classes
    Status
  105. val NOT_FOUND: Int
    Definition Classes
    Status
  106. val NOT_IMPLEMENTED: Int
    Definition Classes
    Status
  107. val NOT_MODIFIED: Int
    Definition Classes
    Status
  108. val NO_CONTENT: Int
    Definition Classes
    Status
  109. val NetworkAuthenticationRequired: Status
    Definition Classes
    Results
  110. val NoContent: Result
    Definition Classes
    Results
  111. val NonAuthoritativeInformation: Status
    Definition Classes
    Results
  112. val NotAcceptable: Status
    Definition Classes
    Results
  113. val NotFound: Status
    Definition Classes
    Results
  114. val NotImplemented: Status
    Definition Classes
    Results
  115. val NotModified: Result
    Definition Classes
    Results
  116. val OK: Int
    Definition Classes
    Status
  117. val ORIGIN: String
    Definition Classes
    HeaderNames
  118. val Ok: Status
    Definition Classes
    Results
  119. val PARTIAL_CONTENT: Int
    Definition Classes
    Status
  120. val PAYMENT_REQUIRED: Int
    Definition Classes
    Status
  121. val PERMANENT_REDIRECT: Int
    Definition Classes
    Status
  122. val PRAGMA: String
    Definition Classes
    HeaderNames
  123. val PRECONDITION_FAILED: Int
    Definition Classes
    Status
  124. val PRECONDITION_REQUIRED: Int
    Definition Classes
    Status
  125. val PROXY_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  126. val PROXY_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  127. val PROXY_AUTHORIZATION: String
    Definition Classes
    HeaderNames
  128. val PartialContent: Status
    Definition Classes
    Results
  129. val PaymentRequired: Status
    Definition Classes
    Results
  130. def PermanentRedirect(url: String): Result
    Definition Classes
    Results
  131. val PreconditionFailed: Status
    Definition Classes
    Results
  132. val PreconditionRequired: Status
    Definition Classes
    Results
  133. val RANGE: String
    Definition Classes
    HeaderNames
  134. val REFERER: String
    Definition Classes
    HeaderNames
  135. val REFERRER_POLICY: String
    Definition Classes
    HeaderNames
  136. val REQUESTED_RANGE_NOT_SATISFIABLE: Int
    Definition Classes
    Status
  137. val REQUEST_ENTITY_TOO_LARGE: Int
    Definition Classes
    Status
  138. val REQUEST_HEADER_FIELDS_TOO_LARGE: Int
    Definition Classes
    Status
  139. val REQUEST_TIMEOUT: Int
    Definition Classes
    Status
  140. val REQUEST_URI_TOO_LONG: Int
    Definition Classes
    Status
  141. val RESET_CONTENT: Int
    Definition Classes
    Status
  142. val RETRY_AFTER: String
    Definition Classes
    HeaderNames
  143. def Redirect(call: Call, status: Int): Result
    Definition Classes
    Results
  144. def Redirect(call: Call): Result
    Definition Classes
    Results
  145. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result
    Definition Classes
    Results
  146. def Redirect(url: String, status: Int): Result
    Definition Classes
    Results
  147. val RequestHeaderFieldsTooLarge: Status
    Definition Classes
    Results
  148. val RequestTimeout: Status
    Definition Classes
    Results
  149. val ResetContent: Result
    Definition Classes
    Results
  150. val SEE_OTHER: Int
    Definition Classes
    Status
  151. val SERVER: String
    Definition Classes
    HeaderNames
  152. val SERVICE_UNAVAILABLE: Int
    Definition Classes
    Status
  153. val SET_COOKIE: String
    Definition Classes
    HeaderNames
  154. val SET_COOKIE2: String
    Definition Classes
    HeaderNames
  155. val STRICT_TRANSPORT_SECURITY: String
    Definition Classes
    HeaderNames
  156. val SWITCHING_PROTOCOLS: Int
    Definition Classes
    Status
  157. def SeeOther(url: String): Result
    Definition Classes
    Results
  158. val ServiceUnavailable: Status
    Definition Classes
    Results
  159. def Status(code: Int): Status
    Definition Classes
    Results
  160. val SwitchingProtocols: Result
    Definition Classes
    Results
  161. val TE: String
    Definition Classes
    HeaderNames
  162. val TEMPORARY_REDIRECT: Int
    Definition Classes
    Status
  163. def TEXT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  164. lazy val TODO: Action[AnyContent]
    Definition Classes
    ControllerHelpers
  165. val TOO_MANY_REQUESTS: Int
    Definition Classes
    Status
  166. val TRAILER: String
    Definition Classes
    HeaderNames
  167. val TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  168. def TemporaryRedirect(url: String): Result
    Definition Classes
    Results
  169. val TooManyRequests: Status
    Definition Classes
    Results
  170. val UNAUTHORIZED: Int
    Definition Classes
    Status
  171. val UNPROCESSABLE_ENTITY: Int
    Definition Classes
    Status
  172. val UNSUPPORTED_MEDIA_TYPE: Int
    Definition Classes
    Status
  173. val UPGRADE: String
    Definition Classes
    HeaderNames
  174. val UPGRADE_REQUIRED: Int
    Definition Classes
    Status
  175. val USER_AGENT: String
    Definition Classes
    HeaderNames
  176. val USE_PROXY: Int
    Definition Classes
    Status
  177. val Unauthorized: Status
    Definition Classes
    Results
  178. val UnprocessableEntity: Status
    Definition Classes
    Results
  179. val UnsupportedMediaType: Status
    Definition Classes
    Results
  180. val UriTooLong: Status
    Definition Classes
    Results
  181. val VARY: String
    Definition Classes
    HeaderNames
  182. val VIA: String
    Definition Classes
    HeaderNames
  183. val WARNING: String
    Definition Classes
    HeaderNames
  184. val WWW_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  185. def XHTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  186. def XML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  187. val X_CONTENT_SECURITY_POLICY_NONCE_HEADER: String
    Definition Classes
    HeaderNames
  188. val X_CONTENT_TYPE_OPTIONS: String
    Definition Classes
    HeaderNames
  189. val X_FORWARDED_FOR: String
    Definition Classes
    HeaderNames
  190. val X_FORWARDED_HOST: String
    Definition Classes
    HeaderNames
  191. val X_FORWARDED_PORT: String
    Definition Classes
    HeaderNames
  192. val X_FORWARDED_PROTO: String
    Definition Classes
    HeaderNames
  193. val X_FRAME_OPTIONS: String
    Definition Classes
    HeaderNames
  194. val X_PERMITTED_CROSS_DOMAIN_POLICIES: String
    Definition Classes
    HeaderNames
  195. val X_REQUESTED_WITH: String
    Definition Classes
    HeaderNames
  196. val X_XSS_PROTECTION: String
    Definition Classes
    HeaderNames
  197. def closeGroupChannelAndLeaveGroup(studyResult: StudyResult): Unit

    Closes the group channel which includes sending a left message to all group members and leaves the GroupResult.

    Closes the group channel which includes sending a left message to all group members and leaves the GroupResult.

    Definition Classes
    GroupChannel
  198. def defaultExecutionContext: ExecutionContext
    Definition Classes
    BaseControllerHelpers
  199. implicit lazy val defaultFormBinding: FormBinding
    Definition Classes
    BaseControllerHelpers
  200. implicit def fileMimeTypes: FileMimeTypes
    Definition Classes
    BaseControllerHelpers
  201. var groupAdministration: GroupAdministration
    Definition Classes
    GroupChannel
  202. var idCookieService: IdCookieService
    Definition Classes
    GroupChannel
  203. def join(studyResult: StudyResult)(implicit request: RequestHeader): Unit

    Joins a group but doesn't open the group channel.

    Joins a group but doesn't open the group channel. In case of an error/problem an PublixException is thrown. Synchronized to prevent race conditions with group members joining, leaving, reassigning.

    Definition Classes
    GroupChannel
    Annotations
    @throws(classOf[PublixException])
  204. def leave(studyResult: StudyResult)(implicit request: Request[_]): Result

    Let this study run (specified by the study result ID) leave the group that it joined before.

    Let this study run (specified by the study result ID) leave the group that it joined before. Synchronized to prevent race conditions with group members joining, leaving, reassigning.

    Definition Classes
    GroupChannel
    Annotations
    @throws(classOf[PublixException])
  205. implicit var materializer: Materializer
    Definition Classes
    GroupChannel
  206. implicit def messagesApi: MessagesApi
    Definition Classes
    BaseControllerHelpers
  207. def open(studyResult: StudyResult): Flow[Any, Nothing, _]

    Opens a group channel and returns a Akka stream Flow that will be turned into WebSocket.

    Opens a group channel and returns a Akka stream Flow that will be turned into WebSocket. In case of an error/problem an PublixException is thrown.

    Definition Classes
    GroupChannel
    Annotations
    @throws(classOf[PublixException])
  208. def parse: PlayBodyParsers
    Definition Classes
    BaseControllerHelpers
  209. def reassign(studyResult: StudyResult)(implicit request: Request[_]): Result

    Tries to reassign this study run (specified by study result ID) to a different group.

    Tries to reassign this study run (specified by study result ID) to a different group. If the reassignment was successful an Ok is returned. If it was unsuccessful a Forbidden is returned. In case of an error/problem an PublixException is thrown. Synchronized to prevent race conditions with group members joining, leaving, reassigning.

    Definition Classes
    GroupChannel
    Annotations
    @throws(classOf[PublixException])
  210. implicit def request2flash(implicit request: RequestHeader): Flash
    Definition Classes
    RequestImplicits
  211. implicit def request2session(implicit request: RequestHeader): Session
    Definition Classes
    RequestImplicits
  212. implicit def supportedLangs: Langs
    Definition Classes
    BaseControllerHelpers
  213. implicit var system: ActorSystem
    Definition Classes
    GroupChannel
  214. implicit val timeout: Timeout

    Time to wait for an answer after asking an Akka actor

    Time to wait for an answer after asking an Akka actor

    Definition Classes
    GroupChannel
  215. 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 2.6.0) Use TOO_MANY_REQUESTS instead

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

    (Since version 2.6.0) Use TooManyRequests instead