package fintrospect
- Alphabetic
- Public
- All
Type Members
-
case class
ApiKey
[T, K >: Request](param: Parameter with Mandatory[K, T], validateKey: Service[T, Boolean]) extends Security with Product with Serializable
Checks the presence of the named Api Key parameter.
Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.
-
class
BrokenContract
extends Exception
This exception is thrown at runtime when not all of the required parameters have been passed to the RouteClient function
- final case class ContentType (value: String) extends AnyVal with Product with Serializable
-
trait
Contract
extends AnyRef
Marker interface which can be used to organise sets of ContactEndpoints, and also to create a ContractProxyModules.
-
trait
ContractEndpoint
extends AnyRef
A single Contract endpoint which provides an UnboundRoute to bind something to.
- trait Module extends AnyRef
- case class RequestBuilder (method: Method, uriParts: Seq[String] = Nil, queries: Map[String, Seq[String]] = Map(), fn: (Request) ⇒ Request = identity) extends Product with Serializable
- trait ResourceLoader extends AnyRef
-
class
ResponseSpec
extends AnyRef
Defines a potential response from a route, with a possible example
- class ReverseRouter extends AnyRef
-
class
RouteClient
[Rsp] extends AnyRef
Representation of a pre-configured client HTTP call
-
class
RouteModule
[RQ, RS] extends Module
Self-describing module builder (uses the immutable builder pattern).
-
case class
RouteSpec
extends Product with Serializable
Encapsulates the specification of an HTTP endpoint, for use by either a Finagle server or client.
-
sealed
trait
Security
extends AnyRef
Endpoint security.
Endpoint security. Provides filter to be applied to endpoints for all requests.
- abstract class ServerRoute [RQ, RS] extends AnyRef
-
trait
ServerRoutes
[RQ, RS] extends Iterable[ServerRoute[RQ, RS]]
Implement this trait if there is a requirement to have more than one route in a single class.
- class StaticModule extends Module
-
case class
TagInfo
(name: String, description: Option[String] = None) extends Product with Serializable
Info about a Swagger tag.
- trait UnboundRoute extends AnyRef
-
class
UnboundRoute0
extends UnboundRoute
An UnboundRoute with 0 path parts
-
class
UnboundRoute1
[A] extends UnboundRoute
An UnboundRoute with 1 path part
-
class
UnboundRoute2
[A, B] extends UnboundRoute
An UnboundRoute with 2 path parts
-
class
UnboundRoute3
[A, B, C] extends UnboundRoute
An UnboundRoute with 3 path parts
-
class
UnboundRoute4
[A, B, C, D] extends UnboundRoute
An UnboundRoute with 4 path parts
-
class
UnboundRoute5
[A, B, C, D, E] extends UnboundRoute
An UnboundRoute with 5 path parts
-
class
UnboundRoute6
[A, B, C, D, E, F] extends UnboundRoute
An UnboundRoute with 6 path parts
-
class
UnboundRoute7
[A, B, C, D, E, F, G] extends UnboundRoute
An UnboundRoute with 7 path parts
Value Members
- object ContentType extends Serializable
- object ContentTypes
-
object
ContractProxyModule
Creates a standard Module which acts as a proxy to the set of routes declared in the passed Contract.
- object Headers
- object Module
-
object
NoSecurity
extends Security
Default NoOp security filter.
Default NoOp security filter. Filter allows all traffic through.
- object ResourceLoader
- object ResponseSpec
- object RouteClient
- object RouteModule
- object RouteSpec extends Serializable
- object StaticModule
- object TagInfo extends Serializable
-
object
UnboundRoute
An unbound route represents a RouteSpec which has been assigned a Method (and a partial or complete Path), but has not yet been bound to a server or client Service.
Deprecated Value Members
-
object
ModuleSpec
Renamed to RouteModule.
Renamed to RouteModule. Self-describing module builder (uses the immutable builder pattern).
- Annotations
- @deprecated
- Deprecated
(Since version 13.16.0) Renamed: use RouteModule instead