com.sksamuel.scruffy.healthcheck

HealthcheckModule

Related Doc: package healthcheck

case class HealthcheckModule(checks: Seq[Healthcheck] = Nil, url: String = "healthcheck")(implicit serializer: Serializer[HealthcheckResponse], executor: ExecutionContext) extends HttpModule with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, HttpModule, DefaultProcessors, SessionProcessors, PathProcessors, QueryParamProcessors, HeaderProcessors, EntityProcessors, CookieProcessors, ContentTypeProcessors, ResponseImplicits, Processors, ResponseBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HealthcheckModule
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HttpModule
  7. DefaultProcessors
  8. SessionProcessors
  9. PathProcessors
  10. QueryParamProcessors
  11. HeaderProcessors
  12. EntityProcessors
  13. CookieProcessors
  14. ContentTypeProcessors
  15. ResponseImplicits
  16. Processors
  17. ResponseBuilder
  18. AnyRef
  19. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HealthcheckModule(checks: Seq[Healthcheck] = Nil, url: String = "healthcheck")(implicit serializer: Serializer[HealthcheckResponse], executor: ExecutionContext)

Type Members

  1. implicit class FutureOps[A] extends AnyRef

    Definition Classes
    ResponseBuilder

  2. type Processor = (HttpRequest) ⇒ Future[HttpResponse]

    Definition Classes
    Processors

  3. implicit class RichFuture[T] extends AnyRef

    Definition Classes
    ResponseImplicits

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 accepted: HttpResponse

    Definition Classes
    ResponseBuilder

  5. def add(listeners: Listener*): Unit

    Definition Classes
    HttpModule

  6. def addHeader(name: String, v: String)(f: Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    HeaderProcessors

  7. def addHeader(key: HeaderKey, v: String)(f: Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    HeaderProcessors

  8. def ajax(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. val badGateway: HttpResponse

    Definition Classes
    ResponseBuilder

  11. def badRequest(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  12. val badRequest: HttpResponse

    Definition Classes
    ResponseBuilder

  13. implicit def byteArrayToFutureResponse(b: Array[Byte]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  14. val checks: Seq[Healthcheck]

  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  16. def complete(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  17. val conflict: HttpResponse

    Definition Classes
    ResponseBuilder

  18. def consumes(mediaTypes: MediaType*)(f: Processor): Processor

    Definition Classes
    ContentTypeProcessors

  19. def contentTypeOverride(mediaType: MediaType)(f: Processor): Processor

    Definition Classes
    ContentTypeProcessors

  20. def cookie(name: String)(f: (Cookie) ⇒ Processor): Processor

    Definition Classes
    CookieProcessors

  21. def cookieValue(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    CookieProcessors

  22. val created: HttpResponse

    Definition Classes
    ResponseBuilder

  23. def define(method: Method, url: String, f: Processor): HttpEndpoint

    Attributes
    protected
    Definition Classes
    HttpModule

  24. def delete(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  25. def deleteCookie(name: String)(f: ⇒ Processor)(implicit executor: ExecutionContext): Processor

    Definition Classes
    CookieProcessors

  26. def entity(f: (Array[Byte]) ⇒ Processor): Processor

    Definition Classes
    EntityProcessors

  27. def entityAs[E](f: (E) ⇒ Processor)(implicit manifest: Manifest[E], deserializer: Deserializer[E]): Processor

    Definition Classes
    EntityProcessors

  28. def entitySizeLimit(size: Int)(f: Processor): Processor

    Definition Classes
    EntityProcessors

  29. def entityToResponse(x: Any): HttpResponse

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    AnyRef

  31. var errorHandler: Option[ErrorHandler]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  32. def errors(f: ⇒ ErrorHandler): Unit

    Definition Classes
    HttpModule

  33. implicit def exception2Response(e: Throwable): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  34. val expectationFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  35. def filter(filter: HttpFilter): HealthcheckModule.this.type

    Definition Classes
    HttpModule

  36. var filters: ListBuffer[FilterHolder]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  37. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  38. def forbidden(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  39. def forbidden: HttpResponse

    Definition Classes
    ResponseBuilder

  40. val found: HttpResponse

    Definition Classes
    ResponseBuilder

  41. implicit def futureTeeToFutureResponse[T](f: Future[T])(implicit fn: (T) ⇒ HttpResponse, executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  42. def gatewayTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  43. def get(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

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

    Definition Classes
    AnyRef → Any

  45. val gone: HttpResponse

    Definition Classes
    ResponseBuilder

  46. def hasHeader(name: HeaderName, value: Any)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  47. def hasHeader(name: String, value: Any)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  48. def hasHeader(name: HeaderName)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  49. def hasHeader(name: String)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  50. def hasQueryParam(name: String, value: String)(f: Processor): Processor

    Definition Classes
    QueryParamProcessors

  51. def head(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  52. def header(name: HeaderName)(f: (String) ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  53. def header(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  54. def hostname(regex: String)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  55. def http(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  56. val httpEndpoints: ListBuffer[HttpEndpoint]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  57. def https(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  58. def ifMatch(name: String)(f: ⇒ Processor): Processor

    Definition Classes
    HeaderProcessors

  59. def internalServerError(entity: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  60. def internalServerError(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  61. def internalServerError(e: Throwable): HttpResponse

    Definition Classes
    ResponseBuilder

  62. val internalServerError: HttpResponse

    Definition Classes
    ResponseBuilder

  63. def ipAddress(f: (String) ⇒ Processor): Processor

    Definition Classes
    DefaultProcessors

  64. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  65. def json[T](future: Future[T])(implicit serializer: Serializer[T], executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  66. def json[T](option: Option[T])(implicit serializer: Serializer[T]): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  67. def json[T](t: T)(implicit serializer: Serializer[T]): Future[HttpResponse]

    Definition Classes
    ContentTypeProcessors

  68. val lengthRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  69. var listeners: ListBuffer[Listener]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  70. def marshall(mediaType: MediaType)(f: Processor)(implicit serializer: Serializer[Any], executor: ExecutionContext): Processor

    Definition Classes
    ContentTypeProcessors

  71. def matchesIpAddress(regex: String)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  72. val methodNotAllowed: HttpResponse

    Definition Classes
    ResponseBuilder

  73. val movedPermanently: HttpResponse

    Definition Classes
    ResponseBuilder

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

    Definition Classes
    AnyRef

  75. def noEntity(f: Processor): Processor

    Definition Classes
    EntityProcessors

  76. val nocontent: HttpResponse

    Definition Classes
    ResponseBuilder

  77. implicit def nodeToEndpointFn(node: Node): Processor

    Definition Classes
    ResponseImplicits

  78. implicit def nodeToFuture(node: Node): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  79. implicit def nodeToResponse(node: Node): HttpResponse

    Definition Classes
    ResponseImplicits

  80. val nonAuthoritativeInformation: HttpResponse

    Definition Classes
    ResponseBuilder

  81. val notAcceptable: HttpResponse

    Definition Classes
    ResponseBuilder

  82. def notFound(f: NotFoundHandler): Unit

    Definition Classes
    HttpModule

  83. def notFound(body: String): HttpResponse

    Definition Classes
    ResponseBuilder

  84. val notFound: HttpResponse

    Definition Classes
    ResponseBuilder

  85. var notFoundHandler: Option[NotFoundHandler]

    Attributes
    protected[com.sksamuel.scruffy]
    Definition Classes
    HttpModule

  86. def notImplemented(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  87. val notImplemented: HttpResponse

    Definition Classes
    ResponseBuilder

  88. val notModified: HttpResponse

    Definition Classes
    ResponseBuilder

  89. final def notify(): Unit

    Definition Classes
    AnyRef

  90. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  91. def ok(ent: Any, contentType: MediaType): HttpResponse

    Definition Classes
    ResponseBuilder

  92. def ok(ent: Any, contentType: String): HttpResponse

    Definition Classes
    ResponseBuilder

  93. def ok(e: Any): HttpResponse

    Definition Classes
    ResponseBuilder

  94. val ok: HttpResponse

    Definition Classes
    ResponseBuilder

  95. implicit def optionToEndpointFn(o: Option[_]): Processor

    Definition Classes
    ResponseImplicits

  96. implicit def optionToEndpointFn(f: Future[Option[_]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  97. implicit def optionToFuture(o: Option[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  98. implicit def optionToFuture(f: Future[Option[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  99. def options(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  100. val partialContent: HttpResponse

    Definition Classes
    ResponseBuilder

  101. def pathParam(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    PathProcessors

  102. val paymentRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  103. def permanentRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  104. def post(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  105. def postfilter(fn: (HttpResponse) ⇒ HttpResponse)(implicit executor: ExecutionContext): HealthcheckModule.this.type

    Definition Classes
    HttpModule

  106. val preconditionFailed: HttpResponse

    Definition Classes
    ResponseBuilder

  107. def prefilter(fn: (HttpRequest) ⇒ HttpRequest): HealthcheckModule.this.type

    Definition Classes
    HttpModule

  108. val proxyAuthenticationRequired: HttpResponse

    Definition Classes
    ResponseBuilder

  109. def put(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  110. def queryParam(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  111. def queryParam(name: String, default: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  112. def queryParamBoolean(name: String, default: Boolean)(f: (Boolean) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  113. def queryParamBoolean(name: String)(f: (Boolean) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  114. def queryParamDouble(name: String, default: Double)(f: (Double) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  115. def queryParamDouble(name: String)(f: (Double) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  116. def queryParamInt(name: String, default: Int)(f: (Int) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  117. def queryParamInt(name: String)(f: (Int) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  118. def queryParamLong(name: String, default: Long)(f: (Long) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  119. def queryParamLong(name: String)(f: (Long) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  120. def queryParamOpt(name: String)(f: (Option[String]) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  121. def queryParams(name: String)(f: (Seq[String]) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors

  122. def rateLimit(requestsPerSecond: Double, warmupPeriod: FiniteDuration)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  123. def rateLimit(limiter: RateLimiter)(f: Processor): Processor

    Definition Classes
    DefaultProcessors

  124. implicit def redirectToFutureResponse(redirect: Redirect): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  125. implicit def redirectToResponse(redirect: Redirect): HttpResponse

    Definition Classes
    ResponseImplicits

  126. val requestEntityTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  127. val requestHeaderFieldsTooLarge: HttpResponse

    Definition Classes
    ResponseBuilder

  128. val requestTimeout: HttpResponse

    Definition Classes
    ResponseBuilder

  129. val requestURITooLong: HttpResponse

    Definition Classes
    ResponseBuilder

  130. val requestedRangeNotSatisfiable: HttpResponse

    Definition Classes
    ResponseBuilder

  131. def requiresEntity(f: Processor): Processor

    Definition Classes
    EntityProcessors

  132. val resetContent: HttpResponse

    Definition Classes
    ResponseBuilder

  133. implicit def responseFutureToProcessor(resp: Future[HttpResponse]): Processor

    Definition Classes
    ResponseImplicits

  134. implicit def responseToFuture(resp: HttpResponse): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  135. implicit def responseToProcessorFn(resp: HttpResponse): Processor

    Definition Classes
    ResponseImplicits

  136. implicit def scalazFailureToFutureResponse(f: Future[Failure[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  137. implicit def scalazFailureToFutureResponse(f: Failure[_]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  138. implicit def scalazFailureToResponse(f: Failure[_]): HttpResponse

    Definition Classes
    ResponseImplicits

  139. implicit def scalazValToEndpointFn(v: ValidationNel[_, _])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  140. implicit def scalazValToEndpointFn(f: Future[ValidationNel[_, _]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  141. implicit def scalazValToFutureResponse(f: Future[ValidationNel[_, _]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  142. implicit def scalazValToFutureResponse(v: ValidationNel[_, _]): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  143. implicit def scalazValToResponse(f: ValidationNel[_, _]): HttpResponse

    Definition Classes
    ResponseImplicits

  144. def schema(f: (String) ⇒ Processor): Processor

    Definition Classes
    DefaultProcessors

  145. def seeOther(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  146. val serviceUnavailable: HttpResponse

    Definition Classes
    ResponseBuilder

  147. def session(f: (Session) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  148. def sessionOption(f: (Option[Session]) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  149. def sessionProperty[T](key: SessionKey[T])(f: (T) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  150. def sessionPropertyOption[T](key: SessionKey[T])(f: (Option[T]) ⇒ Processor): Processor

    Definition Classes
    SessionProcessors

  151. def status(s: Int, reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  152. def status(s: Int): HttpResponse

    Definition Classes
    ResponseBuilder

  153. def status(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseBuilder

  154. implicit def statusToFuture(s: HttpStatus): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  155. implicit def statusToProcessor(s: HttpStatus): Processor

    Definition Classes
    ResponseImplicits

  156. implicit def statusToResponse(s: HttpStatus): HttpResponse

    Definition Classes
    ResponseImplicits

  157. implicit def stringToFuture(str: String): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  158. implicit def stringToFuture(f: Future[String])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  159. implicit def stringToProcessor(str: String): Processor

    Definition Classes
    ResponseImplicits

  160. implicit def stringToProcessor(f: Future[String])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

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

    Definition Classes
    AnyRef

  162. implicit def tToFuture[T](t: T): Future[T]

    Definition Classes
    ResponseImplicits

  163. def temporaryRedirect(location: String): HttpResponse

    Definition Classes
    ResponseBuilder

  164. val tooManyRequests: HttpResponse

    Definition Classes
    ResponseBuilder

  165. def trace(url: String)(p: Processor): HttpEndpoint

    Definition Classes
    HttpModule

  166. implicit def tryToEndpointFn(t: Try[_])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  167. implicit def tryToEndpointFn(f: Future[Try[_]])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  168. implicit def tryToFuture(t: Try[_])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  169. implicit def tryToFuture(f: Future[Try[_]])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  170. val unauthorized: HttpResponse

    Definition Classes
    ResponseBuilder

  171. implicit def unitToEndpointFn(unit: Unit): Processor

    Definition Classes
    ResponseImplicits

  172. implicit def unitToEndpointFn(f: Future[Unit])(implicit executor: ExecutionContext): Processor

    Definition Classes
    ResponseImplicits

  173. implicit def unitToFuture(unit: Unit): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  174. implicit def unitToFuture(f: Future[Unit])(implicit executor: ExecutionContext): Future[HttpResponse]

    Definition Classes
    ResponseImplicits

  175. implicit def unitToResponse(unit: Unit): HttpResponse

    Definition Classes
    ResponseImplicits

  176. def unprocessableEntity(reason: String): HttpResponse

    Definition Classes
    ResponseBuilder

  177. val unprocessableEntity: HttpResponse

    Definition Classes
    ResponseBuilder

  178. val unsupportedMediaType: HttpResponse

    Definition Classes
    ResponseBuilder

  179. val url: String

  180. val useProxy: HttpResponse

    Definition Classes
    ResponseBuilder

  181. def userAgent(regex: String)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  182. def userAgent(regex: Regex)(f: Processor): Processor

    Definition Classes
    HeaderProcessors

  183. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def hasParam(name: String, value: String)(f: Processor): Processor

    Definition Classes
    QueryParamProcessors
    Annotations
    @deprecated
    Deprecated

    (Since version 1.13.3) prefer hasQueryParam

  2. def param(name: String)(f: (String) ⇒ Processor): Processor

    Definition Classes
    QueryParamProcessors
    Annotations
    @deprecated
    Deprecated

    (Since version 1.13.3) prefer queryParam

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HttpModule

Inherited from DefaultProcessors

Inherited from SessionProcessors

Inherited from PathProcessors

Inherited from QueryParamProcessors

Inherited from HeaderProcessors

Inherited from EntityProcessors

Inherited from CookieProcessors

Inherited from ContentTypeProcessors

Inherited from ResponseImplicits

Inherited from Processors

Inherited from ResponseBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped