Packages

t

endpoints4s.http4s.server

BasicAuthentication

trait BasicAuthentication extends EndpointsWithCustomErrors with algebra.BasicAuthentication

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicAuthentication
  2. BasicAuthentication
  3. EndpointsWithCustomErrors
  4. Urls
  5. StatusCodes
  6. Methods
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract type ClientErrors
    Definition Classes
    Errors
  4. abstract type Effect[A]
    Definition Classes
    EndpointsWithCustomErrors → Urls
  5. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  7. type Method = org.http4s.Method
    Definition Classes
    Methods → Methods
  8. type Params = Map[String, Seq[String]]
    Definition Classes
    Urls
  9. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  10. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  11. type QueryString[A] = (Params) => Validated[A]
    Definition Classes
    Urls → Urls
  12. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  13. type Request[A] = PartialFunction[org.http4s.Request[Effect], Effect[Either[org.http4s.Response[Effect], A]]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  14. type RequestEntity[A] = (org.http4s.Request[Effect]) => Effect[Either[org.http4s.Response[Effect], A]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  15. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  16. type RequestHeaders[A] = (Headers) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  17. type Response[A] = (A) => org.http4s.Response[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseEntity[A] = EntityEncoder[Effect, A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. type ResponseHeaders[A] = (A) => Headers
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  21. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  22. abstract type ServerError
    Definition Classes
    Errors
  23. type StatusCode = Status
    Definition Classes
    StatusCodes → StatusCodes
  24. case class Endpoint[A, B](request: Request[A], response: Response[B], operationId: Option[String]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  25. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  26. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  27. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  28. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. implicit abstract def Effect: Sync[Effect]
    Definition Classes
    EndpointsWithCustomErrors
  2. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  3. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

Concrete 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. def Accepted: Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: Method
    Definition Classes
    Methods → Methods
  14. def Gone: Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Status
    Definition Classes
    StatusCodes → StatusCodes
  29. def Options: Method
    Definition Classes
    Methods → Methods
  30. def PartialContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  31. def Patch: Method
    Definition Classes
    Methods → Methods
  32. def PayloadTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  33. def PaymentRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  34. def Post: Method
    Definition Classes
    Methods → Methods
  35. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  36. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def Put: Method
    Definition Classes
    Methods → Methods
  39. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  51. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  52. def authenticatedEndpoint[U, E, R, H, UE, HCred, Out](method: Method, url: Url[U], response: Response[R], requestEntity: RequestEntity[E], requestHeaders: RequestHeaders[H], unauthenticatedDocs: Documentation, requestDocs: Documentation, endpointDocs: EndpointDocs)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerHCred: Tupler.Aux[H, Credentials, HCred], tuplerUEHCred: Tupler.Aux[UE, HCred, Out]): Endpoint[Out, Option[R]]
    Definition Classes
    BasicAuthentication
  53. def authenticatedRequest[U, E, H, UE, HC, Out](method: Method, url: Url[U], entity: RequestEntity[E], headers: RequestHeaders[H], requestDocs: Documentation = None)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerHC: Tupler.Aux[H, Credentials, HC], tuplerUEHC: Tupler.Aux[UE, HC, Out]): Request[Out]
    Definition Classes
    BasicAuthentication → BasicAuthentication
  54. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  55. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  56. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  57. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  58. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  59. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  60. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  61. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    Urls → Urls
  62. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  63. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  64. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  65. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  66. def emptyRequestHeaders: RequestHeaders[Unit]

    HEADERS

    HEADERS

    Definition Classes
    EndpointsWithCustomErrors → Requests
  67. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  68. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  69. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  70. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  72. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  73. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. def handleClientErrors(invalid: Invalid): Effect[org.http4s.Response[Effect]]

    This method is called by endpoints when decoding a request failed.

    This method is called by endpoints when decoding a request failed.

    The provided implementation calls clientErrorsResponse to construct a response containing the errors.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    EndpointsWithCustomErrors
  75. def handleServerError(throwable: Throwable): Effect[org.http4s.Response[Effect]]

    This method is called by endpoints when an exception is thrown during request processing.

    This method is called by endpoints when an exception is thrown during request processing.

    The provided implementation calls serverErrorResponse to construct a response containing the error message.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    EndpointsWithCustomErrors
  76. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  78. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  79. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  80. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  81. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  82. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  83. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  84. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  85. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  86. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  87. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  88. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  89. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  90. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  91. val path: Path[Unit]
    Definition Classes
    Urls
  92. implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  93. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  94. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  95. def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  96. implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  97. implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  98. def remainingSegments(name: String = "", docs: Documentation = None): Path[String]
    Definition Classes
    Urls → Urls
  99. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  100. def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  101. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  102. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  103. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  104. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  106. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  107. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  108. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  109. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  110. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  112. def routesFromEndpoints(endpoints: PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]*): PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]
    Definition Classes
    EndpointsWithCustomErrors
  113. def segment[A](name: String = "", docs: Documentation = None)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  114. implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  115. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  116. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  117. implicit def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  118. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  119. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  120. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  121. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  122. def toString(): String
    Definition Classes
    AnyRef → Any
  123. implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  124. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    Urls → Urls
  125. val utf8Name: String
    Definition Classes
    Urls
  126. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  127. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  128. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  131. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  132. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from algebra.BasicAuthentication

Inherited from EndpointsWithCustomErrors

Inherited from Urls

Inherited from StatusCodes

Inherited from Methods

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped