diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/index.html index 742a73bc1e7..18fbda3a2a6 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/index.html @@ -1292,7 +1292,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/index.html index 4d3304f2b7f..d0b515c4765 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/index.html @@ -1283,7 +1283,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/index.html index de37d9619c0..3cc03c1b8f7 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/index.html @@ -1271,7 +1271,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/index.html index 6d8e1250c98..2a01fd9a412 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/index.html @@ -1296,7 +1296,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/index.html index c15cb091d82..3b56923dbe7 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/index.html @@ -1284,7 +1284,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/index.html index 176a1584700..a129f55745c 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/index.html @@ -1275,7 +1275,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/index.html index 135d5b39e93..22f9fe397eb 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/index.html @@ -1288,7 +1288,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/index.html index d42222dbe6a..b7e55fca0da 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/index.html @@ -1287,7 +1287,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/index.html b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/index.html index 3e019d5364d..fbebf30a985 100644 --- a/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/index.html +++ b/0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/index.html @@ -1296,7 +1296,7 @@

FunctionsunknownFields -[jvm]
fun unknownFields(): ByteString +[jvm]
open fun unknownFields(): ByteString withoutUnknownFields diff --git a/0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/index.html b/0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/index.html index 05b9f931f2c..d070b80be3a 100644 --- a/0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/index.html +++ b/0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/index.html @@ -1162,7 +1162,7 @@

AutoCloseableLease

[jvm]\ class AutoCloseableLease(lease: Lease) : Lease, AutoCloseable

-

Converts a lease into an AutoCloseable resource.

+

Converts a lease into an AutoCloseable resource.

Constructors

diff --git a/0.x/wisp-lease/wisp-lease/wisp.lease/index.html b/0.x/wisp-lease/wisp-lease/wisp.lease/index.html index eaeb45124c3..3c38e0e45a5 100644 --- a/0.x/wisp-lease/wisp-lease/wisp.lease/index.html +++ b/0.x/wisp-lease/wisp-lease/wisp.lease/index.html @@ -1162,7 +1162,7 @@

Types&

- + diff --git a/search/search_index.json b/search/search_index.json index 827d5bd39f9..f5e6f4b3097 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Overview","text":""},{"location":"#overview","title":"Overview","text":""},{"location":"#what-is-misk","title":"What is Misk","text":"

Misk (Microservice Container in Kotlin) is an open source microservice container from Cash App. It allows you to quickly create a microservice in Kotlin or Java, and provides libraries for common concerns like serving endpoints, caching, queueing, persistence, distributed leasing and clustering. It also includes the Wisp library, which is a collection of Kotlin modules providing various features and utilities, including config, logging, feature flags and more.

It has been powering hundreds of microservices within Cash App since 2018.

"},{"location":"#a-tour-of-features","title":"A Tour of Features","text":""},{"location":"#whats-next","title":"What\u2019s Next?","text":"

Want to jump right into it? Check out our Getting Started Guide.

What to know more about each module, see Developer Guide.

"},{"location":"actions/","title":"Actions","text":"

Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.

"},{"location":"actions/#web-actions","title":"Web Actions","text":"

Below are some example Web action declarations. Note that many of the annotations are optional.

Calls are authenticated at the service-level (service is listed in the @Authenticated annotation) or at the user-level (user has at least one of the capabilities listed in the @Authenticated annotation).

GET:

@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n  @Get(\"/hello/{name}\") // Enclose path parameters in {}\n  @ResponseContentType(MediaTypes.APPLICATION_JSON)\n  @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n  fun hello(\n    // Use @PathParam with the name of the param. Required if there's a param in the path pattern.\n    @PathParam name: String,\n    // RequestHeaders is optional:\n    @RequestHeaders headers: Headers,\n    // QueryParams are optional:\n    @QueryParam nickName: String?, // e.g. /hello/abc?nickName=def\n    @QueryParam greetings: List<String>? // e.g. /hello/abc?greetings=def&greetings=ghi\n  ): HelloResponse {\n    return HelloResponse(name)\n  }\n}\n

POST:

@Singleton\nclass HelloWebPostAction @Inject constructor() : WebAction {\n  @Post(\"/hello/{name}\")\n  @RequestContentType(MediaTypes.APPLICATION_JSON)\n  @ResponseContentType(MediaTypes.APPLICATION_JSON)\n  @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n  fun hello(\n      @PathParam name: String, \n      // RequestBody is optional, and is automatically deserialized to the provided type.\n      @RequestBody body: PostBody\n  ): HelloPostResponse {\n    return HelloPostResponse(body.greeting, name)\n  }\n}\n\ndata class HelloPostResponse(val greeting: String, val name: String)\n\ndata class PostBody(val greeting: String)\n
"},{"location":"actions/#setting-up-http-actions","title":"Setting up HTTP actions","text":"

Install the action into a module: 

class HelloModule : KAbstractModule() {\n  override fun configure() {\n    install(WebActionModule.create<HelloWebAction>())\n    install(WebActionModule.create<HelloWebPostAction>())\n  }\n}\n

And then put that module onto the top level MiskApplication. 

fun main(args: Array<String>) {\n  MiskApplication(\n    // ...\n    HelloModule(), // new!\n  ).run(args)\n}\n

"},{"location":"actions/#response-type","title":"Response type","text":"

If you change the action\u2019s response type to Response<T>, it gives you better control over the response status code and headers.

@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n  @Get(\"/hello_but_203/{name}\")\n  @ResponseContentType(MediaTypes.APPLICATION_JSON)\n  fun hello(@PathParam name: String): Response<HelloResponse> = Response(\n    statusCode = 203,\n    headers = headersOf(),\n    body = HelloResponse()\n  )\n}\n

It\u2019s also possible to throw exceptions that are mapped to status codes.

@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n  @Get(\"/no_access/{name}\")\n  fun hello(@PathParam name: String): HelloResponse {\n      throw UnauthenticatedException()\n  }\n}\n
"},{"location":"actions/#grpc-actions","title":"gRPC Actions","text":"

Misk has support for gRPC actions via the Wire protocol buffer (protobuf) library.

To create a gRPC action, first define the relevant protos for your service. Let\u2019s say we\u2019re creating a GreeterService that exposes one API, Hello. Create this file in src/main/proto/hello.proto:

syntax = \"proto2\";\npackage squareup.cash.hello;\n\noption java_package = \"com.squareup.protos.cash.hello\";\n\nmessage HelloRequest {\n  optional string message = 1;\n}\n\nmessage HelloResponse {\n  optional string message = 1;\n}\n\nservice GreeterService {\n  rpc Hello(HelloRequest) returns (HelloResponse) {}\n}\n

Next, in your project\u2019s build file (for this example, build.gradle.kts), add a dependency on the wire plugin:

plugins {\n  id(\"com.squareup.wire\")\n}\n

Add the following configuration to generate the gRPC interfaces for your service:

wire {\n  sourcePath {\n    srcDir(\"src/main/proto\")\n  }\n\n  kotlin {\n    include(\"squareup.cash.hello.GreeterService\")\n    rpcCallStyle = \"blocking\"\n    rpcRole = \"server\"\n    singleMethodServices = true\n  }\n\n  java {\n  }\n}\n

Finally, implement and bind your gRPC action. GreeterServiceHelloBlockingServer is generated by Wire.

@Singleton\nclass HelloGrpcAction @Inject internal constructor()\n  : GreeterServiceHelloBlockingServer, WebAction {\n\n  @Unauthorized\n  override fun Hello(request: HelloRequest): HelloResponse {\n    return HelloResponse(\"message\")\n  }\n}\n\n// This module binds HelloGrpcAction.\nclass GreeterActionModule : KAbstractModule() {\n  override fun configure() {\n    install(WebActionModule.create<HelloGrpcAction>())\n  }\n}\n

Misk also supports rpcCallStyle = \"suspending\" for suspending gRPC actions. This is the way to generate server actions if you intend to use coroutines to implement the business logic of your action. The generated interface will then expect you to implement a suspending function instead of a regular blocking function for your action\u2019s handler method. See coroutines for more information.

wire {\n  sourcePath {\n    srcDir(\"src/main/proto\")\n  }\n\n  kotlin {\n    include(\"squareup.cash.hello.GreeterService\")\n    rpcCallStyle = \"suspending\"\n    rpcRole = \"server\"\n    singleMethodServices = true\n  }\n\n  java {\n  }\n}\n

The above Wire Gradle plugin configuration will have a suspending function in the generated interface instead of a regular function. Your implementing class will then look like this:

@Singleton\nclass HelloGrpcAction @Inject internal constructor()\n  : GreeterServiceHelloBlockingServer, WebAction {\n\n  @Unauthorized\n  override suspend fun Hello(request: HelloRequest): HelloResponse {\n    return HelloResponse(\"message\")\n  }\n}\n

Creating a gRPC action automatically creates a JSON endpoint with all of the same annotations in the path defined by the ...BlockingServer, typically /<package>.<service name>/<rpc name>.

You can also create a second class that extends WebAction to customize this further. Read more about HTTP actions in Web Actions. If you\u2019re building both a gRPC and a HTTP action, a common pattern is to have them both use a common dependency:

@Singleton\nclass HelloGrpcAction @Inject constructor(val greeter: Greeter)\n  : GreeterServiceHelloBlockingServer, WebAction {\n  @Unauthorized override fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass HelloWebAction @Inject constructor(val greeter: Greeter) : WebAction {\n  @Unauthorized\n  @Get(\"/hello\")\n  @ResponseContentType(MediaTypes.APPLICATION_JSON)\n  fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass Greeter @Inject constructor()  {\n  fun greet() = \"Hello world\"\n}\n
"},{"location":"actions/#actionscoped","title":"ActionScoped","text":"

ActionScoped gives an action access to context produced by the action\u2019s interceptors.

Misk has a few ActionScoped items built in:

"},{"location":"actions/#testing","title":"Testing","text":"

Use tests annotated with @MiskTest to perform tests. There are two common patterns to testing actions:

"},{"location":"actions/#test-action-classes-directly","title":"Test Action classes directly","text":"

Make sure that the module under test contains a Guice binding for the action and its dependencies, then inject your action.

class MyModule : KAbstractModule() {\n  override fun configure() {\n    install(WebActionModule.create<HelloWebAction>())\n    // Alternatively, a direct or just-in-time binding might be sufficient.\n  }\n}\n\n@MiskTest class MyTest {\n  @MiskTestModule val module = MyModule()\n  @Inject lateinit var action: HelloWebAction\n\n  // use action...\n}\n
"},{"location":"actions/#testing-actionscoped","title":"Testing ActionScoped","text":"

Use @WithMiskCaller for ActionScoped<MiskCaller>:

@MiskTest\n@WithMiskCaller(user = \"test-user\") // or @WithMiskCaller(service = \"test-service\")\nclass MyTest {\n  @MiskTestModule val module = MyModule()\n  @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MiskCaller>\n\n  // use action...\n}\n

For types other than MiskCaller, use ActionScope directly either within your setup and teardown test methods:

@MiskTest\nclass MyTest {\n  @MiskTestModule val module = MyModule()\n  @Inject lateinit var actionScope: ActionScope\n  @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MyScopedObject>\n\n  @BeforeEach fun setUp() {\n    actionScope.create(\n      mapOf(\n        keyOf<MyScopedObject>() to MyScopedObject()\n      )\n    ).enter()\n  }\n\n  @AfterEach fun tearDown() {\n    actionScope.close()\n  }\n\n  @Test fun test() {\n    // use action...\n  }\n}\n

\u2026or within the test itself:

@MiskTest\nclass MyTest {\n  @MiskTestModule val module = MyModule()\n  @Inject lateinit var actionScope: ActionScope\n  @Inject lateinit var action: HelloWebAction\n\n  @Test fun test() {\n    actionScope.create(\n      mapOf(\n        keyOf<MyScopedObject>() to MyScopedObject()\n      )\n    ).inScope {\n      // use action or class which injects ActionScoped<MyScopedObject>...\n    }\n  }\n}\n
"},{"location":"actions/#integration-tests","title":"Integration tests","text":"

It\u2019s possible to perform tests terminating at the app\u2019s HTTP/gRPC interface.

The module under test should include WebServerTestingModule so that Misk stands up a server during tests:

class MyModule : KAbstractModule() {\n   override fun configure(){\n    install(WebServerTestingModule())\n    // install other modules...\n }\n}\n

Then test HTTP requests using WebTestClient (assertions here were made using Kotest):

@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n  @Suppress(\"unused\")\n  @MiskTestModule val module = MyModule()\n\n  @Inject lateinit var webTestClient: WebTestClient\n\n  @Test\n  fun `makes a call to the service`() {\n    val response = webTestClient.post(\"/hello\", HelloRequest(\"world\"))\n    response.response.code shouldBe 200\n    response.parseJson<HelloResponse>() shouldBe HelloResponse(\"hello world\")\n  }\n}\n

Test gRPC requests by setting up a gRPC client pointing to the running app:

class MyServerModule : KAbstractModule() {\n  override fun configure() {\n    install(WebServerTestingModule())\n    // Assume RobotLocatorWebAction is a gRPC action.\n    install(WebActionModule.create<RobotLocatorWebAction>())\n  }\n}\n\nclass MyClientModule(val jetty: JettyService): KAbstractModule() {\n  override fun configure() {\n    // Assume RobotLocator was generated via Wire.\n    install(GrpcClientModule.create<RobotLocator, GrpcRobotLocator>(\"robots\"))\n  }\n\n  @Provides\n  @Singleton\n  fun provideHttpClientConfig(): HttpClientsConfig {\n    return HttpClientsConfig(\n      endpoints = mapOf(\n        \"robots\" to HttpClientEndpointConfig(jetty.httpServerUrl.toString())\n      )\n    )\n  }\n}\n\n@MiskTest(startService = true)\nclass RobotLocatorIntegrationTest {\n  @Suppress(\"unused\")\n  @MiskTestModule val module = MyServerModule()\n\n  @Inject lateinit var jettyService: JettyService\n\n  @Test \n  fun `makes a call to the service`() {\n    val robotLocator = Guice.createInjector(MyClientModule(jettyService))\n      .getInstance<RobotLocator>()\n\n    robotLocator.SayHello().executeBlocking(HelloRequest.builder().name(\"world\").build()) shouldBe \n      HelloReply.Builder().message(\"hello world\").build()\n  }\n}\n
"},{"location":"changelog/","title":"Changelog","text":"

Misk releases since 2023-05-27 have been automatically published to Maven on PR merge to master.

The Changelog consequently will not be updated regularly since releases only include the changes of the last PR so the Changelog is now equivalent to the git commit history.

Major and breaking changes will still be documented in the Changelog.

"},{"location":"changelog/#2024-q2-summary","title":"2024 Q2 Summary","text":"

Misk had a busy quarter with 98 PRs merged (over one per day!) from over 30 contributors.

From their efforts, numerous bug fixes, API improvements, and net-new functionality is now available to the growing community of developers building services with Misk.

"},{"location":"changelog/#thank-you-misk-contributors","title":"Thank you Misk Contributors!","text":"

Misk has an active community of contributors giving back by upstreaming improvements, often motivated by their own experience building and operating Misk services.

Thanks to all who made Misk a better framework this quarter!

"},{"location":"changelog/#showcase-the-new-misk-ui-stack","title":"Showcase: The New Misk UI Stack","text":"

Over the past year, the Misk admin dashboard has migrated to a new UI stack: kotlinx.html, Hotwire, and Tailwind UI.

This stack doesn\u2019t have a dedicated web build (ie. npm node modules, webpack\u2026) and has proven to be a lightweight, developer friendly stack for quickly shipping and maintaining simple UI from your Misk service. Builds are automatically part of your usual Gradle Misk Kotlin build which makes local development and CI builds fast and simple.

\u201cHaving a quick and easy way (for a backend eng \ud83d\ude05) to create custom UI is a power tool in your toolkit! It has helped us to creates internal utilities that makes operating and validate our services a walk in the park. I was able to successfully ship some new UI in one morning!\u201d \u2013 @frojasg

Developers have been surprised how fast they can ramp up and ship UI from their service, on the order of a few hours one morning, instead of a few weeks (or months) to build a full JS frontend app.

See the Exemplar service code in the repo for full examples of the new UI stack in use for building dedicated frontend apps, admin dashboard tabs, and more.

"},{"location":"changelog/#showcase-new-schema-migrator-gradle-plugin","title":"Showcase: New Schema Migrator Gradle Plugin","text":"

Misk has shipped with a performant database schema migrator for years. It \u201cjust works\u201d ensuring table schemas are up to date and running migrations in local develompent and test environments.

Now, the Misk Schema Migrator is available as a standalone Gradle plugin for use without running the service or test suite. For some services previously forced to rely on a more complex plugin like Flyway to use libraries like jOOQ, the new Schema Migrator Gradle Plugin provides a simple way to get that functionality without new non-Misk dependencies. Additionally, the Schema Migrator Gradle Plugin is compatible with the Gradle config cache for optimal performance.

Check out the simple syntax and user docs here and try it for yourself today.

"},{"location":"changelog/#showcase-new-metadata-tab-in-the-misk-admin-dashboard","title":"Showcase: New Metadata tab in the Misk admin dashboard","text":"

The new Metadata tab makes it easy to expose information from all parts of your running service. Find it at /_admin/metadata/!

The Metadata tab already includes the following information:

If you want to expose more metadata from Misk or your internal library or service, see the Exemplar service code.

"},{"location":"changelog/#showcase-new-requirerequest-utility-apis","title":"Showcase: New requireRequest utility APIs","text":"

A common pattern in request validation is ensuring non-null request fields and throwing a BadRequestException otherwise. The new requireRequestNotNull utility API does this in a single line, reducing boilerplate and making the code more readable.

Before

requireRequest(request.parameter != null) { \"parameter must not be null\" }\n\n// later, safe do because of previous null check\nrequest.parameter!!\n

After

requireRequestNotNull(request.parameter) { \"parameter must not be null\" }\n\n// later - no need for !!\nrequest.parameter\n

Misk is open for PRs if there are other broad usage utility functions which would be beneficial to offer to all users of Misk.

"},{"location":"changelog/#version-20240709","title":"Version 2024.07.09","text":"

Breaking changes:

"},{"location":"changelog/#version-20240522","title":"Version 2024.05.22","text":"

Breaking changes:

"},{"location":"changelog/#version-20240516","title":"Version 2024.05.16","text":"

Breaking changes:

"},{"location":"changelog/#version-20240514","title":"Version 2024.05.14","text":"

Breaking changes:

"},{"location":"changelog/#version-20240506","title":"Version 2024.05.06","text":"

Breaking changes:

"},{"location":"changelog/#version-0240-2022-04-13","title":"Version 0.24.0 (2022-04-13)","text":"

New features and fixes:

"},{"location":"changelog/#version-0230-2022-03-30","title":"Version 0.23.0 (2022-03-30)","text":"

Thank you to all the contributors, as always.

Breaking changes:

New features:

Fixes:

"},{"location":"changelog/#version-0220-2021-11-03","title":"Version 0.22.0 (2021-11-03)","text":"

Breaking changes:

New features and fixes:

"},{"location":"changelog/#version-0210-2021-10-18","title":"Version 0.21.0 (2021-10-18)","text":"

Public release.

"},{"location":"changelog/#version-0200-2021-08-31","title":"Version 0.20.0 (2021-08-31)","text":"

Breaking changes:

New features and fixes:

"},{"location":"changelog/#version-0190-2021-06-30","title":"Version 0.19.0 (2021-06-30)","text":"

Public release.

"},{"location":"changelog/#version-0180-2021-06-28","title":"Version 0.18.0 (2021-06-28)","text":"

Public release.

"},{"location":"changelog/#version-0171-2021-04-29","title":"Version 0.17.1 (2021-04-29)","text":"

Public release.

"},{"location":"changelog/#version-0170-2021-04-28","title":"Version 0.17.0 (2021-04-28)","text":"

Public release.

"},{"location":"changelog/#version-0160-2020-12-17","title":"Version 0.16.0 (2020-12-17)","text":"

Public release.

"},{"location":"changelog/#version-0150-2020-12-03","title":"Version 0.15.0 (2020-12-03)","text":"

Public release.

"},{"location":"changelog/#version-0140-2020-11-12","title":"Version 0.14.0 (2020-11-12)","text":"

Public release.

"},{"location":"changelog/#version-0130-2020-07-16","title":"Version 0.13.0 (2020-07-16)","text":"

Public release.

"},{"location":"changelog/#version-0120-2020-05-06","title":"Version 0.12.0 (2020-05-06)","text":"

Public release.

"},{"location":"changelog/#version-0110-2020-02-25","title":"Version 0.11.0 (2020-02-25)","text":"

Public release.

"},{"location":"changelog/#version-0100-2019-01-21","title":"Version 0.10.0 (2019-01-21)","text":"

Public release.

"},{"location":"changelog/#version-090-2019-12-06","title":"Version 0.9.0 (2019-12-06)","text":"

Public release.

"},{"location":"changelog/#version-080-2019-10-22","title":"Version 0.8.0 (2019-10-22)","text":"

Public release.

"},{"location":"changelog/#version-070-2019-08-26","title":"Version 0.7.0 (2019-08-26)","text":"

Public release.

"},{"location":"changelog/#version-025-2018-06-11","title":"Version 0.2.5 (2018-06-11)","text":""},{"location":"changelog/#new","title":"New","text":""},{"location":"changelog/#fix","title":"Fix","text":""},{"location":"changelog/#version-024-2018-05-14","title":"Version 0.2.4 (2018-05-14)","text":""},{"location":"changelog/#new_1","title":"New","text":""},{"location":"changelog/#fix_1","title":"Fix","text":""},{"location":"changelog/#version-023-2018-04-27","title":"Version 0.2.3 (2018-04-27)","text":""},{"location":"changelog/#new_2","title":"New","text":""},{"location":"changelog/#fix_2","title":"Fix","text":""},{"location":"changelog/#version-021-2018-03-26","title":"Version 0.2.1 (2018-03-26)","text":""},{"location":"changelog/#new_3","title":"New","text":""},{"location":"changelog/#fix_3","title":"Fix","text":""},{"location":"changelog/#version-020-2018-03-13","title":"Version 0.2.0 (2018-03-13)","text":""},{"location":"changelog/#new_4","title":"New","text":""},{"location":"changelog/#fix_4","title":"Fix","text":""},{"location":"changelog/#version-010-2018-02-01","title":"Version 0.1.0 (2018-02-01)","text":"

Initial release.

"},{"location":"clients/","title":"Clients","text":"

Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.

"},{"location":"clients/#http-clients","title":"HTTP Clients","text":""},{"location":"clients/#config","title":"Config","text":"

Set up a Config object (and use MiskConfig.load to load config from a YAML file):

data class MyServiceConfig(\n  val http_clients: HttpClientsConfig,\n  // ...\n) : Config\n

In the configuration YAML, specify the target service\u2019s address:

http_clients:\n  ...\n  endpoints:\n    ...\n    greeter:  { url: \"https://hello.example.com\" }\n
"},{"location":"clients/#create-an-okhttpclient","title":"Create an OkHttpClient","text":"

Use HttpClientModule:

class MyClientModule : KAbstractModule() {\n  override fun configure() {\n    install(HttpClientModule(\n      // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n      name = \"greeter\",\n      // Optional annotation to define how you inject your client dependency\n      annotation = Names.named(\"greeterHttp\")\n    ))\n  }\n}\n

This binds an OkHttpClient that you can inject:

class MyClient @Inject constructor(@Named(\"greeterHttp\") val client: OkHttpClient) {\n  fun callGreeter() {\n    val response = client.newCall(\n      Request.Builder()\n        .url(\"http://localhost:8080/hello\")\n        .build()\n    ).execute()\n  }\n}\n
"},{"location":"clients/#create-typed-clients-with-retrofit","title":"Create typed clients with Retrofit","text":"

First, create a Retrofit interface. See the Retrofit docs for more details.

interface GreeterApi {\n  @POST(\"/hello\")\n  @Headers(value = [\"accept: application/json\"])\n  fun hello(\n    @Body request: HelloRequest\n  ): Call<HelloResponse>\n}\n

Next, install a TypedHttpClientModule with this interface.

class HelloClientModule : KAbstractModule() {\n  override fun configure() {\n    install(\n      TypedHttpClientModule(\n        GreeterApi::class, \n        // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n        name = \"greeter\", \n        // Optional annotation to define how you inject your client dependency\n        annotation = Names.named(\"greeterApi\")\n      )\n    )\n  }\n}\n

Now you can inject an implementation of this client:

@Singleton class MyApiClient @Inject constructor(\n  @Named(\"greeterApi\") private val api: GreeterApi\n) {\n  fun hello(message: String): String {\n    val response = api.hello(\n      HelloRequest(\n        message = message\n      )\n    ).execute()\n  }\n}\n
"},{"location":"clients/#grpc-clients","title":"gRPC Clients","text":"

First, include the auto-generated gRPC client code at the caller module using the Wire Gradle plugin.

plugins {\n  id(\"com.squareup.wire\")\n}\n\nwire {\n  sourcePath {\n    srcDir(\"src/main/proto\")\n  }\n\n  // Generate Kotlin for the gRPC client API.\n  kotlin {\n    // Set this to false if you're generating client and server interfaces in one module\n    exclusive = false\n    includes (\"squareup.cash.hello.GreeterService\")\n    rpcRole = \"client\"\n  }\n\n  java {\n  }\n}\n

Next, bind your client in code in a similar fashion to an HTTP client. Set up client configuration, as described in Config. Then, bind a GrpcClientModule:

class GreeterClientModule : KAbstractModule() {\n  override fun configure() {\n    install(GrpcClientModule.create<GreeterServiceClient, GrpcGreeterServiceClient>(\n        // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n        name = \"greeter\",\n        // Optional annotation to define how you inject your client dependency\n        annotation = Names.named(\"greeterGrpc\")\n    ))\n  }\n}\n

With this all setup, you can now inject your client in source code and connect via gRPC:

internal class GrpcGreeterServiceClient @Inject internal constructor(\n  @Named(\"greeterGrpc\") private val greeterGrpc: GreeterServiceClient\n) {\n  fun get(message: String) {\n    val response = greeterGrpc.Hello().executeBlocking(HelloRequest(message))\n\n    // ... do something with the response here\n  }\n}\n
"},{"location":"contributing/","title":"Contributing","text":"

If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA).

"},{"location":"contributing/#building-misk-locally","title":"Building Misk locally","text":"

Install and activate hermit: https://cashapp.github.io/hermit/

Use gradle to run all Kotlin tests locally:

gradle build\n

misk-hibernate tests expect a mysql server running on localhost:3306 with no password set on the root user. You might stand up a server with a docker image, e.g.

docker run -d --rm --name \"mysql-80\" -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true -e MYSQL_LOG_CONSOLE=true mysql:8.0 --sql-mode=\"\"\n

Misk may download these Docker images as part of its tests. Because tests can time out, pre-downloading these can help resolve timeouts.

alpine:latest\namazon/dynamodb-local:latest\ncockroachdb/cockroach\ngcr.io/cloud-spanner-emulator/emulator\npingcap/tidb\npostgres\nredis:6.2-alpine\nsoftwaremill/elasticmq\nvitess/base\n
"},{"location":"contributing/#breaking-changes","title":"Breaking changes","text":"

Note: Remember to document breaking changes in CHANGELOG.md.

We integrate Kotlin Binary Compatibility Validator into our build pipeline to automatically detect breaking changes that could affect existing clients.

"},{"location":"contributing/#kotlin-binary-compatibility-validator","title":"Kotlin Binary Compatibility Validator","text":"

This tool checks for changes to the public binary API. The plugin generates a dump of the current API and compares it to the previous version. If a binary incompatibility is detected, the build will fail.

If the change is intentional, you can run the :apiDump task and commit the resulting changes to the .api files. .api files should not have removals and additions in the same change so that downstream apps do not immediately run into backwards-compatibility issues.

This runs as part of gradle check task, or you can call directly with gradle apiCheck.

"},{"location":"coroutines/","title":"Misk Coroutines Rules","text":"

Coroutines are cooperative concurrency. If you don\u2019t cooperate (ie. suspend regularly), things will not be as efficient and may potentially deadlock.

Misk allows for per request threading for which coroutines can be used to model concurrent operations. If the coroutines suspend, then multiple coroutines can be run in parallel on the same thread. If coroutines need to block, they will run serially unless a Dispatcher is provided that allows for running on multiple threads. Both models are supported.

Mixing thread based concurrency primitives, to synchronize coroutines, can result in deadlocks if threads are blocked waiting Example ```class DangerTest { @Test fun threads() { val latch = CountDownLatch(3) thread { latch.countDown() } thread { latch.countDown() } thread { latch.countDown() } latch.await() }

@Test fun coroutineDeadlock(){ runBlocking { val latch = CountDownLatch(3) async { latch.countDown() } async { latch.countDown() } async { latch.countDown() } latch.await() } } }```

When an action is declared with the suspend modifier, it will be called with a Dispatcher that has a single backing thread (runBlocking). This thread is part of the Jetty Thread Pool and allocated to this specific request, therefore it is safe to make blocking calls on. This will also take care of request scoped features that are thread local, such as ActionScoped values, MDC, tracing, etc.

When that function returns, the request and response body streams will be flushed and closed immediately. The framework will release these resources for you.

Follow structured concurrency best practices, including: - All coroutines should be in child scopes for the incoming request scope. - Don\u2019t use GlobalScope or create a new CoroutineScope() object.

Misk is gradually adding experimental support for Kotlin coroutines. Functionality may be partially implemented or buggy in the short term as support is added to core libraries and implementations. Please report any issues encountered.

"},{"location":"developer-guide/","title":"Developer Guide","text":""},{"location":"developer-guide/#action","title":"Action","text":"

Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.

Learn more about Misk actions

"},{"location":"developer-guide/#interceptors","title":"Interceptors","text":"

Misk uses interceptors (middleware) to observe and potentially transform HTTP messages. The pattern is borrowed from OkHttp Interceptors.

Learn more about Misk interceptors

"},{"location":"developer-guide/#clients","title":"Clients","text":"

Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.

Learn more about how to create, configure and test HTTP clients or gRPC clients within a Misk application here.

"},{"location":"developer-guide/#tests","title":"Tests","text":"

Misk provides a few ways to streamline testing with JUnit.

Learn more about Misk tests

"},{"location":"developer-guide/#modules","title":"Modules","text":"

Misk provides dozens of modules to facilitate the development and deployment of applications, and the integration with clouds and various common technologies.

Learn more about Misk modules

"},{"location":"developer-guide/#wisp","title":"Wisp","text":"

Wisp is a collection of kotlin modules providing various features and utilities, including config, logging, feature flags and more. It is basically extracted Misk functionality without Dependency Injection (i.e., no Guice).

Learn more about Wisp.

"},{"location":"getting-started/","title":"Getting Started","text":"

The easiest way to get started is to copy the Misk exemplar project. This exemplar contains a Misk web app with the requisite dependencies.

"},{"location":"getting-started/#prerequisites","title":"Prerequisites","text":"

Misk relies on hermit to install tools required to develop and run the service. Please follow this to install and activate hermit.

Misk uses Gradle to build and run test locally.

"},{"location":"getting-started/#start-the-service","title":"Start the service","text":"

Run ExemplarService#main from your IDE, or use gradle to run:

gradle run\n
"},{"location":"getting-started/#set-up-bindings","title":"Set up bindings","text":"

A Misk application is wired together using Guice. Features of Misk are managed by Guava Services, provided by Guice Modules, and configured using Misk Configs. For example, if your application needs a Redis cache, you would install RedisModule, and add a corresponding RedisConfig to your application\u2019s config YAML.

Misk is unopinionated about which of its features your application chooses to use, and offers multiple alternatives for some common concerns.

"},{"location":"getting-started/#the-main-function","title":"The main function","text":"

The entry point to every Misk application is MiskApplication:

fun main(args: Array<String>) {\n  val environment = Environment.fromEnvironmentVariable()\n  val env = Env(environment.name)\n  val config = MiskConfig.load<ExemplarConfig>(\"exemplar\", env)\n\n  MiskApplication(\n    MiskRealServiceModule(),\n    MiskWebModule(config.web),\n    ExemplarAccessModule(),\n    ExemplarWebActionsModule(),\n\n    // e.g. to add an admin dashboard:\n    AdminDashboardModule(isDevelopment = true)\n  ).run(args)\n}\n
"},{"location":"getting-started/#set-up-configuration","title":"Set up configuration","text":"

Every Misk application has a top-level class that implements the Config marker interface. This Config encapsulates all of the configuration for the app.

By default, configs are loaded from YAML files at the app\u2019s resources root. Each value in the config must have a corresponding entry in the YAML file.

Modules in Misk that require configuration usually have their own Config objects. If you want to use the Module in your app, you should add them as properties of your app\u2019s Config object, for example:

data class MyAppConfig(\n    val my_config_value: String,\n    val http_clients: HttpClientsConfig\n) : Config\n

This then corresponds to a YAML file:

my_config_value: \"this value\"\n\nhttp_clients:\n  # ... config\n
"},{"location":"getting-started/#config-resolution","title":"Config resolution","text":"

Configs are loaded using the app\u2019s resource loader. The config loader looks for files in the following order by default:

  1. $SERVICE_NAME-common.yaml
  2. $SERVICE_NAME-$ENVIRONMENT.yaml

At least one of $SERVICE_NAME-common.yaml or $SERVICE_NAME-$ENVIRONMENT.yaml must exist.

Values from later files take precedence.

"},{"location":"getting-started/#write-an-endpoint","title":"Write an endpoint","text":"

Actions are Misk\u2019s unit for an endpoint.

Actions inherit from WebAction and have a @Get/@Post annotation:

@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n  @Get(\"/hello/{name}\")\n  @Unauthenticated\n  @ResponseContentType(MediaTypes.APPLICATION_JSON)\n  fun hello(\n    @PathParam name: String,\n  ): HelloResponse {\n    return HelloResponse(name)\n  }\n}\n\ndata class HelloResponse(val name: String)\n

Read more about this in Actions.

"},{"location":"getting-started/#test-the-endpoint","title":"Test the endpoint","text":"

You can unit test directly: 

class HelloWebActionTest {\n  @Test\n  fun `tests the unit`() {\n    assertThat(HelloWebAction().hello(\"sandy\", headersOf(), null, null))\n        .isEqualTo(HelloResponse(\"sandy\"))\n  }\n}\n

Integration tests set up a module for you, and adds an injector to the test class.

You can use WebServerTestingModule to set up a running web server and make WebTestClient available.

@MiskTest(startService = true)\nclass HelloWebActionTest {\n  @MiskTestModule val module = TestModule()\n\n  @Inject private lateinit var webTestClient: WebTestClient\n\n  @Test\n  fun `tests a request being made`() {\n    val hello = webTestClient.get(\"/hello/sandy\")\n    assertThat(hello.response.code).isEqualTo(200)\n    assertThat(hello.parseJson<HelloResponse>())\n      .isEqualTo(HelloResponse(\"sandy\"))\n  }\n\n  class TestModule : KAbstractModule() {\n    override fun configure() {\n      install(WebServerTestingModule())\n      install(HelloModule())\n    }\n  }\n}\n

Read more about this in Actions

"},{"location":"getting-started/#create-services","title":"Create services","text":"

The main function is just an entry point for wiring together components of Misk. Long-running threads that do the real work are written as Services using Guava\u2019s Service Framework.

A Service is bound by installing a ServiceModule, for example: 

class MyServiceModule : KAbstractModule() {\n  override fun configure() {\n    install(ServiceModule<MyService>())\n  }\n}\n

Notice that in this example we use KAbstractModule(), Misk\u2019s Kotlin wrapper for AbstractModule, as our base Module class.

MiskApplication will start all services installed by a ServiceModule.

If there is a Service that must be run after a other set of Services have started, the service dependency graph should be specified at the installation site.

For example, if you are operating a movie service, which needs a database: 

class MovieServiceModule : KAbstractModule() {\n  override fun configure() {\n    // Note that DatabaseService does not have to be installed here.\n    // It could be installed in another KAbstractModule if preferred.\n    install(ServiceModule<DatabaseService>())\n\n    // Multiple dependencies can be added by chaining calls to `dependsOn`.\n    install(ServiceModule<MovieService>()\n        .dependsOn<DatabaseService>())\n  }\n}\n
See ServiceModule for more details about the service graph.

When writing Services, always prefer to inherit from one of the common base classes: AbstractIdleService, AbstractScheduledService, or AbstractExecutionThreadService. See Services Explained for details. If your service is can make use of exponential backoff and scheduling, take a look at using RepeatedTaskQueue.

"},{"location":"interceptors/","title":"Interceptors","text":"

Misk has interceptors (middleware) to observe & potentially transform HTTP messages. The pattern borrows from OkHttp Interceptors.

Interceptors can be for inbound calls to Misk\u2019s Jetty webserver from an external client, or outbound calls from Misk\u2019s OkHttpClient to an external service.

Interceptors can be network interceptors that operate on the encoded HTTP messages, or application interceptors that operate on decoded value objects.

Misk has both built-in interceptors and user-provided interceptors. In all cases, interceptors must be registered with a Guice multibinding.

"},{"location":"interceptors/#inbound-network-interceptors","title":"Inbound Network Interceptors","text":"

These run for inbound HTTP calls into Misk.

They may short-circuit the inbound calls, preventing the calls from ever reaching the destination action. For example, the concurrency limiting (ie. load shedding) interceptor short-circuits inbound calls when it predicts a timeout. Inbound calls may also be short-circuited if authentication headers are absent or inadequate.

/** This sample interceptor decompresses the inbound request body. */\nclass GunzipRequestBodyInterceptor : NetworkInterceptor {\n  override fun intercept(chain: NetworkChain) {\n    val httpCall = chain.httpCall\n    val contentEncoding = httpCall.requestHeaders[CONTENT_ENCODING]\n      ?: return chain.proceed(httpCall)\n    if (contentEncoding.lowercase() == GZIP) {\n      httpCall.takeRequestBody()?.let {\n        httpCall.putRequestBody(GzipSource(it).buffer())\n      }\n    }\n    chain.proceed(httpCall)\n  }\n}\n

Though inbound interceptors may rewrite the inbound request, they generally run too late to rewrite the outbound response. In particular, by the time the proceed() call returns, the outbound HTTP response has already been encoded and transmitted.

The built-in inbound network interceptors are:

Multibind these with NetworkInterceptor.Factory.

"},{"location":"interceptors/#inbound-application-interceptors","title":"Inbound Application Interceptors","text":"

These run after the network interceptors, and after the request body has been decoded into the type specified by the target action.

class RequestBodyLoggingInterceptor: ApplicationInterceptor {\n  override fun intercept(chain: Chain): Any {\n    val result = chain.proceed(chain.args)\n    log(\"Request arguments: ${chain.args}, response value: $result\")\n    return result\n  }\n}\n

Working in this layer is convenient because the chain argument has the action, its args, its function, and its HttpCall. Because the action is already selected and its arguments are already decoded, this layer cannot be used to rewrite the bytes of the request! But it can change the arguments to the function (in a type-safe way).

The built-in inbound application interceptors are:

Multibind these with ApplicationInterceptor.Factory.

"},{"location":"interceptors/#outbound-application-interceptors","title":"Outbound Application Interceptors","text":"

On inbound calls, network interceptors run before application interceptors. On outbound calls, the ordering is reversed: application interceptors run first.

Outbound application interceptors use OkHttp\u2019s Interceptor type for calls. Multibind these using ClientApplicationInterceptorFactory.

class LoggingInterceptor : Interceptor {\n\n  override fun intercept(chain: Interceptor.Chain): Response {\n    val response = chain.proceed(chain.request())\n    log(\"Call to ${targetName(chain)} returned ${response.code}\")\n    return response\n  }\n\n  private fun targetName(chain: Interceptor.Chain): String? {\n    val invocation = chain.request().tag(Invocation::class.java)\n    if (invocation != null) return \"$clientName.${invocation.method().name}\"\n\n    val grpcMethod = chain.request().tag(GrpcMethod::class.java)\n    if (grpcMethod != null) return \"$clientName.${grpcMethod.path.substringAfterLast(\"/\")}\"\n\n    return null\n  }\n}\n

Calls made via Retrofit or the Wire gRPC client have metadata objects available as tags on the HTTP request. You can use these to find out which Retrofit method was called (and its arguments), or which gRPC method was called.

In these interceptors it\u2019s possible to rewrite the request body, request URL, and request headers. It\u2019s also possible to rewrite the returned response body, headers, or status code. You might do this to inject a missing response header or remove one.

The built-in outbound application interceptors are:

Multibind these with ClientApplicationInterceptorFactory.

"},{"location":"interceptors/#outbound-network-interceptors","title":"Outbound Network Interceptors","text":"

These run on outbound calls after the outbound application interceptors. These run after the socket connection to the remote HTTP server has been established.

class LoggingInterceptor : ClientNetworkInterceptor {\n  override fun intercept(chain: ClientNetworkChain): Response {\n    log(\"executing ${chain.action}\")\n    return chain.proceed(chain.request)\n  }\n}\n

Network interceptors cannot rewrite the destination hostname or URL. They can rewrite outbound request bodies and request headers. They can also rewrite returned status codes, bodies and headers.

Misk has no built-in network interceptors.

Multibind these with ClientNetworkInterceptor.Factory.

"},{"location":"modules/","title":"Misk Modules","text":"

Misk is split into many Gradle subprojects to organize functionality and create smaller dependencies for downstream users. Integrations with external libraries (like DynamoDB, Hibernate, etc.) should each live in their own module.

Misk uses the Gradle test fixtures plugin to colocate production code with any relevant test helper classes. However, there are some *-testing modules that haven\u2019t yet been migrated to test fixtures.

"},{"location":"modules/#descriptions","title":"Descriptions","text":""},{"location":"modules/#misk","title":"misk","text":"

Most of the implementation of Misk\u2019s web server components.

This is the original monolithic module. Pieces are being extracted into new modules to align with the smaller module strategy.

"},{"location":"modules/#misk-actions","title":"misk-actions","text":"

The core annotations and interfaces necessary to define actions that can be hosted in Misk. This package has no dependency on the enclosing container (Misk!) and so your actions can be used in other environments without any heavy dependencies.

Actions should extend WebAction, be annotated with a HTTP method like @Post, accept a request object and return a response object. Throw an exception like BadRequestException to fail the request without much boilerplate.

"},{"location":"modules/#misk-api","title":"misk-api","text":"

High level interfaces and data classes which are implemented by both misk and wisp modules. This module is agnostic to implementation details.

"},{"location":"modules/#misk-aws","title":"misk-aws","text":"

Integrate with Amazon Web Services, and includes packages to integrate with S3 and SQS.

"},{"location":"modules/#misk-aws-dynamodb","title":"misk-aws-dynamodb","text":"

Integrate with AWS DynamoDb using AWS SDK for Java 1.x. It should be safe to install side-by-side with misk-aws2-dynamodb if you need to use features in both.

"},{"location":"modules/#misk-aws-dynamodb-testing","title":"misk-aws-dynamodb-testing","text":"

Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 1.x. Use alongside with misk-aws-dynamodb.

Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.

Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.

"},{"location":"modules/#misk-aws2-dynamodb","title":"misk-aws2-dynamodb","text":"

Integrate with AWS DynamoDb using AWS SDK for Java 2.x. It should be safe to install side-by-side with misk-aws-dynamodb if you need to use features in both.

Please read the AWS SDK for Java 2.x Migration Guide for more details.

"},{"location":"modules/#misk-aws2-dynamodb-testing","title":"misk-aws2-dynamodb-testing","text":"

Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 2.x. Use alongside with misk-aws2-dynamodb.

Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.

Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.

"},{"location":"modules/#misk-core","title":"misk-core","text":"

A collection of utility functions and interfaces that are used in many places.

"},{"location":"modules/#misk-service","title":"misk-service","text":"

Bind Guava services with inter-service dependencies.

Any service can depend on any other service. ServiceManager won\u2019t start a service until the services it depends on are running.

"},{"location":"modules/#misk-inject","title":"misk-inject","text":"

Integrates Guice with Kotlin.

Extending KAbstractModule instead of Guice\u2019s AbstractModule lets you use KClass instead of java.lang.Class and other conveniences.

"},{"location":"modules/#misk-feature","title":"misk-feature","text":"

Runtime feature flags. misk-launchdarkly is the reference implementation.

"},{"location":"modules/#misk-jobqueue","title":"misk-jobqueue","text":"

A job queue with a high quality fake. AwsSqsJobQueueModule from misk-aws is the reference implementation.

"},{"location":"modules/#misk-events","title":"misk-events","text":"

An event publisher + consumer. There is no open source reference implementation at this time.

"},{"location":"modules/#wisp","title":"wisp.*","text":"

These modules were created to extract specific pieces of functionality out of the misk* modules into new, low-dependency modules. They were especially focused on having no Guice dependencies. Some of these modules duplicate existing Misk functionality, but over time implementations will be deduplicated as part of broader code cleanup efforts.

"},{"location":"multipart/","title":"Multipart","text":"

Multipart Forms are a way to encode multiple files in a single request. This is commonly used when uploading files to a server.

Misk support this by leveraging the okhttp3.MultipartReader class. The following is an example of how to use it in a Misk WebAction:

import misk.web.Post\nimport misk.web.RequestBody\nimport misk.web.RequestContentType\nimport misk.web.ResponseContentType\nimport misk.web.actions.WebAction\nimport misk.web.mediatype.MediaTypes\nimport misk.web.actions.WebAction\nimport okhttp3.MultipartReader\n\nclass UploadFileAction @Inject constructor() : WebAction {\n  @Post(\"/internal/upload-file\")\n  @RequestContentType(\"multipart/*\")\n  @ResponseContentType(MediaTypes.TEXT_PLAIN_UTF8)\n  fun upload(\n    @RequestBody multipartReader: MultipartReader\n  ): String { \n    // use multipartReader to read the parts of the request\n  }\n}\n

To illustrate how to use the MultipartReader class, let\u2019s consider an example where you want to upload the following file:

19119888,127009194,436445396,143573243,307290287\n

For each element of the part (separated by comma) we want to log an info message. This can be accomplished by the following code:

  fun execute(\n    @RequestBody multipartReader: MultipartReader\n  ): String {\n    val part = multipartReader.nextPart() ?: return \"Empty part\"\n    val partContent = part.body.readUtf8().split(\",\")\n    val idempotenceToken = part.headers[\"X-Idempotence-Token\"]\n\n    partContent.forEach {\n      logger.info { \"Processing row: $it with $idempotenceToken.\" }\n    }\n\n    return \"Success\"\n  }\n

A part can also carry headers and this could come in handy to pass additional information like X-Idempotence-Token that could serve as an idempotence token so elements are just processed once.

The following is an example of how to test the above code using curl:

  curl -v -F \"upload=@localfilename;headers=\\\"X-Idempotence-Token:as456\\\" http://<BASE_URL>/internal/upload-file\n

Where localfilename is the location of a file with the content described above, and the headers attribute is used to pass the X-Idempotence-Token header.

You could upload multiple parts in the curl request, and in such cases you will have to iterate over the parts in the MultipartReader object:

  fun execute(\n    @RequestBody multipartReader: MultipartReader\n  ): String {\n    var part = multipartReader.nextPart()\n    while (part != null) {\n      ...\n      part = multipartReader.nextPart()\n    }\n    return \"Success\"\n  }\n
"},{"location":"releasing/","title":"Releasing","text":"

Our release process is designed to be hands-off and automatic. This document aims to provide an understanding of the automated workflow we use to release new versions of Misk repository, along with insights into how to troubleshoot potential publishing issues.

"},{"location":"releasing/#prerequisites","title":"Prerequisites","text":"

Before proceeding with the release process, ensure the following: - You have read CONTRIBUTING.md - build.gradle.kts is properly configured with the correct publishing configurations and publishing plugin is applied - If you are changing the publication details, it is recommended that you have the necessary permissions and credentials to publish artifacts to Sonatype Nexus Repository (OSSRH)

"},{"location":"releasing/#automated-publishing-workflow","title":"Automated Publishing Workflow","text":"

This repository is set up with an automated workflow using GitHub Actions. - The workflow is triggered as soon as a pull request is merged into the master branch. - A version number is dynamically generated and assigned to the release - The artifacts are published to Sonatype Nexus to a staging repository - Sonatype performs various checks and validations on the artifacts - Once verified, these artifacts are promoted and eventually synchronized to Maven Central - Public builds can be found here

"},{"location":"releasing/#troubleshooting","title":"Troubleshooting","text":"

While our release process is designed to be seamless, occasionally, issues may arise that require attention. Here are some tips to help diagnose:

  1. Review the logs and look for error messages or warnings related to the publishing process
  2. If the failure seems to be related to network issues or timeouts, you can manually re-run the job in the Actions tab.
  3. Verify the publication configurations are correct with the appropriate Sonatype host and pom settings
  4. If the issue persists, you can contact the maintainers or reach out to Sonatype support for assistance.
"},{"location":"testing/","title":"Testing","text":"

Misk provides a few ways to streamline testing with JUnit.

Without Misk, you would instantiate units under test and their dependencies:

class FeatureWithoutMiskTest {\n    @Test \n    fun `tests something`() {\n        val repository = MyRepository()\n        val handler = MyHandler(repository)\n\n        // ... perform assertions\n    }\n}\n
"},{"location":"testing/#using-misktest","title":"Using @MiskTest","text":"

@MiskTest will stand up a Misk app given a provided module and then inject members onto the test class. For instance, with a test that looks like this:

@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n  @MiskTestModule val module = MyTestingModule()\n\n  @Inject lateinit var myHandler: MyHandler\n\n  @Test\n  fun `makes a call to the service`() {\n      // use myHandler...\n  }\n}\n\nclass MyTestingModule : KAbstractModule() {\n    override fun configure() {\n        // add modules, declare bindings...\n    }\n}\n
"},{"location":"testing/#next-steps","title":"Next steps","text":"

Some common domains to test:

"},{"location":"0.x/bucket4j/","title":"bucket4j - Misk","text":"

//bucket4j

"},{"location":"0.x/bucket4j/#bucket4j","title":"bucket4j","text":""},{"location":"0.x/bucket4j/#packages","title":"Packages","text":"Name wisp.ratelimiting.bucket4j"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/","title":"Package-level declarations - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#types","title":"Types","text":"Name Summary Bucket4jPruner [jvm]abstract class Bucket4jPruner : RateLimitPruner Bucket4jRateLimiter [jvm]class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter ClockTimeMeter [jvm]class ClockTimeMeter(clock: Clock) : TimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"

[jvm]\\ abstract class Bucket4jPruner : RateLimitPruner

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#constructors","title":"Constructors","text":"Bucket4jPruner [jvm]constructor()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]abstract val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]abstract fun prune()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/Bucket4jPruner

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"

[jvm]\\ constructor()

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/clockTimeMeter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"

[jvm]\\ abstract val clockTimeMeter: ClockTimeMeter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"

[jvm]\\ class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#constructors","title":"Constructors","text":"Bucket4jRateLimiter [jvm]@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#functions","title":"Functions","text":"Name Summary availableTokens [jvm]open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long consumeToken [jvm]open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData releaseToken [jvm]open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long) resetBucket [jvm]open override fun resetBucket(key: String, configuration: RateLimitConfiguration) testConsumptionAttempt [jvm]open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult withToken [jvm]open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/Bucket4jRateLimiter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"

[jvm]\\

@JvmOverloads

constructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/","title":"availableTokens - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/availableTokens

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/#availabletokens","title":"availableTokens","text":"

[jvm]\\ open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/","title":"consumeToken - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/consumeToken

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/#consumetoken","title":"consumeToken","text":"

[jvm]\\ open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/","title":"releaseToken - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/releaseToken

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/#releasetoken","title":"releaseToken","text":"

[jvm]\\ open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long)

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/","title":"resetBucket - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/resetBucket

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/#resetbucket","title":"resetBucket","text":"

[jvm]\\ open override fun resetBucket(key: String, configuration: RateLimitConfiguration)

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/","title":"testConsumptionAttempt - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/testConsumptionAttempt

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/#testconsumptionattempt","title":"testConsumptionAttempt","text":"

[jvm]\\ open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"

[jvm]\\ class ClockTimeMeter(clock: Clock) : TimeMeter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#constructors","title":"Constructors","text":"ClockTimeMeter [jvm]constructor(clock: Clock)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#functions","title":"Functions","text":"Name Summary currentTimeNanos [jvm]open override fun currentTimeNanos(): Long isWallClockBased [jvm]open override fun isWallClockBased(): Boolean"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/ClockTimeMeter

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"

[jvm]\\ constructor(clock: Clock)

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/","title":"currentTimeNanos - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/currentTimeNanos

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/#currenttimenanos","title":"currentTimeNanos","text":"

[jvm]\\ open override fun currentTimeNanos(): Long

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/","title":"isWallClockBased - Misk","text":"

//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/isWallClockBased

"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/#iswallclockbased","title":"isWallClockBased","text":"

[jvm]\\ open override fun isWallClockBased(): Boolean

"},{"location":"0.x/detektive/","title":"detektive - Misk","text":"

//detektive

"},{"location":"0.x/detektive/#detektive","title":"detektive","text":""},{"location":"0.x/detektive/#packages","title":"Packages","text":"Name cash.detektive cash.detektive.javacompat"},{"location":"0.x/detektive/detektive/cash.detektive/","title":"Package-level declarations - Misk","text":"

//detektive/cash.detektive

"},{"location":"0.x/detektive/detektive/cash.detektive/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive/#types","title":"Types","text":"Name Summary DetektiveRuleSetProvider [jvm]class DetektiveRuleSetProvider : RuleSetProvider"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"

//detektive/cash.detektive/DetektiveRuleSetProvider

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"

[jvm]\\ class DetektiveRuleSetProvider : RuleSetProvider

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#constructors","title":"Constructors","text":"DetektiveRuleSetProvider [jvm]constructor()"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#properties","title":"Properties","text":"Name Summary ruleSetId [jvm]open override val ruleSetId: String"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#functions","title":"Functions","text":"Name Summary instance [jvm]open override fun instance(config: Config): RuleSet"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"

//detektive/cash.detektive/DetektiveRuleSetProvider/DetektiveRuleSetProvider

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"

[jvm]\\ constructor()

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/","title":"instance - Misk","text":"

//detektive/cash.detektive/DetektiveRuleSetProvider/instance

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/#instance","title":"instance","text":"

[jvm]\\ open override fun instance(config: Config): RuleSet

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/","title":"ruleSetId - Misk","text":"

//detektive/cash.detektive/DetektiveRuleSetProvider/ruleSetId

"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/#rulesetid","title":"ruleSetId","text":"

[jvm]\\ open override val ruleSetId: String

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/","title":"Package-level declarations - Misk","text":"

//detektive/cash.detektive.javacompat

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#types","title":"Types","text":"Name Summary AnnotatePublicApisWithJvmOverloads [jvm]class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"

[jvm]\\ class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#constructors","title":"Constructors","text":"AnnotatePublicApisWithJvmOverloads [jvm]constructor(config: Config)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#types","title":"Types","text":"Name Summary ElementType [jvm]enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#properties","title":"Properties","text":"Name Summary active [jvm]open val active: Boolean aliases [jvm]val aliases: Set<String> autoCorrect [jvm]open val autoCorrect: Boolean bindingContext [jvm]var bindingContext: BindingContext compilerResources [jvm]var compilerResources: CompilerResources? defaultRuleIdAliases [jvm]open val defaultRuleIdAliases: Set<String> filters [jvm]open val filters: PathFilters? findings [jvm]open override val findings: List<Finding> issue [jvm]open override val issue: Issue parentPath [jvm]open val parentPath: String? ruleId [jvm]override val ruleId: RuleId ruleSetConfig [jvm]open override val ruleSetConfig: Config"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#functions","title":"Functions","text":"Name Summary clearFindings [jvm]open override fun clearFindings() report [jvm]open override fun report(finding: Finding, aliases: Set<String>, ruleSetId: RuleSetId?)open override fun report(findings: List<Finding>, aliases: Set<String>, ruleSetId: RuleSetId?)fun report(finding: Finding)fun report(findings: List<Finding>) subConfig [jvm]open override fun subConfig(key: String): Config valueOrDefault [jvm]open override fun <T : Any> valueOrDefault(key: String, default: T): T valueOrNull [jvm]open override fun <T : Any> valueOrNull(key: String): T? visit [jvm]open fun visit(root: KtFile) visitAnnotatedExpression [jvm]open fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression)override fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression, p1: Void): Void visitAnnotation [jvm]open fun visitAnnotation(@NotNullp0: KtAnnotation)override fun visitAnnotation(@NotNullp0: KtAnnotation, p1: Void): Void visitAnnotationEntry [jvm]open fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry)override fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry, p1: Void): Void visitAnnotationUseSiteTarget [jvm]open fun visitAnnotationUseSiteTarget(@NotNullp0: KtAnnotationUseSiteTarget, p1: Void): Void visitAnonymousInitializer [jvm]open fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer)override fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer, p1: Void): Void visitArgument [jvm]open fun visitArgument(@NotNullp0: KtValueArgument)override fun visitArgument(@NotNullp0: KtValueArgument, p1: Void): Void visitArrayAccessExpression [jvm]open fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression)override fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression, p1: Void): Void visitBackingField [jvm]open fun visitBackingField(@NotNullp0: KtBackingField, p1: Void): Void visitBinaryExpression [jvm]open fun visitBinaryExpression(@NotNullp0: KtBinaryExpression)override fun visitBinaryExpression(@NotNullp0: KtBinaryExpression, p1: Void): Void visitBinaryFile [jvm]open fun visitBinaryFile(@NotNullp0: @NotNullPsiBinaryFile) visitBinaryWithTypeRHSExpression [jvm]open fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS)override fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS, p1: Void): Void visitBlockExpression [jvm]open fun visitBlockExpression(@NotNullp0: KtBlockExpression)override fun visitBlockExpression(@NotNullp0: KtBlockExpression, p1: Void): Void visitBlockStringTemplateEntry [jvm]open fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry)override fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry, p1: Void): Void visitBreakExpression [jvm]open fun visitBreakExpression(@NotNullp0: KtBreakExpression)override fun visitBreakExpression(@NotNullp0: KtBreakExpression, p1: Void): Void visitCallableReferenceExpression [jvm]open fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression)override fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression, p1: Void): Void visitCallExpression [jvm]open fun visitCallExpression(@NotNullp0: KtCallExpression)override fun visitCallExpression(@NotNullp0: KtCallExpression, p1: Void): Void visitCatchSection [jvm]open fun visitCatchSection(@NotNullp0: KtCatchClause)override fun visitCatchSection(@NotNullp0: KtCatchClause, p1: Void): Void visitClass [jvm]open fun visitClass(@NotNullp0: KtClass)override fun visitClass(@NotNullp0: KtClass, p1: Void): Void visitClassBody [jvm]open fun visitClassBody(@NotNullp0: KtClassBody)override fun visitClassBody(@NotNullp0: KtClassBody, p1: Void): Void visitClassInitializer [jvm]open fun visitClassInitializer(@NotNullp0: KtClassInitializer)open override fun visitClassInitializer(@NotNullp0: KtClassInitializer, p1: Void): Void visitClassLiteralExpression [jvm]open fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression)override fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression, p1: Void): Void visitClassOrObject [jvm]open fun visitClassOrObject(@NotNullp0: KtClassOrObject)override fun visitClassOrObject(@NotNullp0: KtClassOrObject, p1: Void): Void visitCollectionLiteralExpression [jvm]open fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression)override fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression, p1: Void): Void visitComment [jvm]open fun visitComment(@NotNullp0: @NotNullPsiComment) visitCondition [jvm]open override fun visitCondition(root: KtFile): Boolean visitConstantExpression [jvm]open fun visitConstantExpression(@NotNullp0: KtConstantExpression)override fun visitConstantExpression(@NotNullp0: KtConstantExpression, p1: Void): Void visitConstructorCalleeExpression [jvm]open fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression)override fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression, p1: Void): Void visitConstructorDelegationCall [jvm]open fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall)override fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall, p1: Void): Void visitContextReceiverList [jvm]open fun visitContextReceiverList(@NotNullp0: KtContextReceiverList, p1: Void): Voidopen fun visitContextReceiverList(@NotNullp0: KtContextReceiverList) visitContinueExpression [jvm]open fun visitContinueExpression(@NotNullp0: KtContinueExpression)override fun visitContinueExpression(@NotNullp0: KtContinueExpression, p1: Void): Void visitDeclaration [jvm]open fun visitDeclaration(@NotNullp0: KtDeclaration)override fun visitDeclaration(@NotNullp0: KtDeclaration, p1: Void): Void visitDelegatedSuperTypeEntry [jvm]open fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry)override fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry, p1: Void): Void visitDestructuringDeclaration [jvm]open fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration)override fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration, p1: Void): Void visitDestructuringDeclarationEntry [jvm]open fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry)override fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry, p1: Void): Void visitDirectory [jvm]open fun visitDirectory(@NotNullp0: @NotNullPsiDirectory) visitDotQualifiedExpression [jvm]open fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression)override fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression, p1: Void): Void visitDoubleColonExpression [jvm]open fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression)override fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression, p1: Void): Void visitDoWhileExpression [jvm]open fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression)override fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression, p1: Void): Void visitDynamicType [jvm]open fun visitDynamicType(@NotNullp0: KtDynamicType)open override fun visitDynamicType(@NotNullp0: KtDynamicType, p1: Void): Void visitElement [jvm]open override fun visitElement(@NotNullp0: PsiElement) visitEnumEntry [jvm]open fun visitEnumEntry(@NotNullp0: KtEnumEntry)override fun visitEnumEntry(@NotNullp0: KtEnumEntry, p1: Void): Void visitErrorElement [jvm]open fun visitErrorElement(@NotNullp0: @NotNullPsiErrorElement) visitEscapeStringTemplateEntry [jvm]open fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry)override fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry, p1: Void): Void visitExpression [jvm]open fun visitExpression(@NotNullp0: KtExpression)override fun visitExpression(@NotNullp0: KtExpression, p1: Void): Void visitExpressionWithLabel [jvm]open fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel)override fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel, p1: Void): Void visitFile [jvm]fun visitFile(root: KtFile, bindingContext: BindingContext, compilerResources: CompilerResources?)open fun visitFile(@NotNullp0: @NotNullPsiFile) visitFileAnnotationList [jvm]open fun visitFileAnnotationList(@NotNullp0: KtFileAnnotationList, p1: Void): Void visitFinallySection [jvm]open fun visitFinallySection(@NotNullp0: KtFinallySection)override fun visitFinallySection(@NotNullp0: KtFinallySection, p1: Void): Void visitForExpression [jvm]open fun visitForExpression(@NotNullp0: KtForExpression)override fun visitForExpression(@NotNullp0: KtForExpression, p1: Void): Void visitFunctionType [jvm]open fun visitFunctionType(@NotNullp0: KtFunctionType)override fun visitFunctionType(@NotNullp0: KtFunctionType, p1: Void): Void visitIfExpression [jvm]open fun visitIfExpression(@NotNullp0: KtIfExpression)override fun visitIfExpression(@NotNullp0: KtIfExpression, p1: Void): Void visitImportAlias [jvm]open fun visitImportAlias(@NotNullp0: KtImportAlias, p1: Void): Voidopen fun visitImportAlias(@NotNullp0: KtImportAlias) visitImportDirective [jvm]open fun visitImportDirective(@NotNullp0: KtImportDirective)override fun visitImportDirective(@NotNullp0: KtImportDirective, p1: Void): Void visitImportList [jvm]open fun visitImportList(@NotNullp0: KtImportList)override fun visitImportList(@NotNullp0: KtImportList, p1: Void): Void visitInitializerList [jvm]open fun visitInitializerList(@NotNullp0: KtInitializerList)override fun visitInitializerList(@NotNullp0: KtInitializerList, p1: Void): Void visitIntersectionType [jvm]open fun visitIntersectionType(@NotNullp0: KtIntersectionType)open override fun visitIntersectionType(@NotNullp0: KtIntersectionType, p1: Void): Void visitIsExpression [jvm]open fun visitIsExpression(@NotNullp0: KtIsExpression)override fun visitIsExpression(@NotNullp0: KtIsExpression, p1: Void): Void visitKtCommonFile [jvm]fun visitKtCommonFile(@NotNullp0: KtCommonFile): Void visitKtElement [jvm]open fun visitKtElement(@NotNullp0: KtElement)override fun visitKtElement(@NotNullp0: KtElement, p1: Void): Void visitKtFile [jvm]open fun visitKtFile(@NotNullp0: KtFile)override fun visitKtFile(@NotNullp0: KtFile, p1: Void): Void visitLabeledExpression [jvm]open fun visitLabeledExpression(@NotNullp0: KtLabeledExpression)override fun visitLabeledExpression(@NotNullp0: KtLabeledExpression, p1: Void): Void visitLambdaExpression [jvm]open fun visitLambdaExpression(@NotNullp0: KtLambdaExpression)override fun visitLambdaExpression(@NotNullp0: KtLambdaExpression, p1: Void): Void visitLiteralStringTemplateEntry [jvm]open fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry)override fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry, p1: Void): Void visitLoopExpression [jvm]open fun visitLoopExpression(@NotNullp0: KtLoopExpression)override fun visitLoopExpression(@NotNullp0: KtLoopExpression, p1: Void): Void visitModifierList [jvm]open fun visitModifierList(@NotNullp0: KtModifierList)override fun visitModifierList(@NotNullp0: KtModifierList, p1: Void): Void visitNamedDeclaration [jvm]open fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration)override fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration, p1: Void): Void visitNamedFunction [jvm]open override fun visitNamedFunction(function: KtNamedFunction)override fun visitNamedFunction(@NotNullp0: KtNamedFunction, p1: Void): Void visitNullableType [jvm]open fun visitNullableType(@NotNullp0: KtNullableType)override fun visitNullableType(@NotNullp0: KtNullableType, p1: Void): Void visitObjectDeclaration [jvm]open fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration)override fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration, p1: Void): Void visitObjectLiteralExpression [jvm]open fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression)override fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression, p1: Void): Void visitOuterLanguageElement [jvm]open fun visitOuterLanguageElement(@NotNullp0: @NotNullOuterLanguageElement) visitPackageDirective [jvm]open fun visitPackageDirective(@NotNullp0: KtPackageDirective)open override fun visitPackageDirective(@NotNullp0: KtPackageDirective, p1: Void): Void visitParameter [jvm]open fun visitParameter(@NotNullp0: KtParameter)override fun visitParameter(@NotNullp0: KtParameter, p1: Void): Void visitParameterList [jvm]open fun visitParameterList(@NotNullp0: KtParameterList)override fun visitParameterList(@NotNullp0: KtParameterList, p1: Void): Void visitParenthesizedExpression [jvm]open fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression)override fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression, p1: Void): Void visitPlainText [jvm]open fun visitPlainText(@NotNullp0: @NotNullPsiPlainText) visitPlainTextFile [jvm]open fun visitPlainTextFile(@NotNullp0: @NotNullPsiPlainTextFile) visitPostfixExpression [jvm]open fun visitPostfixExpression(@NotNullp0: KtPostfixExpression)override fun visitPostfixExpression(@NotNullp0: KtPostfixExpression, p1: Void): Void visitPrefixExpression [jvm]open fun visitPrefixExpression(@NotNullp0: KtPrefixExpression)override fun visitPrefixExpression(@NotNullp0: KtPrefixExpression, p1: Void): Void visitPrimaryConstructor [jvm]open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)override fun visitPrimaryConstructor(@NotNullp0: KtPrimaryConstructor, p1: Void): Void visitProperty [jvm]open fun visitProperty(@NotNullp0: KtProperty)override fun visitProperty(@NotNullp0: KtProperty, p1: Void): Void visitPropertyAccessor [jvm]open fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor)override fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor, p1: Void): Void visitPropertyDelegate [jvm]open fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate)override fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate, p1: Void): Void visitQualifiedExpression [jvm]open fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression)override fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression, p1: Void): Void visitReferenceExpression [jvm]open fun visitReferenceExpression(@NotNullp0: KtReferenceExpression)override fun visitReferenceExpression(@NotNullp0: KtReferenceExpression, p1: Void): Void visitReturnExpression [jvm]open fun visitReturnExpression(@NotNullp0: KtReturnExpression)override fun visitReturnExpression(@NotNullp0: KtReturnExpression, p1: Void): Void visitSafeQualifiedExpression [jvm]open fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression)override fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression, p1: Void): Void visitScript [jvm]open fun visitScript(@NotNullp0: KtScript)override fun visitScript(@NotNullp0: KtScript, p1: Void): Void visitScriptInitializer [jvm]open fun visitScriptInitializer(@NotNullp0: KtScriptInitializer)open override fun visitScriptInitializer(@NotNullp0: KtScriptInitializer, p1: Void): Void visitSecondaryConstructor [jvm]open fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor)override fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor, p1: Void): Void visitSelfType [jvm]open fun visitSelfType(@NotNullp0: KtSelfType)override fun visitSelfType(@NotNullp0: KtSelfType, p1: Void): Void visitSimpleNameExpression [jvm]open fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression)override fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression, p1: Void): Void visitSimpleNameStringTemplateEntry [jvm]open fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry)override fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry, p1: Void): Void visitStringTemplateEntry [jvm]open fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry)override fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry, p1: Void): Void visitStringTemplateEntryWithExpression [jvm]open fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression)override fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression, p1: Void): Void visitStringTemplateExpression [jvm]open fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression)override fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression, p1: Void): Void visitSuperExpression [jvm]open fun visitSuperExpression(@NotNullp0: KtSuperExpression)override fun visitSuperExpression(@NotNullp0: KtSuperExpression, p1: Void): Void visitSuperTypeCallEntry [jvm]open fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry)override fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry, p1: Void): Void visitSuperTypeEntry [jvm]open fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry)override fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry, p1: Void): Void visitSuperTypeList [jvm]open fun visitSuperTypeList(@NotNullp0: KtSuperTypeList)override fun visitSuperTypeList(@NotNullp0: KtSuperTypeList, p1: Void): Void visitSuperTypeListEntry [jvm]open fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry)override fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry, p1: Void): Void visitThisExpression [jvm]open fun visitThisExpression(@NotNullp0: KtThisExpression)override fun visitThisExpression(@NotNullp0: KtThisExpression, p1: Void): Void visitThrowExpression [jvm]open fun visitThrowExpression(@NotNullp0: KtThrowExpression)override fun visitThrowExpression(@NotNullp0: KtThrowExpression, p1: Void): Void visitTryExpression [jvm]open fun visitTryExpression(@NotNullp0: KtTryExpression)override fun visitTryExpression(@NotNullp0: KtTryExpression, p1: Void): Void visitTypeAlias [jvm]open fun visitTypeAlias(@NotNullp0: KtTypeAlias)override fun visitTypeAlias(@NotNullp0: KtTypeAlias, p1: Void): Void visitTypeArgumentList [jvm]open fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList)override fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList, p1: Void): Void visitTypeConstraint [jvm]open fun visitTypeConstraint(@NotNullp0: KtTypeConstraint)override fun visitTypeConstraint(@NotNullp0: KtTypeConstraint, p1: Void): Void visitTypeConstraintList [jvm]open fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList)override fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList, p1: Void): Void visitTypeParameter [jvm]open fun visitTypeParameter(@NotNullp0: KtTypeParameter)override fun visitTypeParameter(@NotNullp0: KtTypeParameter, p1: Void): Void visitTypeParameterList [jvm]open fun visitTypeParameterList(@NotNullp0: KtTypeParameterList)override fun visitTypeParameterList(@NotNullp0: KtTypeParameterList, p1: Void): Void visitTypeProjection [jvm]open fun visitTypeProjection(@NotNullp0: KtTypeProjection)override fun visitTypeProjection(@NotNullp0: KtTypeProjection, p1: Void): Void visitTypeReference [jvm]open fun visitTypeReference(@NotNullp0: KtTypeReference)override fun visitTypeReference(@NotNullp0: KtTypeReference, p1: Void): Void visitUnaryExpression [jvm]open fun visitUnaryExpression(@NotNullp0: KtUnaryExpression)override fun visitUnaryExpression(@NotNullp0: KtUnaryExpression, p1: Void): Void visitUserType [jvm]open fun visitUserType(@NotNullp0: KtUserType)override fun visitUserType(@NotNullp0: KtUserType, p1: Void): Void visitValueArgumentList [jvm]open fun visitValueArgumentList(@NotNullp0: KtValueArgumentList)override fun visitValueArgumentList(@NotNullp0: KtValueArgumentList, p1: Void): Void visitWhenConditionInRange [jvm]open fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange)override fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange, p1: Void): Void visitWhenConditionIsPattern [jvm]open fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern)override fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern, p1: Void): Void visitWhenConditionWithExpression [jvm]open fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression)override fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression, p1: Void): Void visitWhenEntry [jvm]open fun visitWhenEntry(@NotNullp0: KtWhenEntry)override fun visitWhenEntry(@NotNullp0: KtWhenEntry, p1: Void): Void visitWhenExpression [jvm]open fun visitWhenExpression(@NotNullp0: KtWhenExpression)override fun visitWhenExpression(@NotNullp0: KtWhenExpression, p1: Void): Void visitWhileExpression [jvm]open fun visitWhileExpression(@NotNullp0: KtWhileExpression)override fun visitWhileExpression(@NotNullp0: KtWhileExpression, p1: Void): Void visitWhiteSpace [jvm]open fun visitWhiteSpace(@NotNullp0: @NotNullPsiWhiteSpace) withAutoCorrect [jvm]open fun withAutoCorrect(block: () -> Unit)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/AnnotatePublicApisWithJvmOverloads

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"

[jvm]\\ constructor(config: Config)

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/","title":"issue - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/issue

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/#issue","title":"issue","text":"

[jvm]\\ open override val issue: Issue

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/","title":"visitNamedFunction - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitNamedFunction

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/#visitnamedfunction","title":"visitNamedFunction","text":"

[jvm]\\ open override fun visitNamedFunction(function: KtNamedFunction)

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/","title":"visitPrimaryConstructor - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitPrimaryConstructor

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/#visitprimaryconstructor","title":"visitPrimaryConstructor","text":"

[jvm]\\ open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/","title":"ElementType - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#elementtype","title":"ElementType","text":"

[jvm]\\ enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#entries","title":"Entries","text":"FUNCTION [jvm]FUNCTION CONSTRUCTOR [jvm]CONSTRUCTOR"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/","title":"entries - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/entries

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/#entries","title":"entries","text":"

[jvm]\\ val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>

Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.

This method may be used to iterate over the enum entries.

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/","title":"valueOf - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/valueOf

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#valueof","title":"valueOf","text":"

[jvm]\\ fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementType

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/","title":"values - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/values

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/#values","title":"values","text":"

[jvm]\\ fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>

Returns an array containing the constants of this enum type, in the order they\u2019re declared.

This method may be used to iterate over the constants.

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/","title":"CONSTRUCTOR - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/CONSTRUCTOR

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#constructor","title":"CONSTRUCTOR","text":"

[jvm]\\ CONSTRUCTOR

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/","title":"FUNCTION - Misk","text":"

//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/FUNCTION

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#function","title":"FUNCTION","text":"

[jvm]\\ FUNCTION

"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/exemplar/","title":"exemplar - Misk","text":"

//exemplar

"},{"location":"0.x/exemplar/#exemplar","title":"exemplar","text":""},{"location":"0.x/exemplar/#packages","title":"Packages","text":"Name com.squareup.exemplar com.squareup.exemplar.actions com.squareup.exemplar.dashboard com.squareup.exemplar.dashboard.admin com.squareup.exemplar.dashboard.frontend com.squareup.exemplar.dashboard.support"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#types","title":"Types","text":"Name Summary AnotherServiceImpl [jvm]class AnotherServiceImpl : Service DinoMetadata [jvm]data class DinoMetadata(val dinos: List<String>) : Metadata DinoMetadataProvider [jvm]class DinoMetadataProvider : MetadataProvider<Metadata> ExemplarAccessModule [jvm]class ExemplarAccessModule : KAbstractModule ExemplarConfig [jvm]data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config ExemplarCronModule [jvm]class ExemplarCronModule : KAbstractModule ExemplarGuiceBindingsModule [jvm]class ExemplarGuiceBindingsModule : KAbstractModule ExemplarJavaApp [jvm]open class ExemplarJavaApp ExemplarJavaConfig [jvm]open class ExemplarJavaConfig : Config ExemplarJavaModule [jvm]open class ExemplarJavaModule : AbstractModule ExemplarLogging [jvm]object ExemplarLogging ExemplarMetadataModule [jvm]class ExemplarMetadataModule : KAbstractModule ExemplarWebActionsModule [jvm]class ExemplarWebActionsModule : KAbstractModule HelloJavaAction [jvm]@Singletonopen class HelloJavaAction : WebAction Service [jvm]interface Service ServiceImpl [jvm]class ServiceImpl : Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/","title":"main - Misk","text":"

//exemplar/com.squareup.exemplar/main

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/#main","title":"main","text":"

[jvm]\\ fun main(args: Array<String>)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"

//exemplar/com.squareup.exemplar/AnotherServiceImpl

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"

[jvm]\\ class AnotherServiceImpl : Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#constructors","title":"Constructors","text":"AnotherServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"

//exemplar/com.squareup.exemplar/AnotherServiceImpl/AnotherServiceImpl

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/","title":"execute - Misk","text":"

//exemplar/com.squareup.exemplar/AnotherServiceImpl/execute

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/#execute","title":"execute","text":"

[jvm]\\ open override fun execute(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/","title":"DinoMetadata - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadata

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"

[jvm]\\ data class DinoMetadata(val dinos: List<String>) : Metadata

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#constructors","title":"Constructors","text":"DinoMetadata [jvm]constructor(dinos: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String dinos [jvm]val dinos: List<String> metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/","title":"DinoMetadata - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadata/DinoMetadata

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"

[jvm]\\ constructor(dinos: List<String>)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/","title":"contentBlock - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadata/contentBlock

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/#contentblock","title":"contentBlock","text":"

[jvm]\\ open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/","title":"dinos - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadata/dinos

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/#dinos","title":"dinos","text":"

[jvm]\\ val dinos: List<String>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadataProvider

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"

[jvm]\\ class DinoMetadataProvider : MetadataProvider<Metadata>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#constructors","title":"Constructors","text":"DinoMetadataProvider [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DinoMetadata"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadataProvider/DinoMetadataProvider

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadataProvider/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/#get","title":"get","text":"

[jvm]\\ open override fun get(): DinoMetadata

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/","title":"id - Misk","text":"

//exemplar/com.squareup.exemplar/DinoMetadataProvider/id

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/#id","title":"id","text":"

[jvm]\\ open override val id: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarAccessModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"

[jvm]\\ class ExemplarAccessModule : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#constructors","title":"Constructors","text":"ExemplarAccessModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarAccessModule/ExemplarAccessModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/","title":"ExemplarConfig - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"

[jvm]\\ data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#constructors","title":"Constructors","text":"ExemplarConfig [jvm]constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#properties","title":"Properties","text":"Name Summary apiKey [jvm]val apiKey: Secret<String> prometheus [jvm]val prometheus: PrometheusConfig redacted [jvm]val redacted: String web [jvm]val web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/","title":"ExemplarConfig - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig/ExemplarConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"

[jvm]\\ constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/","title":"apiKey - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig/apiKey

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/#apikey","title":"apiKey","text":"

[jvm]\\ val apiKey: Secret<String>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/","title":"prometheus - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig/prometheus

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/#prometheus","title":"prometheus","text":"

[jvm]\\ val prometheus: PrometheusConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/","title":"redacted - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig/redacted

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/#redacted","title":"redacted","text":"

[jvm]\\ val redacted: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/","title":"web - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarConfig/web

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/#web","title":"web","text":"

[jvm]\\ val web: WebConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"

[jvm]\\ class ExemplarCronModule : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#constructors","title":"Constructors","text":"ExemplarCronModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#types","title":"Types","text":"Name Summary MinuteCron [jvm]@Singletonclass MinuteCron@Injectconstructor : Runnable"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/ExemplarCronModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/","title":"MinuteCron - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#minutecron","title":"MinuteCron","text":"

[jvm]\\ @Singleton

class MinuteCron@Injectconstructor : Runnable

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#constructors","title":"Constructors","text":"MinuteCron [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#properties","title":"Properties","text":"Name Summary counter [jvm]var counter: Int"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#functions","title":"Functions","text":"Name Summary run [jvm]open override fun run()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/","title":"MinuteCron - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/MinuteCron

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/#minutecron","title":"MinuteCron","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/","title":"counter - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/counter

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/#counter","title":"counter","text":"

[jvm]\\ var counter: Int

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/","title":"run - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/run

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/#run","title":"run","text":"

[jvm]\\ open override fun run()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/","title":"log - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion/log

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/#log","title":"log","text":"

[jvm]\\ val log: KLogger

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"

[jvm]\\ class ExemplarGuiceBindingsModule : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#constructors","title":"Constructors","text":"ExemplarGuiceBindingsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideYetAnotherService [jvm]@Providesfun provideYetAnotherService(): Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/ExemplarGuiceBindingsModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/","title":"provideYetAnotherService - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/provideYetAnotherService

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/#provideyetanotherservice","title":"provideYetAnotherService","text":"

[jvm]\\

@Provides

fun provideYetAnotherService(): Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/#types","title":"Types","text":"Name Summary MyCompanionService [jvm]class MyCompanionService : Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/","title":"MyCompanionService - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/Companion/MyCompanionService

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/#mycompanionservice","title":"MyCompanionService","text":"

[jvm]\\ class MyCompanionService : Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/#constructors","title":"Constructors","text":"MyCompanionService [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/-my-companion-service/","title":"MyCompanionService - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/Companion/MyCompanionService/MyCompanionService

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/-my-companion-service/#mycompanionservice","title":"MyCompanionService","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/execute/","title":"execute - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/Companion/MyCompanionService/execute

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-companion/-my-companion-service/execute/#execute","title":"execute","text":"

[jvm]\\ open override fun execute(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaApp

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"

[jvm]\\ open class ExemplarJavaApp

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#constructors","title":"Constructors","text":"ExemplarJavaApp [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#functions","title":"Functions","text":"Name Summary main [jvm]open fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaApp/ExemplarJavaApp

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/","title":"main - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaApp/main

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/#main","title":"main","text":"

[jvm]\\ open fun main(args: Array<String>)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"

[jvm]\\ open class ExemplarJavaConfig : Config

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#constructors","title":"Constructors","text":"ExemplarJavaConfig [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#properties","title":"Properties","text":"Name Summary web [jvm]open var web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaConfig/ExemplarJavaConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/","title":"web - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaConfig/web

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/#web","title":"web","text":"

[jvm]\\ open var web: WebConfig

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"

[jvm]\\ open class ExemplarJavaModule : AbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#constructors","title":"Constructors","text":"ExemplarJavaModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarJavaModule/ExemplarJavaModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/","title":"ExemplarLogging - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarLogging

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#exemplarlogging","title":"ExemplarLogging","text":"

[jvm]\\ object ExemplarLogging

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/","title":"configure - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarLogging/configure

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/#configure","title":"configure","text":"

[jvm]\\ fun configure()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarMetadataModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"

[jvm]\\ class ExemplarMetadataModule : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#constructors","title":"Constructors","text":"ExemplarMetadataModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarMetadataModule/ExemplarMetadataModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarWebActionsModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"

[jvm]\\ class ExemplarWebActionsModule : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#constructors","title":"Constructors","text":"ExemplarWebActionsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"

//exemplar/com.squareup.exemplar/ExemplarWebActionsModule/ExemplarWebActionsModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/","title":"HelloJavaAction - Misk","text":"

//exemplar/com.squareup.exemplar/HelloJavaAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"

[jvm]\\ @Singleton

open class HelloJavaAction : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#constructors","title":"Constructors","text":"HelloJavaAction [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#functions","title":"Functions","text":"Name Summary hello [jvm]open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/","title":"HelloJavaAction - Misk","text":"

//exemplar/com.squareup.exemplar/HelloJavaAction/HelloJavaAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/","title":"hello - Misk","text":"

//exemplar/com.squareup.exemplar/HelloJavaAction/hello

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/#hello","title":"hello","text":"

[jvm]\\ open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/","title":"Service - Misk","text":"

//exemplar/com.squareup.exemplar/Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#service","title":"Service","text":"

interface Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#inheritors","title":"Inheritors","text":"MyCompanionService ServiceImpl AnotherServiceImpl"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#functions","title":"Functions","text":"Name Summary execute [jvm]abstract fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/","title":"execute - Misk","text":"

//exemplar/com.squareup.exemplar/Service/execute

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/#execute","title":"execute","text":"

[jvm]\\ abstract fun execute(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/","title":"ServiceImpl - Misk","text":"

//exemplar/com.squareup.exemplar/ServiceImpl

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#serviceimpl","title":"ServiceImpl","text":"

[jvm]\\ class ServiceImpl : Service

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#constructors","title":"Constructors","text":"ServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/","title":"ServiceImpl - Misk","text":"

//exemplar/com.squareup.exemplar/ServiceImpl/ServiceImpl

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/#serviceimpl","title":"ServiceImpl","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/","title":"execute - Misk","text":"

//exemplar/com.squareup.exemplar/ServiceImpl/execute

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/#execute","title":"execute","text":"

[jvm]\\ open override fun execute(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar.actions

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#types","title":"Types","text":"Name Summary DownloadAFileWebAction [jvm]@Singletonclass DownloadAFileWebAction@Injectconstructor : WebAction EchoFormAction [jvm]@Singletonclass EchoFormAction@Injectconstructor : WebAction ExampleRateLimitConfiguration [jvm]object ExampleRateLimitConfiguration : RateLimitConfiguration HelloPostResponse [jvm]data class HelloPostResponse(val greeting: String, val name: String) HelloResponse [jvm]data class HelloResponse(val greeting: String, val name: String) HelloWebAction [jvm]@Singletonclass HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction HelloWebPostAction [jvm]@Singletonclass HelloWebPostAction@Injectconstructor : WebAction HelloWebProtoAction [jvm]class HelloWebProtoAction@Injectconstructor : WebAction PostBody [jvm]data class PostBody(val greeting: String) RateLimitedAction [jvm]@Singletonclass RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter) RateLimitedExampleResponse [jvm]data class RateLimitedExampleResponse(val number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"

[jvm]\\ @Singleton

class DownloadAFileWebAction@Injectconstructor : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#constructors","title":"Constructors","text":"DownloadAFileWebAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#functions","title":"Functions","text":"Name Summary download [jvm]fun download(name: String): Response<String>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/DownloadAFileWebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/","title":"download - Misk","text":"

//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/download

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/#download","title":"download","text":"

[jvm]\\ fun download(name: String): Response<String>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/","title":"EchoFormAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"

[jvm]\\ @Singleton

class EchoFormAction@Injectconstructor : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#constructors","title":"Constructors","text":"EchoFormAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#types","title":"Types","text":"Name Summary Form [jvm]data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#functions","title":"Functions","text":"Name Summary echo [jvm]fun echo(form: EchoFormAction.Form): EchoFormAction.Form"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/","title":"EchoFormAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/EchoFormAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/","title":"echo - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/echo

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/#echo","title":"echo","text":"

[jvm]\\ fun echo(form: EchoFormAction.Form): EchoFormAction.Form

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/","title":"Form - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#form","title":"Form","text":"

[jvm]\\ data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#constructors","title":"Constructors","text":"Form [jvm]constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#properties","title":"Properties","text":"Name Summary int [jvm]val int: Int list [jvm]val list: List<String> nullable [jvm]val nullable: String? optional [jvm]val optional: String string [jvm]val string: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/","title":"Form - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/Form

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/#form","title":"Form","text":"

[jvm]\\ constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/","title":"int - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/int

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/#int","title":"int","text":"

[jvm]\\ val int: Int

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/","title":"list - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/list

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/#list","title":"list","text":"

[jvm]\\ val list: List<String>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/","title":"nullable - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/nullable

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/#nullable","title":"nullable","text":"

[jvm]\\ val nullable: String?

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/","title":"optional - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/optional

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/#optional","title":"optional","text":"

[jvm]\\ val optional: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/","title":"string - Misk","text":"

//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/string

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/#string","title":"string","text":"

[jvm]\\ val string: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/","title":"ExampleRateLimitConfiguration - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#exampleratelimitconfiguration","title":"ExampleRateLimitConfiguration","text":"

[jvm]\\ object ExampleRateLimitConfiguration : RateLimitConfiguration

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#properties","title":"Properties","text":"Name Summary capacity [jvm]open override val capacity: Long = 10 name [jvm]open override val name: String refillAmount [jvm]open override val refillAmount: Long = 10 refillPeriod [jvm]open override val refillPeriod: Duration refillStrategy [jvm]open val refillStrategy: RateLimitBucketRefillStrategy version [jvm]open override val version: Long = 0"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/","title":"capacity - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/capacity

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/#capacity","title":"capacity","text":"

[jvm]\\ open override val capacity: Long = 10

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/","title":"name - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/name

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/#name","title":"name","text":"

[jvm]\\ open override val name: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/","title":"refillAmount - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillAmount

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/#refillamount","title":"refillAmount","text":"

[jvm]\\ open override val refillAmount: Long = 10

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/","title":"refillPeriod - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillPeriod

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/#refillperiod","title":"refillPeriod","text":"

[jvm]\\ open override val refillPeriod: Duration

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/version/","title":"version - Misk","text":"

//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/version

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/version/#version","title":"version","text":"

[jvm]\\ open override val version: Long = 0

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/","title":"HelloPostResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloPostResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"

[jvm]\\ data class HelloPostResponse(val greeting: String, val name: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#constructors","title":"Constructors","text":"HelloPostResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/","title":"HelloPostResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloPostResponse/HelloPostResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"

[jvm]\\ constructor(greeting: String, name: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/","title":"greeting - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloPostResponse/greeting

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/#greeting","title":"greeting","text":"

[jvm]\\ val greeting: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/","title":"name - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloPostResponse/name

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/","title":"HelloResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#helloresponse","title":"HelloResponse","text":"

[jvm]\\ data class HelloResponse(val greeting: String, val name: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#constructors","title":"Constructors","text":"HelloResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/","title":"HelloResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloResponse/HelloResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/#helloresponse","title":"HelloResponse","text":"

[jvm]\\ constructor(greeting: String, name: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/","title":"greeting - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloResponse/greeting

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/#greeting","title":"greeting","text":"

[jvm]\\ val greeting: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/","title":"name - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloResponse/name

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/","title":"HelloWebAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"

[jvm]\\ @Singleton

class HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#constructors","title":"Constructors","text":"HelloWebAction [jvm]@Injectconstructor(tokenGenerator: TokenGenerator)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/","title":"HelloWebAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebAction/HelloWebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"

[jvm]\\

@Inject

constructor(tokenGenerator: TokenGenerator)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/","title":"hello - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebAction/hello

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/#hello","title":"hello","text":"

[jvm]\\ fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebPostAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"

[jvm]\\ @Singleton

class HelloWebPostAction@Injectconstructor : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#constructors","title":"Constructors","text":"HelloWebPostAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, body: PostBody): HelloPostResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/HelloWebPostAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/","title":"hello - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/hello

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/#hello","title":"hello","text":"

[jvm]\\ fun hello(name: String, body: PostBody): HelloPostResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"

[jvm]\\ class HelloWebProtoAction@Injectconstructor : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#constructors","title":"Constructors","text":"HelloWebProtoAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(request: HelloWebRequest): Response<HelloWebResponse>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/HelloWebProtoAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/","title":"hello - Misk","text":"

//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/hello

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/#hello","title":"hello","text":"

[jvm]\\ fun hello(request: HelloWebRequest): Response<HelloWebResponse>

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/","title":"PostBody - Misk","text":"

//exemplar/com.squareup.exemplar.actions/PostBody

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#postbody","title":"PostBody","text":"

[jvm]\\ data class PostBody(val greeting: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#constructors","title":"Constructors","text":"PostBody [jvm]constructor(greeting: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/","title":"PostBody - Misk","text":"

//exemplar/com.squareup.exemplar.actions/PostBody/PostBody

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/#postbody","title":"PostBody","text":"

[jvm]\\ constructor(greeting: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/","title":"greeting - Misk","text":"

//exemplar/com.squareup.exemplar.actions/PostBody/greeting

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/#greeting","title":"greeting","text":"

[jvm]\\ val greeting: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"

[jvm]\\ @Singleton

class RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#constructors","title":"Constructors","text":"RateLimitedAction [jvm]@Injectconstructor(rateLimiter: RateLimiter)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#functions","title":"Functions","text":"Name Summary rateLimitedExample [jvm]fun rateLimitedExample(): RateLimitedExampleResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedAction/RateLimitedAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"

[jvm]\\

@Inject

constructor(rateLimiter: RateLimiter)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/","title":"rateLimitedExample - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedAction/rateLimitedExample

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/#ratelimitedexample","title":"rateLimitedExample","text":"

[jvm]\\ fun rateLimitedExample(): RateLimitedExampleResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"

[jvm]\\ data class RateLimitedExampleResponse(val number: Long)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#constructors","title":"Constructors","text":"RateLimitedExampleResponse [jvm]constructor(number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#properties","title":"Properties","text":"Name Summary number [jvm]val number: Long"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/RateLimitedExampleResponse

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"

[jvm]\\ constructor(number: Long)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/","title":"number - Misk","text":"

//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/number

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/#number","title":"number","text":"

[jvm]\\ val number: Long

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#types","title":"Types","text":"Name Summary ExemplarDashboardModule [jvm]class ExemplarDashboardModule(deployment: Deployment) : KAbstractModule SupportDashboard [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class SupportDashboardDashboard Annotation used for all tabs bound in the Exemplar service support dashboard. SupportDashboardAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class SupportDashboardAccessAccess for the support dashboard."},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"

[jvm]\\ class ExemplarDashboardModule(deployment: Deployment) : KAbstractModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#constructors","title":"Constructors","text":"ExemplarDashboardModule [jvm]constructor(deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule/ExemplarDashboardModule

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"

[jvm]\\ constructor(deployment: Deployment)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/","title":"SupportDashboard - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard/SupportDashboard

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/#supportdashboard","title":"SupportDashboard","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])

annotation class SupportDashboard

Dashboard Annotation used for all tabs bound in the Exemplar service support dashboard.

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/","title":"SupportDashboardAccess - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard/SupportDashboardAccess

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/#supportdashboardaccess","title":"SupportDashboardAccess","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class SupportDashboardAccess

Access for the support dashboard.

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#types","title":"Types","text":"Name Summary AlphaIndexAction [jvm]@Singletonclass AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#properties","title":"Properties","text":"Name Summary dashboardIndexAccessBlock [jvm]val dashboardIndexAccessBlock: DashboardIndexAccessBlock dashboardIndexBlock1 [jvm]val dashboardIndexBlock1: DashboardIndexBlock dashboardIndexBlock2 [jvm]val dashboardIndexBlock2: DashboardIndexBlock"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/","title":"dashboardIndexAccessBlock - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexAccessBlock

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/#dashboardindexaccessblock","title":"dashboardIndexAccessBlock","text":"

[jvm]\\ val dashboardIndexAccessBlock: DashboardIndexAccessBlock

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/","title":"dashboardIndexBlock1 - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock1

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/#dashboardindexblock1","title":"dashboardIndexBlock1","text":"

[jvm]\\ val dashboardIndexBlock1: DashboardIndexBlock

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/","title":"dashboardIndexBlock2 - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock2

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/#dashboardindexblock2","title":"dashboardIndexBlock2","text":"

[jvm]\\ val dashboardIndexBlock2: DashboardIndexBlock

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"

[jvm]\\ @Singleton

class AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#constructors","title":"Constructors","text":"AlphaIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/AlphaIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"

[jvm]\\

@Inject

constructor(dashboardPageLayout: DashboardPageLayout)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion/PATH

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"

[jvm]\\ const val PATH: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#types","title":"Types","text":"Name Summary EcommerceLandingPage [jvm]@Singletonclass EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages GraphD3JsPage [jvm]@Singletonclass GraphD3JsPage@Injectconstructor : WebActionExample page that shows usage of D3.js graph library https://d3js.org/ IndexPage [jvm]@Singletonclass IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages SimplePage [jvm]@Singletonclass SimplePage@Injectconstructor(appName: String) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"

[jvm]\\ @Singleton

class EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction

Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#constructors","title":"Constructors","text":"EcommerceLandingPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/EcommerceLandingPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"

[jvm]\\

@Inject

constructor(appName: String, deployment: Deployment)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion/PATH

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/#path","title":"PATH","text":"

[jvm]\\ const val PATH: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"

[jvm]\\ @Singleton

class GraphD3JsPage@Injectconstructor : WebAction

Example page that shows usage of D3.js graph library https://d3js.org/

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#constructors","title":"Constructors","text":"GraphD3JsPage [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/GraphD3JsPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion/PATH

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/#path","title":"PATH","text":"

[jvm]\\ const val PATH: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/","title":"IndexPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#indexpage","title":"IndexPage","text":"

[jvm]\\ @Singleton

class IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction

Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#constructors","title":"Constructors","text":"IndexPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/","title":"IndexPage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/IndexPage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/#indexpage","title":"IndexPage","text":"

[jvm]\\

@Inject

constructor(appName: String, deployment: Deployment)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/","title":"SimplePage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#simplepage","title":"SimplePage","text":"

[jvm]\\ @Singleton

class SimplePage@Injectconstructor(appName: String) : WebAction

Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#constructors","title":"Constructors","text":"SimplePage [jvm]@Injectconstructor(appName: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/","title":"SimplePage - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/SimplePage

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/#simplepage","title":"SimplePage","text":"

[jvm]\\

@Inject

constructor(appName: String)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/","title":"Companion - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion/PATH

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/#path","title":"PATH","text":"

[jvm]\\ const val PATH: String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/","title":"Package-level declarations - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#types","title":"Types","text":"Name Summary SupportBravoIndexAction [jvm]@Singletonclass SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction SupportDashboardIndexAction [jvm]@Singletonclass SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"

[jvm]\\ @Singleton

class SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#constructors","title":"Constructors","text":"SupportBravoIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/SupportBravoIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"

[jvm]\\

@Inject

constructor(dashboardPageLayout: DashboardPageLayout)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"

[jvm]\\ @Singleton

class SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#constructors","title":"Constructors","text":"SupportDashboardIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/SupportDashboardIndexAction

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"

[jvm]\\

@Inject

constructor(dashboardPageLayout: DashboardPageLayout)

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/","title":"get - Misk","text":"

//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/get

"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/#get","title":"get","text":"

[jvm]\\ fun get(): String

"},{"location":"0.x/exemplarchat/","title":"exemplarchat - Misk","text":"

//exemplarchat

"},{"location":"0.x/exemplarchat/#exemplarchat","title":"exemplarchat","text":""},{"location":"0.x/exemplarchat/#packages","title":"Packages","text":"Name com.squareup.chat com.squareup.chat.actions com.squareup.chat.healthchecks"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/","title":"Package-level declarations - Misk","text":"

//exemplarchat/com.squareup.chat

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#types","title":"Types","text":"Name Summary ChatConfig [jvm]data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config ChatLogging [jvm]object ChatLogging ChatModule [jvm]class ChatModule : KAbstractModule"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/","title":"main - Misk","text":"

//exemplarchat/com.squareup.chat/main

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/#main","title":"main","text":"

[jvm]\\ fun main(args: Array<String>)

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/","title":"ChatConfig - Misk","text":"

//exemplarchat/com.squareup.chat/ChatConfig

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#chatconfig","title":"ChatConfig","text":"

[jvm]\\ data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#constructors","title":"Constructors","text":"ChatConfig [jvm]constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#properties","title":"Properties","text":"Name Summary kubernetes [jvm]val kubernetes: KubernetesConfig prometheus [jvm]val prometheus: PrometheusConfig web [jvm]val web: WebConfig"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/","title":"ChatConfig - Misk","text":"

//exemplarchat/com.squareup.chat/ChatConfig/ChatConfig

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/#chatconfig","title":"ChatConfig","text":"

[jvm]\\ constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/","title":"kubernetes - Misk","text":"

//exemplarchat/com.squareup.chat/ChatConfig/kubernetes

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/#kubernetes","title":"kubernetes","text":"

[jvm]\\ val kubernetes: KubernetesConfig

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/","title":"prometheus - Misk","text":"

//exemplarchat/com.squareup.chat/ChatConfig/prometheus

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/#prometheus","title":"prometheus","text":"

[jvm]\\ val prometheus: PrometheusConfig

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/","title":"web - Misk","text":"

//exemplarchat/com.squareup.chat/ChatConfig/web

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/#web","title":"web","text":"

[jvm]\\ val web: WebConfig

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/","title":"ChatLogging - Misk","text":"

//exemplarchat/com.squareup.chat/ChatLogging

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#chatlogging","title":"ChatLogging","text":"

[jvm]\\ object ChatLogging

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/","title":"configure - Misk","text":"

//exemplarchat/com.squareup.chat/ChatLogging/configure

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/#configure","title":"configure","text":"

[jvm]\\ fun configure()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/","title":"ChatModule - Misk","text":"

//exemplarchat/com.squareup.chat/ChatModule

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#chatmodule","title":"ChatModule","text":"

[jvm]\\ class ChatModule : KAbstractModule

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#constructors","title":"Constructors","text":"ChatModule [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/","title":"ChatModule - Misk","text":"

//exemplarchat/com.squareup.chat/ChatModule/ChatModule

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/#chatmodule","title":"ChatModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/","title":"Package-level declarations - Misk","text":"

//exemplarchat/com.squareup.chat.actions

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#types","title":"Types","text":"Name Summary ChatWebSocketAction [jvm]@Singletonclass ChatWebSocketAction@Injectconstructor(redis: Redis) : WebActionChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections. ToggleManualHealthCheckAction [jvm]@Singletonclass ToggleManualHealthCheckAction@Injectconstructor : WebAction"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"

[jvm]\\ @Singleton

class ChatWebSocketAction@Injectconstructor(redis: Redis) : WebAction

ChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections.

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#constructors","title":"Constructors","text":"ChatWebSocketAction [jvm]@Injectconstructor(redis: Redis)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#functions","title":"Functions","text":"Name Summary chat [jvm]fun chat(name: String, webSocket: WebSocket): WebSocketListener"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/ChatWebSocketAction

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"

[jvm]\\

@Inject

constructor(redis: Redis)

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/","title":"chat - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/chat

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/#chat","title":"chat","text":"

[jvm]\\ fun chat(name: String, webSocket: WebSocket): WebSocketListener

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"

[jvm]\\ @Singleton

class ToggleManualHealthCheckAction@Injectconstructor : WebAction

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#constructors","title":"Constructors","text":"ToggleManualHealthCheckAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#properties","title":"Properties","text":"Name Summary manualHealthCheck [jvm]@Injectlateinit var manualHealthCheck: ManualHealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#functions","title":"Functions","text":"Name Summary setManualHealthCheck [jvm]fun setManualHealthCheck(status: String?): Response<String>"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/ToggleManualHealthCheckAction

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/","title":"manualHealthCheck - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/manualHealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/#manualhealthcheck","title":"manualHealthCheck","text":"

[jvm]\\

@Inject

lateinit var manualHealthCheck: ManualHealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/","title":"setManualHealthCheck - Misk","text":"

//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/setManualHealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/#setmanualhealthcheck","title":"setManualHealthCheck","text":"

[jvm]\\ fun setManualHealthCheck(status: String?): Response<String>

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/","title":"Package-level declarations - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#types","title":"Types","text":"Name Summary ManualHealthCheck [jvm]@Singletonclass ManualHealthCheck : HealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"

[jvm]\\ @Singleton

class ManualHealthCheck : HealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#constructors","title":"Constructors","text":"ManualHealthCheck [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#functions","title":"Functions","text":"Name Summary setHealth [jvm]fun setHealth() setUnhealthy [jvm]fun setUnhealthy() status [jvm]open override fun status(): HealthStatus"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/ManualHealthCheck

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"

[jvm]\\ constructor()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/","title":"setHealth - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setHealth

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/#sethealth","title":"setHealth","text":"

[jvm]\\ fun setHealth()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/","title":"setUnhealthy - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setUnhealthy

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/#setunhealthy","title":"setUnhealthy","text":"

[jvm]\\ fun setUnhealthy()

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/","title":"status - Misk","text":"

//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/status

"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/#status","title":"status","text":"

[jvm]\\ open override fun status(): HealthStatus

"},{"location":"0.x/misk/","title":"misk - Misk","text":"

//misk

"},{"location":"0.x/misk/#misk","title":"misk","text":""},{"location":"0.x/misk/#packages","title":"Packages","text":"Name misk misk.client misk.concurrent misk.environment misk.grpc misk.io misk.jvm misk.logging misk.monitoring misk.moshi misk.moshi.adapters misk.moshi.okio misk.moshi.time misk.okio misk.perf misk.security.authz misk.security.cert misk.security.csp misk.security.keys misk.security.ssl misk.tasks misk.time misk.web misk.web.actions misk.web.concurrencylimits misk.web.exceptions misk.web.extractors misk.web.formatter misk.web.interceptors misk.web.jetty misk.web.marshal misk.web.mdc misk.web.metadata.guice misk.web.metadata.webaction misk.web.proxy misk.web.resources"},{"location":"0.x/misk/misk/misk/","title":"Package-level declarations - Misk","text":"

//misk/misk

"},{"location":"0.x/misk/misk/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk/#types","title":"Types","text":"Name Summary Action [jvm]data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism) ApplicationInterceptor [jvm]interface ApplicationInterceptor Chain [jvm]interface Chain MiskApplication [jvm]class MiskApplicationThe entry point for misk applications MiskCommand [jvm]abstract class MiskCommand(name: String, modules: List<Module>) : RunnableA command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command. MiskCommonServiceModule [jvm]class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig(), installMetrics: Boolean = true) : KAbstractModuleThis module has common bindings for all environments (both real and testing). MiskRealServiceModule [jvm]class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModuleInstall this module in real environments."},{"location":"0.x/misk/misk/misk/#functions","title":"Functions","text":"Name Summary asAction [jvm]fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action"},{"location":"0.x/misk/misk/misk/as-action/","title":"asAction - Misk","text":"

//misk/misk/asAction

"},{"location":"0.x/misk/misk/misk/as-action/#asaction","title":"asAction","text":"

[jvm]\\ fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action

"},{"location":"0.x/misk/misk/misk/-action/","title":"Action - Misk","text":"

//misk/misk/Action

"},{"location":"0.x/misk/misk/misk/-action/#action","title":"Action","text":"

[jvm]\\ data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism)

"},{"location":"0.x/misk/misk/misk/-action/#constructors","title":"Constructors","text":"Action [jvm]constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)"},{"location":"0.x/misk/misk/misk/-action/#properties","title":"Properties","text":"Name Summary acceptedMediaRanges [jvm]val acceptedMediaRanges: List<MediaRange> dispatchMechanism [jvm]val dispatchMechanism: DispatchMechanism function [jvm]val function: KFunction<*> name [jvm]val name: String parameters [jvm]val parameters: List<KParameter> parameterTypes [jvm]val parameterTypes: List<KType>ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params. requestType [jvm]val requestType: KType? responseContentType [jvm]val responseContentType: MediaType? returnType [jvm]val returnType: KType"},{"location":"0.x/misk/misk/misk/-action/#functions","title":"Functions","text":"Name Summary hasReturnValue [jvm]fun hasReturnValue(): Boolean toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk/-action/-action/","title":"Action - Misk","text":"

//misk/misk/Action/Action

"},{"location":"0.x/misk/misk/misk/-action/-action/#action","title":"Action","text":"

[jvm]\\ constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)

"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/","title":"acceptedMediaRanges - Misk","text":"

//misk/misk/Action/acceptedMediaRanges

"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/#acceptedmediaranges","title":"acceptedMediaRanges","text":"

[jvm]\\ val acceptedMediaRanges: List<MediaRange>

"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/","title":"dispatchMechanism - Misk","text":"

//misk/misk/Action/dispatchMechanism

"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"

[jvm]\\ val dispatchMechanism: DispatchMechanism

"},{"location":"0.x/misk/misk/misk/-action/function/","title":"function - Misk","text":"

//misk/misk/Action/function

"},{"location":"0.x/misk/misk/misk/-action/function/#function","title":"function","text":"

[jvm]\\ val function: KFunction<*>

"},{"location":"0.x/misk/misk/misk/-action/has-return-value/","title":"hasReturnValue - Misk","text":"

//misk/misk/Action/hasReturnValue

"},{"location":"0.x/misk/misk/misk/-action/has-return-value/#hasreturnvalue","title":"hasReturnValue","text":"

[jvm]\\ fun hasReturnValue(): Boolean

"},{"location":"0.x/misk/misk/misk/-action/name/","title":"name - Misk","text":"

//misk/misk/Action/name

"},{"location":"0.x/misk/misk/misk/-action/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/misk/misk/misk/-action/parameter-types/","title":"parameterTypes - Misk","text":"

//misk/misk/Action/parameterTypes

"},{"location":"0.x/misk/misk/misk/-action/parameter-types/#parametertypes","title":"parameterTypes","text":"

[jvm]\\ val parameterTypes: List<KType>

ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params.

"},{"location":"0.x/misk/misk/misk/-action/parameters/","title":"parameters - Misk","text":"

//misk/misk/Action/parameters

"},{"location":"0.x/misk/misk/misk/-action/parameters/#parameters","title":"parameters","text":"

[jvm]\\ val parameters: List<KParameter>

"},{"location":"0.x/misk/misk/misk/-action/request-type/","title":"requestType - Misk","text":"

//misk/misk/Action/requestType

"},{"location":"0.x/misk/misk/misk/-action/request-type/#requesttype","title":"requestType","text":"

[jvm]\\ val requestType: KType?

"},{"location":"0.x/misk/misk/misk/-action/response-content-type/","title":"responseContentType - Misk","text":"

//misk/misk/Action/responseContentType

"},{"location":"0.x/misk/misk/misk/-action/response-content-type/#responsecontenttype","title":"responseContentType","text":"

[jvm]\\ val responseContentType: MediaType?

"},{"location":"0.x/misk/misk/misk/-action/return-type/","title":"returnType - Misk","text":"

//misk/misk/Action/returnType

"},{"location":"0.x/misk/misk/misk/-action/return-type/#returntype","title":"returnType","text":"

[jvm]\\ val returnType: KType

"},{"location":"0.x/misk/misk/misk/-action/to-string/","title":"toString - Misk","text":"

//misk/misk/Action/toString

"},{"location":"0.x/misk/misk/misk/-action/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

"},{"location":"0.x/misk/misk/misk/-application-interceptor/","title":"ApplicationInterceptor - Misk","text":"

//misk/misk/ApplicationInterceptor

"},{"location":"0.x/misk/misk/misk/-application-interceptor/#applicationinterceptor","title":"ApplicationInterceptor","text":"

interface ApplicationInterceptor

"},{"location":"0.x/misk/misk/misk/-application-interceptor/#inheritors","title":"Inheritors","text":"AccessInterceptor RequestBodyLoggingInterceptor"},{"location":"0.x/misk/misk/misk/-application-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk/ApplicationInterceptor/intercept

"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ abstract fun intercept(chain: Chain): Any

"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk/ApplicationInterceptor/Factory

"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#factory","title":"Factory","text":"

interface Factory

"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk/ApplicationInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(action: Action): ApplicationInterceptor?

"},{"location":"0.x/misk/misk/misk/-chain/","title":"Chain - Misk","text":"

//misk/misk/Chain

"},{"location":"0.x/misk/misk/misk/-chain/#chain","title":"Chain","text":"

[jvm]\\ interface Chain

"},{"location":"0.x/misk/misk/misk/-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: WebAction args [jvm]abstract val args: List<Any?> function [jvm]abstract val function: KFunction<*> httpCall [jvm]abstract val httpCall: HttpCall"},{"location":"0.x/misk/misk/misk/-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<Any?>): Any"},{"location":"0.x/misk/misk/misk/-chain/action/","title":"action - Misk","text":"

//misk/misk/Chain/action

"},{"location":"0.x/misk/misk/misk/-chain/action/#action","title":"action","text":"

[jvm]\\ abstract val action: WebAction

"},{"location":"0.x/misk/misk/misk/-chain/args/","title":"args - Misk","text":"

//misk/misk/Chain/args

"},{"location":"0.x/misk/misk/misk/-chain/args/#args","title":"args","text":"

[jvm]\\ abstract val args: List<Any?>

"},{"location":"0.x/misk/misk/misk/-chain/function/","title":"function - Misk","text":"

//misk/misk/Chain/function

"},{"location":"0.x/misk/misk/misk/-chain/function/#function","title":"function","text":"

[jvm]\\ abstract val function: KFunction<*>

"},{"location":"0.x/misk/misk/misk/-chain/http-call/","title":"httpCall - Misk","text":"

//misk/misk/Chain/httpCall

"},{"location":"0.x/misk/misk/misk/-chain/http-call/#httpcall","title":"httpCall","text":"

[jvm]\\ abstract val httpCall: HttpCall

"},{"location":"0.x/misk/misk/misk/-chain/proceed/","title":"proceed - Misk","text":"

//misk/misk/Chain/proceed

"},{"location":"0.x/misk/misk/misk/-chain/proceed/#proceed","title":"proceed","text":"

[jvm]\\ abstract fun proceed(args: List<Any?>): Any

"},{"location":"0.x/misk/misk/misk/-misk-application/","title":"MiskApplication - Misk","text":"

//misk/misk/MiskApplication

"},{"location":"0.x/misk/misk/misk/-misk-application/#miskapplication","title":"MiskApplication","text":"

[jvm]\\ class MiskApplication

The entry point for misk applications

"},{"location":"0.x/misk/misk/misk/-misk-application/#constructors","title":"Constructors","text":"MiskApplication [jvm]constructor(vararg modules: Module)constructor(vararg commands: MiskCommand)constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())constructor(injector: Injector)"},{"location":"0.x/misk/misk/misk/-misk-application/#functions","title":"Functions","text":"Name Summary run [jvm]fun run(args: Array<String>)Runs the application, finding and executing the appropriate command based on the provided command line arguments"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/","title":"MiskApplication - Misk","text":"

//misk/misk/MiskApplication/MiskApplication

"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/#miskapplication","title":"MiskApplication","text":"

[jvm]\\ constructor(vararg modules: Module)

constructor(vararg commands: MiskCommand)

constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())

constructor(injector: Injector)

"},{"location":"0.x/misk/misk/misk/-misk-application/run/","title":"run - Misk","text":"

//misk/misk/MiskApplication/run

"},{"location":"0.x/misk/misk/misk/-misk-application/run/#run","title":"run","text":"

[jvm]\\ fun run(args: Array<String>)

Runs the application, finding and executing the appropriate command based on the provided command line arguments

"},{"location":"0.x/misk/misk/misk/-misk-command/","title":"MiskCommand - Misk","text":"

//misk/misk/MiskCommand

"},{"location":"0.x/misk/misk/misk/-misk-command/#miskcommand","title":"MiskCommand","text":"

[jvm]\\ abstract class MiskCommand(name: String, modules: List<Module>) : Runnable

A command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command.

"},{"location":"0.x/misk/misk/misk/-misk-command/#constructors","title":"Constructors","text":"MiskCommand [jvm]constructor(name: String, vararg modules: Module)constructor(name: String, modules: List<Module>)"},{"location":"0.x/misk/misk/misk/-misk-command/#functions","title":"Functions","text":"Name Summary requireCli [jvm]fun requireCli(value: Boolean, lazyMessage: () -> String)Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message. run [jvm]abstract fun run()"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/","title":"MiskCommand - Misk","text":"

//misk/misk/MiskCommand/MiskCommand

"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/#miskcommand","title":"MiskCommand","text":"

[jvm]\\ constructor(name: String, vararg modules: Module)

constructor(name: String, modules: List<Module>)

"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/","title":"requireCli - Misk","text":"

//misk/misk/MiskCommand/requireCli

"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/#requirecli","title":"requireCli","text":"

[jvm]\\ fun requireCli(value: Boolean, lazyMessage: () -> String)

Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message.

"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"

//misk/misk/MiskCommonServiceModule

"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"

[jvm]\\ class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig(), installMetrics: Boolean = true) : KAbstractModule

This module has common bindings for all environments (both real and testing).

"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#constructors","title":"Constructors","text":"MiskCommonServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig(), installMetrics: Boolean = true)"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"

//misk/misk/MiskCommonServiceModule/MiskCommonServiceModule

"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"

[jvm]\\

@JvmOverloads

constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig(), installMetrics: Boolean = true)

"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"

//misk/misk/MiskRealServiceModule

"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"

[jvm]\\ class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule

Install this module in real environments.

The vast majority of Service bindings belong in MiskCommonServiceModule, in order to share with MiskTestingServiceModule. Only bindings that are not suitable for a unit testing environment belong here.

"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#constructors","title":"Constructors","text":"MiskRealServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"

//misk/misk/MiskRealServiceModule/MiskRealServiceModule

"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"

[jvm]\\

@JvmOverloads

constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())

"},{"location":"0.x/misk/misk/misk.client/","title":"Package-level declarations - Misk","text":"

//misk/misk.client

"},{"location":"0.x/misk/misk/misk.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.client/#types","title":"Types","text":"Name Summary BackwardsCompatibleClientsConfig [jvm]data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false) BackwardsCompatibleClientsConfigConverter [jvm]class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig> BackwardsCompatibleEndpointConfig [jvm]data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null) BeginClientCallChain [jvm]interface BeginClientCallChain CallFactoryWrapper [jvm]interface CallFactoryWrapperCallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider. ClientApplicationInterceptorFactory [jvm]interface ClientApplicationInterceptorFactory ClientChain [jvm]interface ClientChain ClientMetricsInterceptor [jvm]class ClientMetricsInterceptor : Interceptor ClientNetworkInterceptorsModule [jvm]class ClientNetworkInterceptorsModule : KAbstractModuleThe common set of ClientNetworkInterceptors for all misk apps. GrpcClientModule [jvm]class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModuleCreates a gRPC client given a Wire-generated interface and HTTP configuration. HttpClientConfig [jvm]data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null) HttpClientConfigUrlProvider [jvm]class HttpClientConfigUrlProvider@InjectconstructorCalculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly. HttpClientEndpointConfig [jvm]data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig()) HttpClientEnvoyConfig [jvm]data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null) HttpClientFactory [jvm]@Singletonclass HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator) HttpClientModule [jvm]class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModuleProvides an OkHttpClient and ProtoMessageHttpClient for a peer service HttpClientsConfig [jvm]data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config HttpClientsConfigModule [jvm]class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule HttpClientSSLConfig [jvm]data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig) JettyPortPeerClientModule [jvm]class JettyPortPeerClientModule : KAbstractModuleFor testing. OkHttpClientCommonConfigurator [jvm]class OkHttpClientCommonConfigurator@Injectconstructor PeerClientFactory [jvm]class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster. PeerClientModule [jvm]class PeerClientModule : KAbstractModuleBinds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig. ProtoMessageHttpClient [jvm]class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes. TypedClientFactory [jvm]class TypedClientFactory@Injectconstructor TypedHttpClientModule [jvm]class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client given an API interface and an HTTP configuration. TypedPeerClientFactory [jvm]interface TypedPeerClientFactory<T>Factory for creating typed clients that call other members of a cluster. TypedPeerHttpClientModule [jvm]class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client factory given an API interface and an HTTP configuration."},{"location":"0.x/misk/misk/misk.client/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/apply-defaults/","title":"applyDefaults - Misk","text":"

//misk/misk.client/applyDefaults

"},{"location":"0.x/misk/misk/misk.client/apply-defaults/#applydefaults","title":"applyDefaults","text":"

[jvm]\\ fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"

[jvm]\\ data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false)

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfig [jvm]@JvmOverloadsconstructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#properties","title":"Properties","text":"Name Summary defaultCallTimeout [jvm]val defaultCallTimeout: Duration? = null defaultConnectTimeout [jvm]val defaultConnectTimeout: Duration? = null defaultPingInterval [jvm]val defaultPingInterval: Duration? = null defaultReadTimeout [jvm]val defaultReadTimeout: Duration? = null defaultWriteTimeout [jvm]val defaultWriteTimeout: Duration? = null endpoints [jvm]val endpoints: Map<String, BackwardsCompatibleEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false ssl [jvm]val ssl: HttpClientSSLConfig? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/BackwardsCompatibleClientsConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"

[jvm]\\

@JvmOverloads

constructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/","title":"defaultCallTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/defaultCallTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/#defaultcalltimeout","title":"defaultCallTimeout","text":"

[jvm]\\ val defaultCallTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/","title":"defaultConnectTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/defaultConnectTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/#defaultconnecttimeout","title":"defaultConnectTimeout","text":"

[jvm]\\ val defaultConnectTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/","title":"defaultPingInterval - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/defaultPingInterval

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/#defaultpinginterval","title":"defaultPingInterval","text":"

[jvm]\\ val defaultPingInterval: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/","title":"defaultReadTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/defaultReadTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/#defaultreadtimeout","title":"defaultReadTimeout","text":"

[jvm]\\ val defaultReadTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/","title":"defaultWriteTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/defaultWriteTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/#defaultwritetimeout","title":"defaultWriteTimeout","text":"

[jvm]\\ val defaultWriteTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/","title":"endpoints - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/endpoints

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/#endpoints","title":"endpoints","text":"

[jvm]\\ val endpoints: Map<String, BackwardsCompatibleEndpointConfig>

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/","title":"hostConfigs - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/hostConfigs

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"

[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/","title":"logRequests - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/logRequests

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/#logrequests","title":"logRequests","text":"

[jvm]\\ val logRequests: Boolean = false

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/","title":"ssl - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfig/ssl

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/#ssl","title":"ssl","text":"

[jvm]\\ val ssl: HttpClientSSLConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfigConverter

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"

[jvm]\\ class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig>

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfigConverter [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#functions","title":"Functions","text":"Name Summary convert [jvm]open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig getInputType [jvm]open override fun getInputType(typeFactory: TypeFactory): JavaType getOutputType [jvm]open override fun getOutputType(typeFactory: TypeFactory): JavaType"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfigConverter/BackwardsCompatibleClientsConfigConverter

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/","title":"convert - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfigConverter/convert

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/#convert","title":"convert","text":"

[jvm]\\ open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/","title":"getInputType - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getInputType

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/#getinputtype","title":"getInputType","text":"

[jvm]\\ open override fun getInputType(typeFactory: TypeFactory): JavaType

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/","title":"getOutputType - Misk","text":"

//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getOutputType

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/#getoutputtype","title":"getOutputType","text":"

[jvm]\\ open override fun getOutputType(typeFactory: TypeFactory): JavaType

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"

[jvm]\\ data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null)

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#constructors","title":"Constructors","text":"BackwardsCompatibleEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null clientConfig [jvm]val clientConfig: HttpClientConfig? = null connectTimeout [jvm]val connectTimeout: Duration? = null envoy [jvm]val envoy: HttpClientEnvoyConfig? = null keepAliveDuration [jvm]val keepAliveDuration: Duration maxIdleConnections [jvm]val maxIdleConnections: Int = 100 maxRequests [jvm]val maxRequests: Int = 128 maxRequestsPerHost [jvm]val maxRequestsPerHost: Int = 32 pingInterval [jvm]val pingInterval: Duration? = null readTimeout [jvm]val readTimeout: Duration? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null url [jvm]val url: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/BackwardsCompatibleEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"

[jvm]\\

@JvmOverloads

constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/","title":"callTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/callTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/#calltimeout","title":"callTimeout","text":"

[jvm]\\ val callTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/","title":"clientConfig - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/clientConfig

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"

[jvm]\\ val clientConfig: HttpClientConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/","title":"connectTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/connectTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"

[jvm]\\ val connectTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/","title":"envoy - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/envoy

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/#envoy","title":"envoy","text":"

[jvm]\\ val envoy: HttpClientEnvoyConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/keepAliveDuration

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"

[jvm]\\ val keepAliveDuration: Duration

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/maxIdleConnections

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"

[jvm]\\ val maxIdleConnections: Int = 100

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequestsPerHost

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"

[jvm]\\ val maxRequestsPerHost: Int = 32

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/","title":"maxRequests - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequests

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/#maxrequests","title":"maxRequests","text":"

[jvm]\\ val maxRequests: Int = 128

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/","title":"pingInterval - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/pingInterval

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/#pinginterval","title":"pingInterval","text":"

[jvm]\\ val pingInterval: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/","title":"readTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/readTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/#readtimeout","title":"readTimeout","text":"

[jvm]\\ val readTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/","title":"ssl - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/ssl

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/#ssl","title":"ssl","text":"

[jvm]\\ val ssl: HttpClientSSLConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/","title":"url - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/url

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/#url","title":"url","text":"

[jvm]\\ val url: String? = null

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/","title":"writeTimeout - Misk","text":"

//misk/misk.client/BackwardsCompatibleEndpointConfig/writeTimeout

"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/#writetimeout","title":"writeTimeout","text":"

[jvm]\\ val writeTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/","title":"BeginClientCallChain - Misk","text":"

//misk/misk.client/BeginClientCallChain

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#beginclientcallchain","title":"BeginClientCallChain","text":"

[jvm]\\ interface BeginClientCallChain

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>): Call<Any>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/","title":"action - Misk","text":"

//misk/misk.client/BeginClientCallChain/action

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/#action","title":"action","text":"

[jvm]\\ abstract val action: ClientAction

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/","title":"args - Misk","text":"

//misk/misk.client/BeginClientCallChain/args

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/#args","title":"args","text":"

[jvm]\\ abstract val args: List<*>

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/","title":"proceed - Misk","text":"

//misk/misk.client/BeginClientCallChain/proceed

"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/#proceed","title":"proceed","text":"

[jvm]\\ abstract fun proceed(args: List<*>): Call<Any>

"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/","title":"CallFactoryWrapper - Misk","text":"

//misk/misk.client/CallFactoryWrapper

"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/#callfactorywrapper","title":"CallFactoryWrapper","text":"

[jvm]\\ interface CallFactoryWrapper

CallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider.

The ability to extend the Call.Factory instance gives you similar functionalities to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, where you can modify the request/response of the outgoing request. The main difference is that Call.Factory will be run in the thread the client is making the request as opposite to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, which might be run on the okhttp3.Dispatcher threads when executing requests asynchronously. That can be problematic if ActionScoped or ThreadLocal information wants to be propagated using interceptors to downstream services. For example, tracing related information.

This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<CallFactoryWrapper>().to<MyFactoryWrapper>()\n
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/#functions","title":"Functions","text":"Name Summary wrap [jvm]abstract fun wrap(action: ClientAction, delegate: Call.Factory): Call.Factory?Returns a Call.Factory that wraps the original call factory delegate pass as argument."},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/","title":"wrap - Misk","text":"

//misk/misk.client/CallFactoryWrapper/wrap

"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/#wrap","title":"wrap","text":"

[jvm]\\ abstract fun wrap(action: ClientAction, delegate: Call.Factory): Call.Factory?

Returns a Call.Factory that wraps the original call factory delegate pass as argument.

"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/","title":"ClientApplicationInterceptorFactory - Misk","text":"

//misk/misk.client/ClientApplicationInterceptorFactory

"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#clientapplicationinterceptorfactory","title":"ClientApplicationInterceptorFactory","text":"

[jvm]\\ interface ClientApplicationInterceptorFactory

"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: ClientAction): Interceptor?"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/","title":"create - Misk","text":"

//misk/misk.client/ClientApplicationInterceptorFactory/create

"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(action: ClientAction): Interceptor?

"},{"location":"0.x/misk/misk/misk.client/-client-chain/","title":"ClientChain - Misk","text":"

//misk/misk.client/ClientChain

"},{"location":"0.x/misk/misk/misk.client/-client-chain/#clientchain","title":"ClientChain","text":"

[jvm]\\ interface ClientChain

"},{"location":"0.x/misk/misk/misk.client/-client-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*> call [jvm]abstract val call: Call<Any> callback [jvm]abstract val callback: Callback<Any>"},{"location":"0.x/misk/misk/misk.client/-client-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>, callback: Callback<Any>)"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/","title":"action - Misk","text":"

//misk/misk.client/ClientChain/action

"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/#action","title":"action","text":"

[jvm]\\ abstract val action: ClientAction

"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/","title":"args - Misk","text":"

//misk/misk.client/ClientChain/args

"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/#args","title":"args","text":"

[jvm]\\ abstract val args: List<*>

"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/","title":"call - Misk","text":"

//misk/misk.client/ClientChain/call

"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/#call","title":"call","text":"

[jvm]\\ abstract val call: Call<Any>

"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/","title":"callback - Misk","text":"

//misk/misk.client/ClientChain/callback

"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/#callback","title":"callback","text":"

[jvm]\\ abstract val callback: Callback<Any>

"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/","title":"proceed - Misk","text":"

//misk/misk.client/ClientChain/proceed

"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/#proceed","title":"proceed","text":"

[jvm]\\ abstract fun proceed(args: List<*>, callback: Callback<Any>)

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/","title":"ClientMetricsInterceptor - Misk","text":"

//misk/misk.client/ClientMetricsInterceptor

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#clientmetricsinterceptor","title":"ClientMetricsInterceptor","text":"

[jvm]\\ class ClientMetricsInterceptor : Interceptor

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#properties","title":"Properties","text":"Name Summary clientName [jvm]val clientName: String"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): Response"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/","title":"clientName - Misk","text":"

//misk/misk.client/ClientMetricsInterceptor/clientName

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/#clientname","title":"clientName","text":"

[jvm]\\ val clientName: String

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.client/ClientMetricsInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.client/ClientMetricsInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(clientName: String): ClientMetricsInterceptor"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.client/ClientMetricsInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ fun create(clientName: String): ClientMetricsInterceptor

"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"

//misk/misk.client/ClientNetworkInterceptorsModule

"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"

[jvm]\\ class ClientNetworkInterceptorsModule : KAbstractModule

The common set of ClientNetworkInterceptors for all misk apps.

"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#constructors","title":"Constructors","text":"ClientNetworkInterceptorsModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"

//misk/misk.client/ClientNetworkInterceptorsModule/ClientNetworkInterceptorsModule

"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"

//misk/misk.client/GrpcClientModule

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"

[jvm]\\ class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModule

Creates a gRPC client given a Wire-generated interface and HTTP configuration.

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#constructors","title":"Constructors","text":"GrpcClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"

//misk/misk.client/GrpcClientModule/GrpcClientModule

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"

[jvm]\\

@JvmOverloads

constructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.client/GrpcClientModule/Companion

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/","title":"create - Misk","text":"

//misk/misk.client/GrpcClientModule/Companion/create

"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/#create","title":"create","text":"

[jvm]\\ inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/","title":"HttpClientConfig - Misk","text":"

//misk/misk.client/HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"

[jvm]\\ data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null)

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#constructors","title":"Constructors","text":"HttpClientConfig [jvm]@JvmOverloadsconstructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null connectTimeout [jvm]val connectTimeout: Duration? = null keepAliveDuration [jvm]val keepAliveDuration: Duration? = null maxIdleConnections [jvm]val maxIdleConnections: Int? = null maxRequests [jvm]val maxRequests: Int? = null maxRequestsPerHost [jvm]val maxRequestsPerHost: Int? = null pingInterval [jvm]val pingInterval: Duration? = null protocols [jvm]val protocols: List<String>? = null readTimeout [jvm]val readTimeout: Duration? = null retryOnConnectionFailure [jvm]val retryOnConnectionFailure: Boolean? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null unixSocketFile [jvm]val unixSocketFile: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig toWispConfig [jvm]fun toWispConfig(): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/","title":"HttpClientConfig - Misk","text":"

//misk/misk.client/HttpClientConfig/HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"

[jvm]\\

@JvmOverloads

constructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/","title":"callTimeout - Misk","text":"

//misk/misk.client/HttpClientConfig/callTimeout

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/#calltimeout","title":"callTimeout","text":"

[jvm]\\ val callTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/","title":"connectTimeout - Misk","text":"

//misk/misk.client/HttpClientConfig/connectTimeout

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"

[jvm]\\ val connectTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"

//misk/misk.client/HttpClientConfig/keepAliveDuration

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"

[jvm]\\ val keepAliveDuration: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"

//misk/misk.client/HttpClientConfig/maxIdleConnections

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"

[jvm]\\ val maxIdleConnections: Int? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"

//misk/misk.client/HttpClientConfig/maxRequestsPerHost

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"

[jvm]\\ val maxRequestsPerHost: Int? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/","title":"maxRequests - Misk","text":"

//misk/misk.client/HttpClientConfig/maxRequests

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/#maxrequests","title":"maxRequests","text":"

[jvm]\\ val maxRequests: Int? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/","title":"pingInterval - Misk","text":"

//misk/misk.client/HttpClientConfig/pingInterval

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/#pinginterval","title":"pingInterval","text":"

[jvm]\\ val pingInterval: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/","title":"protocols - Misk","text":"

//misk/misk.client/HttpClientConfig/protocols

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/#protocols","title":"protocols","text":"

[jvm]\\ val protocols: List<String>? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/","title":"readTimeout - Misk","text":"

//misk/misk.client/HttpClientConfig/readTimeout

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/#readtimeout","title":"readTimeout","text":"

[jvm]\\ val readTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"

//misk/misk.client/HttpClientConfig/retryOnConnectionFailure

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"

[jvm]\\ val retryOnConnectionFailure: Boolean? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/","title":"ssl - Misk","text":"

//misk/misk.client/HttpClientConfig/ssl

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/#ssl","title":"ssl","text":"

[jvm]\\ val ssl: HttpClientSSLConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/","title":"toWispConfig - Misk","text":"

//misk/misk.client/HttpClientConfig/toWispConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"

[jvm]\\ fun toWispConfig(): HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/","title":"unixSocketFile - Misk","text":"

//misk/misk.client/HttpClientConfig/unixSocketFile

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/#unixsocketfile","title":"unixSocketFile","text":"

[jvm]\\ val unixSocketFile: String? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/","title":"writeTimeout - Misk","text":"

//misk/misk.client/HttpClientConfig/writeTimeout

"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/#writetimeout","title":"writeTimeout","text":"

[jvm]\\ val writeTimeout: Duration? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"

//misk/misk.client/HttpClientConfigUrlProvider

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"

[jvm]\\ class HttpClientConfigUrlProvider@Injectconstructor

Calculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly.

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#constructors","title":"Constructors","text":"HttpClientConfigUrlProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#functions","title":"Functions","text":"Name Summary getUrl [jvm]fun getUrl(endpointConfig: HttpClientEndpointConfig): String"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"

//misk/misk.client/HttpClientConfigUrlProvider/HttpClientConfigUrlProvider

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/","title":"envoyClientEndpointProvider - Misk","text":"

//misk/misk.client/HttpClientConfigUrlProvider/envoyClientEndpointProvider

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"

[jvm]\\

@Inject(optional = true)

lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/","title":"getUrl - Misk","text":"

//misk/misk.client/HttpClientConfigUrlProvider/getUrl

"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/#geturl","title":"getUrl","text":"

[jvm]\\ fun getUrl(endpointConfig: HttpClientEndpointConfig): String

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"

[jvm]\\ data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig())

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#constructors","title":"Constructors","text":"HttpClientEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#properties","title":"Properties","text":"Name Summary clientConfig [jvm]val clientConfig: HttpClientConfig envoy [jvm]val envoy: HttpClientEnvoyConfig? = null url [jvm]val url: String? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig/HttpClientEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"

[jvm]\\

@JvmOverloads

constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/","title":"clientConfig - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig/clientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"

[jvm]\\ val clientConfig: HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/","title":"envoy - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig/envoy

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/#envoy","title":"envoy","text":"

[jvm]\\ val envoy: HttpClientEnvoyConfig? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/","title":"toWispConfig - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig/toWispConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"

[jvm]\\ fun toWispConfig(): HttpClientEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/","title":"url - Misk","text":"

//misk/misk.client/HttpClientEndpointConfig/url

"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/#url","title":"url","text":"

[jvm]\\ val url: String? = null

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"

//misk/misk.client/HttpClientEnvoyConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"

[jvm]\\ data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null)

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#constructors","title":"Constructors","text":"HttpClientEnvoyConfig [jvm]@JvmOverloadsconstructor(app: String, env: String? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#properties","title":"Properties","text":"Name Summary app [jvm]val app: String env [jvm]val env: String? = nullEnvironment to target. If null, the same environment as the app is running in is assumed."},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEnvoyConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"

//misk/misk.client/HttpClientEnvoyConfig/HttpClientEnvoyConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"

[jvm]\\

@JvmOverloads

constructor(app: String, env: String? = null)

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/","title":"app - Misk","text":"

//misk/misk.client/HttpClientEnvoyConfig/app

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/#app","title":"app","text":"

[jvm]\\ val app: String

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/","title":"env - Misk","text":"

//misk/misk.client/HttpClientEnvoyConfig/env

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/#env","title":"env","text":"

[jvm]\\ val env: String? = null

Environment to target. If null, the same environment as the app is running in is assumed.

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/","title":"toWispConfig - Misk","text":"

//misk/misk.client/HttpClientEnvoyConfig/toWispConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"

[jvm]\\ fun toWispConfig(): HttpClientEnvoyConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/","title":"HttpClientFactory - Misk","text":"

//misk/misk.client/HttpClientFactory

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"

[jvm]\\ @Singleton

class HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#constructors","title":"Constructors","text":"HttpClientFactory [jvm]@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)var envoyClientEndpointProvider: EnvoyClientEndpointProvider? okhttpInterceptors [jvm]@Inject(optional = true)var okhttpInterceptors: Provider<List<Interceptor>>?"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsfun create(config: HttpClientEndpointConfig, serviceName: String? = null): OkHttpClientReturns a client initialized based on config."},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/","title":"HttpClientFactory - Misk","text":"

//misk/misk.client/HttpClientFactory/HttpClientFactory

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"

[jvm]\\

@Inject

constructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/","title":"create - Misk","text":"

//misk/misk.client/HttpClientFactory/create

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/#create","title":"create","text":"

[jvm]\\

@JvmOverloads

fun create(config: HttpClientEndpointConfig, serviceName: String? = null): OkHttpClient

Returns a client initialized based on config.

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/#parameters","title":"Parameters","text":"

jvm

config the configuration for the client serviceName the name of the target service, used for client side metrics. If null, no metrics will be collected."},{"location":"0.x/misk/misk/misk.client/-http-client-factory/envoy-client-endpoint-provider/","title":"envoyClientEndpointProvider - Misk","text":"

//misk/misk.client/HttpClientFactory/envoyClientEndpointProvider

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"

[jvm]\\

@Inject(optional = true)

var envoyClientEndpointProvider: EnvoyClientEndpointProvider?

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/","title":"okhttpInterceptors - Misk","text":"

//misk/misk.client/HttpClientFactory/okhttpInterceptors

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/#okhttpinterceptors","title":"okhttpInterceptors","text":"

[jvm]\\

@Inject(optional = true)

var okhttpInterceptors: Provider<List<Interceptor>>?

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/","title":"Companion - Misk","text":"

//misk/misk.client/HttpClientFactory/Companion

"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.client/-http-client-module/","title":"HttpClientModule - Misk","text":"

//misk/misk.client/HttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"

[jvm]\\ class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModule

Provides an OkHttpClient and ProtoMessageHttpClient for a peer service

"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#constructors","title":"Constructors","text":"HttpClientModule [jvm]@JvmOverloadsconstructor(name: String, annotation: Annotation? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/","title":"HttpClientModule - Misk","text":"

//misk/misk.client/HttpClientModule/HttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"

[jvm]\\

@JvmOverloads

constructor(name: String, annotation: Annotation? = null)

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"

//misk/misk.client/HttpClientSSLConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"

[jvm]\\ data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig)

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#constructors","title":"Constructors","text":"HttpClientSSLConfig [jvm]constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig? trust_store [jvm]val trust_store: TrustStoreConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientSSLConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"

//misk/misk.client/HttpClientSSLConfig/HttpClientSSLConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"

[jvm]\\ constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/","title":"cert_store - Misk","text":"

//misk/misk.client/HttpClientSSLConfig/cert_store

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/#cert_store","title":"cert_store","text":"

[jvm]\\ val cert_store: CertStoreConfig?

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/","title":"toWispConfig - Misk","text":"

//misk/misk.client/HttpClientSSLConfig/toWispConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"

[jvm]\\ fun toWispConfig(): HttpClientSSLConfig

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/","title":"trust_store - Misk","text":"

//misk/misk.client/HttpClientSSLConfig/trust_store

"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/#trust_store","title":"trust_store","text":"

[jvm]\\ val trust_store: TrustStoreConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"

//misk/misk.client/HttpClientsConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"

[jvm]\\ data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#constructors","title":"Constructors","text":"HttpClientsConfig [jvm]@JvmOverloadsconstructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#properties","title":"Properties","text":"Name Summary endpoints [jvm]val endpoints: Map<String, HttpClientEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#functions","title":"Functions","text":"Name Summary endpointNames [jvm]fun endpointNames(): Set<String>Names of configured endpoints, all of which can be fetched using get get [jvm]operator fun get(url: URL): HttpClientEndpointConfigoperator fun get(clientName: String): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"

//misk/misk.client/HttpClientsConfig/HttpClientsConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"

[jvm]\\

@JvmOverloads

constructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/","title":"endpointNames - Misk","text":"

//misk/misk.client/HttpClientsConfig/endpointNames

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/#endpointnames","title":"endpointNames","text":"

[jvm]\\ fun endpointNames(): Set<String>

Names of configured endpoints, all of which can be fetched using get

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/","title":"endpoints - Misk","text":"

//misk/misk.client/HttpClientsConfig/endpoints

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/#endpoints","title":"endpoints","text":"

[jvm]\\ val endpoints: Map<String, HttpClientEndpointConfig>

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/","title":"get - Misk","text":"

//misk/misk.client/HttpClientsConfig/get

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#get","title":"get","text":"

[jvm]\\ operator fun get(clientName: String): HttpClientEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return","title":"Return","text":"

The HttpClientEndpointConfig for the given client, populated with defaults as needed

[jvm]\\ operator fun get(url: URL): HttpClientEndpointConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return_1","title":"Return","text":"

The HttpClientEndpointConfig for the given URL, populated with defaults as needed

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/","title":"hostConfigs - Misk","text":"

//misk/misk.client/HttpClientsConfig/hostConfigs

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"

[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/","title":"logRequests - Misk","text":"

//misk/misk.client/HttpClientsConfig/logRequests

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/#logrequests","title":"logRequests","text":"

[jvm]\\ val logRequests: Boolean = false

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/","title":"Companion - Misk","text":"

//misk/misk.client/HttpClientsConfig/Companion

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#properties","title":"Properties","text":"Name Summary httpClientConfigDefaults [jvm]val httpClientConfigDefaults: HttpClientConfig logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/","title":"httpClientConfigDefaults - Misk","text":"

//misk/misk.client/HttpClientsConfig/Companion/httpClientConfigDefaults

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/#httpclientconfigdefaults","title":"httpClientConfigDefaults","text":"

[jvm]\\ val httpClientConfigDefaults: HttpClientConfig

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/","title":"logger - Misk","text":"

//misk/misk.client/HttpClientsConfig/Companion/logger

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/#logger","title":"logger","text":"

[jvm]\\ val logger: KLogger

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"

//misk/misk.client/HttpClientsConfigModule

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"

[jvm]\\ class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#constructors","title":"Constructors","text":"HttpClientsConfigModule [jvm]constructor(config: HttpClientsConfig)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"

//misk/misk.client/HttpClientsConfigModule/HttpClientsConfigModule

"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"

[jvm]\\ constructor(config: HttpClientsConfig)

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"

//misk/misk.client/JettyPortPeerClientModule

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"

[jvm]\\ class JettyPortPeerClientModule : KAbstractModule

For testing.

Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the Jetty server\u2019s port.

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#constructors","title":"Constructors","text":"JettyPortPeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"

//misk/misk.client/JettyPortPeerClientModule/JettyPortPeerClientModule

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"

//misk/misk.client/JettyPortPeerClientModule/peerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"

[jvm]\\

@Provides

@Singleton

fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"

//misk/misk.client/OkHttpClientCommonConfigurator

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"

[jvm]\\ class OkHttpClientCommonConfigurator@Injectconstructor

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#constructors","title":"Constructors","text":"OkHttpClientCommonConfigurator [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: OkHttpClientCommonConfigurator"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"

//misk/misk.client/OkHttpClientCommonConfigurator/OkHttpClientCommonConfigurator

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/","title":"configure - Misk","text":"

//misk/misk.client/OkHttpClientCommonConfigurator/configure

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/#configure","title":"configure","text":"

[jvm]\\ fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/","title":"delegate - Misk","text":"

//misk/misk.client/OkHttpClientCommonConfigurator/delegate

"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/#delegate","title":"delegate","text":"

[jvm]\\ val delegate: OkHttpClientCommonConfigurator

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"

//misk/misk.client/PeerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"

[jvm]\\ class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)

Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster.

An OkHttpClient is cached for each peer.

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#constructors","title":"Constructors","text":"PeerClientFactory [jvm]constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#functions","title":"Functions","text":"Name Summary baseUrl [jvm]fun baseUrl(peer: Cluster.Member): StringGet the base URL for calling the given peer cluster member. client [jvm]fun client(peer: Cluster.Member): OkHttpClientGet a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service."},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"

//misk/misk.client/PeerClientFactory/PeerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"

[jvm]\\ constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/","title":"baseUrl - Misk","text":"

//misk/misk.client/PeerClientFactory/baseUrl

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/#baseurl","title":"baseUrl","text":"

[jvm]\\ fun baseUrl(peer: Cluster.Member): String

Get the base URL for calling the given peer cluster member.

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/","title":"client - Misk","text":"

//misk/misk.client/PeerClientFactory/client

"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/#client","title":"client","text":"

[jvm]\\ fun client(peer: Cluster.Member): OkHttpClient

Get a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service.

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/","title":"PeerClientModule - Misk","text":"

//misk/misk.client/PeerClientModule

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"

[jvm]\\ class PeerClientModule : KAbstractModule

Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig.

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#constructors","title":"Constructors","text":"PeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/","title":"PeerClientModule - Misk","text":"

//misk/misk.client/PeerClientModule/PeerClientModule

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"

//misk/misk.client/PeerClientModule/peerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"

[jvm]\\

@Provides

@Singleton

fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"

//misk/misk.client/ProtoMessageHttpClient

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"

[jvm]\\ class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)

This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes.

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#constructors","title":"Constructors","text":"ProtoMessageHttpClient [jvm]constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#functions","title":"Functions","text":"Name Summary post [jvm]inline fun <O : Any> post(path: String, requestBody: Message<, *>): Ofun <O : Any> post(path: String, requestBody: Message<, *>, responseType: Class<O>): O"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"

//misk/misk.client/ProtoMessageHttpClient/ProtoMessageHttpClient

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"

[jvm]\\ constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/","title":"post - Misk","text":"

//misk/misk.client/ProtoMessageHttpClient/post

"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/#post","title":"post","text":"

[jvm]\\ fun <O : Any> post(path: String, requestBody: Message<*, *>, responseType: Class<O>): O

inline fun <O : Any> post(path: String, requestBody: Message<*, *>): O

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"

//misk/misk.client/TypedClientFactory

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"

[jvm]\\ class TypedClientFactory@Injectconstructor

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#constructors","title":"Constructors","text":"TypedClientFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#functions","title":"Functions","text":"Name Summary build [jvm]@JvmOverloadsinline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): TReified flavor of build[jvm]fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): TBuild up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to."},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"

//misk/misk.client/TypedClientFactory/TypedClientFactory

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/","title":"build - Misk","text":"

//misk/misk.client/TypedClientFactory/build

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#build","title":"build","text":"

[jvm]\\ fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): T

Build up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to.

Services should cache the resulting clients to avoid incurring the construction on every call.

"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#parameters","title":"Parameters","text":"

jvm

endpointConfig HTTP configuration to use to connect to the service kclass The class of the typed client that will be built name A name to reference the client by for observability purposes retrofitBuilderProvider Optional retrofit builder override. If not provided, an empty builder is used

[jvm]\\

@JvmOverloads

inline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): T

Reified flavor of build

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"

//misk/misk.client/TypedHttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"

class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule

Creates a retrofit-backed typed client given an API interface and an HTTP configuration.

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#parameters","title":"Parameters","text":"

jvm

retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#constructors","title":"Constructors","text":"TypedHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"

//misk/misk.client/TypedHttpClientModule/TypedHttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"

[jvm]\\

@JvmOverloads

constructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#parameters","title":"Parameters","text":"

jvm

retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.client/TypedHttpClientModule/Companion

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/","title":"create - Misk","text":"

//misk/misk.client/TypedHttpClientModule/Companion/create

"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/#create","title":"create","text":"

[jvm]\\ inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/","title":"TypedPeerClientFactory - Misk","text":"

//misk/misk.client/TypedPeerClientFactory

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#typedpeerclientfactory","title":"TypedPeerClientFactory","text":"

[jvm]\\ interface TypedPeerClientFactory<T>

Factory for creating typed clients that call other members of a cluster.

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#functions","title":"Functions","text":"Name Summary client [jvm]abstract fun client(peer: Cluster.Member): T"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/","title":"client - Misk","text":"

//misk/misk.client/TypedPeerClientFactory/client

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/#client","title":"client","text":"

[jvm]\\ abstract fun client(peer: Cluster.Member): T

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"

//misk/misk.client/TypedPeerHttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"

[jvm]\\ class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule

Creates a retrofit-backed typed client factory given an API interface and an HTTP configuration.

The factory returned typed clients that can be used to call other members of the cluster.

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#constructors","title":"Constructors","text":"TypedPeerHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"

//misk/misk.client/TypedPeerHttpClientModule/TypedPeerHttpClientModule

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"

[jvm]\\

@JvmOverloads

constructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.client/TypedPeerHttpClientModule/Companion

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/","title":"create - Misk","text":"

//misk/misk.client/TypedPeerHttpClientModule/Companion/create

"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/#create","title":"create","text":"

[jvm]\\ inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>

"},{"location":"0.x/misk/misk/misk.concurrent/","title":"Package-level declarations - Misk","text":"

//misk/misk.concurrent

"},{"location":"0.x/misk/misk/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.concurrent/#types","title":"Types","text":"Name Summary ExecutorServiceModule [jvm]class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModuleInstall this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down. ExplicitReleaseBlockingQueue [jvm]class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T> An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items. ExplicitReleaseDelayQueue [jvm]class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T> An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"

//misk/misk.concurrent/ExecutorServiceModule

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"

[jvm]\\ class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModule

Install this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down.

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#constructors","title":"Constructors","text":"ExecutorServiceModule [jvm]constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"

//misk/misk.concurrent/ExecutorServiceModule/ExecutorServiceModule

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"

[jvm]\\ constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.concurrent/ExecutorServiceModule/Companion

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#functions","title":"Functions","text":"Name Summary withFixedThreadPool [jvm]fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule withUnboundThreadPool [jvm]fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/","title":"withFixedThreadPool - Misk","text":"

//misk/misk.concurrent/ExecutorServiceModule/Companion/withFixedThreadPool

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/#withfixedthreadpool","title":"withFixedThreadPool","text":"

[jvm]\\ fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/","title":"withUnboundThreadPool - Misk","text":"

//misk/misk.concurrent/ExecutorServiceModule/Companion/withUnboundThreadPool

"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/#withunboundthreadpool","title":"withUnboundThreadPool","text":"

[jvm]\\ fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"

[jvm]\\ class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T>

An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items.

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#constructors","title":"Constructors","text":"ExplicitReleaseBlockingQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(c: MutableCollection<in T>): Intopen override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int element [jvm]open override fun element(): T isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(e: T): Booleanopen override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean peek [jvm]open override fun peek(): T? peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): T?open override fun poll(timeout: Long, unit: TimeUnit): T? put [jvm]open override fun put(e: T) release [jvm]fun release(n: Int): Intreleases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue releaseAll [jvm]fun releaseAll(): Intreleases all items from the pending queue, returning the number of items released remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): T?open override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/ExplicitReleaseBlockingQueue

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/","title":"addAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/addAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/#addall","title":"addAll","text":"

[jvm]\\ open override fun addAll(elements: Collection<T>): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/","title":"add - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/add

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/#add","title":"add","text":"

[jvm]\\ open override fun add(element: T): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/","title":"clear - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/clear

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/#clear","title":"clear","text":"

[jvm]\\ open override fun clear()

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/","title":"containsAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/containsAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/#containsall","title":"containsAll","text":"

[jvm]\\ open override fun containsAll(elements: Collection<T>): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/","title":"contains - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/contains

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/#contains","title":"contains","text":"

[jvm]\\ open operator override fun contains(element: T): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/","title":"drainTo - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/drainTo

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/#drainto","title":"drainTo","text":"

[jvm]\\ open override fun drainTo(c: MutableCollection<in T>): Int

open override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/","title":"element - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/element

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/#element","title":"element","text":"

[jvm]\\ open override fun element(): T

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/","title":"isEmpty - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/isEmpty

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/#isempty","title":"isEmpty","text":"

[jvm]\\ open override fun isEmpty(): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/","title":"iterator - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/iterator

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/#iterator","title":"iterator","text":"

[jvm]\\ open operator override fun iterator(): MutableIterator<T>

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/","title":"offer - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/offer

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/#offer","title":"offer","text":"

[jvm]\\ open override fun offer(e: T): Boolean

open override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/","title":"peekPending - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peekPending

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/#peekpending","title":"peekPending","text":"

[jvm]\\ fun peekPending(): T?

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/","title":"peek - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peek

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/#peek","title":"peek","text":"

[jvm]\\ open override fun peek(): T?

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/","title":"poll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/poll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/#poll","title":"poll","text":"

[jvm]\\ open override fun poll(timeout: Long, unit: TimeUnit): T?

open override fun poll(): T?

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/","title":"put - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/put

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/#put","title":"put","text":"

[jvm]\\ open override fun put(e: T)

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/","title":"releaseAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/releaseAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/#releaseall","title":"releaseAll","text":"

[jvm]\\ fun releaseAll(): Int

releases all items from the pending queue, returning the number of items released

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/","title":"release - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/release

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#release","title":"release","text":"

[jvm]\\ fun release(n: Int): Int

releases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#return","title":"Return","text":"

the number of items actually releases

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/","title":"remainingCapacity - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remainingCapacity

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/#remainingcapacity","title":"remainingCapacity","text":"

[jvm]\\ open override fun remainingCapacity(): Int

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/","title":"removeAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/removeAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/#removeall","title":"removeAll","text":"

[jvm]\\ open override fun removeAll(elements: Collection<T>): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/","title":"remove - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remove

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/#remove","title":"remove","text":"

[jvm]\\ open override fun remove(element: T): Boolean

open override fun remove(): T?

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/","title":"retainAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/retainAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/#retainall","title":"retainAll","text":"

[jvm]\\ open override fun retainAll(elements: Collection<T>): Boolean

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/","title":"size - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/size

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/#size","title":"size","text":"

[jvm]\\ open override val size: Int

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/","title":"take - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseBlockingQueue/take

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/#take","title":"take","text":"

[jvm]\\ open override fun take(): T

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseDelayQueue

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"

[jvm]\\ class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T>

An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#constructors","title":"Constructors","text":"ExplicitReleaseDelayQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(p0: MutableCollection<in T>): Intopen override fun drainTo(p0: MutableCollection<in T>, p1: Int): Int element [jvm]open override fun element(): T isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(p0: T): Booleanopen override fun offer(p0: T, p1: Long, p2: TimeUnit): Boolean peek [jvm]open override fun peek(): T peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): Topen override fun poll(p0: Long, p1: TimeUnit): T put [jvm]open override fun put(p0: T) release [jvm]fun release(n: Int): Int releaseAll [jvm]fun releaseAll(): Int remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): Topen override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseDelayQueue/ExplicitReleaseDelayQueue

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/","title":"peekPending - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseDelayQueue/peekPending

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/#peekpending","title":"peekPending","text":"

[jvm]\\ fun peekPending(): T?

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/","title":"releaseAll - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseDelayQueue/releaseAll

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/#releaseall","title":"releaseAll","text":"

[jvm]\\ fun releaseAll(): Int

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/","title":"release - Misk","text":"

//misk/misk.concurrent/ExplicitReleaseDelayQueue/release

"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/#release","title":"release","text":"

[jvm]\\ fun release(n: Int): Int

"},{"location":"0.x/misk/misk/misk.environment/","title":"Package-level declarations - Misk","text":"

//misk/misk.environment

"},{"location":"0.x/misk/misk/misk.environment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.environment/#types","title":"Types","text":"Name Summary DeploymentModule [jvm]class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModuleBinds Deployment to make it available to services and actions EnvVarLoader [jvm]interface EnvVarLoader : EnvironmentVariableLoaderLoads an environment variable value. FakeEnvVarModule [jvm]class FakeEnvVarModule : KAbstractModuleBinds a EnvVarLoader for tests. Tests can contribute values through the @ForEnvVars Map<String, String> binding. ForEnvVars [jvm]@Qualifierannotation class ForEnvVars RealEnvVarModule [jvm]class RealEnvVarModule : KAbstractModuleBinds a EnvVarLoader for production"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/","title":"DeploymentModule - Misk","text":"

//misk/misk.environment/DeploymentModule

"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"

[jvm]\\ class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModule

Binds Deployment to make it available to services and actions

"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#constructors","title":"Constructors","text":"DeploymentModule [jvm]@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/","title":"DeploymentModule - Misk","text":"

//misk/misk.environment/DeploymentModule/DeploymentModule

"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"

[jvm]\\

@JvmOverloads

constructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())

"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/","title":"EnvVarLoader - Misk","text":"

//misk/misk.environment/EnvVarLoader

"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#envvarloader","title":"EnvVarLoader","text":"

[jvm]\\ interface EnvVarLoader : EnvironmentVariableLoader

Loads an environment variable value.

"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): String getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String getEnvVar [jvm]open fun getEnvVar(name: String): StringGet the environment variable value"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/","title":"getEnvVar - Misk","text":"

//misk/misk.environment/EnvVarLoader/getEnvVar

"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#getenvvar","title":"getEnvVar","text":"

[jvm]\\ open fun getEnvVar(name: String): String

Get the environment variable value

"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#throws","title":"Throws","text":"IllegalStateException if the environment variable is not found"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/","title":"FakeEnvVarModule - Misk","text":"

//misk/misk.environment/FakeEnvVarModule

"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"

[jvm]\\ class FakeEnvVarModule : KAbstractModule

Binds a EnvVarLoader for tests. Tests can contribute values through the @ForEnvVars Map<String, String> binding.

"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/#constructors","title":"Constructors","text":"FakeEnvVarModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/-fake-env-var-module/","title":"FakeEnvVarModule - Misk","text":"

//misk/misk.environment/FakeEnvVarModule/FakeEnvVarModule

"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/","title":"ForEnvVars - Misk","text":"

//misk/misk.environment/ForEnvVars

"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/#forenvvars","title":"ForEnvVars","text":"

[jvm]\\ @Qualifier

annotation class ForEnvVars

"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"

//misk/misk.environment/RealEnvVarModule

"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"

[jvm]\\ class RealEnvVarModule : KAbstractModule

Binds a EnvVarLoader for production

"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#constructors","title":"Constructors","text":"RealEnvVarModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"

//misk/misk.environment/RealEnvVarModule/RealEnvVarModule

"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.grpc/","title":"Package-level declarations - Misk","text":"

//misk/misk.grpc

"},{"location":"0.x/misk/misk/misk.grpc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.grpc/#functions","title":"Functions","text":"Name Summary consumeEachAndClose [jvm]fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/","title":"consumeEachAndClose - Misk","text":"

//misk/misk.grpc/consumeEachAndClose

"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/#consumeeachandclose","title":"consumeEachAndClose","text":"

[jvm]\\ fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)

"},{"location":"0.x/misk/misk/misk.io/","title":"Package-level declarations - Misk","text":"

//misk/misk.io

"},{"location":"0.x/misk/misk/misk.io/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.io/#functions","title":"Functions","text":"Name Summary listRecursively [jvm]fun Path.listRecursively(includeDirs: Boolean = false): List<Path>"},{"location":"0.x/misk/misk/misk.io/list-recursively/","title":"listRecursively - Misk","text":"

//misk/misk.io/listRecursively

"},{"location":"0.x/misk/misk/misk.io/list-recursively/#listrecursively","title":"listRecursively","text":"

[jvm]\\ fun Path.listRecursively(includeDirs: Boolean = false): List<Path>

"},{"location":"0.x/misk/misk/misk.io/list-recursively/#return","title":"Return","text":"

all of the paths beneath this one, including nested paths

"},{"location":"0.x/misk/misk/misk.jvm/","title":"Package-level declarations - Misk","text":"

//misk/misk.jvm

"},{"location":"0.x/misk/misk/misk.jvm/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.jvm/#types","title":"Types","text":"Name Summary JvmManagementFactoryModule [jvm]class JvmManagementFactoryModule : KInstallOnceModuleDefault providers for the ManagementFactory beans that the framework depends on."},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"

//misk/misk.jvm/JvmManagementFactoryModule

"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"

[jvm]\\ class JvmManagementFactoryModule : KInstallOnceModule

Default providers for the ManagementFactory beans that the framework depends on.

"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#constructors","title":"Constructors","text":"JvmManagementFactoryModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int provideRuntimeMxBean [jvm]@Providesfun provideRuntimeMxBean(): RuntimeMXBean"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"

//misk/misk.jvm/JvmManagementFactoryModule/JvmManagementFactoryModule

"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/","title":"provideRuntimeMxBean - Misk","text":"

//misk/misk.jvm/JvmManagementFactoryModule/provideRuntimeMxBean

"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/#provideruntimemxbean","title":"provideRuntimeMxBean","text":"

[jvm]\\

@Provides

fun provideRuntimeMxBean(): RuntimeMXBean

"},{"location":"0.x/misk/misk/misk.logging/","title":"Package-level declarations - Misk","text":"

//misk/misk.logging

"},{"location":"0.x/misk/misk/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.logging/#types","title":"Types","text":"Name Summary MdcModule [jvm]class MdcModule : KInstallOnceModule MiskMdc [jvm]object MiskMdc : Mdc"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/","title":"MdcModule - Misk","text":"

//misk/misk.logging/MdcModule

"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#mdcmodule","title":"MdcModule","text":"

[jvm]\\ class MdcModule : KInstallOnceModule

"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#constructors","title":"Constructors","text":"MdcModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/","title":"MdcModule - Misk","text":"

//misk/misk.logging/MdcModule/MdcModule

"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/#mdcmodule","title":"MdcModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/","title":"MiskMdc - Misk","text":"

//misk/misk.logging/MiskMdc

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#miskmdc","title":"MiskMdc","text":"

[jvm]\\ object MiskMdc : Mdc

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() get [jvm]open override fun get(key: String): String? put [jvm]open override fun put(key: String, value: String?)"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/","title":"clear - Misk","text":"

//misk/misk.logging/MiskMdc/clear

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/#clear","title":"clear","text":"

[jvm]\\ open override fun clear()

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/","title":"get - Misk","text":"

//misk/misk.logging/MiskMdc/get

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/#get","title":"get","text":"

[jvm]\\ open override fun get(key: String): String?

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/","title":"put - Misk","text":"

//misk/misk.logging/MiskMdc/put

"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/#put","title":"put","text":"

[jvm]\\ open override fun put(key: String, value: String?)

"},{"location":"0.x/misk/misk/misk.monitoring/","title":"Package-level declarations - Misk","text":"

//misk/misk.monitoring

"},{"location":"0.x/misk/misk/misk.monitoring/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.monitoring/#types","title":"Types","text":"Name Summary JvmMetrics [jvm]@Singletonclass JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)Exposes additional JVM metrics. MonitoringModule [jvm]class MonitoringModule : KInstallOnceModule"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/","title":"JvmMetrics - Misk","text":"

//misk/misk.monitoring/JvmMetrics

"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"

[jvm]\\ @Singleton

class JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)

Exposes additional JVM metrics.

"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#constructors","title":"Constructors","text":"JvmMetrics [jvm]@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/","title":"JvmMetrics - Misk","text":"

//misk/misk.monitoring/JvmMetrics/JvmMetrics

"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"

[jvm]\\

@Inject

constructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)

"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/","title":"MonitoringModule - Misk","text":"

//misk/misk.monitoring/MonitoringModule

"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"

[jvm]\\ class MonitoringModule : KInstallOnceModule

"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#constructors","title":"Constructors","text":"MonitoringModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/","title":"MonitoringModule - Misk","text":"

//misk/misk.monitoring/MonitoringModule/MonitoringModule

"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.moshi/","title":"Package-level declarations - Misk","text":"

//misk/misk.moshi

"},{"location":"0.x/misk/misk/misk.moshi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi/#types","title":"Types","text":"Name Summary MoshiAdapterModule [jvm]class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule MoshiModule [jvm]class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModuleFor service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly."},{"location":"0.x/misk/misk/misk.moshi/#functions","title":"Functions","text":"Name Summary adapter [jvm]inline fun <T> Moshi.adapter(): JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.moshi/adapter/","title":"adapter - Misk","text":"

//misk/misk.moshi/adapter

"},{"location":"0.x/misk/misk/misk.moshi/adapter/#adapter","title":"adapter","text":"

[jvm]\\ inline fun <T> Moshi.adapter(): JsonAdapter<T>

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"

//misk/misk.moshi/MoshiAdapterModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"

[jvm]\\ class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#constructors","title":"Constructors","text":"MoshiAdapterModule [jvm]@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"

//misk/misk.moshi/MoshiAdapterModule/MoshiAdapterModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"

[jvm]\\

@JvmOverloads

constructor(jsonAdapter: Any, addLast: Boolean = false)

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.moshi/MoshiAdapterModule/Companion

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#functions","title":"Functions","text":"Name Summary invoke [jvm]inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/","title":"invoke - Misk","text":"

//misk/misk.moshi/MoshiAdapterModule/Companion/invoke

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/#invoke","title":"invoke","text":"

[jvm]\\ inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/","title":"MoshiModule - Misk","text":"

//misk/misk.moshi/MoshiModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#moshimodule","title":"MoshiModule","text":"

[jvm]\\ class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModule

For service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly.

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#constructors","title":"Constructors","text":"MoshiModule [jvm]@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singletonfun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/","title":"MoshiModule - Misk","text":"

//misk/misk.moshi/MoshiModule/MoshiModule

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/#moshimodule","title":"MoshiModule","text":"

[jvm]\\

@JvmOverloads

constructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/","title":"provideMoshi - Misk","text":"

//misk/misk.moshi/MoshiModule/provideMoshi

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"

[jvm]\\

@Provides

@Singleton

fun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.moshi/MoshiModule/Companion

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-companion/#properties","title":"Properties","text":"Name Summary defaultMoshiAdapters [jvm]val defaultMoshiAdapters: List<Any>"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-companion/default-moshi-adapters/","title":"defaultMoshiAdapters - Misk","text":"

//misk/misk.moshi/MoshiModule/Companion/defaultMoshiAdapters

"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-companion/default-moshi-adapters/#defaultmoshiadapters","title":"defaultMoshiAdapters","text":"

[jvm]\\ val defaultMoshiAdapters: List<Any>

"},{"location":"0.x/misk/misk/misk.moshi.adapters/","title":"Package-level declarations - Misk","text":"

//misk/misk.moshi.adapters

"},{"location":"0.x/misk/misk/misk.moshi.adapters/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.adapters/#types","title":"Types","text":"Name Summary BigDecimalAdapter [jvm]object BigDecimalAdapter"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/","title":"BigDecimalAdapter - Misk","text":"

//misk/misk.moshi.adapters/BigDecimalAdapter

"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#bigdecimaladapter","title":"BigDecimalAdapter","text":"

[jvm]\\ object BigDecimalAdapter

"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#functions","title":"Functions","text":"Name Summary decode [jvm]fun decode(decimal: String): BigDecimal encode [jvm]fun encode(decimal: BigDecimal): String"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/","title":"decode - Misk","text":"

//misk/misk.moshi.adapters/BigDecimalAdapter/decode

"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/#decode","title":"decode","text":"

[jvm]\\ fun decode(decimal: String): BigDecimal

"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/","title":"encode - Misk","text":"

//misk/misk.moshi.adapters/BigDecimalAdapter/encode

"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/#encode","title":"encode","text":"

[jvm]\\ fun encode(decimal: BigDecimal): String

"},{"location":"0.x/misk/misk/misk.moshi.okio/","title":"Package-level declarations - Misk","text":"

//misk/misk.moshi.okio

"},{"location":"0.x/misk/misk/misk.moshi.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.okio/#types","title":"Types","text":"Name Summary ByteStringAdapter [jvm]object ByteStringAdapterJSON adapter converting ByteStrings as base64 encoded strings"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/","title":"ByteStringAdapter - Misk","text":"

//misk/misk.moshi.okio/ByteStringAdapter

"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#bytestringadapter","title":"ByteStringAdapter","text":"

[jvm]\\ object ByteStringAdapter

JSON adapter converting ByteStrings as base64 encoded strings

"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String): ByteString toJson [jvm]fun toJson(value: ByteString): String"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/","title":"fromJson - Misk","text":"

//misk/misk.moshi.okio/ByteStringAdapter/fromJson

"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/#fromjson","title":"fromJson","text":"

[jvm]\\ fun fromJson(value: String): ByteString

"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/","title":"toJson - Misk","text":"

//misk/misk.moshi.okio/ByteStringAdapter/toJson

"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/#tojson","title":"toJson","text":"

[jvm]\\ fun toJson(value: ByteString): String

"},{"location":"0.x/misk/misk/misk.moshi.time/","title":"Package-level declarations - Misk","text":"

//misk/misk.moshi.time

"},{"location":"0.x/misk/misk/misk.moshi.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.time/#types","title":"Types","text":"Name Summary InstantAdapter [jvm]object InstantAdapter LocalDateAdapter [jvm]object LocalDateAdapter OffsetDateTimeAdapter [jvm]object OffsetDateTimeAdapter"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/","title":"InstantAdapter - Misk","text":"

//misk/misk.moshi.time/InstantAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#instantadapter","title":"InstantAdapter","text":"

[jvm]\\ object InstantAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): Instant? toJson [jvm]fun toJson(value: Instant?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/","title":"fromJson - Misk","text":"

//misk/misk.moshi.time/InstantAdapter/fromJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/#fromjson","title":"fromJson","text":"

[jvm]\\ fun fromJson(date: Date?): Instant?

"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/","title":"toJson - Misk","text":"

//misk/misk.moshi.time/InstantAdapter/toJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/#tojson","title":"toJson","text":"

[jvm]\\ fun toJson(value: Instant?): Date?

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/","title":"LocalDateAdapter - Misk","text":"

//misk/misk.moshi.time/LocalDateAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#localdateadapter","title":"LocalDateAdapter","text":"

[jvm]\\ object LocalDateAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): LocalDate? toJson [jvm]fun toJson(value: LocalDate?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/","title":"fromJson - Misk","text":"

//misk/misk.moshi.time/LocalDateAdapter/fromJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/#fromjson","title":"fromJson","text":"

[jvm]\\ fun fromJson(date: Date?): LocalDate?

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/","title":"toJson - Misk","text":"

//misk/misk.moshi.time/LocalDateAdapter/toJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/#tojson","title":"toJson","text":"

[jvm]\\ fun toJson(value: LocalDate?): Date?

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/","title":"OffsetDateTimeAdapter - Misk","text":"

//misk/misk.moshi.time/OffsetDateTimeAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#offsetdatetimeadapter","title":"OffsetDateTimeAdapter","text":"

[jvm]\\ object OffsetDateTimeAdapter

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String?): OffsetDateTime? toJson [jvm]fun toJson(value: OffsetDateTime?): String?"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/","title":"fromJson - Misk","text":"

//misk/misk.moshi.time/OffsetDateTimeAdapter/fromJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/#fromjson","title":"fromJson","text":"

[jvm]\\ fun fromJson(value: String?): OffsetDateTime?

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/","title":"toJson - Misk","text":"

//misk/misk.moshi.time/OffsetDateTimeAdapter/toJson

"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/#tojson","title":"toJson","text":"

[jvm]\\ fun toJson(value: OffsetDateTime?): String?

"},{"location":"0.x/misk/misk/misk.okio/","title":"Package-level declarations - Misk","text":"

//misk/misk.okio

"},{"location":"0.x/misk/misk/misk.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.okio/#functions","title":"Functions","text":"Name Summary forEachBlock [jvm]fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit) split [jvm]fun BufferedSource.split(separator: ByteString): Sequence<Buffer>"},{"location":"0.x/misk/misk/misk.okio/for-each-block/","title":"forEachBlock - Misk","text":"

//misk/misk.okio/forEachBlock

"},{"location":"0.x/misk/misk/misk.okio/for-each-block/#foreachblock","title":"forEachBlock","text":"

[jvm]\\ fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)

fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit)

"},{"location":"0.x/misk/misk/misk.okio/split/","title":"split - Misk","text":"

//misk/misk.okio/split

"},{"location":"0.x/misk/misk/misk.okio/split/#split","title":"split","text":"

[jvm]\\ fun BufferedSource.split(separator: ByteString): Sequence<Buffer>

"},{"location":"0.x/misk/misk/misk.perf/","title":"Package-level declarations - Misk","text":"

//misk/misk.perf

"},{"location":"0.x/misk/misk/misk.perf/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.perf/#types","title":"Types","text":"Name Summary ForPauseDetector [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ForPauseDetectorUsed to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector PauseDetectorConfig [jvm]data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)Configuration for the PauseDetector PauseDetectorModule [jvm]class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModuleInstall this module to run the PauseDetector in the background."},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/","title":"ForPauseDetector - Misk","text":"

//misk/misk.perf/ForPauseDetector

"},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/#forpausedetector","title":"ForPauseDetector","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])

annotation class ForPauseDetector

Used to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"

//misk/misk.perf/PauseDetectorConfig

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"

[jvm]\\ data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)

Configuration for the PauseDetector

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#constructors","title":"Constructors","text":"PauseDetectorConfig [jvm]@JvmOverloadsconstructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#properties","title":"Properties","text":"Name Summary logErrorMillis [jvm]val logErrorMillis: LongThe minimum number of millis paused before logging at error. -1 for never. logInfoMillis [jvm]val logInfoMillis: Long = 1000The minimum number of millis paused before logging at info. -1 for never. logWarnMillis [jvm]val logWarnMillis: LongThe minimum number of millis paused before logging at warn. -1 for never. metricsUpdateFloor [jvm]val metricsUpdateFloor: Long = 0The minimum number of millis required to trigger an update of the histogram resolutionMillis [jvm]val resolutionMillis: Long = 1The delay between detector runs. If 0, the detector runs in a spin loop."},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/PauseDetectorConfig

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"

[jvm]\\

@JvmOverloads

constructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/","title":"logErrorMillis - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/logErrorMillis

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/#logerrormillis","title":"logErrorMillis","text":"

[jvm]\\ val logErrorMillis: Long

The minimum number of millis paused before logging at error. -1 for never.

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/","title":"logInfoMillis - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/logInfoMillis

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/#loginfomillis","title":"logInfoMillis","text":"

[jvm]\\ val logInfoMillis: Long = 1000

The minimum number of millis paused before logging at info. -1 for never.

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/","title":"logWarnMillis - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/logWarnMillis

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/#logwarnmillis","title":"logWarnMillis","text":"

[jvm]\\ val logWarnMillis: Long

The minimum number of millis paused before logging at warn. -1 for never.

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/","title":"metricsUpdateFloor - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/metricsUpdateFloor

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/#metricsupdatefloor","title":"metricsUpdateFloor","text":"

[jvm]\\ val metricsUpdateFloor: Long = 0

The minimum number of millis required to trigger an update of the histogram

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/","title":"resolutionMillis - Misk","text":"

//misk/misk.perf/PauseDetectorConfig/resolutionMillis

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/#resolutionmillis","title":"resolutionMillis","text":"

[jvm]\\ val resolutionMillis: Long = 1

The delay between detector runs. If 0, the detector runs in a spin loop.

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"

//misk/misk.perf/PauseDetectorModule

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"

[jvm]\\ class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModule

Install this module to run the PauseDetector in the background.

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#constructors","title":"Constructors","text":"PauseDetectorModule [jvm]@JvmOverloadsconstructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#properties","title":"Properties","text":"Name Summary pauseDetectorConfig [jvm]val pauseDetectorConfig: PauseDetectorConfig"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"

//misk/misk.perf/PauseDetectorModule/PauseDetectorModule

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"

[jvm]\\

@JvmOverloads

constructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/","title":"pauseDetectorConfig - Misk","text":"

//misk/misk.perf/PauseDetectorModule/pauseDetectorConfig

"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/#pausedetectorconfig","title":"pauseDetectorConfig","text":"

[jvm]\\ val pauseDetectorConfig: PauseDetectorConfig

"},{"location":"0.x/misk/misk/misk.security.authz/","title":"Package-level declarations - Misk","text":"

//misk/misk.security.authz

"},{"location":"0.x/misk/misk/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.authz/#types","title":"Types","text":"Name Summary AccessAnnotationEntry [jvm]data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it. AccessControlModule [jvm]class AccessControlModule : ActionScopedProviderModuleInstall support for performing access control checks for actions based on the incoming caller. AccessInterceptor [jvm]class AccessInterceptor : ApplicationInterceptor DevelopmentOnly [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class DevelopmentOnly ExcludeFromAllowAnyService [jvm]@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])annotation class ExcludeFromAllowAnyServiceExclude a service from @AllowAnyService. FakeCallerAuthenticator [jvm]@Singletonclass FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticatorA caller authenticator that blindly trusts HTTP headers. Unsafe for production use. MiskCallerAuthenticator [jvm]interface MiskCallerAuthenticatorInterface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information."},{"location":"0.x/misk/misk/misk.security.authz/#functions","title":"Functions","text":"Name Summary AccessAnnotationEntry [jvm]inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"

[jvm]\\ inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"

[jvm]\\ data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)

Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it.

To demonstrate, let\u2019s define an access annotation. By convention these annotations are suffixed Access:

@Retention(AnnotationRetention.RUNTIME)\n@Target(AnnotationTarget.FUNCTION)\nannotation class PaleontologistAccess\n

Next we define actions that apply our annotation:

class DiscoverDinosaurAction @Inject constructor() : WebAction {\n  @Get(\"/discover\")\n  @PaleontologistAccess\n  fun discover()\n}\n\nclass DigUpDinosaurAction @Inject constructor() : WebAction {\n  @Get(\"/dig\")\n  @PaleontologistAccess\n  fun dig()\n}\n

Finally we use multibindings to specify which services and capabilities are permitted:

multibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<PaleontologistAccess>(capabilities = listOf(\"paleontologist\", \"intern\")))\n
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#constructors","title":"Constructors","text":"AccessAnnotationEntry [jvm]@JvmOverloadsconstructor(annotation: KClass<out Annotation>, services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false)"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#properties","title":"Properties","text":"Name Summary allowAnyService [jvm]val allowAnyService: Boolean = false allowAnyUser [jvm]val allowAnyUser: Boolean = false annotation [jvm]val annotation: KClass<out Annotation> capabilities [jvm]val capabilities: List<String> services [jvm]val services: List<String>"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/AccessAnnotationEntry

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"

[jvm]\\

@JvmOverloads

constructor(annotation: KClass<out Annotation>, services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false)

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/","title":"allowAnyService - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/allowAnyService

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/#allowanyservice","title":"allowAnyService","text":"

[jvm]\\ val allowAnyService: Boolean = false

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/","title":"allowAnyUser - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/allowAnyUser

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"

[jvm]\\ val allowAnyUser: Boolean = false

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/","title":"annotation - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/annotation

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/#annotation","title":"annotation","text":"

[jvm]\\ val annotation: KClass<out Annotation>

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/","title":"capabilities - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/capabilities

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/#capabilities","title":"capabilities","text":"

[jvm]\\ val capabilities: List<String>

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/","title":"services - Misk","text":"

//misk/misk.security.authz/AccessAnnotationEntry/services

"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/#services","title":"services","text":"

[jvm]\\ val services: List<String>

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/","title":"AccessControlModule - Misk","text":"

//misk/misk.security.authz/AccessControlModule

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"

[jvm]\\ class AccessControlModule : ActionScopedProviderModule

Install support for performing access control checks for actions based on the incoming caller.

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#constructors","title":"Constructors","text":"AccessControlModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation?)fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation?) bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?) bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>) configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]open override fun configureProviders()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/","title":"AccessControlModule - Misk","text":"

//misk/misk.security.authz/AccessControlModule/AccessControlModule

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/","title":"configureProviders - Misk","text":"

//misk/misk.security.authz/AccessControlModule/configureProviders

"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/#configureproviders","title":"configureProviders","text":"

[jvm]\\ open override fun configureProviders()

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/","title":"AccessInterceptor - Misk","text":"

//misk/misk.security.authz/AccessInterceptor

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#accessinterceptor","title":"AccessInterceptor","text":"

[jvm]\\ class AccessInterceptor : ApplicationInterceptor

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String>"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"

//misk/misk.security.authz/AccessInterceptor/allowedCapabilities

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"

[jvm]\\ val allowedCapabilities: Set<String>

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/","title":"allowedServices - Misk","text":"

//misk/misk.security.authz/AccessInterceptor/allowedServices

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/#allowedservices","title":"allowedServices","text":"

[jvm]\\ val allowedServices: Set<String>

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.security.authz/AccessInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: Chain): Any

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/","title":"Companion - Misk","text":"

//misk/misk.security.authz/AccessInterceptor/Companion

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/","title":"logger - Misk","text":"

//misk/misk.security.authz/AccessInterceptor/Companion/logger

"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/#logger","title":"logger","text":"

[jvm]\\ val logger: KLogger

"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/","title":"DevelopmentOnly - Misk","text":"

//misk/misk.security.authz/DevelopmentOnly

"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/#developmentonly","title":"DevelopmentOnly","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])

annotation class DevelopmentOnly

"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/","title":"ExcludeFromAllowAnyService - Misk","text":"

//misk/misk.security.authz/ExcludeFromAllowAnyService

"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/#excludefromallowanyservice","title":"ExcludeFromAllowAnyService","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])

annotation class ExcludeFromAllowAnyService

Exclude a service from @AllowAnyService.

Add any external proxies that do service-to-service authentication to prevent AllowAnyService from also allowing external traffic to your service.

You can still explicitly include these services by including them in

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"

[jvm]\\ @Singleton

class FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticator

A caller authenticator that blindly trusts HTTP headers. Unsafe for production use.

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#constructors","title":"Constructors","text":"FakeCallerAuthenticator [jvm]@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>)"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#properties","title":"Properties","text":"Name Summary developmentCaller [jvm]@Inject(optional = true)var developmentCaller: MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]open override fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/FakeCallerAuthenticator

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"

[jvm]\\

@Inject

constructor(currentHttpCall: ActionScoped<HttpCall>)

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/","title":"developmentCaller - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/developmentCaller

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/#developmentcaller","title":"developmentCaller","text":"

[jvm]\\

@Inject(optional = true)

var developmentCaller: MiskCaller?

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/getAuthenticatedCaller

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"

[jvm]\\ open override fun getAuthenticatedCaller(): MiskCaller?

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/","title":"Companion - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/Companion

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#properties","title":"Properties","text":"Name Summary CAPABILITIES_HEADER [jvm]const val CAPABILITIES_HEADER: String SERVICE_HEADER [jvm]const val SERVICE_HEADER: String USER_HEADER [jvm]const val USER_HEADER: String"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/","title":"CAPABILITIES_HEADER - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/Companion/CAPABILITIES_HEADER

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/#capabilities_header","title":"CAPABILITIES_HEADER","text":"

[jvm]\\ const val CAPABILITIES_HEADER: String

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/","title":"SERVICE_HEADER - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/Companion/SERVICE_HEADER

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/#service_header","title":"SERVICE_HEADER","text":"

[jvm]\\ const val SERVICE_HEADER: String

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/","title":"USER_HEADER - Misk","text":"

//misk/misk.security.authz/FakeCallerAuthenticator/Companion/USER_HEADER

"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/#user_header","title":"USER_HEADER","text":"

[jvm]\\ const val USER_HEADER: String

"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/","title":"MiskCallerAuthenticator - Misk","text":"

//misk/misk.security.authz/MiskCallerAuthenticator

"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#miskcallerauthenticator","title":"MiskCallerAuthenticator","text":"

interface MiskCallerAuthenticator

Interface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information.

This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<MiskCallerAuthenticator>().to<MyAuthenticator>()\n

We allow binding up many authenticators in case applications would like to support alternative ways in which to authenticate requests. For example, one mechanism might leverage HTTP headers while another mechanism might leverage third party authentication services.

"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#inheritors","title":"Inheritors","text":"FakeCallerAuthenticator"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]abstract fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"

//misk/misk.security.authz/MiskCallerAuthenticator/getAuthenticatedCaller

"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"

[jvm]\\ abstract fun getAuthenticatedCaller(): MiskCaller?

"},{"location":"0.x/misk/misk/misk.security.cert/","title":"Package-level declarations - Misk","text":"

//misk/misk.security.cert

"},{"location":"0.x/misk/misk/misk.security.cert/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.cert/#types","title":"Types","text":"Name Summary X500Name [jvm]data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/#properties","title":"Properties","text":"Name Summary isSelfSigned [jvm]val X509Certificate.isSelfSigned: Boolean"},{"location":"0.x/misk/misk/misk.security.cert/#functions","title":"Functions","text":"Name Summary isSignedBy [jvm]fun X509Certificate.isSignedBy(key: PublicKey): Booleanfun X509Certificate.isSignedBy(cert: Certificate): Boolean"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/","title":"isSelfSigned - Misk","text":"

//misk/misk.security.cert/isSelfSigned

"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/#isselfsigned","title":"isSelfSigned","text":"

[jvm]\\ val X509Certificate.isSelfSigned: Boolean

"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/","title":"isSignedBy - Misk","text":"

//misk/misk.security.cert/isSignedBy

"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/#issignedby","title":"isSignedBy","text":"

[jvm]\\ fun X509Certificate.isSignedBy(cert: Certificate): Boolean

fun X509Certificate.isSignedBy(key: PublicKey): Boolean

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/","title":"X500Name - Misk","text":"

//misk/misk.security.cert/X500Name

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#x500name","title":"X500Name","text":"

[jvm]\\ data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#constructors","title":"Constructors","text":"X500Name [jvm]constructor(components: Map<String, String>)constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#properties","title":"Properties","text":"Name Summary commonName [jvm]val commonName: String? country [jvm]val country: String? locality [jvm]val locality: String? organization [jvm]val organization: String? organizationalUnit [jvm]val organizationalUnit: String? state [jvm]val state: String?"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/","title":"X500Name - Misk","text":"

//misk/misk.security.cert/X500Name/X500Name

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/#x500name","title":"X500Name","text":"

[jvm]\\ constructor(components: Map<String, String>)

constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/","title":"commonName - Misk","text":"

//misk/misk.security.cert/X500Name/commonName

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/#commonname","title":"commonName","text":"

[jvm]\\ val commonName: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/","title":"country - Misk","text":"

//misk/misk.security.cert/X500Name/country

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/#country","title":"country","text":"

[jvm]\\ val country: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/","title":"locality - Misk","text":"

//misk/misk.security.cert/X500Name/locality

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/#locality","title":"locality","text":"

[jvm]\\ val locality: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/","title":"organization - Misk","text":"

//misk/misk.security.cert/X500Name/organization

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/#organization","title":"organization","text":"

[jvm]\\ val organization: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/","title":"organizationalUnit - Misk","text":"

//misk/misk.security.cert/X500Name/organizationalUnit

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/#organizationalunit","title":"organizationalUnit","text":"

[jvm]\\ val organizationalUnit: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/","title":"state - Misk","text":"

//misk/misk.security.cert/X500Name/state

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/#state","title":"state","text":"

[jvm]\\ val state: String?

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/","title":"Companion - Misk","text":"

//misk/misk.security.cert/X500Name/Companion

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(dnString: String): X500Name"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/","title":"parse - Misk","text":"

//misk/misk.security.cert/X500Name/Companion/parse

"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/#parse","title":"parse","text":"

[jvm]\\ fun parse(dnString: String): X500Name

"},{"location":"0.x/misk/misk/misk.security.csp/","title":"Package-level declarations - Misk","text":"

//misk/misk.security.csp

"},{"location":"0.x/misk/misk/misk.security.csp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.csp/#types","title":"Types","text":"Name Summary ContentSecurityPolicy [jvm]annotation class ContentSecurityPolicy(val rules: Array<String>)This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added. ContentSecurityPolicyInterceptor [jvm]class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/","title":"ContentSecurityPolicy - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicy

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/#contentsecuritypolicy","title":"ContentSecurityPolicy","text":"

annotation class ContentSecurityPolicy(val rules: Array<String>)

This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added.

Production CSPs can be very long so a future contribution should add the ability to define CSP into YAML configs and point the @Csp annotation to the config value. This annotation is currently dumb, it adds the rules passed to a Content-Security-Policy header directive, with no inspection or validation. A future change could parse the policy. Developers using this should check out the various browser extensions to verify the actual CSP on their webpages. #### Parameters jvm | | | |---|---| | rules | A list of valid Content-Security-Policy rules. | ## Properties | Name | Summary | |---|---| | [rules](rules.md) | [jvm]val [rules](rules.md): [Array](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)> |"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/","title":"rules - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicy/rules

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#rules","title":"rules","text":"

[jvm]\\ val rules: Array<String>

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#parameters","title":"Parameters","text":"

jvm

rules A list of valid Content-Security-Policy rules."},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"

[jvm]\\ class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#constructors","title":"Constructors","text":"ContentSecurityPolicyInterceptor [jvm]constructor(rules: List<String>)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#properties","title":"Properties","text":"Name Summary rules [jvm]val rules: List<String>"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/ContentSecurityPolicyInterceptor

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"

[jvm]\\ constructor(rules: List<String>)

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/","title":"rules - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/rules

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/#rules","title":"rules","text":"

[jvm]\\ val rules: List<String>

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ class Factory@Injectconstructor : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/Factory

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.security.keys/","title":"Package-level declarations - Misk","text":"

//misk/misk.security.keys

"},{"location":"0.x/misk/misk/misk.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.keys/#types","title":"Types","text":"Name Summary KeyService [jvm]interface KeyServiceHandles encryption and decryption using keys stored in a key management service"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/","title":"KeyService - Misk","text":"

//misk/misk.security.keys/KeyService

"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#keyservice","title":"KeyService","text":"

[jvm]\\ interface KeyService

Handles encryption and decryption using keys stored in a key management service

"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#functions","title":"Functions","text":"Name Summary decrypt [jvm]abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteStringdecrypts the provided cipher text using the given stored key encrypt [jvm]abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteStringencrypts the provided plain text using the given stored key"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/","title":"decrypt - Misk","text":"

//misk/misk.security.keys/KeyService/decrypt

"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/#decrypt","title":"decrypt","text":"

[jvm]\\ abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteString

decrypts the provided cipher text using the given stored key

"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/","title":"encrypt - Misk","text":"

//misk/misk.security.keys/KeyService/encrypt

"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/#encrypt","title":"encrypt","text":"

[jvm]\\ abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteString

encrypts the provided plain text using the given stored key

"},{"location":"0.x/misk/misk/misk.security.ssl/","title":"Package-level declarations - Misk","text":"

//misk/misk.security.ssl

"},{"location":"0.x/misk/misk/misk.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.ssl/#types","title":"Types","text":"Name Summary CipherSuites [jvm]object CipherSuites ClientCertChain [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertChainQualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any) ClientCertIssuer [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertIssuerQualifier annotation for an ActionScoped containing the issuer of the client cert ClientCertSubject [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertSubjectQualifier annotation for an ActionScoped containing the subject of the client cert TlsProtocols [jvm]object TlsProtocols"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/","title":"CipherSuites - Misk","text":"

//misk/misk.security.ssl/CipherSuites

"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#ciphersuites","title":"CipherSuites","text":"

[jvm]\\ object CipherSuites

"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/","title":"compatible - Misk","text":"

//misk/misk.security.ssl/CipherSuites/compatible

"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/#compatible","title":"compatible","text":"

[jvm]\\ val compatible: Array<String>

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/","title":"ClientCertChain - Misk","text":"

//misk/misk.security.ssl/ClientCertChain

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/#clientcertchain","title":"ClientCertChain","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])

annotation class ClientCertChain

Qualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any)

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/","title":"ClientCertIssuer - Misk","text":"

//misk/misk.security.ssl/ClientCertIssuer

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/#clientcertissuer","title":"ClientCertIssuer","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])

annotation class ClientCertIssuer

Qualifier annotation for an ActionScoped containing the issuer of the client cert

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/","title":"ClientCertSubject - Misk","text":"

//misk/misk.security.ssl/ClientCertSubject

"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/#clientcertsubject","title":"ClientCertSubject","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])

annotation class ClientCertSubject

Qualifier annotation for an ActionScoped containing the subject of the client cert

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/","title":"TlsProtocols - Misk","text":"

//misk/misk.security.ssl/TlsProtocols

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#tlsprotocols","title":"TlsProtocols","text":"

[jvm]\\ object TlsProtocols

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>List of safe to use TLS protocols, in preferred order restricted [jvm]val restricted: Array<String>List of modern TLS protocols for extra security, in preferred order"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/","title":"compatible - Misk","text":"

//misk/misk.security.ssl/TlsProtocols/compatible

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/#compatible","title":"compatible","text":"

[jvm]\\ val compatible: Array<String>

List of safe to use TLS protocols, in preferred order

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/","title":"restricted - Misk","text":"

//misk/misk.security.ssl/TlsProtocols/restricted

"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/#restricted","title":"restricted","text":"

[jvm]\\ val restricted: Array<String>

List of modern TLS protocols for extra security, in preferred order

"},{"location":"0.x/misk/misk/misk.tasks/","title":"Package-level declarations - Misk","text":"

//misk/misk.tasks

"},{"location":"0.x/misk/misk/misk.tasks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.tasks/#types","title":"Types","text":"Name Summary DelayedTask [jvm]class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : DelayedA DelayedTask is a task that runs in the future RepeatedTaskQueue [jvm]class RepeatedTaskQueue : AbstractExecutionThreadServiceA RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution. RepeatedTaskQueueConfig [jvm]data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1) RepeatedTaskQueueFactory [jvm]@Singletonclass RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory) RepeatedTaskQueueMetrics [jvm]@Singletonclass RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics) Result [jvm]data class Result(val status: Status, val nextDelay: Duration) Status [jvm]enum Status : Enum<Status>"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/","title":"DelayedTask - Misk","text":"

//misk/misk.tasks/DelayedTask

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#delayedtask","title":"DelayedTask","text":"

[jvm]\\ class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : Delayed

A DelayedTask is a task that runs in the future

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#constructors","title":"Constructors","text":"DelayedTask [jvm]constructor(clock: Clock, executionTime: Instant, task: () -> Result)"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#properties","title":"Properties","text":"Name Summary task [jvm]val task: () -> Result"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Delayed): Int getDelay [jvm]open override fun getDelay(unit: TimeUnit): Long"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/","title":"DelayedTask - Misk","text":"

//misk/misk.tasks/DelayedTask/DelayedTask

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/#delayedtask","title":"DelayedTask","text":"

[jvm]\\ constructor(clock: Clock, executionTime: Instant, task: () -> Result)

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/","title":"compareTo - Misk","text":"

//misk/misk.tasks/DelayedTask/compareTo

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/#compareto","title":"compareTo","text":"

[jvm]\\ open operator override fun compareTo(other: Delayed): Int

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/","title":"getDelay - Misk","text":"

//misk/misk.tasks/DelayedTask/getDelay

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/#getdelay","title":"getDelay","text":"

[jvm]\\ open override fun getDelay(unit: TimeUnit): Long

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/","title":"task - Misk","text":"

//misk/misk.tasks/DelayedTask/task

"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/#task","title":"task","text":"

[jvm]\\ val task: () -> Result

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/","title":"RepeatedTaskQueue - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueue

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#repeatedtaskqueue","title":"RepeatedTaskQueue","text":"

[jvm]\\ class RepeatedTaskQueue : AbstractExecutionThreadService

A RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution.

RepeatedTaskQueue implements the Service interface, which requires proper startup and shutdown. Alternatively, you can add new instances to the Service multibind.

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean schedule [jvm]@JvmOverloadsfun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client scheduleWithBackoff [jvm]@JvmOverloadsfun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/","title":"name - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueue/name

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/","title":"scheduleWithBackoff - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueue/scheduleWithBackoff

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/#schedulewithbackoff","title":"scheduleWithBackoff","text":"

[jvm]\\

@JvmOverloads

fun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)

Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/","title":"schedule - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueue/schedule

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/#schedule","title":"schedule","text":"

[jvm]\\

@JvmOverloads

fun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)

Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/","title":"Companion - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueue/Companion

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"

[jvm]\\ data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1)

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#constructors","title":"Constructors","text":"RepeatedTaskQueueConfig [jvm]@JvmOverloadsconstructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#properties","title":"Properties","text":"Name Summary default_jitter_ms [jvm]val default_jitter_ms: Long = 50The default amount of jitter to use when scheduling backoffs. default_max_delay_sec [jvm]val default_max_delay_sec: Long = 60The default maximum backoff time. num_parallel_tasks [jvm]val num_parallel_tasks: Int = 1The fixed number of parallel tasks to run."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#functions","title":"Functions","text":"Name Summary defaultBackoff [jvm]fun defaultBackoff(initialDelay: Duration): BackoffConstruct an ExponentialBackoff from the initial delay using the default configs."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig/RepeatedTaskQueueConfig

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"

[jvm]\\

@JvmOverloads

constructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/","title":"defaultBackoff - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig/defaultBackoff

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/#defaultbackoff","title":"defaultBackoff","text":"

[jvm]\\ fun defaultBackoff(initialDelay: Duration): Backoff

Construct an ExponentialBackoff from the initial delay using the default configs.

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/","title":"default_jitter_ms - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig/default_jitter_ms

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/#default_jitter_ms","title":"default_jitter_ms","text":"

[jvm]\\ val default_jitter_ms: Long = 50

The default amount of jitter to use when scheduling backoffs.

Can be overridden when scheduling a tasks.

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/","title":"default_max_delay_sec - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig/default_max_delay_sec

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/#default_max_delay_sec","title":"default_max_delay_sec","text":"

[jvm]\\ val default_max_delay_sec: Long = 60

The default maximum backoff time.

Can be overridden when scheduling a task.

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/","title":"num_parallel_tasks - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueConfig/num_parallel_tasks

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/#num_parallel_tasks","title":"num_parallel_tasks","text":"

[jvm]\\ val num_parallel_tasks: Int = 1

The fixed number of parallel tasks to run.

If -1 then an unbounded number of parallel tasks are allowed. An unbounded number of tasks can be useful for an App that needs to dynamically compute the number of tasks at runtime. However, the App is then responsible for ensuring an upper bound for the number of tasks submitted.

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueFactory

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"

[jvm]\\ @Singleton

class RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#constructors","title":"Constructors","text":"RepeatedTaskQueueFactory [jvm]@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#functions","title":"Functions","text":"Name Summary forTesting [jvm]@JvmOverloadsfun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue for testing new [jvm]@JvmOverloadsfun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueFactory/RepeatedTaskQueueFactory

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"

[jvm]\\

@Inject

constructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/","title":"forTesting - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueFactory/forTesting

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/#fortesting","title":"forTesting","text":"

[jvm]\\

@JvmOverloads

fun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueue

Builds a new instance of a RepeatedTaskQueue for testing

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/","title":"new - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueFactory/new

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/#new","title":"new","text":"

[jvm]\\

@JvmOverloads

fun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueue

Builds a new instance of a RepeatedTaskQueue

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueMetrics

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"

[jvm]\\ @Singleton

class RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics)

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#constructors","title":"Constructors","text":"RepeatedTaskQueueMetrics [jvm]@Injectconstructor(metrics: Metrics)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"

//misk/misk.tasks/RepeatedTaskQueueMetrics/RepeatedTaskQueueMetrics

"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"

[jvm]\\

@Inject

constructor(metrics: Metrics)

"},{"location":"0.x/misk/misk/misk.tasks/-result/","title":"Result - Misk","text":"

//misk/misk.tasks/Result

"},{"location":"0.x/misk/misk/misk.tasks/-result/#result","title":"Result","text":"

[jvm]\\ data class Result(val status: Status, val nextDelay: Duration)

"},{"location":"0.x/misk/misk/misk.tasks/-result/#constructors","title":"Constructors","text":"Result [jvm]constructor(status: Status, nextDelay: Duration)"},{"location":"0.x/misk/misk/misk.tasks/-result/#properties","title":"Properties","text":"Name Summary nextDelay [jvm]val nextDelay: Duration status [jvm]val status: Status"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/","title":"Result - Misk","text":"

//misk/misk.tasks/Result/Result

"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/#result","title":"Result","text":"

[jvm]\\ constructor(status: Status, nextDelay: Duration)

"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/","title":"nextDelay - Misk","text":"

//misk/misk.tasks/Result/nextDelay

"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/#nextdelay","title":"nextDelay","text":"

[jvm]\\ val nextDelay: Duration

"},{"location":"0.x/misk/misk/misk.tasks/-result/status/","title":"status - Misk","text":"

//misk/misk.tasks/Result/status

"},{"location":"0.x/misk/misk/misk.tasks/-result/status/#status","title":"status","text":"

[jvm]\\ val status: Status

"},{"location":"0.x/misk/misk/misk.tasks/-status/","title":"Status - Misk","text":"

//misk/misk.tasks/Status

"},{"location":"0.x/misk/misk/misk.tasks/-status/#status","title":"Status","text":"

[jvm]\\ enum Status : Enum<Status>

"},{"location":"0.x/misk/misk/misk.tasks/-status/#entries","title":"Entries","text":"OK [jvm]OKThe task completed successfully and processed work NO_WORK [jvm]NO_WORKThe task had no work to complete FAILED [jvm]FAILEDThe task resulted in an error NO_RESCHEDULE [jvm]NO_RESCHEDULEThe task should not be rescheduled"},{"location":"0.x/misk/misk/misk.tasks/-status/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Status>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored. valueOf [jvm]fun valueOf(value: String): StatusReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Status>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.tasks/-status/entries/","title":"entries - Misk","text":"

//misk/misk.tasks/Status/entries

"},{"location":"0.x/misk/misk/misk.tasks/-status/entries/#entries","title":"entries","text":"

[jvm]\\ val entries: EnumEntries<Status>

Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.

This method may be used to iterate over the enum entries.

"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/","title":"metricLabel - Misk","text":"

//misk/misk.tasks/Status/metricLabel

"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/#metriclabel","title":"metricLabel","text":"

[jvm]\\ fun metricLabel(): String

The metric label for the status. This is used instead of name() in case the code is refactored.

"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/","title":"valueOf - Misk","text":"

//misk/misk.tasks/Status/valueOf

"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#valueof","title":"valueOf","text":"

[jvm]\\ fun valueOf(value: String): Status

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.tasks/-status/values/","title":"values - Misk","text":"

//misk/misk.tasks/Status/values

"},{"location":"0.x/misk/misk/misk.tasks/-status/values/#values","title":"values","text":"

[jvm]\\ fun values(): Array<Status>

Returns an array containing the constants of this enum type, in the order they\u2019re declared.

This method may be used to iterate over the constants.

"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/","title":"FAILED - Misk","text":"

//misk/misk.tasks/Status/FAILED

"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#failed","title":"FAILED","text":"

[jvm]\\ FAILED

The task resulted in an error

"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/","title":"NO_RESCHEDULE - Misk","text":"

//misk/misk.tasks/Status/NO_RESCHEDULE

"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#no_reschedule","title":"NO_RESCHEDULE","text":"

[jvm]\\ NO_RESCHEDULE

The task should not be rescheduled

"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/","title":"NO_WORK - Misk","text":"

//misk/misk.tasks/Status/NO_WORK

"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#no_work","title":"NO_WORK","text":"

[jvm]\\ NO_WORK

The task had no work to complete

"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/","title":"OK - Misk","text":"

//misk/misk.tasks/Status/OK

"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#ok","title":"OK","text":"

[jvm]\\ OK

The task completed successfully and processed work

"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.time/","title":"Package-level declarations - Misk","text":"

//misk/misk.time

"},{"location":"0.x/misk/misk/misk.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.time/#types","title":"Types","text":"Name Summary ForceUtcTimeZoneService [jvm]@Singletonclass ForceUtcTimeZoneService@Injectconstructor : AbstractIdleServiceForces the default JVM timezone to UTC."},{"location":"0.x/misk/misk/misk.time/#functions","title":"Functions","text":"Name Summary timed [jvm]fun <T> timed(f: () -> T): Pair<Duration, T>fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>"},{"location":"0.x/misk/misk/misk.time/timed/","title":"timed - Misk","text":"

//misk/misk.time/timed

"},{"location":"0.x/misk/misk/misk.time/timed/#timed","title":"timed","text":"

[jvm]\\ fun <T> timed(f: () -> T): Pair<Duration, T>

fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>

"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"

//misk/misk.time/ForceUtcTimeZoneService

"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"

[jvm]\\ @Singleton

class ForceUtcTimeZoneService@Injectconstructor : AbstractIdleService

Forces the default JVM timezone to UTC.

This is useful when running Misk applications on machines that don\u2019t have UTC set as the system timezone (eg. development machines).

"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#constructors","title":"Constructors","text":"ForceUtcTimeZoneService [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"

//misk/misk.time/ForceUtcTimeZoneService/ForceUtcTimeZoneService

"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web/","title":"Package-level declarations - Misk","text":"

//misk/misk.web

"},{"location":"0.x/misk/misk/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web/#types","title":"Types","text":"Name Summary ConcurrencyLimiterConfig [jvm]data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR) CorsConfig [jvm]data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf()) FeatureBinding [jvm]interface FeatureBindingBinds an HTTP call to a WebAction function. GracefulShutdownConfig [jvm]data class GracefulShutdownConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val idle_timeout: Long = 2000, val max_graceful_wait: Long, val rejection_status_code: Int = HTTP_SERVICE_UNAVAILABLE) HttpCall [jvm]interface HttpCall : HttpRequestA live HTTP call from a client for use by a chain of network interceptors. MiskWebFormBuilder [jvm]class MiskWebFormBuilderProvides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping. MiskWebModule [jvm]class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule NetworkChain [jvm]interface NetworkChain NetworkInterceptor [jvm]interface NetworkInterceptor PathPattern [jvm]class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern> A path with placeholders for variables. Paths may be constant like /app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters. SocketAddress [jvm]sealed class SocketAddressInformation about the socket on which a HTTP call arrived. WebActionSeedDataTransformerFactory [jvm]interface WebActionSeedDataTransformerFactoryCreates a SeedDataTransformer for a specific web Action. WebConfig [jvm]data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val health_dedicated_jetty_instance: Boolean = false, val graceful_shutdown_config: GracefulShutdownConfig? = null, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val jetty_use_input_direct_byte_buffers: Boolean = true, val jetty_use_output_direct_byte_buffers: Boolean = true, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config WebSslConfig [jvm]data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN) WebUnixDomainSocketConfig [jvm]data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/#functions","title":"Functions","text":"Name Summary readUtf8 [jvm]fun Response<*>.readUtf8(): String toMisk [jvm]fun Response.toMisk(): Response<ResponseBody> toResponseBody [jvm]fun String.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as UTF-8.[jvm]fun ByteString.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as bytestring."},{"location":"0.x/misk/misk/misk.web/read-utf8/","title":"readUtf8 - Misk","text":"

//misk/misk.web/readUtf8

"},{"location":"0.x/misk/misk/misk.web/read-utf8/#readutf8","title":"readUtf8","text":"

[jvm]\\ fun Response<*>.readUtf8(): String

"},{"location":"0.x/misk/misk/misk.web/to-misk/","title":"toMisk - Misk","text":"

//misk/misk.web/toMisk

"},{"location":"0.x/misk/misk/misk.web/to-misk/#tomisk","title":"toMisk","text":"

[jvm]\\ fun Response.toMisk(): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web/to-response-body/","title":"toResponseBody - Misk","text":"

//misk/misk.web/toResponseBody

"},{"location":"0.x/misk/misk/misk.web/to-response-body/#toresponsebody","title":"toResponseBody","text":"

[jvm]\\ fun String.toResponseBody(): ResponseBody

Returns a ResponseBody that writes this out as UTF-8.

[jvm]\\ fun ByteString.toResponseBody(): ResponseBody

Returns a ResponseBody that writes this out as bytestring.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"

[jvm]\\ data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR)

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#constructors","title":"Constructors","text":"ConcurrencyLimiterConfig [jvm]@JvmOverloadsconstructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#properties","title":"Properties","text":"Name Summary disabled [jvm]val disabled: Boolean = falseIf true, disables automatic load shedding when degraded. initial_limit [jvm]val initial_limit: Int? = nullInitial limit used by the concurrency limiter. log_level [jvm]val log_level: LevelThe level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility. max_concurrency [jvm]val max_concurrency: Int? = nullMaximum allowed concurrency limit providing an upper bound failsafe. min_limit [jvm]val min_limit: Int? = nullMinimum concurrency limit allowed. strategy [jvm]val strategy: ConcurrencyLimiterStrategyThe algorithm to use for determining concurrency limits."},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/ConcurrencyLimiterConfig

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"

[jvm]\\

@JvmOverloads

constructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/","title":"disabled - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/disabled

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/#disabled","title":"disabled","text":"

[jvm]\\ val disabled: Boolean = false

If true, disables automatic load shedding when degraded.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/","title":"initial_limit - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/initial_limit

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/#initial_limit","title":"initial_limit","text":"

[jvm]\\ val initial_limit: Int? = null

Initial limit used by the concurrency limiter.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/","title":"log_level - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/log_level

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/#log_level","title":"log_level","text":"

[jvm]\\ val log_level: Level

The level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/","title":"max_concurrency - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/max_concurrency

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/#max_concurrency","title":"max_concurrency","text":"

[jvm]\\ val max_concurrency: Int? = null

Maximum allowed concurrency limit providing an upper bound failsafe.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/","title":"min_limit - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/min_limit

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/#min_limit","title":"min_limit","text":"

[jvm]\\ val min_limit: Int? = null

Minimum concurrency limit allowed.

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/","title":"strategy - Misk","text":"

//misk/misk.web/ConcurrencyLimiterConfig/strategy

"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/#strategy","title":"strategy","text":"

[jvm]\\ val strategy: ConcurrencyLimiterStrategy

The algorithm to use for determining concurrency limits.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/","title":"CorsConfig - Misk","text":"

//misk/misk.web/CorsConfig

"},{"location":"0.x/misk/misk/misk.web/-cors-config/#corsconfig","title":"CorsConfig","text":"

[jvm]\\ data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf())

"},{"location":"0.x/misk/misk/misk.web/-cors-config/#constructors","title":"Constructors","text":"CorsConfig [jvm]@JvmOverloadsconstructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())"},{"location":"0.x/misk/misk/misk.web/-cors-config/#properties","title":"Properties","text":"Name Summary allowCredentials [jvm]val allowCredentials: Boolean = trueA boolean indicating if the resource allows requests with credentials. allowedHeaders [jvm]val allowedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be specified when accessing the resources. allowedMethods [jvm]val allowedMethods: Array<String>A comma separated list of HTTP methods that are allowed to be used when accessing the resources. allowedOrigins [jvm]val allowedOrigins: Array<String>A comma separated list of origins that are allowed to access the resources. chainPreflight [jvm]val chainPreflight: Boolean = trueTrue if preflight requests are chained to their target resource for normal handling (as an OPTION request). exposedHeaders [jvm]val exposedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be exposed on the client. preflightMaxAge [jvm]val preflightMaxAge: StringThe number of seconds that preflight requests can be cached by the client."},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/","title":"CorsConfig - Misk","text":"

//misk/misk.web/CorsConfig/CorsConfig

"},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/#corsconfig","title":"CorsConfig","text":"

[jvm]\\

@JvmOverloads

constructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/","title":"allowCredentials - Misk","text":"

//misk/misk.web/CorsConfig/allowCredentials

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/#allowcredentials","title":"allowCredentials","text":"

[jvm]\\ val allowCredentials: Boolean = true

A boolean indicating if the resource allows requests with credentials.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/","title":"allowedHeaders - Misk","text":"

//misk/misk.web/CorsConfig/allowedHeaders

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/#allowedheaders","title":"allowedHeaders","text":"

[jvm]\\ val allowedHeaders: Array<String>

A comma separated list of HTTP headers that are allowed to be specified when accessing the resources.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/","title":"allowedMethods - Misk","text":"

//misk/misk.web/CorsConfig/allowedMethods

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/#allowedmethods","title":"allowedMethods","text":"

[jvm]\\ val allowedMethods: Array<String>

A comma separated list of HTTP methods that are allowed to be used when accessing the resources.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/","title":"allowedOrigins - Misk","text":"

//misk/misk.web/CorsConfig/allowedOrigins

"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/#allowedorigins","title":"allowedOrigins","text":"

[jvm]\\ val allowedOrigins: Array<String>

A comma separated list of origins that are allowed to access the resources.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/","title":"chainPreflight - Misk","text":"

//misk/misk.web/CorsConfig/chainPreflight

"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/#chainpreflight","title":"chainPreflight","text":"

[jvm]\\ val chainPreflight: Boolean = true

True if preflight requests are chained to their target resource for normal handling (as an OPTION request).

"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/","title":"exposedHeaders - Misk","text":"

//misk/misk.web/CorsConfig/exposedHeaders

"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/#exposedheaders","title":"exposedHeaders","text":"

[jvm]\\ val exposedHeaders: Array<String>

A comma separated list of HTTP headers that are allowed to be exposed on the client.

"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/","title":"preflightMaxAge - Misk","text":"

//misk/misk.web/CorsConfig/preflightMaxAge

"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/#preflightmaxage","title":"preflightMaxAge","text":"

[jvm]\\ val preflightMaxAge: String

The number of seconds that preflight requests can be cached by the client.

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/","title":"FeatureBinding - Misk","text":"

//misk/misk.web/FeatureBinding

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#featurebinding","title":"FeatureBinding","text":"

[jvm]\\ interface FeatureBinding

Binds an HTTP call to a WebAction function.

Each web action has several features:

Each bindings claims one or more features that it is responsible for. Some examples:

A binding can claim multiple features. beforeCall is invoked if any features are claimed, and afterCall is only invoked if the return value is claimed.

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#creating-bindings","title":"Creating Bindings","text":"

Each factory is executed once for each endpoint at service startup time. Factories should interrogate the function and claim whichever features that intend to bind. This happens early so Misk can validate that every feature is bound exactly once.

Factories that return null must make no claims. If no claims are made then no binding is executed.

Misk will validate that every feature is claimed exactly once. If a feature is unclaimed that is a fatal error and the service will not be started.

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#binding-execution","title":"Binding Execution","text":"

Once a functions bindings have been created and validated, each binding will be executed once before and once after every each HTTP call. In this method it must bind the features it claimed by providing parameters, reading the request body, writing the response body, or taking the return value.

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#types","title":"Types","text":"Name Summary Claimer [jvm]interface Claimer Factory [jvm]interface Factory Subject [jvm]interface Subject"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#functions","title":"Functions","text":"Name Summary afterCall [jvm]open fun afterCall(subject: FeatureBinding.Subject) beforeCall [jvm]open fun beforeCall(subject: FeatureBinding.Subject)"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/","title":"afterCall - Misk","text":"

//misk/misk.web/FeatureBinding/afterCall

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/#aftercall","title":"afterCall","text":"

[jvm]\\ open fun afterCall(subject: FeatureBinding.Subject)

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/","title":"beforeCall - Misk","text":"

//misk/misk.web/FeatureBinding/beforeCall

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/#beforecall","title":"beforeCall","text":"

[jvm]\\ open fun beforeCall(subject: FeatureBinding.Subject)

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/","title":"Claimer - Misk","text":"

//misk/misk.web/FeatureBinding/Claimer

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#claimer","title":"Claimer","text":"

[jvm]\\ interface Claimer

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#functions","title":"Functions","text":"Name Summary claimParameter [jvm]abstract fun claimParameter(index: Int)abstract fun claimParameter(parameter: KParameter) claimRequestBody [jvm]abstract fun claimRequestBody() claimResponseBody [jvm]abstract fun claimResponseBody() claimReturnValue [jvm]abstract fun claimReturnValue()"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/","title":"claimParameter - Misk","text":"

//misk/misk.web/FeatureBinding/Claimer/claimParameter

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/#claimparameter","title":"claimParameter","text":"

[jvm]\\ abstract fun claimParameter(index: Int)

abstract fun claimParameter(parameter: KParameter)

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/","title":"claimRequestBody - Misk","text":"

//misk/misk.web/FeatureBinding/Claimer/claimRequestBody

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/#claimrequestbody","title":"claimRequestBody","text":"

[jvm]\\ abstract fun claimRequestBody()

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/","title":"claimResponseBody - Misk","text":"

//misk/misk.web/FeatureBinding/Claimer/claimResponseBody

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/#claimresponsebody","title":"claimResponseBody","text":"

[jvm]\\ abstract fun claimResponseBody()

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/","title":"claimReturnValue - Misk","text":"

//misk/misk.web/FeatureBinding/Claimer/claimReturnValue

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/#claimreturnvalue","title":"claimReturnValue","text":"

[jvm]\\ abstract fun claimReturnValue()

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/","title":"Factory - Misk","text":"

//misk/misk.web/FeatureBinding/Factory

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#factory","title":"Factory","text":"

[jvm]\\ interface Factory

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/","title":"create - Misk","text":"

//misk/misk.web/FeatureBinding/Factory/create

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/","title":"Subject - Misk","text":"

//misk/misk.web/FeatureBinding/Subject

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#subject","title":"Subject","text":"

[jvm]\\ interface Subject

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#properties","title":"Properties","text":"Name Summary httpCall [jvm]abstract val httpCall: HttpCall pathMatcher [jvm]abstract val pathMatcher: Matcher webAction [jvm]abstract val webAction: WebAction"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#functions","title":"Functions","text":"Name Summary setParameter [jvm]abstract fun setParameter(index: Int, value: Any?)abstract fun setParameter(parameter: KParameter, value: Any?) takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink takeReturnValue [jvm]abstract fun takeReturnValue(): Any?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/","title":"httpCall - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/httpCall

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/#httpcall","title":"httpCall","text":"

[jvm]\\ abstract val httpCall: HttpCall

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/","title":"pathMatcher - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/pathMatcher

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/#pathmatcher","title":"pathMatcher","text":"

[jvm]\\ abstract val pathMatcher: Matcher

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/","title":"setParameter - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/setParameter

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/#setparameter","title":"setParameter","text":"

[jvm]\\ abstract fun setParameter(parameter: KParameter, value: Any?)

abstract fun setParameter(index: Int, value: Any?)

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/","title":"takeRequestBody - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/takeRequestBody

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/#takerequestbody","title":"takeRequestBody","text":"

[jvm]\\ abstract fun takeRequestBody(): BufferedSource

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/","title":"takeResponseBody - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/takeResponseBody

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"

[jvm]\\ abstract fun takeResponseBody(): BufferedSink

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/","title":"takeReturnValue - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/takeReturnValue

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/#takereturnvalue","title":"takeReturnValue","text":"

[jvm]\\ abstract fun takeReturnValue(): Any?

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/","title":"webAction - Misk","text":"

//misk/misk.web/FeatureBinding/Subject/webAction

"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/#webaction","title":"webAction","text":"

[jvm]\\ abstract val webAction: WebAction

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/","title":"GracefulShutdownConfig - Misk","text":"

//misk/misk.web/GracefulShutdownConfig

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/#gracefulshutdownconfig","title":"GracefulShutdownConfig","text":"

[jvm]\\ data class GracefulShutdownConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val idle_timeout: Long = 2000, val max_graceful_wait: Long, val rejection_status_code: Int = HTTP_SERVICE_UNAVAILABLE)

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/#constructors","title":"Constructors","text":"GracefulShutdownConfig [jvm]@JvmOverloadsconstructor(disabled: Boolean = false, idle_timeout: Long = 2000, max_graceful_wait: Long, rejection_status_code: Int = HTTP_SERVICE_UNAVAILABLE)"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/#properties","title":"Properties","text":"Name Summary disabled [jvm]val disabled: Boolean = falsetrue to explicitly disable graceful shutdown service/interceptor. idle_timeout [jvm]val idle_timeout: Long = 2000Milliseconds no new incoming requests have come in before proceeding with shutdown. max_graceful_wait [jvm]val max_graceful_wait: LongThe maximum amount of time to wait for no in-flight requests and the idle timeout to expire. If <= 0 the service will not limit the amount of time to wait for idle, however it might be forcibly killed by an external source, like kubernetes. rejection_status_code [jvm]val rejection_status_code: IntThe status code to use for rejecting incoming requests after shutdown has begun. If <= 0 the service will not reject incoming requests and wait until new requests have processed and the idle_timeout is reached."},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/-graceful-shutdown-config/","title":"GracefulShutdownConfig - Misk","text":"

//misk/misk.web/GracefulShutdownConfig/GracefulShutdownConfig

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/-graceful-shutdown-config/#gracefulshutdownconfig","title":"GracefulShutdownConfig","text":"

[jvm]\\

@JvmOverloads

constructor(disabled: Boolean = false, idle_timeout: Long = 2000, max_graceful_wait: Long, rejection_status_code: Int = HTTP_SERVICE_UNAVAILABLE)

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/disabled/","title":"disabled - Misk","text":"

//misk/misk.web/GracefulShutdownConfig/disabled

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/disabled/#disabled","title":"disabled","text":"

[jvm]\\ val disabled: Boolean = false

true to explicitly disable graceful shutdown service/interceptor.

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/idle_timeout/","title":"idle_timeout - Misk","text":"

//misk/misk.web/GracefulShutdownConfig/idle_timeout

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/idle_timeout/#idle_timeout","title":"idle_timeout","text":"

[jvm]\\ val idle_timeout: Long = 2000

Milliseconds no new incoming requests have come in before proceeding with shutdown.

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/max_graceful_wait/","title":"max_graceful_wait - Misk","text":"

//misk/misk.web/GracefulShutdownConfig/max_graceful_wait

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/max_graceful_wait/#max_graceful_wait","title":"max_graceful_wait","text":"

[jvm]\\ val max_graceful_wait: Long

The maximum amount of time to wait for no in-flight requests and the idle timeout to expire. If <= 0 the service will not limit the amount of time to wait for idle, however it might be forcibly killed by an external source, like kubernetes.

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/rejection_status_code/","title":"rejection_status_code - Misk","text":"

//misk/misk.web/GracefulShutdownConfig/rejection_status_code

"},{"location":"0.x/misk/misk/misk.web/-graceful-shutdown-config/rejection_status_code/#rejection_status_code","title":"rejection_status_code","text":"

[jvm]\\ val rejection_status_code: Int

The status code to use for rejecting incoming requests after shutdown has begun. If <= 0 the service will not reject incoming requests and wait until new requests have processed and the idle_timeout is reached.

"},{"location":"0.x/misk/misk/misk.web/-http-call/","title":"HttpCall - Misk","text":"

//misk/misk.web/HttpCall

"},{"location":"0.x/misk/misk/misk.web/-http-call/#httpcall","title":"HttpCall","text":"

[jvm]\\ interface HttpCall : HttpRequest

A live HTTP call from a client for use by a chain of network interceptors.

"},{"location":"0.x/misk/misk/misk.web/-http-call/#properties","title":"Properties","text":"Name Summary cookies [jvm]abstract var cookies: List<Cookie>Cookies derived from request\u2019s \"Cookie\" header, if any dispatchMechanism [jvm]abstract val dispatchMechanism: DispatchMechanism linkLayerLocalAddress [jvm]abstract val linkLayerLocalAddress: SocketAddress? networkStatusCode [jvm]abstract val networkStatusCode: IntThe HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec. requestHeaders [jvm]abstract var requestHeaders: Headers responseHeaders [jvm]abstract val responseHeaders: Headers statusCode [jvm]abstract var statusCode: IntMeaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors. url [jvm]abstract val url: HttpUrl"},{"location":"0.x/misk/misk/misk.web/-http-call/#functions","title":"Functions","text":"Name Summary accepts [jvm]open fun accepts(): List<MediaRange> addResponseHeaders [jvm]abstract fun addResponseHeaders(headers: Headers) asOkHttpRequest [jvm]open fun asOkHttpRequest(): Request computeRequestHeader [jvm]open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)Set or replaces an existing HTTP request header. contentType [jvm]open fun contentType(): MediaType? initWebSocketListener [jvm]abstract fun initWebSocketListener(webSocketListener: WebSocketListener)Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls. putRequestBody [jvm]abstract fun putRequestBody(requestBody: BufferedSource)Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics. putResponseBody [jvm]abstract fun putResponseBody(responseBody: BufferedSink)Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics. putWebSocket [jvm]abstract fun putWebSocket(webSocket: WebSocket)Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics. requireTrailers [jvm]abstract fun requireTrailers()Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls. setResponseHeader [jvm]abstract fun setResponseHeader(name: String, value: String) setResponseTrailer [jvm]abstract fun setResponseTrailer(name: String, value: String)Add a trailer. This requires that requireTrailers was called before the response body is written. setStatusCodes [jvm]abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource?Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed. takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink?Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed. takeWebSocket [jvm]abstract fun takeWebSocket(): WebSocket?Claim ownership of the call\u2019s web socket."},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/","title":"accepts - Misk","text":"

//misk/misk.web/HttpCall/accepts

"},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/#accepts","title":"accepts","text":"

[jvm]\\ open fun accepts(): List<MediaRange>

"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/","title":"addResponseHeaders - Misk","text":"

//misk/misk.web/HttpCall/addResponseHeaders

"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/#addresponseheaders","title":"addResponseHeaders","text":"

[jvm]\\ abstract fun addResponseHeaders(headers: Headers)

"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/","title":"asOkHttpRequest - Misk","text":"

//misk/misk.web/HttpCall/asOkHttpRequest

"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/#asokhttprequest","title":"asOkHttpRequest","text":"

[jvm]\\ open fun asOkHttpRequest(): Request

"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/","title":"computeRequestHeader - Misk","text":"

//misk/misk.web/HttpCall/computeRequestHeader

"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/#computerequestheader","title":"computeRequestHeader","text":"

[jvm]\\ open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)

Set or replaces an existing HTTP request header.

"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/","title":"contentType - Misk","text":"

//misk/misk.web/HttpCall/contentType

"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open fun contentType(): MediaType?

"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/","title":"cookies - Misk","text":"

//misk/misk.web/HttpCall/cookies

"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/#cookies","title":"cookies","text":"

[jvm]\\ abstract var cookies: List<Cookie>

Cookies derived from request\u2019s \"Cookie\" header, if any

"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/","title":"initWebSocketListener - Misk","text":"

//misk/misk.web/HttpCall/initWebSocketListener

"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/#initwebsocketlistener","title":"initWebSocketListener","text":"

[jvm]\\ abstract fun initWebSocketListener(webSocketListener: WebSocketListener)

Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls.

"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/","title":"linkLayerLocalAddress - Misk","text":"

//misk/misk.web/HttpCall/linkLayerLocalAddress

"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/#linklayerlocaladdress","title":"linkLayerLocalAddress","text":"

[jvm]\\ abstract val linkLayerLocalAddress: SocketAddress?

"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/","title":"networkStatusCode - Misk","text":"

//misk/misk.web/HttpCall/networkStatusCode

"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/#networkstatuscode","title":"networkStatusCode","text":"

[jvm]\\ abstract val networkStatusCode: Int

The HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec.

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/","title":"putRequestBody - Misk","text":"

//misk/misk.web/HttpCall/putRequestBody

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/#putrequestbody","title":"putRequestBody","text":"

[jvm]\\ abstract fun putRequestBody(requestBody: BufferedSource)

Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics.

This may only be called on calls whose request body has been taken. Otherwise that would be leaked.

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/","title":"putResponseBody - Misk","text":"

//misk/misk.web/HttpCall/putResponseBody

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/#putresponsebody","title":"putResponseBody","text":"

[jvm]\\ abstract fun putResponseBody(responseBody: BufferedSink)

Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics.

This may only be called on calls whose response body has been taken. Otherwise that would be leaked.

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/","title":"putWebSocket - Misk","text":"

//misk/misk.web/HttpCall/putWebSocket

"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/#putwebsocket","title":"putWebSocket","text":"

[jvm]\\ abstract fun putWebSocket(webSocket: WebSocket)

Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics.

This may only be called on calls whose web socket has been taken. Otherwise that would be leaked.

"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/","title":"requireTrailers - Misk","text":"

//misk/misk.web/HttpCall/requireTrailers

"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/#requiretrailers","title":"requireTrailers","text":"

[jvm]\\ abstract fun requireTrailers()

Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls.

"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/","title":"responseHeaders - Misk","text":"

//misk/misk.web/HttpCall/responseHeaders

"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/#responseheaders","title":"responseHeaders","text":"

[jvm]\\ abstract val responseHeaders: Headers

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/","title":"setResponseHeader - Misk","text":"

//misk/misk.web/HttpCall/setResponseHeader

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/#setresponseheader","title":"setResponseHeader","text":"

[jvm]\\ abstract fun setResponseHeader(name: String, value: String)

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/","title":"setResponseTrailer - Misk","text":"

//misk/misk.web/HttpCall/setResponseTrailer

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/#setresponsetrailer","title":"setResponseTrailer","text":"

[jvm]\\ abstract fun setResponseTrailer(name: String, value: String)

Add a trailer. This requires that requireTrailers was called before the response body is written.

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/","title":"setStatusCodes - Misk","text":"

//misk/misk.web/HttpCall/setStatusCodes

"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/#setstatuscodes","title":"setStatusCodes","text":"

[jvm]\\ abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)

Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics

"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/","title":"statusCode - Misk","text":"

//misk/misk.web/HttpCall/statusCode

"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/#statuscode","title":"statusCode","text":"

[jvm]\\ abstract var statusCode: Int

Meaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors.

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/","title":"takeRequestBody - Misk","text":"

//misk/misk.web/HttpCall/takeRequestBody

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/#takerequestbody","title":"takeRequestBody","text":"

[jvm]\\ abstract fun takeRequestBody(): BufferedSource?

Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed.

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/","title":"takeResponseBody - Misk","text":"

//misk/misk.web/HttpCall/takeResponseBody

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"

[jvm]\\ abstract fun takeResponseBody(): BufferedSink?

Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed.

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/","title":"takeWebSocket - Misk","text":"

//misk/misk.web/HttpCall/takeWebSocket

"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/#takewebsocket","title":"takeWebSocket","text":"

[jvm]\\ abstract fun takeWebSocket(): WebSocket?

Claim ownership of the call\u2019s web socket.

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"

//misk/misk.web/MiskWebFormBuilder

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"

[jvm]\\ class MiskWebFormBuilder

Provides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping.

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#constructors","title":"Constructors","text":"MiskWebFormBuilder [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Field [jvm]data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list. Type [jvm]data class Type(val fields: List<MiskWebFormBuilder.Field>)Akin to a Proto Message, a Type has a list of fields"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#functions","title":"Functions","text":"Name Summary calculateTypes [jvm]fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/MiskWebFormBuilder

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/","title":"calculateTypes - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/calculateTypes

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/#calculatetypes","title":"calculateTypes","text":"

[jvm]\\ fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/","title":"Companion - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Companion

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#functions","title":"Functions","text":"Name Summary createEnumField [jvm]fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" createSyntheticEnumField [jvm]fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" maybeCreatePrimitiveField [jvm]fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped."},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/","title":"createEnumField - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Companion/createEnumField

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/#createenumfield","title":"createEnumField","text":"

[jvm]\\ fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field

Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/","title":"createSyntheticEnumField - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Companion/createSyntheticEnumField

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/#createsyntheticenumfield","title":"createSyntheticEnumField","text":"

[jvm]\\ fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.Field

Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/","title":"maybeCreatePrimitiveField - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Companion/maybeCreatePrimitiveField

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/#maybecreateprimitivefield","title":"maybeCreatePrimitiveField","text":"

[jvm]\\ fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?

Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped.

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/","title":"Field - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#field","title":"Field","text":"

[jvm]\\ data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())

Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list.

Enums are encoded to contain their values within their Type definition as opposed to a unique Type.

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#constructors","title":"Constructors","text":"Field [jvm]@JvmOverloadsconstructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String repeated [jvm]val repeated: Boolean type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/","title":"Field - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field/Field

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/#field","title":"Field","text":"

[jvm]\\

@JvmOverloads

constructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/","title":"annotations - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field/annotations

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/#annotations","title":"annotations","text":"

[jvm]\\ val annotations: List<String>

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/","title":"name - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field/name

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/","title":"repeated - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field/repeated

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/#repeated","title":"repeated","text":"

[jvm]\\ val repeated: Boolean

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/","title":"type - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Field/type

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/#type","title":"type","text":"

[jvm]\\ val type: String

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/","title":"Type - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Type

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#type","title":"Type","text":"

[jvm]\\ data class Type(val fields: List<MiskWebFormBuilder.Field>)

Akin to a Proto Message, a Type has a list of fields

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#constructors","title":"Constructors","text":"Type [jvm]constructor(fields: List<MiskWebFormBuilder.Field>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#properties","title":"Properties","text":"Name Summary fields [jvm]val fields: List<MiskWebFormBuilder.Field>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/","title":"Type - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Type/Type

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/#type","title":"Type","text":"

[jvm]\\ constructor(fields: List<MiskWebFormBuilder.Field>)

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/","title":"fields - Misk","text":"

//misk/misk.web/MiskWebFormBuilder/Type/fields

"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/#fields","title":"fields","text":"

[jvm]\\ val fields: List<MiskWebFormBuilder.Field>

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/","title":"MiskWebModule - Misk","text":"

//misk/misk.web/MiskWebModule

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"

[jvm]\\ class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#constructors","title":"Constructors","text":"MiskWebModule [jvm]@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#types","title":"Types","text":"Name Summary MiskCallerProvider [jvm]class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideGzipHandler [jvm]@Provides@Singletonfun provideGzipHandler(): GzipHandler provideStatisticsHandler [jvm]@Provides@Singletonfun provideStatisticsHandler(): StatisticsHandler readinessRefreshQueue [jvm]@Provides@Singletonfun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/","title":"MiskWebModule - Misk","text":"

//misk/misk.web/MiskWebModule/MiskWebModule

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"

[jvm]\\

@JvmOverloads

constructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/","title":"provideGzipHandler - Misk","text":"

//misk/misk.web/MiskWebModule/provideGzipHandler

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/#providegziphandler","title":"provideGzipHandler","text":"

[jvm]\\

@Provides

@Singleton

fun provideGzipHandler(): GzipHandler

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/","title":"provideStatisticsHandler - Misk","text":"

//misk/misk.web/MiskWebModule/provideStatisticsHandler

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/#providestatisticshandler","title":"provideStatisticsHandler","text":"

[jvm]\\

@Provides

@Singleton

fun provideStatisticsHandler(): StatisticsHandler

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/","title":"readinessRefreshQueue - Misk","text":"

//misk/misk.web/MiskWebModule/readinessRefreshQueue

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/#readinessrefreshqueue","title":"readinessRefreshQueue","text":"

[jvm]\\

@Provides

@Singleton

fun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"

//misk/misk.web/MiskWebModule/MiskCallerProvider

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"

[jvm]\\ class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#constructors","title":"Constructors","text":"MiskCallerProvider [jvm]@Injectconstructor(authenticators: List<MiskCallerAuthenticator>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): MiskCaller?"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"

//misk/misk.web/MiskWebModule/MiskCallerProvider/MiskCallerProvider

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"

[jvm]\\

@Inject

constructor(authenticators: List<MiskCallerAuthenticator>)

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/","title":"get - Misk","text":"

//misk/misk.web/MiskWebModule/MiskCallerProvider/get

"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/#get","title":"get","text":"

[jvm]\\ open override fun get(): MiskCaller?

"},{"location":"0.x/misk/misk/misk.web/-network-chain/","title":"NetworkChain - Misk","text":"

//misk/misk.web/NetworkChain

"},{"location":"0.x/misk/misk/misk.web/-network-chain/#networkchain","title":"NetworkChain","text":"

[jvm]\\ interface NetworkChain

"},{"location":"0.x/misk/misk/misk.web/-network-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ActionThe action for this call. httpCall [jvm]abstract val httpCall: HttpCallThe live HTTP call. You can access hot streams on this call. webAction [jvm]abstract val webAction: WebActionThe action instance this call is routing to."},{"location":"0.x/misk/misk/misk.web/-network-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(httpCall: HttpCall)Invoke the next call in the interceptor chain."},{"location":"0.x/misk/misk/misk.web/-network-chain/action/","title":"action - Misk","text":"

//misk/misk.web/NetworkChain/action

"},{"location":"0.x/misk/misk/misk.web/-network-chain/action/#action","title":"action","text":"

[jvm]\\ abstract val action: Action

The action for this call.

"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/","title":"httpCall - Misk","text":"

//misk/misk.web/NetworkChain/httpCall

"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/#httpcall","title":"httpCall","text":"

[jvm]\\ abstract val httpCall: HttpCall

The live HTTP call. You can access hot streams on this call.

"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/","title":"proceed - Misk","text":"

//misk/misk.web/NetworkChain/proceed

"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/#proceed","title":"proceed","text":"

[jvm]\\ abstract fun proceed(httpCall: HttpCall)

Invoke the next call in the interceptor chain.

"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/","title":"webAction - Misk","text":"

//misk/misk.web/NetworkChain/webAction

"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/#webaction","title":"webAction","text":"

[jvm]\\ abstract val webAction: WebAction

The action instance this call is routing to.

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/","title":"NetworkInterceptor - Misk","text":"

//misk/misk.web/NetworkInterceptor

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#networkinterceptor","title":"NetworkInterceptor","text":"

interface NetworkInterceptor

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#inheritors","title":"Inheritors","text":"ContentSecurityPolicyInterceptor ExceptionHandlingInterceptor ExclusiveTimingInterceptor RebalancingInterceptor RequestLoggingInterceptor WideOpenDevelopmentInterceptor"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web/NetworkInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ abstract fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web/NetworkInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#factory","title":"Factory","text":"

interface Factory

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory Factory Factory InternalErrorInterceptorFactory Factory Factory WideOpenDevelopmentInterceptorFactory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web/NetworkInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/","title":"PathPattern - Misk","text":"

//misk/misk.web/PathPattern

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#pathpattern","title":"PathPattern","text":"

[jvm]\\ class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern>

A path with placeholders for variables. Paths may be constant like /app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters.

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#constructors","title":"Constructors","text":"PathPattern [jvm]constructor(pattern: String, regex: Pattern, variableNames: List<String>, numRegexVariables: Int, numSegments: Int, matchesWildcardPath: Boolean)"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#properties","title":"Properties","text":"Name Summary matchesWildcardPath [jvm]val matchesWildcardPath: Boolean numRegexVariables [jvm]val numRegexVariables: Int numSegments [jvm]val numSegments: Int pattern [jvm]val pattern: String regex [jvm]val regex: Pattern variableNames [jvm]val variableNames: List<String>"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: PathPattern): IntCompares path patterns by specificity with the more specific pattern ordered first. equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int matcher [jvm]fun matcher(requestUrl: HttpUrl): Matcher?Returns a Matcher if requestUrl can be matched, else null toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-path-pattern/","title":"PathPattern - Misk","text":"

//misk/misk.web/PathPattern/PathPattern

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-path-pattern/#pathpattern","title":"PathPattern","text":"

[jvm]\\ constructor(pattern: String, regex: Pattern, variableNames: List<String>, numRegexVariables: Int, numSegments: Int, matchesWildcardPath: Boolean)

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/","title":"compareTo - Misk","text":"

//misk/misk.web/PathPattern/compareTo

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/#compareto","title":"compareTo","text":"

[jvm]\\ open operator override fun compareTo(other: PathPattern): Int

Compares path patterns by specificity with the more specific pattern ordered first.

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/","title":"equals - Misk","text":"

//misk/misk.web/PathPattern/equals

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/#equals","title":"equals","text":"

[jvm]\\ open operator override fun equals(other: Any?): Boolean

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/","title":"hashCode - Misk","text":"

//misk/misk.web/PathPattern/hashCode

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/#hashcode","title":"hashCode","text":"

[jvm]\\ open override fun hashCode(): Int

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/","title":"matcher - Misk","text":"

//misk/misk.web/PathPattern/matcher

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/#matcher","title":"matcher","text":"

[jvm]\\ fun matcher(requestUrl: HttpUrl): Matcher?

Returns a Matcher if requestUrl can be matched, else null

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/","title":"matchesWildcardPath - Misk","text":"

//misk/misk.web/PathPattern/matchesWildcardPath

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/#matcheswildcardpath","title":"matchesWildcardPath","text":"

[jvm]\\ val matchesWildcardPath: Boolean

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/","title":"numRegexVariables - Misk","text":"

//misk/misk.web/PathPattern/numRegexVariables

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/#numregexvariables","title":"numRegexVariables","text":"

[jvm]\\ val numRegexVariables: Int

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/","title":"numSegments - Misk","text":"

//misk/misk.web/PathPattern/numSegments

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/#numsegments","title":"numSegments","text":"

[jvm]\\ val numSegments: Int

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/","title":"pattern - Misk","text":"

//misk/misk.web/PathPattern/pattern

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/#pattern","title":"pattern","text":"

[jvm]\\ val pattern: String

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/","title":"regex - Misk","text":"

//misk/misk.web/PathPattern/regex

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/#regex","title":"regex","text":"

[jvm]\\ val regex: Pattern

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/","title":"toString - Misk","text":"

//misk/misk.web/PathPattern/toString

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/","title":"variableNames - Misk","text":"

//misk/misk.web/PathPattern/variableNames

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/#variablenames","title":"variableNames","text":"

[jvm]\\ val variableNames: List<String>

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/","title":"Companion - Misk","text":"

//misk/misk.web/PathPattern/Companion

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(pattern: String): PathPattern"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/","title":"parse - Misk","text":"

//misk/misk.web/PathPattern/Companion/parse

"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/#parse","title":"parse","text":"

[jvm]\\ fun parse(pattern: String): PathPattern

"},{"location":"0.x/misk/misk/misk.web/-socket-address/","title":"SocketAddress - Misk","text":"

//misk/misk.web/SocketAddress

"},{"location":"0.x/misk/misk/misk.web/-socket-address/#socketaddress","title":"SocketAddress","text":"

sealed class SocketAddress

Information about the socket on which a HTTP call arrived.

"},{"location":"0.x/misk/misk/misk.web/-socket-address/#inheritors","title":"Inheritors","text":"Network Unix"},{"location":"0.x/misk/misk/misk.web/-socket-address/#types","title":"Types","text":"Name Summary Network [jvm]class Network(val ipAddress: String, val port: Int) : SocketAddress Unix [jvm]class Unix(val path: String) : SocketAddress"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/","title":"Network - Misk","text":"

//misk/misk.web/SocketAddress/Network

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#network","title":"Network","text":"

[jvm]\\ class Network(val ipAddress: String, val port: Int) : SocketAddress

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#constructors","title":"Constructors","text":"Network [jvm]constructor(ipAddress: String, port: Int)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#properties","title":"Properties","text":"Name Summary ipAddress [jvm]val ipAddress: String port [jvm]val port: Int"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/","title":"Network - Misk","text":"

//misk/misk.web/SocketAddress/Network/Network

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/#network","title":"Network","text":"

[jvm]\\ constructor(ipAddress: String, port: Int)

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/","title":"ipAddress - Misk","text":"

//misk/misk.web/SocketAddress/Network/ipAddress

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/#ipaddress","title":"ipAddress","text":"

[jvm]\\ val ipAddress: String

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/","title":"port - Misk","text":"

//misk/misk.web/SocketAddress/Network/port

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/#port","title":"port","text":"

[jvm]\\ val port: Int

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/","title":"Unix - Misk","text":"

//misk/misk.web/SocketAddress/Unix

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#unix","title":"Unix","text":"

[jvm]\\ class Unix(val path: String) : SocketAddress

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#constructors","title":"Constructors","text":"Unix [jvm]constructor(path: String)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#properties","title":"Properties","text":"Name Summary path [jvm]val path: String"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/","title":"Unix - Misk","text":"

//misk/misk.web/SocketAddress/Unix/Unix

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/#unix","title":"Unix","text":"

[jvm]\\ constructor(path: String)

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/","title":"path - Misk","text":"

//misk/misk.web/SocketAddress/Unix/path

"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/#path","title":"path","text":"

[jvm]\\ val path: String

"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/","title":"WebActionSeedDataTransformerFactory - Misk","text":"

//misk/misk.web/WebActionSeedDataTransformerFactory

"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/#webactionseeddatatransformerfactory","title":"WebActionSeedDataTransformerFactory","text":"

[jvm]\\ interface WebActionSeedDataTransformerFactory

Creates a SeedDataTransformer for a specific web Action.

This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<WebActionSeedDataTransformerFactory>().toInstance(WebActionSeedDataTransformerFactory(...))\n
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(pathPattern: PathPattern, action: Action): SeedDataTransformer?Returns null to not transform the map on action."},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/create/","title":"create - Misk","text":"

//misk/misk.web/WebActionSeedDataTransformerFactory/create

"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(pathPattern: PathPattern, action: Action): SeedDataTransformer?

Returns null to not transform the map on action.

"},{"location":"0.x/misk/misk/misk.web/-web-config/","title":"WebConfig - Misk","text":"

//misk/misk.web/WebConfig

"},{"location":"0.x/misk/misk/misk.web/-web-config/#webconfig","title":"WebConfig","text":"

[jvm]\\ data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val health_dedicated_jetty_instance: Boolean = false, val graceful_shutdown_config: GracefulShutdownConfig? = null, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val jetty_use_input_direct_byte_buffers: Boolean = true, val jetty_use_output_direct_byte_buffers: Boolean = true, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config

"},{"location":"0.x/misk/misk/misk.web/-web-config/#constructors","title":"Constructors","text":"WebConfig [jvm]@JvmOverloadsconstructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, health_dedicated_jetty_instance: Boolean = false, graceful_shutdown_config: GracefulShutdownConfig? = null, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, jetty_use_input_direct_byte_buffers: Boolean = true, jetty_use_output_direct_byte_buffers: Boolean = true, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)"},{"location":"0.x/misk/misk/misk.web/-web-config/#properties","title":"Properties","text":"Name Summary acceptors [jvm]val acceptors: Int? = nullNumber of acceptor threads. action_exception_log_level [jvm]val action_exception_log_level: ActionExceptionLogLevelConfig close_connection_percent [jvm]val close_connection_percent: Double = 0.0A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses. concurrency_limiter [jvm]val concurrency_limiter: ConcurrencyLimiterConfig? concurrency_limiter_disabled [jvm]val concurrency_limiter_disabled: Boolean = trueIf true, disables automatic load shedding when degraded. concurrency_limiter_log_level [jvm]val concurrency_limiter_log_level: LevelThe level of log when concurrency shedding. cors [jvm]val cors: Map<String, CorsConfig> enable_thread_pool_health_check [jvm]val enable_thread_pool_health_check: Boolean = falseWires up health checks on whether Jetty\u2019s thread pool is low on threads. enable_thread_pool_queue_metrics [jvm]val enable_thread_pool_queue_metrics: Boolean = falseFlag to enable thread pool queue metrics graceful_shutdown_config [jvm]@ExperimentalMiskApival graceful_shutdown_config: GracefulShutdownConfig? = null gzip [jvm]val gzip: Boolean = trueIf true responses which are larger than the minGzipSize will be compressed. health_dedicated_jetty_instance [jvm]@ExperimentalMiskApival health_dedicated_jetty_instance: Boolean = false health_port [jvm]val health_port: IntIf >= 0, By default, use a dedicated jetty thread pool for health checking. With health_dedicated_jetty_instance = true, use a dedicated jetty instance. host [jvm]val host: String? = nullThe network interface to bind to. Null or 0.0.0.0 to bind to all interfaces. http2 [jvm]val http2: Boolean = falseHTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically. http_header_cache_size [jvm]val http_header_cache_size: Int? = nullThe size of Jetty\u2019s header field cache, in terms of unique character branches. http_request_header_size [jvm]val http_request_header_size: Int? = 32768The maximum allowed size in bytes for the HTTP request line and HTTP request headers. idle_timeout [jvm]val idle_timeout: Long = 0If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed. install_default_not_found_action [jvm]val install_default_not_found_action: Boolean = trueIf true install NotFoundAction, the default action when a path is not found. jetty_initial_session_recv_window [jvm]val jetty_initial_session_recv_window: Int? = nullThe initial size of session\u2019s flow control receive window. jetty_initial_stream_recv_window [jvm]val jetty_initial_stream_recv_window: Int? = nullThe initial size of stream\u2019s flow control receive window. jetty_max_concurrent_streams [jvm]val jetty_max_concurrent_streams: Int? = nullThe maximum number of streams per HTTP/2 connection. jetty_max_thread_pool_queue_size [jvm]val jetty_max_thread_pool_queue_size: Int = 300Maximum number of items in the queue for Jetty\u2019s thread pool. jetty_max_thread_pool_size [jvm]val jetty_max_thread_pool_size: Int = 200Maximum number of threads in Jetty\u2019s thread pool. jetty_min_thread_pool_size [jvm]val jetty_min_thread_pool_size: Int = 8Minimum number of threads in Jetty\u2019s thread pool. jetty_output_buffer_size [jvm]val jetty_output_buffer_size: Int? = nullThe output buffer size of Jetty (default is 32KB). jetty_use_input_direct_byte_buffers [jvm]val jetty_use_input_direct_byte_buffers: Boolean = trueWhether to use direct ByteBuffers for reading. jetty_use_output_direct_byte_buffers [jvm]val jetty_use_output_direct_byte_buffers: Boolean = trueWhether to use direct ByteBuffers for writing. minGzipSize [jvm]val minGzipSize: Int = 1024The minimum size in bytes before the response body will be compressed. override_shutdown_idle_timeout [jvm]val override_shutdown_idle_timeout: Long? = nullThe number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown. port [jvm]val port: IntHTTP port to listen on, or 0 for any available port. queue_size [jvm]val queue_size: Int? = nullThe accept backlog. readiness_max_age_ms [jvm]val readiness_max_age_ms: Int = 10000Maximum age of readiness status. If exceeded readiness will return an error readiness_refresh_interval_ms [jvm]val readiness_refresh_interval_ms: Int = 1000How often readiness will re-run its status check. selectors [jvm]val selectors: Int? = nullNumber of NIO selector threads. shutdown_sleep_ms [jvm]val shutdown_sleep_ms: Int = 0The number of milliseconds to sleep before commencing service shutdown. ssl [jvm]val ssl: WebSslConfig? = null unix_domain_socket [jvm]val unix_domain_socket: WebUnixDomainSocketConfig? = nullConfiguration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy). unix_domain_sockets [jvm]val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = nullConfigurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio) use_virtual_threads [jvm]val use_virtual_threads: Boolean = falseIf possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty."},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/","title":"WebConfig - Misk","text":"

//misk/misk.web/WebConfig/WebConfig

"},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/#webconfig","title":"WebConfig","text":"

[jvm]\\

@JvmOverloads

constructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, health_dedicated_jetty_instance: Boolean = false, graceful_shutdown_config: GracefulShutdownConfig? = null, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, jetty_use_input_direct_byte_buffers: Boolean = true, jetty_use_output_direct_byte_buffers: Boolean = true, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)

"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/","title":"acceptors - Misk","text":"

//misk/misk.web/WebConfig/acceptors

"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/#acceptors","title":"acceptors","text":"

[jvm]\\ val acceptors: Int? = null

Number of acceptor threads.

"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/","title":"action_exception_log_level - Misk","text":"

//misk/misk.web/WebConfig/action_exception_log_level

"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/#action_exception_log_level","title":"action_exception_log_level","text":"

[jvm]\\ val action_exception_log_level: ActionExceptionLogLevelConfig

"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/","title":"close_connection_percent - Misk","text":"

//misk/misk.web/WebConfig/close_connection_percent

"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/#close_connection_percent","title":"close_connection_percent","text":"

[jvm]\\ val close_connection_percent: Double = 0.0

A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses.

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/","title":"concurrency_limiter - Misk","text":"

//misk/misk.web/WebConfig/concurrency_limiter

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/#concurrency_limiter","title":"concurrency_limiter","text":"

[jvm]\\ val concurrency_limiter: ConcurrencyLimiterConfig?

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/","title":"concurrency_limiter_disabled - Misk","text":"

//misk/misk.web/WebConfig/concurrency_limiter_disabled

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/#concurrency_limiter_disabled","title":"concurrency_limiter_disabled","text":"

[jvm]\\ val concurrency_limiter_disabled: Boolean = true

If true, disables automatic load shedding when degraded.

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/","title":"concurrency_limiter_log_level - Misk","text":"

//misk/misk.web/WebConfig/concurrency_limiter_log_level

"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/#concurrency_limiter_log_level","title":"concurrency_limiter_log_level","text":"

[jvm]\\ val concurrency_limiter_log_level: Level

The level of log when concurrency shedding.

"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/","title":"cors - Misk","text":"

//misk/misk.web/WebConfig/cors

"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/#cors","title":"cors","text":"

[jvm]\\ val cors: Map<String, CorsConfig>

"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/","title":"enable_thread_pool_health_check - Misk","text":"

//misk/misk.web/WebConfig/enable_thread_pool_health_check

"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/#enable_thread_pool_health_check","title":"enable_thread_pool_health_check","text":"

[jvm]\\ val enable_thread_pool_health_check: Boolean = false

Wires up health checks on whether Jetty\u2019s thread pool is low on threads.

"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/","title":"enable_thread_pool_queue_metrics - Misk","text":"

//misk/misk.web/WebConfig/enable_thread_pool_queue_metrics

"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/#enable_thread_pool_queue_metrics","title":"enable_thread_pool_queue_metrics","text":"

[jvm]\\ val enable_thread_pool_queue_metrics: Boolean = false

Flag to enable thread pool queue metrics

"},{"location":"0.x/misk/misk/misk.web/-web-config/graceful_shutdown_config/","title":"graceful_shutdown_config - Misk","text":"

//misk/misk.web/WebConfig/graceful_shutdown_config

"},{"location":"0.x/misk/misk/misk.web/-web-config/graceful_shutdown_config/#graceful_shutdown_config","title":"graceful_shutdown_config","text":"

[jvm]\\

@ExperimentalMiskApi

val graceful_shutdown_config: GracefulShutdownConfig? = null

"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/","title":"gzip - Misk","text":"

//misk/misk.web/WebConfig/gzip

"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/#gzip","title":"gzip","text":"

[jvm]\\ val gzip: Boolean = true

If true responses which are larger than the minGzipSize will be compressed.

"},{"location":"0.x/misk/misk/misk.web/-web-config/health_dedicated_jetty_instance/","title":"health_dedicated_jetty_instance - Misk","text":"

//misk/misk.web/WebConfig/health_dedicated_jetty_instance

"},{"location":"0.x/misk/misk/misk.web/-web-config/health_dedicated_jetty_instance/#health_dedicated_jetty_instance","title":"health_dedicated_jetty_instance","text":"

[jvm]\\

@ExperimentalMiskApi

val health_dedicated_jetty_instance: Boolean = false

"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/","title":"health_port - Misk","text":"

//misk/misk.web/WebConfig/health_port

"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/#health_port","title":"health_port","text":"

[jvm]\\ val health_port: Int

If >= 0, By default, use a dedicated jetty thread pool for health checking. With health_dedicated_jetty_instance = true, use a dedicated jetty instance.

A dedicated thread pool ensures that health checks are not queued or rejected when the service is saturated and queueing requests. If health checks are rejected and/or queued, the health checks may fail and k8s will kill the container, even though it might be perfectly healthy. This can cause cascading failures by sending more requests to other containers, resulting in longer queues and more health checks failures.

"},{"location":"0.x/misk/misk/misk.web/-web-config/host/","title":"host - Misk","text":"

//misk/misk.web/WebConfig/host

"},{"location":"0.x/misk/misk/misk.web/-web-config/host/#host","title":"host","text":"

[jvm]\\ val host: String? = null

The network interface to bind to. Null or 0.0.0.0 to bind to all interfaces.

"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/","title":"http2 - Misk","text":"

//misk/misk.web/WebConfig/http2

"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/#http2","title":"http2","text":"

[jvm]\\ val http2: Boolean = false

HTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically.

"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/","title":"http_header_cache_size - Misk","text":"

//misk/misk.web/WebConfig/http_header_cache_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/#http_header_cache_size","title":"http_header_cache_size","text":"

[jvm]\\ val http_header_cache_size: Int? = null

The size of Jetty\u2019s header field cache, in terms of unique character branches.

"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/","title":"http_request_header_size - Misk","text":"

//misk/misk.web/WebConfig/http_request_header_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/#http_request_header_size","title":"http_request_header_size","text":"

[jvm]\\ val http_request_header_size: Int? = 32768

The maximum allowed size in bytes for the HTTP request line and HTTP request headers.

"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/","title":"idle_timeout - Misk","text":"

//misk/misk.web/WebConfig/idle_timeout

"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/#idle_timeout","title":"idle_timeout","text":"

[jvm]\\ val idle_timeout: Long = 0

If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed.

"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/","title":"install_default_not_found_action - Misk","text":"

//misk/misk.web/WebConfig/install_default_not_found_action

"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/#install_default_not_found_action","title":"install_default_not_found_action","text":"

[jvm]\\ val install_default_not_found_action: Boolean = true

If true install NotFoundAction, the default action when a path is not found.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/","title":"jetty_initial_session_recv_window - Misk","text":"

//misk/misk.web/WebConfig/jetty_initial_session_recv_window

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/#jetty_initial_session_recv_window","title":"jetty_initial_session_recv_window","text":"

[jvm]\\ val jetty_initial_session_recv_window: Int? = null

The initial size of session\u2019s flow control receive window.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/","title":"jetty_initial_stream_recv_window - Misk","text":"

//misk/misk.web/WebConfig/jetty_initial_stream_recv_window

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/#jetty_initial_stream_recv_window","title":"jetty_initial_stream_recv_window","text":"

[jvm]\\ val jetty_initial_stream_recv_window: Int? = null

The initial size of stream\u2019s flow control receive window.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/","title":"jetty_max_concurrent_streams - Misk","text":"

//misk/misk.web/WebConfig/jetty_max_concurrent_streams

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/#jetty_max_concurrent_streams","title":"jetty_max_concurrent_streams","text":"

[jvm]\\ val jetty_max_concurrent_streams: Int? = null

The maximum number of streams per HTTP/2 connection.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/","title":"jetty_max_thread_pool_queue_size - Misk","text":"

//misk/misk.web/WebConfig/jetty_max_thread_pool_queue_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/#jetty_max_thread_pool_queue_size","title":"jetty_max_thread_pool_queue_size","text":"

[jvm]\\ val jetty_max_thread_pool_queue_size: Int = 300

Maximum number of items in the queue for Jetty\u2019s thread pool.

If 0, no queueing is used and requests are directly handed off to the thread pool. If a thread is not available (i.e max threads in use) the request is rejected. Unfortunately Jetty rejects requests by closing the socket instead of returning a 429. This can lead to confusing EOFExceptions for the client.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/","title":"jetty_max_thread_pool_size - Misk","text":"

//misk/misk.web/WebConfig/jetty_max_thread_pool_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/#jetty_max_thread_pool_size","title":"jetty_max_thread_pool_size","text":"

[jvm]\\ val jetty_max_thread_pool_size: Int = 200

Maximum number of threads in Jetty\u2019s thread pool.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/","title":"jetty_min_thread_pool_size - Misk","text":"

//misk/misk.web/WebConfig/jetty_min_thread_pool_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/#jetty_min_thread_pool_size","title":"jetty_min_thread_pool_size","text":"

[jvm]\\ val jetty_min_thread_pool_size: Int = 8

Minimum number of threads in Jetty\u2019s thread pool.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/","title":"jetty_output_buffer_size - Misk","text":"

//misk/misk.web/WebConfig/jetty_output_buffer_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/#jetty_output_buffer_size","title":"jetty_output_buffer_size","text":"

[jvm]\\ val jetty_output_buffer_size: Int? = null

The output buffer size of Jetty (default is 32KB).

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_use_input_direct_byte_buffers/","title":"jetty_use_input_direct_byte_buffers - Misk","text":"

//misk/misk.web/WebConfig/jetty_use_input_direct_byte_buffers

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_use_input_direct_byte_buffers/#jetty_use_input_direct_byte_buffers","title":"jetty_use_input_direct_byte_buffers","text":"

[jvm]\\ val jetty_use_input_direct_byte_buffers: Boolean = true

Whether to use direct ByteBuffers for reading.

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_use_output_direct_byte_buffers/","title":"jetty_use_output_direct_byte_buffers - Misk","text":"

//misk/misk.web/WebConfig/jetty_use_output_direct_byte_buffers

"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_use_output_direct_byte_buffers/#jetty_use_output_direct_byte_buffers","title":"jetty_use_output_direct_byte_buffers","text":"

[jvm]\\ val jetty_use_output_direct_byte_buffers: Boolean = true

Whether to use direct ByteBuffers for writing.

"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/","title":"minGzipSize - Misk","text":"

//misk/misk.web/WebConfig/minGzipSize

"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/#mingzipsize","title":"minGzipSize","text":"

[jvm]\\ val minGzipSize: Int = 1024

The minimum size in bytes before the response body will be compressed.

"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/","title":"override_shutdown_idle_timeout - Misk","text":"

//misk/misk.web/WebConfig/override_shutdown_idle_timeout

"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/#override_shutdown_idle_timeout","title":"override_shutdown_idle_timeout","text":"

[jvm]\\ val override_shutdown_idle_timeout: Long? = null

The number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown.

Note: There is an underlying strategy to determine the default shutdown idle timeout. Use this value only when necessary.

"},{"location":"0.x/misk/misk/misk.web/-web-config/port/","title":"port - Misk","text":"

//misk/misk.web/WebConfig/port

"},{"location":"0.x/misk/misk/misk.web/-web-config/port/#port","title":"port","text":"

[jvm]\\ val port: Int

HTTP port to listen on, or 0 for any available port.

"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/","title":"queue_size - Misk","text":"

//misk/misk.web/WebConfig/queue_size

"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/#queue_size","title":"queue_size","text":"

[jvm]\\ val queue_size: Int? = null

The accept backlog.

"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/","title":"readiness_max_age_ms - Misk","text":"

//misk/misk.web/WebConfig/readiness_max_age_ms

"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/#readiness_max_age_ms","title":"readiness_max_age_ms","text":"

[jvm]\\ val readiness_max_age_ms: Int = 10000

Maximum age of readiness status. If exceeded readiness will return an error

"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/","title":"readiness_refresh_interval_ms - Misk","text":"

//misk/misk.web/WebConfig/readiness_refresh_interval_ms

"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/#readiness_refresh_interval_ms","title":"readiness_refresh_interval_ms","text":"

[jvm]\\ val readiness_refresh_interval_ms: Int = 1000

How often readiness will re-run its status check.

Ensure that readiness_refresh_interval_ms + \"readiness latency\" is less than readiness_max_age_ms or readiness will fail.\"

"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/","title":"selectors - Misk","text":"

//misk/misk.web/WebConfig/selectors

"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/#selectors","title":"selectors","text":"

[jvm]\\ val selectors: Int? = null

Number of NIO selector threads.

"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/","title":"shutdown_sleep_ms - Misk","text":"

//misk/misk.web/WebConfig/shutdown_sleep_ms

"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/#shutdown_sleep_ms","title":"shutdown_sleep_ms","text":"

[jvm]\\ val shutdown_sleep_ms: Int = 0

The number of milliseconds to sleep before commencing service shutdown.

"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/","title":"ssl - Misk","text":"

//misk/misk.web/WebConfig/ssl

"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/#ssl","title":"ssl","text":"

[jvm]\\ val ssl: WebSslConfig? = null

"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/","title":"unix_domain_socket - Misk","text":"

//misk/misk.web/WebConfig/unix_domain_socket

"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/#unix_domain_socket","title":"unix_domain_socket","text":"

[jvm]\\ val unix_domain_socket: WebUnixDomainSocketConfig? = null

Configuration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy).

"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/","title":"unix_domain_sockets - Misk","text":"

//misk/misk.web/WebConfig/unix_domain_sockets

"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/#unix_domain_sockets","title":"unix_domain_sockets","text":"

[jvm]\\ val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null

Configurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio)

"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/","title":"use_virtual_threads - Misk","text":"

//misk/misk.web/WebConfig/use_virtual_threads

"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/#use_virtual_threads","title":"use_virtual_threads","text":"

[jvm]\\ val use_virtual_threads: Boolean = false

If possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/","title":"WebSslConfig - Misk","text":"

//misk/misk.web/WebSslConfig

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"

[jvm]\\ data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#constructors","title":"Constructors","text":"WebSslConfig [jvm]@JvmOverloadsconstructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#types","title":"Types","text":"Name Summary CipherCompatibility [jvm]enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility> MutualAuth [jvm]enum MutualAuth : Enum<WebSslConfig.MutualAuth>"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig cipher_compatibility [jvm]val cipher_compatibility: WebSslConfig.CipherCompatibility mutual_auth [jvm]val mutual_auth: WebSslConfig.MutualAuth port [jvm]val port: IntHTTPS port to listen on, or 0 for any available port. trust_store [jvm]val trust_store: TrustStoreConfig? = null"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/","title":"WebSslConfig - Misk","text":"

//misk/misk.web/WebSslConfig/WebSslConfig

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"

[jvm]\\

@JvmOverloads

constructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/","title":"cert_store - Misk","text":"

//misk/misk.web/WebSslConfig/cert_store

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/#cert_store","title":"cert_store","text":"

[jvm]\\ val cert_store: CertStoreConfig

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/","title":"cipher_compatibility - Misk","text":"

//misk/misk.web/WebSslConfig/cipher_compatibility

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/#cipher_compatibility","title":"cipher_compatibility","text":"

[jvm]\\ val cipher_compatibility: WebSslConfig.CipherCompatibility

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/","title":"mutual_auth - Misk","text":"

//misk/misk.web/WebSslConfig/mutual_auth

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/#mutual_auth","title":"mutual_auth","text":"

[jvm]\\ val mutual_auth: WebSslConfig.MutualAuth

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/","title":"port - Misk","text":"

//misk/misk.web/WebSslConfig/port

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/#port","title":"port","text":"

[jvm]\\ val port: Int

HTTPS port to listen on, or 0 for any available port.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/","title":"trust_store - Misk","text":"

//misk/misk.web/WebSslConfig/trust_store

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/#trust_store","title":"trust_store","text":"

[jvm]\\ val trust_store: TrustStoreConfig? = null

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/","title":"CipherCompatibility - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#ciphercompatibility","title":"CipherCompatibility","text":"

[jvm]\\ enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility>

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#entries","title":"Entries","text":"COMPATIBLE [jvm]COMPATIBLEAllows the broadest set of clients, including clients that support only out-of-date SSL features. MODERN [jvm]MODERNSupports a wide set of SSL features, allowing modern clients to negotiate SSL. RESTRICTED [jvm]RESTRICTEDSupports a reduced set of SSL features, intended to meet stricter compliance requirements."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.CipherCompatibility>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.CipherCompatibilityReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.CipherCompatibility>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/","title":"entries - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/entries

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/#entries","title":"entries","text":"

[jvm]\\ val entries: EnumEntries<WebSslConfig.CipherCompatibility>

Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.

This method may be used to iterate over the enum entries.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/","title":"valueOf - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/valueOf

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#valueof","title":"valueOf","text":"

[jvm]\\ fun valueOf(value: String): WebSslConfig.CipherCompatibility

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/","title":"values - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/values

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/#values","title":"values","text":"

[jvm]\\ fun values(): Array<WebSslConfig.CipherCompatibility>

Returns an array containing the constants of this enum type, in the order they\u2019re declared.

This method may be used to iterate over the constants.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/","title":"COMPATIBLE - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/COMPATIBLE

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#compatible","title":"COMPATIBLE","text":"

[jvm]\\ COMPATIBLE

Allows the broadest set of clients, including clients that support only out-of-date SSL features.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/","title":"MODERN - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/MODERN

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#modern","title":"MODERN","text":"

[jvm]\\ MODERN

Supports a wide set of SSL features, allowing modern clients to negotiate SSL.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/","title":"RESTRICTED - Misk","text":"

//misk/misk.web/WebSslConfig/CipherCompatibility/RESTRICTED

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#restricted","title":"RESTRICTED","text":"

[jvm]\\ RESTRICTED

Supports a reduced set of SSL features, intended to meet stricter compliance requirements.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/","title":"MutualAuth - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#mutualauth","title":"MutualAuth","text":"

[jvm]\\ enum MutualAuth : Enum<WebSslConfig.MutualAuth>

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#entries","title":"Entries","text":"NONE [jvm]NONE REQUIRED [jvm]REQUIRED DESIRED [jvm]DESIRED"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.MutualAuth>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.MutualAuthReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.MutualAuth>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/","title":"entries - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/entries

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/#entries","title":"entries","text":"

[jvm]\\ val entries: EnumEntries<WebSslConfig.MutualAuth>

Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.

This method may be used to iterate over the enum entries.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/","title":"valueOf - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/valueOf

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#valueof","title":"valueOf","text":"

[jvm]\\ fun valueOf(value: String): WebSslConfig.MutualAuth

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/","title":"values - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/values

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/#values","title":"values","text":"

[jvm]\\ fun values(): Array<WebSslConfig.MutualAuth>

Returns an array containing the constants of this enum type, in the order they\u2019re declared.

This method may be used to iterate over the constants.

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/","title":"DESIRED - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/DESIRED

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#desired","title":"DESIRED","text":"

[jvm]\\ DESIRED

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/","title":"NONE - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/NONE

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#none","title":"NONE","text":"

[jvm]\\ NONE

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/","title":"REQUIRED - Misk","text":"

//misk/misk.web/WebSslConfig/MutualAuth/REQUIRED

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#required","title":"REQUIRED","text":"

[jvm]\\ REQUIRED

"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"

//misk/misk.web/WebUnixDomainSocketConfig

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"

[jvm]\\ data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#constructors","title":"Constructors","text":"WebUnixDomainSocketConfig [jvm]@JvmOverloadsconstructor(path: String, h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#properties","title":"Properties","text":"Name Summary h2c [jvm]val h2c: Boolean? = trueIf true, the listener will support H2C. path [jvm]val path: StringThe Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"

//misk/misk.web/WebUnixDomainSocketConfig/WebUnixDomainSocketConfig

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"

[jvm]\\

@JvmOverloads

constructor(path: String, h2c: Boolean? = true)

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/","title":"h2c - Misk","text":"

//misk/misk.web/WebUnixDomainSocketConfig/h2c

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/#h2c","title":"h2c","text":"

[jvm]\\ val h2c: Boolean? = true

If true, the listener will support H2C.

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/","title":"path - Misk","text":"

//misk/misk.web/WebUnixDomainSocketConfig/path

"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/#path","title":"path","text":"

[jvm]\\ val path: String

The Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)

"},{"location":"0.x/misk/misk/misk.web.actions/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.actions

"},{"location":"0.x/misk/misk/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.actions/#types","title":"Types","text":"Name Summary InternalErrorAction [jvm]@Singletonclass InternalErrorAction@Injectconstructor : WebAction LivenessCheckAction [jvm]@Singletonclass LivenessCheckAction : WebAction NotFoundAction [jvm]@Singletonclass NotFoundAction : WebAction ReadinessCheckAction [jvm]@Singletonclass ReadinessCheckAction : WebAction StatusAction [jvm]@Singletonclass StatusAction : WebActionReturns the current status of the service for programmatic tools that want to query for the current state of the server"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/","title":"InternalErrorAction - Misk","text":"

//misk/misk.web.actions/InternalErrorAction

"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"

[jvm]\\ @Singleton

class InternalErrorAction@Injectconstructor : WebAction

"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#constructors","title":"Constructors","text":"InternalErrorAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#functions","title":"Functions","text":"Name Summary error [jvm]fun error(): Nothing"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/","title":"InternalErrorAction - Misk","text":"

//misk/misk.web.actions/InternalErrorAction/InternalErrorAction

"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/","title":"error - Misk","text":"

//misk/misk.web.actions/InternalErrorAction/error

"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/#error","title":"error","text":"

[jvm]\\ fun error(): Nothing

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/","title":"LivenessCheckAction - Misk","text":"

//misk/misk.web.actions/LivenessCheckAction

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#livenesscheckaction","title":"LivenessCheckAction","text":"

[jvm]\\ @Singleton

class LivenessCheckAction : WebAction

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#functions","title":"Functions","text":"Name Summary livenessCheck [jvm]fun livenessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/","title":"livenessCheck - Misk","text":"

//misk/misk.web.actions/LivenessCheckAction/livenessCheck

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/#livenesscheck","title":"livenessCheck","text":"

[jvm]\\ fun livenessCheck(): Response<String>

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.actions/LivenessCheckAction/Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/","title":"NotFoundAction - Misk","text":"

//misk/misk.web.actions/NotFoundAction

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#notfoundaction","title":"NotFoundAction","text":"

[jvm]\\ @Singleton

class NotFoundAction : WebAction

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#functions","title":"Functions","text":"Name Summary notFound [jvm]fun notFound(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/","title":"notFound - Misk","text":"

//misk/misk.web.actions/NotFoundAction/notFound

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/#notfound","title":"notFound","text":"

[jvm]\\ fun notFound(path: String): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.actions/NotFoundAction/Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#functions","title":"Functions","text":"Name Summary response [jvm]fun response(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/","title":"response - Misk","text":"

//misk/misk.web.actions/NotFoundAction/Companion/response

"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/#response","title":"response","text":"

[jvm]\\ fun response(path: String): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/","title":"ReadinessCheckAction - Misk","text":"

//misk/misk.web.actions/ReadinessCheckAction

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#readinesscheckaction","title":"ReadinessCheckAction","text":"

[jvm]\\ @Singleton

class ReadinessCheckAction : WebAction

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#functions","title":"Functions","text":"Name Summary readinessCheck [jvm]fun readinessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/","title":"readinessCheck - Misk","text":"

//misk/misk.web.actions/ReadinessCheckAction/readinessCheck

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/#readinesscheck","title":"readinessCheck","text":"

[jvm]\\ fun readinessCheck(): Response<String>

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.actions/ReadinessCheckAction/Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/","title":"StatusAction - Misk","text":"

//misk/misk.web.actions/StatusAction

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#statusaction","title":"StatusAction","text":"

[jvm]\\ @Singleton

class StatusAction : WebAction

Returns the current status of the service for programmatic tools that want to query for the current state of the server

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ServerStatus [jvm]data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#functions","title":"Functions","text":"Name Summary getStatus [jvm]fun getStatus(): StatusAction.ServerStatus"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/","title":"getStatus - Misk","text":"

//misk/misk.web.actions/StatusAction/getStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/#getstatus","title":"getStatus","text":"

[jvm]\\ fun getStatus(): StatusAction.ServerStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.actions/StatusAction/Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/","title":"ServerStatus - Misk","text":"

//misk/misk.web.actions/StatusAction/ServerStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#serverstatus","title":"ServerStatus","text":"

[jvm]\\ data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#constructors","title":"Constructors","text":"ServerStatus [jvm]constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#properties","title":"Properties","text":"Name Summary healthCheckStatus [jvm]val healthCheckStatus: Map<String, HealthStatus> serviceStatus [jvm]val serviceStatus: Map<String, Service.State>"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/","title":"ServerStatus - Misk","text":"

//misk/misk.web.actions/StatusAction/ServerStatus/ServerStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/#serverstatus","title":"ServerStatus","text":"

[jvm]\\ constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/","title":"healthCheckStatus - Misk","text":"

//misk/misk.web.actions/StatusAction/ServerStatus/healthCheckStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/#healthcheckstatus","title":"healthCheckStatus","text":"

[jvm]\\ val healthCheckStatus: Map<String, HealthStatus>

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/","title":"serviceStatus - Misk","text":"

//misk/misk.web.actions/StatusAction/ServerStatus/serviceStatus

"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/#servicestatus","title":"serviceStatus","text":"

[jvm]\\ val serviceStatus: Map<String, Service.State>

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.concurrencylimits

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#types","title":"Types","text":"Name Summary ConcurrencyLimiterFactory [jvm]interface ConcurrencyLimiterFactoryMultibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used. ConcurrencyLimiterStrategy [jvm]enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy> Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation. ConcurrencyLimitsModule [jvm]class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/","title":"ConcurrencyLimiterFactory - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/#concurrencylimiterfactory","title":"ConcurrencyLimiterFactory","text":"

[jvm]\\ interface ConcurrencyLimiterFactory

Multibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used.

Misk\u2019s ConcurrencyLimitsInterceptor honors the Quota-Path HTTP header to give callers control of how their calls are aggregated when computing system throughput. The create function will be called for each unique Quota-Path received from an application. If the same Quota-Path header is used on different actions, create is only called for the first action that uses the header.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): Limiter<String>?"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/create/","title":"create - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory/create

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(action: Action): Limiter<String>?

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/","title":"ConcurrencyLimiterStrategy - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#concurrencylimiterstrategy","title":"ConcurrencyLimiterStrategy","text":"

[jvm]\\ enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy>

Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#entries","title":"Entries","text":"VEGAS [jvm]VEGASA limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information. GRADIENT [jvm]GRADIENTConcurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information. GRADIENT2 [jvm]GRADIENT2Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information. AIMD [jvm]AIMDLoss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information. SETTABLE [jvm]SETTABLELimit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information. FIXED [jvm]FIXEDNon dynamic limit with fixed value. See documentation for more information."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<ConcurrencyLimiterStrategy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): ConcurrencyLimiterStrategyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<ConcurrencyLimiterStrategy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/","title":"entries - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/entries

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/#entries","title":"entries","text":"

[jvm]\\ val entries: EnumEntries<ConcurrencyLimiterStrategy>

Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.

This method may be used to iterate over the enum entries.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/","title":"valueOf - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/valueOf

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#valueof","title":"valueOf","text":"

[jvm]\\ fun valueOf(value: String): ConcurrencyLimiterStrategy

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/","title":"values - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/values

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/#values","title":"values","text":"

[jvm]\\ fun values(): Array<ConcurrencyLimiterStrategy>

Returns an array containing the constants of this enum type, in the order they\u2019re declared.

This method may be used to iterate over the constants.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/","title":"AIMD - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/AIMD

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#aimd","title":"AIMD","text":"

[jvm]\\ AIMD

Loss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/","title":"FIXED - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/FIXED

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#fixed","title":"FIXED","text":"

[jvm]\\ FIXED

Non dynamic limit with fixed value. See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/","title":"GRADIENT - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#gradient","title":"GRADIENT","text":"

[jvm]\\ GRADIENT

Concurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/","title":"GRADIENT2 - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT2

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#gradient2","title":"GRADIENT2","text":"

[jvm]\\ GRADIENT2

Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/","title":"SETTABLE - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/SETTABLE

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#settable","title":"SETTABLE","text":"

[jvm]\\ SETTABLE

Limit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/","title":"VEGAS - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/VEGAS

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#vegas","title":"VEGAS","text":"

[jvm]\\ VEGAS

A limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information.

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"

[jvm]\\ class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#constructors","title":"Constructors","text":"ConcurrencyLimitsModule [jvm]constructor(config: ConcurrencyLimiterConfig)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#functions","title":"Functions","text":"Name Summary concurrencyLimiterFactory [jvm]@ProvidesIntoSet@Singletonfun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactoryThis will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed. configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/ConcurrencyLimitsModule

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"

[jvm]\\ constructor(config: ConcurrencyLimiterConfig)

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/","title":"concurrencyLimiterFactory - Misk","text":"

//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/concurrencyLimiterFactory

"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/#concurrencylimiterfactory","title":"concurrencyLimiterFactory","text":"

[jvm]\\

@ProvidesIntoSet

@Singleton

fun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactory

This will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed.

"},{"location":"0.x/misk/misk/misk.web.exceptions/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.exceptions

"},{"location":"0.x/misk/misk/misk.web.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.exceptions/#types","title":"Types","text":"Name Summary ActionExceptionLogLevelConfig [jvm]data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : ConfigConfigures the log Level for an ActionException. ExceptionHandlingInterceptor [jvm]class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptorConverts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule ExceptionMapper [jvm]interface ExceptionMapper<in T : Throwable>Maps an exception to a Response ExceptionMapperModule [jvm]class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModuleBinds a Throwable to an ExceptionMapper. ExceptionMapperResolver [jvm]@Singletonclass ExceptionMapperResolver GrpcErrorResponse [jvm]data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf()) RequestBodyExceptionMapper [jvm]class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>"},{"location":"0.x/misk/misk/misk.web.exceptions/#functions","title":"Functions","text":"Name Summary toGrpcStatus [jvm]fun toGrpcStatus(statusCode: Int): GrpcStatushttps://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/","title":"toGrpcStatus - Misk","text":"

//misk/misk.web.exceptions/toGrpcStatus

"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/#togrpcstatus","title":"toGrpcStatus","text":"

[jvm]\\ fun toGrpcStatus(statusCode: Int): GrpcStatus

https://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"

//misk/misk.web.exceptions/ActionExceptionLogLevelConfig

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"

[jvm]\\ data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : Config

Configures the log Level for an ActionException.

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#constructors","title":"Constructors","text":"ActionExceptionLogLevelConfig [jvm]@JvmOverloadsconstructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#properties","title":"Properties","text":"Name Summary client_error_level [jvm]val client_error_level: Levelthe level used for 4xx error codes server_error_level [jvm]val server_error_level: Levelthe level used for 5xx error codes"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"

//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/ActionExceptionLogLevelConfig

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"

[jvm]\\

@JvmOverloads

constructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/","title":"client_error_level - Misk","text":"

//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/client_error_level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/#client_error_level","title":"client_error_level","text":"

[jvm]\\ val client_error_level: Level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/","title":"server_error_level - Misk","text":"

//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/server_error_level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/#server_error_level","title":"server_error_level","text":"

[jvm]\\ val server_error_level: Level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"

//misk/misk.web.exceptions/ExceptionHandlingInterceptor

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"

[jvm]\\ class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptor

Converts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule

TODO(isabel): Set the response body in a ThreadLocal to log in RequestLoggingInterceptor

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#constructors","title":"Constructors","text":"ExceptionHandlingInterceptor [jvm]constructor(actionName: String, mapperResolver: ExceptionMapperResolver)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"

//misk/misk.web.exceptions/ExceptionHandlingInterceptor/ExceptionHandlingInterceptor

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"

[jvm]\\ constructor(actionName: String, mapperResolver: ExceptionMapperResolver)

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.exceptions/ExceptionHandlingInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ class Factory : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ExceptionHandlingInterceptor"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): ExceptionHandlingInterceptor

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/","title":"ExceptionMapper - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapper

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#exceptionmapper","title":"ExceptionMapper","text":"

interface ExceptionMapper<in T : Throwable>

Maps an exception to a Response

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#inheritors","title":"Inheritors","text":"RequestBodyExceptionMapper"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open fun loggingLevel(th: T): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: T): GrpcErrorResponse? toResponse [jvm]abstract fun toResponse(th: T): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapper/loggingLevel

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"

[jvm]\\ open fun loggingLevel(th: T): Level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#return","title":"Return","text":"

the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/","title":"toGrpcResponse - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapper/toGrpcResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/#togrpcresponse","title":"toGrpcResponse","text":"

[jvm]\\ open fun toGrpcResponse(th: T): GrpcErrorResponse?

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/","title":"toResponse - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapper/toResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#toresponse","title":"toResponse","text":"

[jvm]\\ abstract fun toResponse(th: T): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#return","title":"Return","text":"

the Response corresponding to the exception.

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperModule

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"

[jvm]\\ class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModule

Binds a Throwable to an ExceptionMapper.

When an Exception occurs dispatching an Action, the bound ExceptionMapper is called to handle the Exception. If there is not an explicit binding for the thrown Exception, the mapper for the closest superclass is used.

Given the example code

install(ExceptionMapperModule.create<ActionException, ActionExceptionMapper>())\ninstall(ExceptionMapperModule.create<MyActionException, MyActionExceptionMapper>())\n\nclass MyActionException : ActionException {}\nclass MyOtherActionException : ActionException {}\n

MyActionException maps to the specific MyActionExceptionMapper and MyOtherActionException maps to the ActionExceptionMapper since uses the binding of the closest bound superclass.

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#constructors","title":"Constructors","text":"ExceptionMapperModule [jvm]constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperModule/ExceptionMapperModule

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"

[jvm]\\ constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperModule/Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/","title":"create - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperModule/Companion/create

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/#create","title":"create","text":"

[jvm]\\ inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/","title":"ExceptionMapperResolver - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperResolver

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#exceptionmapperresolver","title":"ExceptionMapperResolver","text":"

[jvm]\\ @Singleton

class ExceptionMapperResolver

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#functions","title":"Functions","text":"Name Summary mapperFor [jvm]fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/","title":"mapperFor - Misk","text":"

//misk/misk.web.exceptions/ExceptionMapperResolver/mapperFor

"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/#mapperfor","title":"mapperFor","text":"

[jvm]\\ fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"

[jvm]\\ data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf())

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#constructors","title":"Constructors","text":"GrpcErrorResponse [jvm]@JvmOverloadsconstructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#properties","title":"Properties","text":"Name Summary details [jvm]val details: List<AnyMessage> message [jvm]val message: String? status [jvm]val status: GrpcStatus"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#functions","title":"Functions","text":"Name Summary copy [jvm]@JvmOverloadsfun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/GrpcErrorResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"

[jvm]\\

@JvmOverloads

constructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/","title":"copy - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/copy

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/#copy","title":"copy","text":"

[jvm]\\

@JvmOverloads

fun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/","title":"details - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/details

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/#details","title":"details","text":"

[jvm]\\ val details: List<AnyMessage>

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/","title":"message - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/message

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/#message","title":"message","text":"

[jvm]\\ val message: String?

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/","title":"status - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/status

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/#status","title":"status","text":"

[jvm]\\ val status: GrpcStatus

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#properties","title":"Properties","text":"Name Summary INTERNAL_SERVER_ERROR [jvm]val INTERNAL_SERVER_ERROR: GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/","title":"INTERNAL_SERVER_ERROR - Misk","text":"

//misk/misk.web.exceptions/GrpcErrorResponse/Companion/INTERNAL_SERVER_ERROR

"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/#internal_server_error","title":"INTERNAL_SERVER_ERROR","text":"

[jvm]\\ val INTERNAL_SERVER_ERROR: GrpcErrorResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/","title":"RequestBodyExceptionMapper - Misk","text":"

//misk/misk.web.exceptions/RequestBodyExceptionMapper

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#requestbodyexceptionmapper","title":"RequestBodyExceptionMapper","text":"

[jvm]\\ class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open override fun loggingLevel(th: RequestBodyException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: RequestBodyException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: RequestBodyException): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"

//misk/misk.web.exceptions/RequestBodyExceptionMapper/loggingLevel

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"

[jvm]\\ open override fun loggingLevel(th: RequestBodyException): Level

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#return","title":"Return","text":"

the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/","title":"toResponse - Misk","text":"

//misk/misk.web.exceptions/RequestBodyExceptionMapper/toResponse

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#toresponse","title":"toResponse","text":"

[jvm]\\ open override fun toResponse(th: RequestBodyException): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#return","title":"Return","text":"

the Response corresponding to the exception.

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#properties","title":"Properties","text":"Name Summary CLIENT_CLOSED_REQUEST [jvm]val CLIENT_CLOSED_REQUEST: Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/","title":"CLIENT_CLOSED_REQUEST - Misk","text":"

//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion/CLIENT_CLOSED_REQUEST

"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/#client_closed_request","title":"CLIENT_CLOSED_REQUEST","text":"

[jvm]\\ val CLIENT_CLOSED_REQUEST: Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.extractors/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.extractors

"},{"location":"0.x/misk/misk/misk.web.extractors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.extractors/#types","title":"Types","text":"Name Summary RequestBodyException [jvm]class RequestBodyException(cause: Throwable) : IOException StringConverter [jvm]typealias StringConverter = (String) -> Any?"},{"location":"0.x/misk/misk/misk.web.extractors/#functions","title":"Functions","text":"Name Summary converterFor [jvm]fun converterFor(type: KType): StringConverter?"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/","title":"converterFor - Misk","text":"

//misk/misk.web.extractors/converterFor

"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/#converterfor","title":"converterFor","text":"

[jvm]\\ fun converterFor(type: KType): StringConverter?

"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/","title":"RequestBodyException - Misk","text":"

//misk/misk.web.extractors/RequestBodyException

"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"

[jvm]\\ class RequestBodyException(cause: Throwable) : IOException

"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#constructors","title":"Constructors","text":"RequestBodyException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/","title":"RequestBodyException - Misk","text":"

//misk/misk.web.extractors/RequestBodyException/RequestBodyException

"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"

[jvm]\\ constructor(cause: Throwable)

"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/","title":"StringConverter - Misk","text":"

//misk/misk.web.extractors/StringConverter

"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/#stringconverter","title":"StringConverter","text":"

[jvm]\\ typealias StringConverter = (String) -> Any?

"},{"location":"0.x/misk/misk/misk.web.formatter/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.formatter

"},{"location":"0.x/misk/misk/misk.web.formatter/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.formatter/#types","title":"Types","text":"Name Summary ClassNameFormatter [jvm]class ClassNameFormatter@Injectconstructor"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"

//misk/misk.web.formatter/ClassNameFormatter

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"

[jvm]\\ class ClassNameFormatter@Injectconstructor

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#constructors","title":"Constructors","text":"ClassNameFormatter [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"

//misk/misk.web.formatter/ClassNameFormatter/ClassNameFormatter

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.formatter/ClassNameFormatter/Companion

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#functions","title":"Functions","text":"Name Summary format [jvm]fun <T : Any> format(kclass: KClass<T>): String"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/","title":"format - Misk","text":"

//misk/misk.web.formatter/ClassNameFormatter/Companion/format

"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/#format","title":"format","text":"

[jvm]\\ fun <T : Any> format(kclass: KClass<T>): String

"},{"location":"0.x/misk/misk/misk.web.interceptors/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.interceptors

"},{"location":"0.x/misk/misk/misk.web.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.interceptors/#types","title":"Types","text":"Name Summary ActionLoggingConfig [jvm]data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)This class should have all the same config options as LogRequestResponse. See that class for details. BeforeContentEncoding [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class BeforeContentEncodingDenotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding. ExcludedTime [jvm]class ExcludedTime@JvmOverloadsconstructor(time: Duration = Duration.ZERO) ExclusiveTimingInterceptor [jvm]class ExclusiveTimingInterceptor(excludedTime: ThreadLocal<ExcludedTime>, metric: Histogram, caller: ActionScoped<MiskCaller?>, actionName: String, getAdditionalTagValues: (ExcludedTime) -> List<String>) : NetworkInterceptorEmits a metric measuring the amount of time spent in the request, excluding any time spent waiting on downstream. InternalErrorInterceptorFactory [jvm]@Singletonclass InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory LogRateLimiter [jvm]@Singletonclass LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation. MiskConcurrencyLimiterFeature [jvm]interface MiskConcurrencyLimiterFeatureInterface for a Feature flag that can dynamically enable/disable the concurrency limiter RebalancingInterceptor [jvm]class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptorWhen we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods. RequestBodyLoggingInterceptor [jvm]class RequestBodyLoggingInterceptor : ApplicationInterceptorStores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor RequestLoggingConfig [jvm]data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)A set of per-action logging config overrides. RequestLoggingInterceptor [jvm]class RequestLoggingInterceptor : NetworkInterceptorLogs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client. RequestLoggingTransformer [jvm]interface RequestLoggingTransformerTransforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data. RequestResponseBody [jvm]data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null) ResponseBodyMarshallerFactory [jvm]@Singletonclass ResponseBodyMarshallerFactory WideOpenDevelopmentInterceptor [jvm]class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor WideOpenDevelopmentInterceptorFactory [jvm]class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/#functions","title":"Functions","text":"Name Summary tryTransform [jvm]fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/","title":"tryTransform - Misk","text":"

//misk/misk.web.interceptors/tryTransform

"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/#trytransform","title":"tryTransform","text":"

[jvm]\\ fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"

[jvm]\\ data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)

This class should have all the same config options as LogRequestResponse. See that class for details.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#constructors","title":"Constructors","text":"ActionLoggingConfig [jvm]@JvmOverloadsconstructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#properties","title":"Properties","text":"Name Summary bodySampling [jvm]val bodySampling: Double = 0.0 errorBodySampling [jvm]val errorBodySampling: Double = 0.0 errorRatePerSecond [jvm]val errorRatePerSecond: Long = 0 excludedEnvironments [jvm]val excludedEnvironments: List<String> ratePerSecond [jvm]val ratePerSecond: Long = 10 requestLoggingMode [jvm]val requestLoggingMode: RequestLoggingMode"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/ActionLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"

[jvm]\\

@JvmOverloads

constructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/","title":"bodySampling - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/bodySampling

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/#bodysampling","title":"bodySampling","text":"

[jvm]\\ val bodySampling: Double = 0.0

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/","title":"errorBodySampling - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/errorBodySampling

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/#errorbodysampling","title":"errorBodySampling","text":"

[jvm]\\ val errorBodySampling: Double = 0.0

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/","title":"errorRatePerSecond - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/errorRatePerSecond

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/#errorratepersecond","title":"errorRatePerSecond","text":"

[jvm]\\ val errorRatePerSecond: Long = 0

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/","title":"excludedEnvironments - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/excludedEnvironments

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/#excludedenvironments","title":"excludedEnvironments","text":"

[jvm]\\ val excludedEnvironments: List<String>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/","title":"ratePerSecond - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/ratePerSecond

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/#ratepersecond","title":"ratePerSecond","text":"

[jvm]\\ val ratePerSecond: Long = 10

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/","title":"requestLoggingMode - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/requestLoggingMode

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/#requestloggingmode","title":"requestLoggingMode","text":"

[jvm]\\ val requestLoggingMode: RequestLoggingMode

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/Companion

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#functions","title":"Functions","text":"Name Summary fromAnnotation [jvm]fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig fromConfigMapOrAnnotation [jvm]fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/","title":"fromAnnotation - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromAnnotation

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/#fromannotation","title":"fromAnnotation","text":"

[jvm]\\ fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/","title":"fromConfigMapOrAnnotation - Misk","text":"

//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromConfigMapOrAnnotation

"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/#fromconfigmaporannotation","title":"fromConfigMapOrAnnotation","text":"

[jvm]\\ fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/","title":"BeforeContentEncoding - Misk","text":"

//misk/misk.web.interceptors/BeforeContentEncoding

"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/#beforecontentencoding","title":"BeforeContentEncoding","text":"

[jvm]\\ @Qualifier

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])

annotation class BeforeContentEncoding

Denotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/","title":"ExcludedTime - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/#excludedtime","title":"ExcludedTime","text":"

[jvm]\\ class ExcludedTime@JvmOverloadsconstructor(time: Duration = Duration.ZERO)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/#constructors","title":"Constructors","text":"ExcludedTime [jvm]@JvmOverloadsconstructor(time: Duration = Duration.ZERO)"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/#properties","title":"Properties","text":"Name Summary additionalData [jvm]var additionalData: MutableMap<String, Any>Any additional data that you want to be available to your ExclusiveTimingInterceptor.Factory. This can be useful for creating additional metric tags."},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(add: Duration)Adds a length of time that should be excluded from the exclusive duration metric. clear [jvm]fun clear() value [jvm]fun value(): Duration"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/-excluded-time/","title":"ExcludedTime - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime/ExcludedTime

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/-excluded-time/#excludedtime","title":"ExcludedTime","text":"

[jvm]\\

@JvmOverloads

constructor(time: Duration = Duration.ZERO)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/add/","title":"add - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime/add

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/add/#add","title":"add","text":"

[jvm]\\ fun add(add: Duration)

Adds a length of time that should be excluded from the exclusive duration metric.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/additional-data/","title":"additionalData - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime/additionalData

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/additional-data/#additionaldata","title":"additionalData","text":"

[jvm]\\ var additionalData: MutableMap<String, Any>

Any additional data that you want to be available to your ExclusiveTimingInterceptor.Factory. This can be useful for creating additional metric tags.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/clear/","title":"clear - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime/clear

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/clear/#clear","title":"clear","text":"

[jvm]\\ fun clear()

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/value/","title":"value - Misk","text":"

//misk/misk.web.interceptors/ExcludedTime/value

"},{"location":"0.x/misk/misk/misk.web.interceptors/-excluded-time/value/#value","title":"value","text":"

[jvm]\\ fun value(): Duration

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/","title":"ExclusiveTimingInterceptor - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/#exclusivetiminginterceptor","title":"ExclusiveTimingInterceptor","text":"

[jvm]\\ class ExclusiveTimingInterceptor(excludedTime: ThreadLocal<ExcludedTime>, metric: Histogram, caller: ActionScoped<MiskCaller?>, actionName: String, getAdditionalTagValues: (ExcludedTime) -> List<String>) : NetworkInterceptor

Emits a metric measuring the amount of time spent in the request, excluding any time spent waiting on downstream.

Use this by installing via install(ExclusiveTimingInterceptor.Module()), and then inject a ThreadLocal<DownstreamTime> into places in your code where you want to exclude time.

You can also use a custom interceptor factory if you want to customize the metric name and tags. Install it via install(ExclusiveTimingInterceptor.Module.of<MyExclusiveTimingInterceptorFactory>()) instead.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/#constructors","title":"Constructors","text":"ExclusiveTimingInterceptor [jvm]constructor(excludedTime: ThreadLocal<ExcludedTime>, metric: Histogram, caller: ActionScoped<MiskCaller?>, actionName: String, getAdditionalTagValues: (ExcludedTime) -> List<String>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonopen class Factory@Injectconstructor(excludedTime: ThreadLocal<ExcludedTime>, metrics: Metrics, caller: ActionScoped<MiskCaller?>) : NetworkInterceptor.Factory Module [jvm]class Module<T : ExclusiveTimingInterceptor.Factory>(factoryClass: KClass<T>) : KAbstractModule"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-exclusive-timing-interceptor/","title":"ExclusiveTimingInterceptor - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/ExclusiveTimingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-exclusive-timing-interceptor/#exclusivetiminginterceptor","title":"ExclusiveTimingInterceptor","text":"

[jvm]\\ constructor(excludedTime: ThreadLocal<ExcludedTime>, metric: Histogram, caller: ActionScoped<MiskCaller?>, actionName: String, getAdditionalTagValues: (ExcludedTime) -> List<String>)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

open class Factory@Injectconstructor(excludedTime: ThreadLocal<ExcludedTime>, metrics: Metrics, caller: ActionScoped<MiskCaller?>) : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor(excludedTime: ThreadLocal<ExcludedTime>, metrics: Metrics, caller: ActionScoped<MiskCaller?>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/#properties","title":"Properties","text":"Name Summary additionalTagNames [jvm]open val additionalTagNames: List<String> metricName [jvm]open val metricName: String"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor getAdditionalTagValues [jvm]open fun getAdditionalTagValues(excludedTime: ExcludedTime): List<String>"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory/Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor(excludedTime: ThreadLocal<ExcludedTime>, metrics: Metrics, caller: ActionScoped<MiskCaller?>)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/additional-tag-names/","title":"additionalTagNames - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory/additionalTagNames

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/additional-tag-names/#additionaltagnames","title":"additionalTagNames","text":"

[jvm]\\ open val additionalTagNames: List<String>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/get-additional-tag-values/","title":"getAdditionalTagValues - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory/getAdditionalTagValues

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/get-additional-tag-values/#getadditionaltagvalues","title":"getAdditionalTagValues","text":"

[jvm]\\ open fun getAdditionalTagValues(excludedTime: ExcludedTime): List<String>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/metric-name/","title":"metricName - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Factory/metricName

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-factory/metric-name/#metricname","title":"metricName","text":"

[jvm]\\ open val metricName: String

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/","title":"Module - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Module

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/#module","title":"Module","text":"

[jvm]\\ class Module<T : ExclusiveTimingInterceptor.Factory>(factoryClass: KClass<T>) : KAbstractModule

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/#constructors","title":"Constructors","text":"Module [jvm]constructor(factoryClass: KClass<T>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-module/","title":"Module - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Module/Module

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-module/#module","title":"Module","text":"

[jvm]\\ constructor(factoryClass: KClass<T>)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Module/Companion

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/#functions","title":"Functions","text":"Name Summary invoke [jvm]operator fun invoke(): ExclusiveTimingInterceptor.Module<ExclusiveTimingInterceptor.Factory> of [jvm]inline fun <T : ExclusiveTimingInterceptor.Factory> of(): ExclusiveTimingInterceptor.Module<T>"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/invoke/","title":"invoke - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Module/Companion/invoke

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/invoke/#invoke","title":"invoke","text":"

[jvm]\\ operator fun invoke(): ExclusiveTimingInterceptor.Module<ExclusiveTimingInterceptor.Factory>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/of/","title":"of - Misk","text":"

//misk/misk.web.interceptors/ExclusiveTimingInterceptor/Module/Companion/of

"},{"location":"0.x/misk/misk/misk.web.interceptors/-exclusive-timing-interceptor/-module/-companion/of/#of","title":"of","text":"

[jvm]\\ inline fun <T : ExclusiveTimingInterceptor.Factory> of(): ExclusiveTimingInterceptor.Module<T>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"

//misk/misk.web.interceptors/InternalErrorInterceptorFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"

[jvm]\\ @Singleton

class InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#constructors","title":"Constructors","text":"InternalErrorInterceptorFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"

//misk/misk.web.interceptors/InternalErrorInterceptorFactory/InternalErrorInterceptorFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/InternalErrorInterceptorFactory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"

[jvm]\\ @Singleton

class LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)

Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#constructors","title":"Constructors","text":"LogRateLimiter [jvm]@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#types","title":"Types","text":"Name Summary LogBucketId [jvm]data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#functions","title":"Functions","text":"Name Summary tryAcquire [jvm]fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogRateLimiter

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"

[jvm]\\

@Inject

constructor(rateLimiterFactory: RateLimiter.Factory)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/tryAcquire

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"

[jvm]\\ fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/","title":"LogBucketId - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"

[jvm]\\ data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#constructors","title":"Constructors","text":"LogBucketId [jvm]constructor(actionClass: String, isError: Boolean)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: StringActionClass from which we can grab the LogRequestResponse isError [jvm]val isError: BooleanIf the response code is error, we look up the errorRateLimiter"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/","title":"LogBucketId - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/LogBucketId

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"

[jvm]\\ constructor(actionClass: String, isError: Boolean)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/","title":"actionClass - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/actionClass

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/#actionclass","title":"actionClass","text":"

[jvm]\\ val actionClass: String

ActionClass from which we can grab the LogRequestResponse

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/","title":"compareTo - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/compareTo

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/#compareto","title":"compareTo","text":"

[jvm]\\ open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/","title":"isError - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/isError

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/#iserror","title":"isError","text":"

[jvm]\\ val isError: Boolean

If the response code is error, we look up the errorRateLimiter

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/","title":"toString - Misk","text":"

//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/toString

"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/","title":"MiskConcurrencyLimiterFeature - Misk","text":"

//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature

"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#miskconcurrencylimiterfeature","title":"MiskConcurrencyLimiterFeature","text":"

[jvm]\\ interface MiskConcurrencyLimiterFeature

Interface for a Feature flag that can dynamically enable/disable the concurrency limiter

"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#functions","title":"Functions","text":"Name Summary enabled [jvm]abstract fun enabled(): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/","title":"enabled - Misk","text":"

//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature/enabled

"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/#enabled","title":"enabled","text":"

[jvm]\\ abstract fun enabled(): Boolean

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"

//misk/misk.web.interceptors/RebalancingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"

[jvm]\\ class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptor

When we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods.

This does not close Unix domain socket connections. This interceptor is intended to mitigate imbalanced load from long-lived client connections maintained from client apps. Connections over UDS are oriented towards service mesh sidecars that employ sufficient client-side load balancing.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#constructors","title":"Constructors","text":"RebalancingInterceptor [jvm]@Injectconstructor(random: ThreadLocalRandom, probability: Double)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"

//misk/misk.web.interceptors/RebalancingInterceptor/RebalancingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"

[jvm]\\

@Inject

constructor(random: ThreadLocalRandom, probability: Double)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.interceptors/RebalancingInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.interceptors/RebalancingInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/RebalancingInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/","title":"RequestBodyLoggingInterceptor - Misk","text":"

//misk/misk.web.interceptors/RequestBodyLoggingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#requestbodylogginginterceptor","title":"RequestBodyLoggingInterceptor","text":"

[jvm]\\ class RequestBodyLoggingInterceptor : ApplicationInterceptor

Stores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor

Timing information doesn\u2019t count time writing the response to the remote client.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : ApplicationInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: Chain): Any

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : ApplicationInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): ApplicationInterceptor?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"

[jvm]\\ data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)

A set of per-action logging config overrides.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#constructors","title":"Constructors","text":"RequestLoggingConfig [jvm]constructor(actions: Map<String, ActionLoggingConfig>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#properties","title":"Properties","text":"Name Summary actions [jvm]val actions: Map<String, ActionLoggingConfig>"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingConfig/RequestLoggingConfig

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"

[jvm]\\ constructor(actions: Map<String, ActionLoggingConfig>)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/","title":"actions - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingConfig/actions

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/#actions","title":"actions","text":"

[jvm]\\ val actions: Map<String, ActionLoggingConfig>

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/","title":"RequestLoggingInterceptor - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#requestlogginginterceptor","title":"RequestLoggingInterceptor","text":"

[jvm]\\ class RequestLoggingInterceptor : NetworkInterceptor

Logs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain) maybeLog [jvm]fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/","title":"maybeLog - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingInterceptor/maybeLog

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/#maybelog","title":"maybeLog","text":"

[jvm]\\ fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/","title":"RequestLoggingTransformer - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingTransformer

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/#requestloggingtransformer","title":"RequestLoggingTransformer","text":"

[jvm]\\ interface RequestLoggingTransformer

Transforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data.

Note that the order in which RequestLoggingTransformers get applied is considered undefined and cannot be reliably controlled.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/#functions","title":"Functions","text":"Name Summary transform [jvm]abstract fun transform(requestResponseBody: RequestResponseBody?): RequestResponseBody? tryTransform [jvm]fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/transform/","title":"transform - Misk","text":"

//misk/misk.web.interceptors/RequestLoggingTransformer/transform

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/transform/#transform","title":"transform","text":"

[jvm]\\ abstract fun transform(requestResponseBody: RequestResponseBody?): RequestResponseBody?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/","title":"RequestResponseBody - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"

[jvm]\\ data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#constructors","title":"Constructors","text":"RequestResponseBody [jvm]@JvmOverloadsconstructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#properties","title":"Properties","text":"Name Summary request [jvm]val request: Any? requestHeaders [jvm]val requestHeaders: Any? = null response [jvm]val response: Any? responseHeaders [jvm]val responseHeaders: Any? = null"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/","title":"RequestResponseBody - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody/RequestResponseBody

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"

[jvm]\\

@JvmOverloads

constructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/","title":"requestHeaders - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody/requestHeaders

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/#requestheaders","title":"requestHeaders","text":"

[jvm]\\ val requestHeaders: Any? = null

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/","title":"request - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody/request

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/#request","title":"request","text":"

[jvm]\\ val request: Any?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/","title":"responseHeaders - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody/responseHeaders

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/#responseheaders","title":"responseHeaders","text":"

[jvm]\\ val responseHeaders: Any? = null

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/","title":"response - Misk","text":"

//misk/misk.web.interceptors/RequestResponseBody/response

"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/#response","title":"response","text":"

[jvm]\\ val response: Any?

"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/","title":"ResponseBodyMarshallerFactory - Misk","text":"

//misk/misk.web.interceptors/ResponseBodyMarshallerFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#responsebodymarshallerfactory","title":"ResponseBodyMarshallerFactory","text":"

[jvm]\\ @Singleton

class ResponseBodyMarshallerFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(action: Action): Marshaller<Any>Returns a marshaller for action, or null if it has no response to marshal."},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/ResponseBodyMarshallerFactory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/#create","title":"create","text":"

[jvm]\\ fun create(action: Action): Marshaller<Any>

Returns a marshaller for action, or null if it has no response to marshal.

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"

[jvm]\\ class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptor [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/WideOpenDevelopmentInterceptor

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/","title":"intercept - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/intercept

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/#intercept","title":"intercept","text":"

[jvm]\\ open override fun intercept(chain: NetworkChain)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"

[jvm]\\ class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptorFactory [jvm]@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/WideOpenDevelopmentInterceptorFactory

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"

[jvm]\\

@Inject

constructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/","title":"create - Misk","text":"

//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/create

"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(action: Action): NetworkInterceptor?

"},{"location":"0.x/misk/misk/misk.web.jetty/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.jetty

"},{"location":"0.x/misk/misk/misk.web.jetty/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.jetty/#types","title":"Types","text":"Name Summary JettyService [jvm]@Singletonclass JettyService : AbstractIdleService MeasuredQueuedThreadPool [jvm]class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPoolA MeasuredThreadPool for a QueuedThreadPool MeasuredThreadPool [jvm]interface MeasuredThreadPoolA common interface that can emit metrics about a thread pool. MeasuredThreadPoolExecutor [jvm]class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPoolA MeasuredThreadPool for a ThreadPoolExecutor ThreadPoolQueueMetrics [jvm]@Singletonclass ThreadPoolQueueMetrics"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/","title":"JettyService - Misk","text":"

//misk/misk.web.jetty/JettyService

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#jettyservice","title":"JettyService","text":"

[jvm]\\ @Singleton

class JettyService : AbstractIdleService

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#properties","title":"Properties","text":"Name Summary healthServerUrl [jvm]val healthServerUrl: HttpUrl? httpServerUrl [jvm]val httpServerUrl: HttpUrl httpsServerUrl [jvm]val httpsServerUrl: HttpUrl?"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stop [jvm]fun stop() stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/","title":"healthServerUrl - Misk","text":"

//misk/misk.web.jetty/JettyService/healthServerUrl

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/#healthserverurl","title":"healthServerUrl","text":"

[jvm]\\ val healthServerUrl: HttpUrl?

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/","title":"httpServerUrl - Misk","text":"

//misk/misk.web.jetty/JettyService/httpServerUrl

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/#httpserverurl","title":"httpServerUrl","text":"

[jvm]\\ val httpServerUrl: HttpUrl

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/","title":"httpsServerUrl - Misk","text":"

//misk/misk.web.jetty/JettyService/httpsServerUrl

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/#httpsserverurl","title":"httpsServerUrl","text":"

[jvm]\\ val httpsServerUrl: HttpUrl?

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/stop/","title":"stop - Misk","text":"

//misk/misk.web.jetty/JettyService/stop

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/stop/#stop","title":"stop","text":"

[jvm]\\ fun stop()

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.jetty/JettyService/Companion

"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"

[jvm]\\ class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPool

A MeasuredThreadPool for a QueuedThreadPool

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#constructors","title":"Constructors","text":"MeasuredQueuedThreadPool [jvm]constructor(threadPool: QueuedThreadPool)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool/MeasuredQueuedThreadPool

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"

[jvm]\\ constructor(threadPool: QueuedThreadPool)

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/","title":"activeCount - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool/activeCount

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/#activecount","title":"activeCount","text":"

[jvm]\\ open override fun activeCount(): Int

The number of active threads.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool/maxPoolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"

[jvm]\\ open override fun maxPoolSize(): Int

The maximum size the pool can grow to.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/","title":"poolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool/poolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/#poolsize","title":"poolSize","text":"

[jvm]\\ open override fun poolSize(): Int

The current size of the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/","title":"queueSize - Misk","text":"

//misk/misk.web.jetty/MeasuredQueuedThreadPool/queueSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/#queuesize","title":"queueSize","text":"

[jvm]\\ open override fun queueSize(): Int

The current number of tasks in the queue waiting to be processed by the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/","title":"MeasuredThreadPool - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPool

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#measuredthreadpool","title":"MeasuredThreadPool","text":"

interface MeasuredThreadPool

A common interface that can emit metrics about a thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#inheritors","title":"Inheritors","text":"MeasuredQueuedThreadPool MeasuredThreadPoolExecutor"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]abstract fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]abstract fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]abstract fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]abstract fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/","title":"activeCount - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPool/activeCount

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/#activecount","title":"activeCount","text":"

[jvm]\\ abstract fun activeCount(): Int

The number of active threads.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPool/maxPoolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"

[jvm]\\ abstract fun maxPoolSize(): Int

The maximum size the pool can grow to.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/","title":"poolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPool/poolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/#poolsize","title":"poolSize","text":"

[jvm]\\ abstract fun poolSize(): Int

The current size of the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/","title":"queueSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPool/queueSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/#queuesize","title":"queueSize","text":"

[jvm]\\ abstract fun queueSize(): Int

The current number of tasks in the queue waiting to be processed by the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"

[jvm]\\ class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPool

A MeasuredThreadPool for a ThreadPoolExecutor

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#constructors","title":"Constructors","text":"MeasuredThreadPoolExecutor [jvm]constructor(threadPool: ThreadPoolExecutor)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor/MeasuredThreadPoolExecutor

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"

[jvm]\\ constructor(threadPool: ThreadPoolExecutor)

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/","title":"activeCount - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor/activeCount

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/#activecount","title":"activeCount","text":"

[jvm]\\ open override fun activeCount(): Int

The number of active threads.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/","title":"maxPoolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor/maxPoolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"

[jvm]\\ open override fun maxPoolSize(): Int

The maximum size the pool can grow to.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/","title":"poolSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor/poolSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/#poolsize","title":"poolSize","text":"

[jvm]\\ open override fun poolSize(): Int

The current size of the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/","title":"queueSize - Misk","text":"

//misk/misk.web.jetty/MeasuredThreadPoolExecutor/queueSize

"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/#queuesize","title":"queueSize","text":"

[jvm]\\ open override fun queueSize(): Int

The current number of tasks in the queue waiting to be processed by the thread pool.

"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/","title":"ThreadPoolQueueMetrics - Misk","text":"

//misk/misk.web.jetty/ThreadPoolQueueMetrics

"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#threadpoolqueuemetrics","title":"ThreadPoolQueueMetrics","text":"

[jvm]\\ @Singleton

class ThreadPoolQueueMetrics

"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#functions","title":"Functions","text":"Name Summary recordQueueLatency [jvm]fun recordQueueLatency(latency: Duration)"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/","title":"recordQueueLatency - Misk","text":"

//misk/misk.web.jetty/ThreadPoolQueueMetrics/recordQueueLatency

"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/#recordqueuelatency","title":"recordQueueLatency","text":"

[jvm]\\ fun recordQueueLatency(latency: Duration)

"},{"location":"0.x/misk/misk/misk.web.marshal/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.marshal

"},{"location":"0.x/misk/misk/misk.web.marshal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.marshal/#types","title":"Types","text":"Name Summary GenericMarshallers [jvm]object GenericMarshallersHandles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content GenericUnmarshallers [jvm]object GenericUnmarshallersHandles generic unmarshalling, for cases where the action can accept anything JsonMarshaller [jvm]class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T> JsonUnmarshaller [jvm]class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller Marshaller [jvm]interface Marshaller<in T>Marshalls typed kotlin objects into a ResponseBody MultipartUnmarshaller [jvm]object MultipartUnmarshaller : Unmarshaller PlainTextMarshaller [jvm]object PlainTextMarshaller : Marshaller<Any> PlainTextUnmarshaller [jvm]object PlainTextUnmarshaller ProtobufMarshaller [jvm]class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T> ProtobufUnmarshaller [jvm]class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller Unmarshaller [jvm]interface UnmarshallerUnmarshalls a typed object from an incoming source"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/","title":"GenericMarshallers - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#genericmarshallers","title":"GenericMarshallers","text":"

[jvm]\\ object GenericMarshallers

Handles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#types","title":"Types","text":"Name Summary FromByteString [jvm]class FromByteString(contentType: MediaType?) : Marshaller<ByteString> ToNothing [jvm]class ToNothing(contentType: MediaType?) : Marshaller<Nothing> ToUnit [jvm]class ToUnit(contentType: MediaType?) : Marshaller<Unit>"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean from [jvm]fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/","title":"canHandle - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/canHandle

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/#canhandle","title":"canHandle","text":"

[jvm]\\ fun canHandle(type: KType): Boolean

fun canHandle(type: Type): Boolean

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/","title":"from - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/from

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/#from","title":"from","text":"

[jvm]\\ fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/","title":"FromByteString - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/FromByteString

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#frombytestring","title":"FromByteString","text":"

[jvm]\\ class FromByteString(contentType: MediaType?) : Marshaller<ByteString>

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#constructors","title":"Constructors","text":"FromByteString [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: ByteString): ResponseBody[jvm]open fun responseBody(o: ByteString, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default."},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/","title":"FromByteString - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/FromByteString/FromByteString

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/#frombytestring","title":"FromByteString","text":"

[jvm]\\ constructor(contentType: MediaType?)

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/FromByteString/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType?

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/FromByteString/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: ByteString): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/","title":"ToNothing - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToNothing

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#tonothing","title":"ToNothing","text":"

[jvm]\\ class ToNothing(contentType: MediaType?) : Marshaller<Nothing>

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#constructors","title":"Constructors","text":"ToNothing [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Nothing): ResponseBody[jvm]open fun responseBody(o: Nothing, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default."},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/","title":"ToNothing - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToNothing/ToNothing

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/#tonothing","title":"ToNothing","text":"

[jvm]\\ constructor(contentType: MediaType?)

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToNothing/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType?

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToNothing/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: Nothing): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/","title":"ToUnit - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToUnit

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#tounit","title":"ToUnit","text":"

[jvm]\\ class ToUnit(contentType: MediaType?) : Marshaller<Unit>

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#constructors","title":"Constructors","text":"ToUnit [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Unit): ResponseBody[jvm]open fun responseBody(o: Unit, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default."},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/","title":"ToUnit - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToUnit/ToUnit

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/#tounit","title":"ToUnit","text":"

[jvm]\\ constructor(contentType: MediaType?)

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToUnit/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType?

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/GenericMarshallers/ToUnit/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: Unit): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/","title":"GenericUnmarshallers - Misk","text":"

//misk/misk.web.marshal/GenericUnmarshallers

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#genericunmarshallers","title":"GenericUnmarshallers","text":"

[jvm]\\ object GenericUnmarshallers

Handles generic unmarshalling, for cases where the action can accept anything

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean into [jvm]fun into(parameter: KParameter): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/","title":"canHandle - Misk","text":"

//misk/misk.web.marshal/GenericUnmarshallers/canHandle

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/#canhandle","title":"canHandle","text":"

[jvm]\\ fun canHandle(type: KType): Boolean

fun canHandle(type: Type): Boolean

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/","title":"into - Misk","text":"

//misk/misk.web.marshal/GenericUnmarshallers/into

"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/#into","title":"into","text":"

[jvm]\\ fun into(parameter: KParameter): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/","title":"JsonMarshaller - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"

[jvm]\\ class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T>

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#constructors","title":"Constructors","text":"JsonMarshaller [jvm]constructor(adapter: JsonAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: T): ResponseBody[jvm]open fun responseBody(o: T, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default."},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/","title":"JsonMarshaller - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/JsonMarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"

[jvm]\\ constructor(adapter: JsonAdapter<T>)

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/","title":"adapter - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/adapter

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/#adapter","title":"adapter","text":"

[jvm]\\ val adapter: JsonAdapter<T>

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: T): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : Marshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/","title":"moshi - Misk","text":"

//misk/misk.web.marshal/JsonMarshaller/Factory/moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/#moshi","title":"moshi","text":"

[jvm]\\ val moshi: Moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"

[jvm]\\ class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#constructors","title":"Constructors","text":"JsonUnmarshaller [jvm]constructor(adapter: JsonAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/JsonUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"

[jvm]\\ constructor(adapter: JsonAdapter<Any>)

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/","title":"adapter - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/adapter

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/#adapter","title":"adapter","text":"

[jvm]\\ val adapter: JsonAdapter<Any>

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : Unmarshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"

//misk/misk.web.marshal/JsonUnmarshaller/Factory/moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"

[jvm]\\ val moshi: Moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/","title":"Marshaller - Misk","text":"

//misk/misk.web.marshal/Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#marshaller","title":"Marshaller","text":"

interface Marshaller<in T>

Marshalls typed kotlin objects into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#inheritors","title":"Inheritors","text":"FromByteString ToNothing ToUnit JsonMarshaller PlainTextMarshaller ProtobufMarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]abstract fun contentType(): MediaType? responseBody [jvm]abstract fun responseBody(o: T): ResponseBody[jvm]open fun responseBody(o: T, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default."},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/Marshaller/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ abstract fun contentType(): MediaType?

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/Marshaller/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ abstract fun responseBody(o: T): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

[jvm]\\ open fun responseBody(o: T, httpCall: HttpCall): ResponseBody

Alternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default.

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#return_1","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/","title":"Companion - Misk","text":"

//misk/misk.web.marshal/Marshaller/Companion

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#functions","title":"Functions","text":"Name Summary actualResponseType [jvm]fun actualResponseType(type: KType): Type"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/","title":"actualResponseType - Misk","text":"

//misk/misk.web.marshal/Marshaller/Companion/actualResponseType

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/#actualresponsetype","title":"actualResponseType","text":"

[jvm]\\ fun actualResponseType(type: KType): Type

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/Marshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/#factory","title":"Factory","text":"

interface Factory

This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<Marshaller.Factory>().to<MyFactory>()\n
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/#inheritors","title":"Inheritors","text":"Factory Factory Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/Marshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Marshaller<Any>?

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/","title":"MultipartUnmarshaller - Misk","text":"

//misk/misk.web.marshal/MultipartUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#multipartunmarshaller","title":"MultipartUnmarshaller","text":"

[jvm]\\ object MultipartUnmarshaller : Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/MultipartUnmarshaller/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/MultipartUnmarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory : Unmarshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/MultipartUnmarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"

//misk/misk.web.marshal/MultipartUnmarshaller/Factory/moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"

[jvm]\\ val moshi: Moshi

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/","title":"PlainTextMarshaller - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#plaintextmarshaller","title":"PlainTextMarshaller","text":"

[jvm]\\ object PlainTextMarshaller : Marshaller<Any>

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open fun responseBody(o: Any, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default.[jvm]open override fun responseBody(o: Any): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: Any): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory@Injectconstructor : Marshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller/Factory/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/PlainTextMarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/","title":"PlainTextUnmarshaller - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#plaintextunmarshaller","title":"PlainTextUnmarshaller","text":"

[jvm]\\ object PlainTextUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : Unmarshaller.Factory ToByteString [jvm]object ToByteString : Unmarshaller ToString [jvm]object ToString : Unmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ class Factory@Injectconstructor : Unmarshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/","title":"ToByteString - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#tobytestring","title":"ToByteString","text":"

[jvm]\\ object ToByteString : Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/","title":"ToString - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/ToString

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#tostring","title":"ToString","text":"

[jvm]\\ object ToString : Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/PlainTextUnmarshaller/ToString/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"

[jvm]\\ class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T>

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#constructors","title":"Constructors","text":"ProtobufMarshaller [jvm]constructor(adapter: ProtoAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open fun responseBody(o: T, httpCall: HttpCall): ResponseBodyAlternate way to marshal the response body with access to the HttpCall. Invokes responseBody by default.[jvm]open override fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/ProtobufMarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"

[jvm]\\ constructor(adapter: ProtoAdapter<T>)

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/","title":"adapter - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/adapter

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/#adapter","title":"adapter","text":"

[jvm]\\ val adapter: ProtoAdapter<T>

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/","title":"contentType - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/contentType

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#contenttype","title":"contentType","text":"

[jvm]\\ open override fun contentType(): MediaType

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#return","title":"Return","text":"

the media type of the marshalled content, if known to the Marshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/","title":"responseBody - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/responseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ open override fun responseBody(o: T): ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#return","title":"Return","text":"

The object marshalled into a ResponseBody

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory@Injectconstructor : Marshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/Factory/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/ProtobufMarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"

[jvm]\\ class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#constructors","title":"Constructors","text":"ProtobufUnmarshaller [jvm]constructor(adapter: ProtoAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/ProtobufUnmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"

[jvm]\\ constructor(adapter: ProtoAdapter<Any>)

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/","title":"adapter - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/adapter

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/#adapter","title":"adapter","text":"

[jvm]\\ val adapter: ProtoAdapter<Any>

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#factory","title":"Factory","text":"

[jvm]\\ @Singleton

class Factory@Injectconstructor : Unmarshaller.Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/","title":"Unmarshaller - Misk","text":"

//misk/misk.web.marshal/Unmarshaller

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#unmarshaller","title":"Unmarshaller","text":"

interface Unmarshaller

Unmarshalls a typed object from an incoming source

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#inheritors","title":"Inheritors","text":"JsonUnmarshaller MultipartUnmarshaller ToString ToByteString ProtobufUnmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"

//misk/misk.web.marshal/Unmarshaller/unmarshal

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"

[jvm]\\ abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/","title":"Factory - Misk","text":"

//misk/misk.web.marshal/Unmarshaller/Factory

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/#factory","title":"Factory","text":"

interface Factory

This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<Unmarshaller.Factory>().to<MyFactory>()\n
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/#inheritors","title":"Inheritors","text":"Factory Factory Factory Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/create/","title":"create - Misk","text":"

//misk/misk.web.marshal/Unmarshaller/Factory/create

"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/create/#create","title":"create","text":"

[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Unmarshaller?

"},{"location":"0.x/misk/misk/misk.web.mdc/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.mdc

"},{"location":"0.x/misk/misk/misk.web.mdc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.mdc/#types","title":"Types","text":"Name Summary LogContextProvider [jvm]interface LogContextProvider"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/","title":"LogContextProvider - Misk","text":"

//misk/misk.web.mdc/LogContextProvider

"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#logcontextprovider","title":"LogContextProvider","text":"

[jvm]\\ interface LogContextProvider

"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(request: HttpServletRequest): String?"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/","title":"get - Misk","text":"

//misk/misk.web.mdc/LogContextProvider/get

"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/#get","title":"get","text":"

[jvm]\\ abstract fun get(request: HttpServletRequest): String?

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.metadata.guice

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.guice/#types","title":"Types","text":"Name Summary GuiceMetadata [jvm]data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata GuiceMetadataProvider [jvm]class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/","title":"GuiceMetadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"

[jvm]\\ data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#constructors","title":"Constructors","text":"GuiceMetadata [jvm]constructor(guice: GuiceMetadataProvider.Metadata)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String guice [jvm]val guice: GuiceMetadataProvider.Metadata metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/","title":"GuiceMetadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadata/GuiceMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"

[jvm]\\ constructor(guice: GuiceMetadataProvider.Metadata)

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/","title":"guice - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadata/guice

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/#guice","title":"guice","text":"

[jvm]\\ val guice: GuiceMetadataProvider.Metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"

[jvm]\\ class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#constructors","title":"Constructors","text":"GuiceMetadataProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#types","title":"Types","text":"Name Summary BindingMetadata [jvm]data class BindingMetadata(val type: String, val typePackage: String, val source: String, val scope: String?, val provider: String, val annotation: String?, val subElements: List<GuiceMetadataProvider.BindingMetadata>?, val subElementsType: String?) Metadata [jvm]data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#properties","title":"Properties","text":"Name Summary allBindings [jvm]val allBindings: MutableMap<Key<>, Binding<>> id [jvm]open override val id: String injector [jvm]@Injectlateinit var injector: Injector"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): GuiceMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/GuiceMetadataProvider

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/","title":"allBindings - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/allBindings

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/#allbindings","title":"allBindings","text":"

[jvm]\\ val allBindings: MutableMap<Key<>, Binding<>>

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/","title":"get - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/get

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/#get","title":"get","text":"

[jvm]\\ open override fun get(): GuiceMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/","title":"id - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/id

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/#id","title":"id","text":"

[jvm]\\ open override val id: String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/","title":"injector - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/injector

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/#injector","title":"injector","text":"

[jvm]\\

@Inject

lateinit var injector: Injector

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/","title":"BindingMetadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"

[jvm]\\ data class BindingMetadata(val type: String, val typePackage: String, val source: String, val scope: String?, val provider: String, val annotation: String?, val subElements: List<GuiceMetadataProvider.BindingMetadata>?, val subElementsType: String?)

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#constructors","title":"Constructors","text":"BindingMetadata [jvm]constructor(type: String, typePackage: String, source: String, scope: String?, provider: String, annotation: String?, subElements: List<GuiceMetadataProvider.BindingMetadata>?, subElementsType: String?)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#properties","title":"Properties","text":"Name Summary annotation [jvm]val annotation: String? provider [jvm]val provider: String scope [jvm]val scope: String? source [jvm]val source: String subElements [jvm]val subElements: List<GuiceMetadataProvider.BindingMetadata>? subElementsType [jvm]val subElementsType: String? type [jvm]val type: String typePackage [jvm]val typePackage: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/","title":"BindingMetadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/BindingMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"

[jvm]\\ constructor(type: String, typePackage: String, source: String, scope: String?, provider: String, annotation: String?, subElements: List<GuiceMetadataProvider.BindingMetadata>?, subElementsType: String?)

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/","title":"annotation - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/annotation

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/#annotation","title":"annotation","text":"

[jvm]\\ val annotation: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/","title":"provider - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/provider

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/#provider","title":"provider","text":"

[jvm]\\ val provider: String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/","title":"scope - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/scope

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/#scope","title":"scope","text":"

[jvm]\\ val scope: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/","title":"source - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/source

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/#source","title":"source","text":"

[jvm]\\ val source: String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/sub-elements-type/","title":"subElementsType - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/subElementsType

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/sub-elements-type/#subelementstype","title":"subElementsType","text":"

[jvm]\\ val subElementsType: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/sub-elements/","title":"subElements - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/subElements

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/sub-elements/#subelements","title":"subElements","text":"

[jvm]\\ val subElements: List<GuiceMetadataProvider.BindingMetadata>?

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/","title":"toString - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/toString

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type-package/","title":"typePackage - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/typePackage

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type-package/#typepackage","title":"typePackage","text":"

[jvm]\\ val typePackage: String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/","title":"type - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/type

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/#type","title":"type","text":"

[jvm]\\ val type: String

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/","title":"Metadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#metadata","title":"Metadata","text":"

[jvm]\\ data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#constructors","title":"Constructors","text":"Metadata [jvm]constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#properties","title":"Properties","text":"Name Summary bindingMetadata [jvm]val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/","title":"Metadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/Metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/#metadata","title":"Metadata","text":"

[jvm]\\ constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/","title":"bindingMetadata - Misk","text":"

//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/bindingMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/#bindingmetadata","title":"bindingMetadata","text":"

[jvm]\\ val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.metadata.webaction

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#types","title":"Types","text":"Name Summary WebActionMetadata [jvm]data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)Metadata front end model for Web Action Misk-Web Tab WebActionMetadataAction [jvm]@Singletonclass WebActionMetadataAction@Injectconstructor : WebAction WebActionsMetadata [jvm]data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata WebActionsMetadataProvider [jvm]@Singletonclass WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"

[jvm]\\ data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)

Metadata front end model for Web Action Misk-Web Tab

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#constructors","title":"Constructors","text":"WebActionMetadata [jvm]constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#types","title":"Types","text":"Name Summary ParameterMetaData [jvm]data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String> applicationInterceptors [jvm]val applicationInterceptors: List<String> description [jvm]val description: String? function [jvm]val function: String functionAnnotations [jvm]val functionAnnotations: List<String> httpMethod [jvm]val httpMethod: String name [jvm]val name: String networkInterceptors [jvm]val networkInterceptors: List<String> packageName [jvm]val packageName: String? parameters [jvm]val parameters: List<WebActionMetadata.ParameterMetaData> parameterTypes [jvm]val parameterTypes: List<String> pathPattern [jvm]val pathPattern: String requestMediaTypes [jvm]val requestMediaTypes: List<String> requestType [jvm]val requestType: String? responseMediaType [jvm]val responseMediaType: String? responseType [jvm]val responseType: String responseTypes [jvm]val responseTypes: Map<String, MiskWebFormBuilder.Type> returnType [jvm]val returnType: String returnTypes [jvm]val returnTypes: Map<String, MiskWebFormBuilder.Type> types [jvm]val types: Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/WebActionMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"

[jvm]\\ constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)

constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/allowedCapabilities

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"

[jvm]\\ val allowedCapabilities: Set<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/","title":"allowedServices - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/allowedServices

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/#allowedservices","title":"allowedServices","text":"

[jvm]\\ val allowedServices: Set<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/","title":"applicationInterceptors - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/applicationInterceptors

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/#applicationinterceptors","title":"applicationInterceptors","text":"

[jvm]\\ val applicationInterceptors: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/","title":"description - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/description

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/#description","title":"description","text":"

[jvm]\\ val description: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/","title":"functionAnnotations - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/functionAnnotations

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/#functionannotations","title":"functionAnnotations","text":"

[jvm]\\ val functionAnnotations: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/","title":"function - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/function

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/#function","title":"function","text":"

[jvm]\\ val function: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/","title":"httpMethod - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/httpMethod

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/#httpmethod","title":"httpMethod","text":"

[jvm]\\ val httpMethod: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/","title":"name - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/name

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/","title":"networkInterceptors - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/networkInterceptors

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/#networkinterceptors","title":"networkInterceptors","text":"

[jvm]\\ val networkInterceptors: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/","title":"packageName - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/packageName

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/#packagename","title":"packageName","text":"

[jvm]\\ val packageName: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/","title":"parameterTypes - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/parameterTypes

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/#parametertypes","title":"parameterTypes","text":"

[jvm]\\ val parameterTypes: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/","title":"parameters - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/parameters

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/#parameters","title":"parameters","text":"

[jvm]\\ val parameters: List<WebActionMetadata.ParameterMetaData>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/","title":"pathPattern - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/pathPattern

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/","title":"requestMediaTypes - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/requestMediaTypes

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/#requestmediatypes","title":"requestMediaTypes","text":"

[jvm]\\ val requestMediaTypes: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/","title":"requestType - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/requestType

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/#requesttype","title":"requestType","text":"

[jvm]\\ val requestType: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/","title":"responseMediaType - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/responseMediaType

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/#responsemediatype","title":"responseMediaType","text":"

[jvm]\\ val responseMediaType: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/","title":"responseType - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/responseType

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/#responsetype","title":"responseType","text":"

[jvm]\\ val responseType: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/","title":"responseTypes - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/responseTypes

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/#responsetypes","title":"responseTypes","text":"

[jvm]\\ val responseTypes: Map<String, MiskWebFormBuilder.Type>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/","title":"returnType - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/returnType

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/#returntype","title":"returnType","text":"

[jvm]\\ val returnType: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/","title":"returnTypes - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/returnTypes

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/#returntypes","title":"returnTypes","text":"

[jvm]\\ val returnTypes: Map<String, MiskWebFormBuilder.Type>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/","title":"types - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/types

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/#types","title":"types","text":"

[jvm]\\ val types: Map<String, MiskWebFormBuilder.Type>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"

[jvm]\\ data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#constructors","title":"Constructors","text":"ParameterMetaData [jvm]constructor(name: String?, annotations: List<String>, type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String? type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/ParameterMetaData

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"

[jvm]\\ constructor(name: String?, annotations: List<String>, type: String)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/","title":"annotations - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/annotations

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/#annotations","title":"annotations","text":"

[jvm]\\ val annotations: List<String>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/","title":"name - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/name

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/#name","title":"name","text":"

[jvm]\\ val name: String?

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/","title":"type - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/type

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/#type","title":"type","text":"

[jvm]\\ val type: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"

[jvm]\\ @Singleton

class WebActionMetadataAction@Injectconstructor : WebAction

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#constructors","title":"Constructors","text":"WebActionMetadataAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#types","title":"Types","text":"Name Summary Response [jvm]data class Response(val webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(): WebActionMetadataAction.Response"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction/WebActionMetadataAction

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/","title":"getAll - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction/getAll

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/#getall","title":"getAll","text":"

[jvm]\\ fun getAll(): WebActionMetadataAction.Response

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/","title":"Response - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#response","title":"Response","text":"

[jvm]\\ data class Response(val webActionMetadata: List<WebActionMetadata>)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#properties","title":"Properties","text":"Name Summary webActionMetadata [jvm]val webActionMetadata: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/","title":"Response - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/Response

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/#response","title":"Response","text":"

[jvm]\\ constructor(webActionMetadata: List<WebActionMetadata>)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/","title":"webActionMetadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/webActionMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/#webactionmetadata","title":"webActionMetadata","text":"

[jvm]\\ val webActionMetadata: List<WebActionMetadata>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"

[jvm]\\ data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#constructors","title":"Constructors","text":"WebActionsMetadata [jvm]constructor(webActions: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String webActions [jvm]val webActions: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadata/WebActionsMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"

[jvm]\\ constructor(webActions: List<WebActionMetadata>)

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/","title":"descriptionBlock - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadata/descriptionBlock

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/#descriptionblock","title":"descriptionBlock","text":"

[jvm]\\ open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/","title":"webActions - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadata/webActions

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/#webactions","title":"webActions","text":"

[jvm]\\ val webActions: List<WebActionMetadata>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadataProvider

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"

[jvm]\\ @Singleton

class WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#constructors","title":"Constructors","text":"WebActionsMetadataProvider [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String metadata [jvm]val metadata: WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/WebActionsMetadataProvider

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/","title":"get - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/get

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/#get","title":"get","text":"

[jvm]\\ open override fun get(): WebActionsMetadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/","title":"id - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/id

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/#id","title":"id","text":"

[jvm]\\ open override val id: String

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/","title":"metadata - Misk","text":"

//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/metadata

"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/#metadata","title":"metadata","text":"

[jvm]\\ val metadata: WebActionsMetadata

"},{"location":"0.x/misk/misk/misk.web.proxy/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.proxy

"},{"location":"0.x/misk/misk/misk.web.proxy/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.proxy/#types","title":"Types","text":"Name Summary OptionalBinder [jvm]@Singletonclass OptionalBinder@Injectconstructorhttps://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor WebProxyAction [jvm]@Singletonclass WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebActionWebProxyAction WebProxyEntry [jvm]data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntryMaps URLs requested against this server to URLs of servers to delegate to"},{"location":"0.x/misk/misk/misk.web.proxy/#functions","title":"Functions","text":"Name Summary WebProxyEntry [jvm]fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"

//misk/misk.web.proxy/WebProxyEntry

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"

[jvm]\\ fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/","title":"OptionalBinder - Misk","text":"

//misk/misk.web.proxy/OptionalBinder

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"

[jvm]\\ @Singleton

class OptionalBinder@Injectconstructor

https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#constructors","title":"Constructors","text":"OptionalBinder [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#properties","title":"Properties","text":"Name Summary proxyClient [jvm]@Inject(optional = true)@Named(value = \"web_proxy_action\")var proxyClient: OkHttpClient"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/","title":"OptionalBinder - Misk","text":"

//misk/misk.web.proxy/OptionalBinder/OptionalBinder

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"

[jvm]\\

@Inject

constructor()

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/","title":"proxyClient - Misk","text":"

//misk/misk.web.proxy/OptionalBinder/proxyClient

"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/#proxyclient","title":"proxyClient","text":"

[jvm]\\

@Inject(optional = true)

@Named(value = \"web_proxy_action\")

var proxyClient: OkHttpClient

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/","title":"WebProxyAction - Misk","text":"

//misk/misk.web.proxy/WebProxyAction

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"

[jvm]\\ @Singleton

class WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebAction

WebProxyAction

Guidelines

Expected Functionality

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/#constructors","title":"Constructors","text":"WebProxyAction [jvm]@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder)"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/#functions","title":"Functions","text":"Name Summary action [jvm]fun action(): Response<ResponseBody> getResponse [jvm]fun getResponse(url: HttpUrl): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/-web-proxy-action/","title":"WebProxyAction - Misk","text":"

//misk/misk.web.proxy/WebProxyAction/WebProxyAction

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"

[jvm]\\

@Inject

constructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder)

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/","title":"action - Misk","text":"

//misk/misk.web.proxy/WebProxyAction/action

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/#action","title":"action","text":"

[jvm]\\ fun action(): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/get-response/","title":"getResponse - Misk","text":"

//misk/misk.web.proxy/WebProxyAction/getResponse

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/get-response/#getresponse","title":"getResponse","text":"

[jvm]\\ fun getResponse(url: HttpUrl): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"

//misk/misk.web.proxy/WebProxyEntry

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"

[jvm]\\ data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntry

Maps URLs requested against this server to URLs of servers to delegate to

url_path_prefix: /_admin/ web_proxy_url: http://localhost:3000/

An incoming request then for /_admin/config.js would route to http://localhost:3000/_admin/config.js.

This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<WebProxyEntry>().toInstance(WebProxyEntry(...))\n
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#constructors","title":"Constructors","text":"WebProxyEntry [jvm]@JvmOverloadsconstructor(url_path_prefix: String = \"/\", web_proxy_url: HttpUrl)"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#properties","title":"Properties","text":"Name Summary url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String web_proxy_url [jvm]val web_proxy_url: HttpUrl"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"

//misk/misk.web.proxy/WebProxyEntry/WebProxyEntry

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"

[jvm]\\

@JvmOverloads

constructor(url_path_prefix: String = \"/\", web_proxy_url: HttpUrl)

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"

//misk/misk.web.proxy/WebProxyEntry/url_path_prefix

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"

[jvm]\\ val url_path_prefix: String

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/","title":"web_proxy_url - Misk","text":"

//misk/misk.web.proxy/WebProxyEntry/web_proxy_url

"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/#web_proxy_url","title":"web_proxy_url","text":"

[jvm]\\ val web_proxy_url: HttpUrl

"},{"location":"0.x/misk/misk/misk.web.resources/","title":"Package-level declarations - Misk","text":"

//misk/misk.web.resources

"},{"location":"0.x/misk/misk/misk.web.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.resources/#types","title":"Types","text":"Name Summary ResourceEntryFinder [jvm]class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>) StaticResourceAction [jvm]@Singletonclass StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebActionStaticResourceAction StaticResourceEntry [jvm]data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntryThis data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"

//misk/misk.web.resources/ResourceEntryFinder

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"

[jvm]\\ class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#constructors","title":"Constructors","text":"ResourceEntryFinder [jvm]@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#functions","title":"Functions","text":"Name Summary staticResource [jvm]fun staticResource(url: HttpUrl): ValidWebEntry? webProxy [jvm]fun webProxy(url: HttpUrl): ValidWebEntry?"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"

//misk/misk.web.resources/ResourceEntryFinder/ResourceEntryFinder

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"

[jvm]\\

@Inject

constructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/","title":"staticResource - Misk","text":"

//misk/misk.web.resources/ResourceEntryFinder/staticResource

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#staticresource","title":"staticResource","text":"

[jvm]\\ fun staticResource(url: HttpUrl): ValidWebEntry?

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#return","title":"Return","text":"

entry whose url_path_prefix most closely matches given url; longest match wins

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/","title":"webProxy - Misk","text":"

//misk/misk.web.resources/ResourceEntryFinder/webProxy

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#webproxy","title":"webProxy","text":"

[jvm]\\ fun webProxy(url: HttpUrl): ValidWebEntry?

"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#return","title":"Return","text":"

entry whose url_path_prefix most closely matches given url; longest match wins

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/","title":"StaticResourceAction - Misk","text":"

//misk/misk.web.resources/StaticResourceAction

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"

[jvm]\\ @Singleton

class StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebAction

StaticResourceAction

This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<StaticResourceEntry>()\n  .toInstance(\n    StaticResourceEntry(\n      url_path_prefix = \"/static/\",\n      resourcePath = \"classpath:/web/static/\"\n    )\n  )\ninstall(WebActionModule.createWithPrefix<StaticResourceAction>(url_path_prefix = \"/static/\"))\n
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/#constructors","title":"Constructors","text":"StaticResourceAction [jvm]@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder)"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/#functions","title":"Functions","text":"Name Summary action [jvm]fun action(): Response<ResponseBody> getResponse [jvm]fun getResponse(url: HttpUrl): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/-static-resource-action/","title":"StaticResourceAction - Misk","text":"

//misk/misk.web.resources/StaticResourceAction/StaticResourceAction

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"

[jvm]\\

@Inject

constructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder)

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/","title":"action - Misk","text":"

//misk/misk.web.resources/StaticResourceAction/action

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/#action","title":"action","text":"

[jvm]\\ fun action(): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/","title":"getResponse - Misk","text":"

//misk/misk.web.resources/StaticResourceAction/getResponse

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/#getresponse","title":"getResponse","text":"

[jvm]\\ fun getResponse(url: HttpUrl): Response<ResponseBody>

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/","title":"StaticResourceEntry - Misk","text":"

//misk/misk.web.resources/StaticResourceEntry

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"

[jvm]\\ data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntry

This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:

multibind<StaticResourceEntry>().toInstance(StaticResourceEntry(...))\n
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#constructors","title":"Constructors","text":"StaticResourceEntry [jvm]@JvmOverloadsconstructor(url_path_prefix: String = \"/\", resourcePath: String)"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#properties","title":"Properties","text":"Name Summary url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#functions","title":"Functions","text":"Name Summary resourcePath [jvm]fun resourcePath(urlPath: String): String"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/-static-resource-entry/","title":"StaticResourceEntry - Misk","text":"

//misk/misk.web.resources/StaticResourceEntry/StaticResourceEntry

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"

[jvm]\\

@JvmOverloads

constructor(url_path_prefix: String = \"/\", resourcePath: String)

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/","title":"resourcePath - Misk","text":"

//misk/misk.web.resources/StaticResourceEntry/resourcePath

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/#resourcepath","title":"resourcePath","text":"

[jvm]\\ fun resourcePath(urlPath: String): String

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"

//misk/misk.web.resources/StaticResourceEntry/url_path_prefix

"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"

[jvm]\\ val url_path_prefix: String

"},{"location":"0.x/misk-action-scopes/","title":"misk-action-scopes - Misk","text":"

//misk-action-scopes

"},{"location":"0.x/misk-action-scopes/#misk-action-scopes","title":"misk-action-scopes","text":""},{"location":"0.x/misk-action-scopes/#packages","title":"Packages","text":"Name misk.concurrent misk.scope misk.scope.executor"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/","title":"Package-level declarations - Misk","text":"

//misk-action-scopes/misk.concurrent

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#types","title":"Types","text":"Name Summary WrappingListeningExecutorService [jvm]abstract class WrappingListeningExecutorService : ForwardingListeningExecutorServiceListeningExecutorService which wraps all calls"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"

abstract class WrappingListeningExecutorService : ForwardingListeningExecutorService

ListeningExecutorService which wraps all calls

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#inheritors","title":"Inheritors","text":"ActionScopedExecutorService"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#constructors","title":"Constructors","text":"WrappingListeningExecutorService [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/WrappingListeningExecutorService

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/","title":"execute - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/execute

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/#execute","title":"execute","text":"

[jvm]\\ open override fun execute(runnable: Runnable)

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/","title":"invokeAll - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAll

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/#invokeall","title":"invokeAll","text":"

[jvm]\\ open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>

open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>>

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/","title":"invokeAny - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAny

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/#invokeany","title":"invokeAny","text":"

[jvm]\\ open override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Any

open override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/","title":"submit - Misk","text":"

//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/submit

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/#submit","title":"submit","text":"

[jvm]\\ open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>

open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T>

open override fun submit(runnable: Runnable): ListenableFuture<*>

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/","title":"Package-level declarations - Misk","text":"

//misk-action-scopes/misk.scope

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#types","title":"Types","text":"Name Summary ActionScope [jvm]@Singletonclass ActionScope : AutoCloseable ActionScopedProviderModule [jvm]abstract class ActionScopedProviderModule : KAbstractModuleModule used by components and applications to provide ActionScoped context objects SeedDataTransformer [jvm]interface SeedDataTransformerWhile executing, actions have ActionScoped values that can be injected by anything running within the action."},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/","title":"ActionScope - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#actionscope","title":"ActionScope","text":"

[jvm]\\ @Singleton

class ActionScope : AutoCloseable

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Instance [jvm]class Instance : AutoCloseable"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#functions","title":"Functions","text":"Name Summary asContextElement [jvm]fun asContextElement(): CoroutineContext.ElementConverts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on. close [jvm]open override fun close() create [jvm]@JvmOverloadsfun create(seedData: Map<Key<>, Any?>, providerOverrides: Map<Key<>, ActionScopedProvider<*>> = emptyMap()): ActionScope.InstanceCreates a new scope on the current thread with the provided seed data get [jvm]fun <T> get(key: Key<T>): TReturns the action scoped value for the given key inScope [jvm]fun inScope(): BooleanReturns true if currently in the scope propagate [jvm]fun <T> propagate(c: Callable<T>): Callable<T>Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: () -> T): () -> TWraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: KFunction<T>): KFunction<T>Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread snapshotActionScopeInstance [jvm]fun snapshotActionScopeInstance(): ActionScope.Instance"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/","title":"asContextElement - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/asContextElement

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/#ascontextelement","title":"asContextElement","text":"

[jvm]\\ fun asContextElement(): CoroutineContext.Element

Converts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on.

Example usage:

scope.enter(seedData).use {\n  runBlocking(scope.asContextElement()) {\n    async(Dispatchers.IO) {\n      tester.fooValue()\n    }.await()\n  }\n}\n
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/close/","title":"close - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/close

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/close/#close","title":"close","text":"

[jvm]\\ open override fun close()

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/","title":"create - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/create

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/#create","title":"create","text":"

[jvm]\\

@JvmOverloads

fun create(seedData: Map<Key<>, Any?>, providerOverrides: Map<Key<>, ActionScopedProvider<*>> = emptyMap()): ActionScope.Instance

Creates a new scope on the current thread with the provided seed data

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/","title":"get - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/get

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/#get","title":"get","text":"

[jvm]\\ fun <T> get(key: Key<T>): T

Returns the action scoped value for the given key

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/","title":"inScope - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/inScope

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/#inscope","title":"inScope","text":"

[jvm]\\ fun inScope(): Boolean

Returns true if currently in the scope

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/","title":"propagate - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/propagate

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/#propagate","title":"propagate","text":"

[jvm]\\ fun <T> propagate(c: Callable<T>): Callable<T>

Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread

[jvm]\\ fun <T> propagate(f: KFunction<T>): KFunction<T>

Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread

[jvm]\\ fun <T> propagate(f: () -> T): () -> T

Wraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/","title":"snapshotActionScopeInstance - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/snapshotActionScopeInstance

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/#snapshotactionscopeinstance","title":"snapshotActionScopeInstance","text":"

[jvm]\\ fun snapshotActionScopeInstance(): ActionScope.Instance

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/","title":"Companion - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/Companion

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/","title":"Instance - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/Instance

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#instance","title":"Instance","text":"

[jvm]\\ class Instance : AutoCloseable

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#functions","title":"Functions","text":"Name Summary close [jvm]open override fun close() enter [jvm]fun enter() inScope [jvm]fun <T> inScope(block: () -> T): T"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/","title":"enter - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/Instance/enter

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/#enter","title":"enter","text":"

[jvm]\\ fun enter()

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/","title":"inScope - Misk","text":"

//misk-action-scopes/misk.scope/ActionScope/Instance/inScope

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/#inscope","title":"inScope","text":"

[jvm]\\ fun <T> inScope(block: () -> T): T

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"

[jvm]\\ abstract class ActionScopedProviderModule : KAbstractModule

Module used by components and applications to provide ActionScoped context objects

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#constructors","title":"Constructors","text":"ActionScopedProviderModule [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]@JvmOverloadsfun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)@JvmOverloadsfun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)Binds a provider that returns a constant value on every invocation. bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)Binds an annotation qualified ActionScoped along with its provider bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)Binds an ActionScoped which only pulls from data seeded at the scope entry[jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]abstract fun configureProviders()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/ActionScopedProviderModule

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"

[jvm]\\ constructor()

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/","title":"bindConstant - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindConstant

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/#bindconstant","title":"bindConstant","text":"

[jvm]\\

@JvmOverloads

fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)

@JvmOverloads

fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)

Binds a provider that returns a constant value on every invocation.

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/","title":"bindProvider - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindProvider

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/#bindprovider","title":"bindProvider","text":"

[jvm]\\

@JvmOverloads

fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)

@JvmOverloads

fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)

fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)

fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)

Binds an annotation qualified ActionScoped along with its provider

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/","title":"bindSeedData - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindSeedData

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/#bindseeddata","title":"bindSeedData","text":"

[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>)

fun <T : Any> bindSeedData(type: TypeLiteral<T>)

Binds an ActionScoped which only pulls from data seeded at the scope entry

[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)

fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)

fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)

Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/","title":"configureProviders - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/configureProviders

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/#configureproviders","title":"configureProviders","text":"

[jvm]\\ abstract fun configureProviders()

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/","title":"Companion - Misk","text":"

//misk-action-scopes/misk.scope/ActionScopedProviderModule/Companion

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/","title":"SeedDataTransformer - Misk","text":"

//misk-action-scopes/misk.scope/SeedDataTransformer

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#seeddatatransformer","title":"SeedDataTransformer","text":"

[jvm]\\ interface SeedDataTransformer

While executing, actions have ActionScoped values that can be injected by anything running within the action.

For example, these values are seeded by default for web actions:

These types are the initial keys in the seedData map; they map to the corresponding instances. Implementations of this interface may modify this map.

To add new seed data keys, you must also subclass ActionScopedProviderModule and call ActionScopedProviderModule.bindSeedData. This makes the seed data type injectable by Guice.

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#functions","title":"Functions","text":"Name Summary transform [jvm]abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/","title":"transform - Misk","text":"

//misk-action-scopes/misk.scope/SeedDataTransformer/transform

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/#transform","title":"transform","text":"

[jvm]\\ abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/","title":"Package-level declarations - Misk","text":"

//misk-action-scopes/misk.scope.executor

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#types","title":"Types","text":"Name Summary ActionScopedExecutorService [jvm]class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorServiceWraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"

//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"

[jvm]\\ class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorService

Wraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#constructors","title":"Constructors","text":"ActionScopedExecutorService [jvm]constructor(target: ExecutorService, scope: ActionScope)"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"

//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService/ActionScopedExecutorService

"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"

[jvm]\\ constructor(target: ExecutorService, scope: ActionScope)

"},{"location":"0.x/misk-actions/","title":"misk-actions - Misk","text":"

//misk-actions

"},{"location":"0.x/misk-actions/#misk-actions","title":"misk-actions","text":""},{"location":"0.x/misk-actions/#packages","title":"Packages","text":"Name misk misk.exceptions misk.security.authz misk.web misk.web.actions misk.web.dashboard misk.web.interceptors"},{"location":"0.x/misk-actions/misk-actions/misk/","title":"Package-level declarations - Misk","text":"

//misk-actions/misk

"},{"location":"0.x/misk-actions/misk-actions/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk/#types","title":"Types","text":"Name Summary MiskCaller [jvm]data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())Information about the authenticated caller of a given action"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/","title":"MiskCaller - Misk","text":"

//misk-actions/misk/MiskCaller

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#miskcaller","title":"MiskCaller","text":"

[jvm]\\ data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())

Information about the authenticated caller of a given action

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#constructors","title":"Constructors","text":"MiskCaller [jvm]@JvmOverloadsconstructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#properties","title":"Properties","text":"Name Summary capabilities [jvm]val capabilities: Set<String>Set of capabilities given to a human user, typically provided by the SSO infrastructure principal [jvm]val principal: StringThe identity of the calling principal, regardless of whether they are a service or a user service [jvm]val service: String? = nullPresent if the caller is an authenticated peer service user [jvm]val user: String? = nullPresent if the caller is a human user, typically from an SSO proxy"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#functions","title":"Functions","text":"Name Summary hasCapability [jvm]fun hasCapability(allowedCapabilities: Set<String>): BooleanCheck whether the caller has one of allowedCapabilities. isService [jvm]fun isService(allowedServices: Set<String>): BooleanCheck whether this is a service-to-service call from one of allowedServices. toString [jvm]open override fun toString(): StringWe don\u2019t like to log usernames."},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/","title":"MiskCaller - Misk","text":"

//misk-actions/misk/MiskCaller/MiskCaller

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/#miskcaller","title":"MiskCaller","text":"

[jvm]\\

@JvmOverloads

constructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/","title":"capabilities - Misk","text":"

//misk-actions/misk/MiskCaller/capabilities

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/#capabilities","title":"capabilities","text":"

[jvm]\\ val capabilities: Set<String>

Set of capabilities given to a human user, typically provided by the SSO infrastructure

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/","title":"hasCapability - Misk","text":"

//misk-actions/misk/MiskCaller/hasCapability

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/#hascapability","title":"hasCapability","text":"

[jvm]\\ fun hasCapability(allowedCapabilities: Set<String>): Boolean

Check whether the caller has one of allowedCapabilities.

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/","title":"isService - Misk","text":"

//misk-actions/misk/MiskCaller/isService

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/#isservice","title":"isService","text":"

[jvm]\\ fun isService(allowedServices: Set<String>): Boolean

Check whether this is a service-to-service call from one of allowedServices.

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/","title":"principal - Misk","text":"

//misk-actions/misk/MiskCaller/principal

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/#principal","title":"principal","text":"

[jvm]\\ val principal: String

The identity of the calling principal, regardless of whether they are a service or a user

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/","title":"service - Misk","text":"

//misk-actions/misk/MiskCaller/service

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/#service","title":"service","text":"

[jvm]\\ val service: String? = null

Present if the caller is an authenticated peer service

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/","title":"toString - Misk","text":"

//misk-actions/misk/MiskCaller/toString

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

We don\u2019t like to log usernames.

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/","title":"user - Misk","text":"

//misk-actions/misk/MiskCaller/user

"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/#user","title":"user","text":"

[jvm]\\ val user: String? = null

Present if the caller is a human user, typically from an SSO proxy

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/","title":"Package-level declarations - Misk","text":"

//misk-actions/misk.exceptions

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#types","title":"Types","text":"Name Summary BadGatewayException [jvm]open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller. BadRequestException [jvm]open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for bad client requests ClientClosedRequestException [jvm]open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. ConflictException [jvm]open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a request causes a conflict GatewayTimeoutException [jvm]open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller. NotFoundException [jvm]open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when resources are not found PayloadTooLargeException [jvm]open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException ResourceUnavailableException [jvm]open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a resource is unavailable. The message is not exposed to the caller. TooManyRequestsException [jvm]open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnauthenticatedException [jvm]open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authentication fails UnauthorizedException [jvm]open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authenticated credentials lack access to a resource UnprocessableEntityException [jvm]open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnsupportedMediaTypeException [jvm]open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException WebActionException [jvm]open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeExceptionEven though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#functions","title":"Functions","text":"Name Summary requireRequest [jvm]inline fun requireRequest(check: Boolean, lazyMessage: () -> String)Similar to kotlin.require, but throws BadRequestException if the check fails requireRequestNotNull [jvm]inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): TSimilar to kotlin.requireNotNull, but throws BadRequestException if the check fails"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/","title":"requireRequestNotNull - Misk","text":"

//misk-actions/misk.exceptions/requireRequestNotNull

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/#requirerequestnotnull","title":"requireRequestNotNull","text":"

[jvm]\\ inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): T

Similar to kotlin.requireNotNull, but throws BadRequestException if the check fails

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/","title":"requireRequest - Misk","text":"

//misk-actions/misk.exceptions/requireRequest

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/#requirerequest","title":"requireRequest","text":"

[jvm]\\ inline fun requireRequest(check: Boolean, lazyMessage: () -> String)

Similar to kotlin.require, but throws BadRequestException if the check fails

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"

//misk-actions/misk.exceptions/BadGatewayException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"

[jvm]\\ open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#constructors","title":"Constructors","text":"BadGatewayException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"

//misk-actions/misk.exceptions/BadGatewayException/BadGatewayException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/","title":"BadRequestException - Misk","text":"

//misk-actions/misk.exceptions/BadRequestException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"

[jvm]\\ open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for bad client requests

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#constructors","title":"Constructors","text":"BadRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/","title":"BadRequestException - Misk","text":"

//misk-actions/misk.exceptions/BadRequestException/BadRequestException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"

//misk-actions/misk.exceptions/ClientClosedRequestException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"

[jvm]\\ open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

This exception is custom to Misk.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#constructors","title":"Constructors","text":"ClientClosedRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"

//misk-actions/misk.exceptions/ClientClosedRequestException/ClientClosedRequestException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/","title":"ConflictException - Misk","text":"

//misk-actions/misk.exceptions/ConflictException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#conflictexception","title":"ConflictException","text":"

[jvm]\\ open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when a request causes a conflict

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#constructors","title":"Constructors","text":"ConflictException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/","title":"ConflictException - Misk","text":"

//misk-actions/misk.exceptions/ConflictException/ConflictException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/#conflictexception","title":"ConflictException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"

//misk-actions/misk.exceptions/GatewayTimeoutException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"

[jvm]\\ open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#constructors","title":"Constructors","text":"GatewayTimeoutException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"

//misk-actions/misk.exceptions/GatewayTimeoutException/GatewayTimeoutException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/","title":"NotFoundException - Misk","text":"

//misk-actions/misk.exceptions/NotFoundException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"

[jvm]\\ open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when resources are not found

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#constructors","title":"Constructors","text":"NotFoundException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/","title":"NotFoundException - Misk","text":"

//misk-actions/misk.exceptions/NotFoundException/NotFoundException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"

//misk-actions/misk.exceptions/PayloadTooLargeException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"

[jvm]\\ open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#constructors","title":"Constructors","text":"PayloadTooLargeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"

//misk-actions/misk.exceptions/PayloadTooLargeException/PayloadTooLargeException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"

//misk-actions/misk.exceptions/ResourceUnavailableException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"

[jvm]\\ open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when a resource is unavailable. The message is not exposed to the caller.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#constructors","title":"Constructors","text":"ResourceUnavailableException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"

//misk-actions/misk.exceptions/ResourceUnavailableException/ResourceUnavailableException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"

//misk-actions/misk.exceptions/TooManyRequestsException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"

[jvm]\\ open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

This exception is custom to Misk.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#constructors","title":"Constructors","text":"TooManyRequestsException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"

//misk-actions/misk.exceptions/TooManyRequestsException/TooManyRequestsException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"

//misk-actions/misk.exceptions/UnauthenticatedException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"

[jvm]\\ open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when authentication fails

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#constructors","title":"Constructors","text":"UnauthenticatedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"

//misk-actions/misk.exceptions/UnauthenticatedException/UnauthenticatedException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"

//misk-actions/misk.exceptions/UnauthorizedException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"

[jvm]\\ open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

Base exception for when authenticated credentials lack access to a resource

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#constructors","title":"Constructors","text":"UnauthorizedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"

//misk-actions/misk.exceptions/UnauthorizedException/UnauthorizedException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"

//misk-actions/misk.exceptions/UnprocessableEntityException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"

[jvm]\\ open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

This exception is custom to Misk.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#constructors","title":"Constructors","text":"UnprocessableEntityException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"

//misk-actions/misk.exceptions/UnprocessableEntityException/UnprocessableEntityException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"

//misk-actions/misk.exceptions/UnsupportedMediaTypeException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"

[jvm]\\ open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#constructors","title":"Constructors","text":"UnsupportedMediaTypeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"

//misk-actions/misk.exceptions/UnsupportedMediaTypeException/UnsupportedMediaTypeException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"

[jvm]\\

@JvmOverloads

constructor(message: String = \"\", cause: Throwable? = null)

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/","title":"WebActionException - Misk","text":"

//misk-actions/misk.exceptions/WebActionException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#webactionexception","title":"WebActionException","text":"

open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeException

Even though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#inheritors","title":"Inheritors","text":"NotFoundException UnauthenticatedException UnauthorizedException ResourceUnavailableException BadRequestException ConflictException UnprocessableEntityException TooManyRequestsException ClientClosedRequestException BadGatewayException GatewayTimeoutException PayloadTooLargeException UnsupportedMediaTypeException"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#constructors","title":"Constructors","text":"WebActionException [jvm]constructor(code: Int, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/","title":"WebActionException - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/WebActionException

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/#webactionexception","title":"WebActionException","text":"

[jvm]\\ constructor(code: Int, message: String, cause: Throwable? = null)

constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)

constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/","title":"code - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/code

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/#code","title":"code","text":"

[jvm]\\ val code: Int

The HTTP status code. Should be 400..599.

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/","title":"details - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/details

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/#details","title":"details","text":"

[jvm]\\ val details: List<AnyMessage>

Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses.

Reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/","title":"grpcStatus - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/grpcStatus

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/#grpcstatus","title":"grpcStatus","text":"

[jvm]\\ val grpcStatus: GrpcStatus? = null

The gPRC status code. If unset, it will be inferred from code.

Reference: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/","title":"isClientError - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/isClientError

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/#isclienterror","title":"isClientError","text":"

[jvm]\\ val isClientError: Boolean

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/","title":"isServerError - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/isServerError

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/#isservererror","title":"isServerError","text":"

[jvm]\\ val isServerError: Boolean

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/","title":"responseBody - Misk","text":"

//misk-actions/misk.exceptions/WebActionException/responseBody

"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/#responsebody","title":"responseBody","text":"

[jvm]\\ val responseBody: String

This is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body.

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/","title":"Package-level declarations - Misk","text":"

//misk-actions/misk.security.authz

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#types","title":"Types","text":"Name Summary Authenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services Unauthenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class UnauthenticatedAnnotation indicating that a given action supports unauthenticated access"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/","title":"Authenticated - Misk","text":"

//misk-actions/misk.security.authz/Authenticated

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#authenticated","title":"Authenticated","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)

Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#properties","title":"Properties","text":"Name Summary allowAnyService [jvm]val allowAnyService: Boolean = falseAllow any service to be authenticated. allowAnyUser [jvm]val allowAnyUser: Boolean = falseAllow any user to be authenticated. capabilities [jvm]val capabilities: Array<String>Calling users must have at least one of these capabilities to be authenticated services [jvm]val services: Array<String>Calling services must be listed here to be authenticated"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/","title":"allowAnyService - Misk","text":"

//misk-actions/misk.security.authz/Authenticated/allowAnyService

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/#allowanyservice","title":"allowAnyService","text":"

[jvm]\\ val allowAnyService: Boolean = false

Allow any service to be authenticated.

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/","title":"allowAnyUser - Misk","text":"

//misk-actions/misk.security.authz/Authenticated/allowAnyUser

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"

[jvm]\\ val allowAnyUser: Boolean = false

Allow any user to be authenticated.

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/","title":"capabilities - Misk","text":"

//misk-actions/misk.security.authz/Authenticated/capabilities

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/#capabilities","title":"capabilities","text":"

[jvm]\\ val capabilities: Array<String>

Calling users must have at least one of these capabilities to be authenticated

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/","title":"services - Misk","text":"

//misk-actions/misk.security.authz/Authenticated/services

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/#services","title":"services","text":"

[jvm]\\ val services: Array<String>

Calling services must be listed here to be authenticated

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/","title":"Unauthenticated - Misk","text":"

//misk-actions/misk.security.authz/Unauthenticated

"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/#unauthenticated","title":"Unauthenticated","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Unauthenticated

Annotation indicating that a given action supports unauthenticated access

"},{"location":"0.x/misk-actions/misk-actions/misk.web/","title":"Package-level declarations - Misk","text":"

//misk-actions/misk.web

"},{"location":"0.x/misk-actions/misk-actions/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web/#types","title":"Types","text":"Name Summary AvailableWhenDegraded [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AvailableWhenDegradedWhen the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP. ConnectWebSocket [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ConnectWebSocket(val pathPattern: String) Delete [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Delete(val pathPattern: String) Description [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Description(val text: String) FormField [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormField(val name: String) FormValue [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormValue Get [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Get(val pathPattern: String) Grpc [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Grpc(val pathPattern: String) Patch [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Patch(val pathPattern: String) PathParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class PathParam(val value: String = \"\") Post [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Post(val pathPattern: String) Put [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Put(val pathPattern: String) QueryParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class QueryParam(val value: String = \"\") RequestBody [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestBody RequestContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class RequestContentType(val value: String) RequestHeaders [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestHeaders Response [jvm]data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })An HTTP response body, headers, and status code. ResponseBody [jvm]interface ResponseBody ResponseContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ResponseContentType(val value: String)Indicates what response content types the action can produce. WebActionModule [jvm]class WebActionModule<A : WebAction> : KAbstractModule"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/","title":"AvailableWhenDegraded - Misk","text":"

//misk-actions/misk.web/AvailableWhenDegraded

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/#availablewhendegraded","title":"AvailableWhenDegraded","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class AvailableWhenDegraded

When the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP.

We must not shed calls to status endpoints like health checks as doing so may create cascading failures: overloaded instances that do not respond to health checks will be killed, and this further overloads the remaining peers.

Only put this on endpoints that must never be rejected. Such endpoints must not do RPCs, database queries or other I/O because unexpected latency there can take down the entire service.

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/","title":"ConnectWebSocket - Misk","text":"

//misk-actions/misk.web/ConnectWebSocket

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#connectwebsocket","title":"ConnectWebSocket","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ConnectWebSocket(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/ConnectWebSocket/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/","title":"Delete - Misk","text":"

//misk-actions/misk.web/Delete

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#delete","title":"Delete","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Delete(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Delete/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/","title":"Description - Misk","text":"

//misk-actions/misk.web/Description

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#description","title":"Description","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Description(val text: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#properties","title":"Properties","text":"Name Summary text [jvm]val text: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/","title":"text - Misk","text":"

//misk-actions/misk.web/Description/text

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/#text","title":"text","text":"

[jvm]\\ val text: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/","title":"FormField - Misk","text":"

//misk-actions/misk.web/FormField

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#formfield","title":"FormField","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FormField(val name: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/","title":"name - Misk","text":"

//misk-actions/misk.web/FormField/name

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/#name","title":"name","text":"

[jvm]\\ val name: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/","title":"FormValue - Misk","text":"

//misk-actions/misk.web/FormValue

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/#formvalue","title":"FormValue","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class FormValue

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/","title":"Get - Misk","text":"

//misk-actions/misk.web/Get

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#get","title":"Get","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Get(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Get/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/","title":"Grpc - Misk","text":"

//misk-actions/misk.web/Grpc

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#grpc","title":"Grpc","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Grpc(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Grpc/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/","title":"Patch - Misk","text":"

//misk-actions/misk.web/Patch

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#patch","title":"Patch","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Patch(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Patch/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/","title":"PathParam - Misk","text":"

//misk-actions/misk.web/PathParam

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#pathparam","title":"PathParam","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class PathParam(val value: String = \"\")

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/","title":"value - Misk","text":"

//misk-actions/misk.web/PathParam/value

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/#value","title":"value","text":"

[jvm]\\ val value: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/","title":"Post - Misk","text":"

//misk-actions/misk.web/Post

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#post","title":"Post","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Post(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Post/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/","title":"Put - Misk","text":"

//misk-actions/misk.web/Put

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#put","title":"Put","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Put(val pathPattern: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/","title":"pathPattern - Misk","text":"

//misk-actions/misk.web/Put/pathPattern

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/#pathpattern","title":"pathPattern","text":"

[jvm]\\ val pathPattern: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/","title":"QueryParam - Misk","text":"

//misk-actions/misk.web/QueryParam

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#queryparam","title":"QueryParam","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class QueryParam(val value: String = \"\")

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/","title":"value - Misk","text":"

//misk-actions/misk.web/QueryParam/value

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/#value","title":"value","text":"

[jvm]\\ val value: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/","title":"RequestBody - Misk","text":"

//misk-actions/misk.web/RequestBody

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/#requestbody","title":"RequestBody","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class RequestBody

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/","title":"RequestContentType - Misk","text":"

//misk-actions/misk.web/RequestContentType

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#requestcontenttype","title":"RequestContentType","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class RequestContentType(val value: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#properties","title":"Properties","text":"Name Summary value [jvm]val value: Array<out String>"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/","title":"value - Misk","text":"

//misk-actions/misk.web/RequestContentType/value

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/#value","title":"value","text":"

[jvm]\\ val value: Array<out String>

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/","title":"RequestHeaders - Misk","text":"

//misk-actions/misk.web/RequestHeaders

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/#requestheaders","title":"RequestHeaders","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class RequestHeaders

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/","title":"Response - Misk","text":"

//misk-actions/misk.web/Response

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#response","title":"Response","text":"

[jvm]\\ data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })

An HTTP response body, headers, and status code.

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#constructors","title":"Constructors","text":"Response [jvm]@JvmOverloadsconstructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#properties","title":"Properties","text":"Name Summary body [jvm]val body: T headers [jvm]val headers: Headers statusCode [jvm]val statusCode: Int = 200 trailers [jvm]val trailers: () -> Headers?"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/","title":"Response - Misk","text":"

//misk-actions/misk.web/Response/Response

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/#response","title":"Response","text":"

[jvm]\\

@JvmOverloads

constructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/","title":"body - Misk","text":"

//misk-actions/misk.web/Response/body

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/#body","title":"body","text":"

[jvm]\\ val body: T

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/","title":"headers - Misk","text":"

//misk-actions/misk.web/Response/headers

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/#headers","title":"headers","text":"

[jvm]\\ val headers: Headers

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/","title":"statusCode - Misk","text":"

//misk-actions/misk.web/Response/statusCode

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/#statuscode","title":"statusCode","text":"

[jvm]\\ val statusCode: Int = 200

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/","title":"toString - Misk","text":"

//misk-actions/misk.web/Response/toString

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/#tostring","title":"toString","text":"

[jvm]\\ open override fun toString(): String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/","title":"trailers - Misk","text":"

//misk-actions/misk.web/Response/trailers

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/#trailers","title":"trailers","text":"

[jvm]\\ val trailers: () -> Headers?

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/","title":"ResponseBody - Misk","text":"

//misk-actions/misk.web/ResponseBody

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#responsebody","title":"ResponseBody","text":"

[jvm]\\ interface ResponseBody

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#functions","title":"Functions","text":"Name Summary writeTo [jvm]abstract fun writeTo(sink: BufferedSink)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/","title":"writeTo - Misk","text":"

//misk-actions/misk.web/ResponseBody/writeTo

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/#writeto","title":"writeTo","text":"

[jvm]\\ abstract fun writeTo(sink: BufferedSink)

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/","title":"ResponseContentType - Misk","text":"

//misk-actions/misk.web/ResponseContentType

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/#responsecontenttype","title":"ResponseContentType","text":"

[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class ResponseContentType(val value: String)

Indicates what response content types the action can produce.

Clients can specify what content type they prefer by setting the Accept header. If the action supports multiple content types but no Accept header is specified, the first content type is used.

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/#properties","title":"Properties","text":"Name Summary value [jvm]val value: Array<out String>"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/value/","title":"value - Misk","text":"

//misk-actions/misk.web/ResponseContentType/value

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/value/#value","title":"value","text":"

[jvm]\\ val value: Array<out String>

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/","title":"WebActionModule - Misk","text":"

//misk-actions/misk.web/WebActionModule

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#webactionmodule","title":"WebActionModule","text":"

[jvm]\\ class WebActionModule<A : WebAction> : KAbstractModule

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<A> url_path_prefix [jvm]val url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/","title":"actionClass - Misk","text":"

//misk-actions/misk.web/WebActionModule/actionClass

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/#actionclass","title":"actionClass","text":"

[jvm]\\ val actionClass: KClass<A>

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/","title":"url_path_prefix - Misk","text":"

//misk-actions/misk.web/WebActionModule/url_path_prefix

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"

[jvm]\\ val url_path_prefix: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/","title":"Companion - Misk","text":"

//misk-actions/misk.web/WebActionModule/Companion

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#companion","title":"Companion","text":"

[jvm]\\ object Companion

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <A : WebAction> create(): WebActionModule<A>@JvmStaticfun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>[jvm]fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>Registers a web action. createWithPrefix [jvm]inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>@JvmStaticfun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>[jvm]fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>Registers a web action with a path prefix."},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/","title":"createWithPrefix - Misk","text":"

//misk-actions/misk.web/WebActionModule/Companion/createWithPrefix

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#createwithprefix","title":"createWithPrefix","text":"

[jvm]\\ inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>

@JvmStatic

fun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>

[jvm]\\ fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>

Registers a web action with a path prefix.

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#parameters","title":"Parameters","text":"

jvm

actionClass : The web action to register. url_path_prefix : Defaults to \"/\". If not empty, must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/","title":"create - Misk","text":"

//misk-actions/misk.web/WebActionModule/Companion/create

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#create","title":"create","text":"

[jvm]\\ inline fun <A : WebAction> create(): WebActionModule<A>

@JvmStatic

fun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>

[jvm]\\ fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>

Registers a web action.

"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#parameters","title":"Parameters","text":"

jvm

actionClass : The web action to register."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/","title":"Package-level declarations - Misk","text":"

//misk-actions/misk.web.actions

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#types","title":"Types","text":"Name Summary WebAction [jvm]interface WebAction WebActionEntry [jvm]data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntryWebActionEntry WebSocket [jvm]interface WebSocketA non-blocking interface to a web socket. WebSocketListener [jvm]open class WebSocketListener"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/","title":"WebAction - Misk","text":"

//misk-actions/misk.web.actions/WebAction

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/#webaction","title":"WebAction","text":"

[jvm]\\ interface WebAction

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/","title":"WebActionEntry - Misk","text":"

//misk-actions/misk.web.actions/WebActionEntry

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"

data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntry

WebActionEntry

A registration of a web action with optional configuration to customize.

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#parameters","title":"Parameters","text":"

jvm

actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#constructors","title":"Constructors","text":"WebActionEntry [jvm]constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<out WebAction> url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/","title":"WebActionEntry - Misk","text":"

//misk-actions/misk.web.actions/WebActionEntry/WebActionEntry

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"

[jvm]\\ constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#parameters","title":"Parameters","text":"

jvm

actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/","title":"actionClass - Misk","text":"

//misk-actions/misk.web.actions/WebActionEntry/actionClass

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#actionclass","title":"actionClass","text":"

[jvm]\\ val actionClass: KClass<out WebAction>

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#parameters","title":"Parameters","text":"

jvm

actionClass : WebAction to multibind to WebServlet"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"

//misk-actions/misk.web.actions/WebActionEntry/url_path_prefix

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"

[jvm]\\ val url_path_prefix: String

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#parameters","title":"Parameters","text":"

jvm

url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/","title":"WebSocket - Misk","text":"

//misk-actions/misk.web.actions/WebSocket

"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/#websocket","title":"WebSocket","text":"

[jvm]\\ interface WebSocket

A non-blocking interface to a web socket.

Web Socket Lifecycle

Upon normal operation each web socket progresses through a sequence of states:

AutoCloseableLease[jvm]
class AutoCloseableLease(lease: Lease) : Lease, AutoCloseable
Converts a lease into an AutoCloseable resource.		[jvm]
class AutoCloseableLease(lease: Lease) : Lease, AutoCloseable
Converts a lease into an AutoCloseable resource.
Lease