All Classes and Interfaces

Class	Description
ActionDispatchHost	Implemented by request-scoped contexts that participate in the POST-handler dispatch chain via the context.actions registry.
AnsiJson	Fast ANSI colorizer for JSON text.
ApacheHttpClient
AuthHandler
AuthorizationCodeAuthHandler	OAuth 2.0 Authorization Code + PKCE Auth Handler.
Background
BaseElement	Locator-based Element implementation that delegates all operations to a Driver.
BasicAuthHandler
BearerAuthHandler
BootBinding	Backing object for the boot global exposed inside karate-boot.js.
BootLoader	Discovers karate-boot.js (workdir root, then classpath root) and evaluates it once per Suite.
CdpClient	Chrome DevTools Protocol client built on WebSocket.
CdpDialog	CDP-based implementation of Dialog.
CdpDriver	CDP-based browser driver implementation.
CdpDriverOptions	CDP-specific driver configuration options.
CdpDriverOptions.Builder
CdpEvent	Wrapper for Chrome DevTools Protocol events with JSONPath extraction.
CdpEventListener	Listener interface for CDP events.
CdpKeys	CDP-based implementation of keyboard actions.
CdpLauncher	CDP-based browser launcher.
CdpMessage	Fluent builder for Chrome DevTools Protocol messages.
CdpMouse	CDP-based implementation of mouse actions.
CdpResponse	Wrapper for Chrome DevTools Protocol responses with JSONPath extraction.
Channel	Represents an async channel (e.g. kafka, grpc) created by a ChannelFactory.
ChannelFactory	Factory for creating Channel instances.
CleanCommand	The 'clean' subcommand for cleaning Karate output directories.
CliCommandProvider	SPI for ext JARs to contribute karate CLI subcommands (e.g.
ClientCredentialsAuthHandler
ConfigLoader	Config-only evaluation: evaluate a project's karate-base.js + karate-config.js (+ the env-specific karate-config-<env>.js) for a working dir and return the merged config Map without running any features (no SUITE_ENTER/SUITE_EXIT, no scenarios).
Console	Console output utilities with ANSI color support.
Cookies
CoreDriver	Core driver interface defining the primitive operations.
CsrfProtection	CSRF (Cross-Site Request Forgery) protection utilities.
CsrfProtection.CsrfToken	CSRF token object exposed to templates.
CucumberJsonReportListener	A ResultListener that generates Cucumber JSON reports.
CucumberJsonWriter	Generates Cucumber JSON reports compatible with third-party tools (Allure, ReportPortal, etc.).
DataUtils
DefaultHttpClientFactory	Default implementation of HttpClientFactory that creates a new ApacheHttpClient instance for each call.
Dialog	Interface for JavaScript dialogs (alert, confirm, prompt, or beforeunload).
DialogHandler	Functional interface for handling JavaScript dialogs (alert, confirm, prompt, beforeunload).
DialogOpenedException	Thrown when a pending Runtime.evaluate is cancelled because a JavaScript dialog (alert, confirm, prompt) opened in the browser.
DiskBackedList	A disk-backed list implementation for handling large collections without exhausting memory.
Driver	Browser automation driver interface.
DriverApi
DriverException	Runtime exception for browser driver errors.
DriverOptions	Base options interface for browser drivers.
DriverProvider	Provider for browser driver instances.
Element	Represents a DOM element found by a locator.
ErrorRunEvent	Error event (ERROR).
ExamplesTable
Expect	Chai-style BDD assertion API for Karate.
Ext	Karate ext SPI — singletons-per-Suite that observe the run via RunListener.
ExtGlobalFactory	Mints a per-scenario ext-global instance, bound fresh into each scenario's JS scope.
ExtHint	Turns a bare ReferenceError: X is not defined inside a step into an actionable failure — when X is a global that an ext would have bound, had the project declared it.
Faker	Faker API for generating random test data.
Feature
FeatureCall	Wrapper for a Feature with an optional tag selector.
FeatureResult
FeatureRunEvent	Feature-level events (FEATURE_ENTER, FEATURE_EXIT).
FeatureRuntime
FeatureSection
FileSessionStore	File-based implementation of SessionStore.
Finder	Positional element finder for relative locators.
Finder.Position
FragmentTraceHandler	Devmode post-processor that emits paired <!-- ka:fragment-begin --> / <!-- ka:fragment-end --> comments around every fragment resolution and suppresses the synthetic <ka-trace> wrapper element that TraceWrappingHandler injected at processor time.
GherkinLexer	Lexer for Gherkin syntax with embedded JavaScript expressions.
GherkinParser
Globals	Global constants and utilities for Karate runtime.
HtmlReportListener	A ResultListener that generates HTML reports.
HtmlReportWriter	Generates HTML reports with inlined JSON data and Alpine.js client-side rendering.
Http	Fluent HTTP client API for making HTTP requests from Java code.
HttpClient
HttpClientFactory	Factory for creating HttpClient instances.
HttpLogger
HttpRequest
HttpRequestBuilder
HttpResponse
HttpRunEvent	HTTP-level events (HTTP_ENTER, HTTP_EXIT).
HttpServer
HttpServerHandler
HttpUtils
HttpUtils.Header
HttpUtils.Method
HxDialect	Thymeleaf dialect for HTMX support.
InMemorySessionStore	In-memory implementation of SessionStore.
InterceptHandler	Functional interface for handling intercepted network requests.
InterceptRequest	Represents an intercepted HTTP request.
InterceptResponse	Represents a mock HTTP response for request interception.
Json
JsonLinesEventWriter	A RunListener that streams events to a JSON Lines (.jsonl) file.
JunitXmlReportListener	A ResultListener that generates JUnit XML reports.
JunitXmlWriter	Generates JUnit XML reports compatible with CI systems (Jenkins, GitHub Actions, etc.).
KarateConfig	Holds runtime configuration settings set via the 'configure' keyword.
KarateException	The exception surfaced to callers (JUnit / surefire, the fluent Runner API, any code that catches a Karate failure) when a step fails.
KarateJs	Main implementation of the karate.* JavaScript API.
KarateJsContext	Minimal context interface for KarateJs to access runtime information.
KarateJsUtils	Stateless utility methods for the karate.* JavaScript API.
KarateOptionsHandler	Applies system-property and environment-variable overrides to a Runner.Builder at the start of parallel().
KaratePom	Represents Karate project configuration loaded from karate-pom.json.
KaratePom.LoggingPom	Logging configuration nested object.
KaratePom.OutputPom	Output configuration nested object.
Keys	Keyboard actions interface for browser automation.
LargeValueStore	Interface for handling large collections that may need to be stored on disk to avoid memory exhaustion.
LocalCallbackServer	Local HTTP server to capture OAuth redirect with authorization code.
Locators	Utility class for transforming locators into JavaScript expressions.
LogContext	Thread-local log collector for scenario execution.
LogContext.LogWriter	Fluent log writer that captures to LogContext buffer AND cascades to SLF4J.
LogContext.Snapshot	Snapshot of the report-buffer threshold, the log mask/pretty settings and — only if something changes them while it is live — the per-category Logback levels.
LogLevel
LogMask	Declarative HTTP log masking.
Main
Main	Main entry point for the Karate CLI.
Markup
MarkupConfig
MarkupContext	Context interface exposed to templates and server-side JavaScript.
MarkupScope	Current-eval scope accessor injected onto a MarkupContext by MarkupTemplateContext at engine-bind time.
MarkupTemplateContext
Match
Match.Type
MatchContext
MatchExpression	Represents a parsed match expression.
MockCommand	The 'mock' subcommand for starting mock servers.
MockConfig	Configuration holder for mock servers.
MockHandler	Mock server request handler that routes requests to matching scenarios.
MockServer	Deprecated, for removal: This API element is subject to removal in a future version. Use MockServer instead.
MockServer	Public API for creating mock servers from feature files.
MockServer.Builder	Deprecated, for removal: This API element is subject to removal in a future version. Use MockServer.Builder instead.
MockServer.Builder	Builder for creating MockServer instances.
Mouse	Mouse actions interface for browser automation.
MultiPartBuilder
OAuth2BrowserCallback	Callback interface for OAuth 2.0 browser-based authorization.
OAuth2Exception
OAuth2Token
OAuth2TokenManager	Manages OAuth 2.0 token storage and refresh.
Operation
OutlineRunEvent	Scenario-outline-level event (OUTLINE_ENTER).
PageLoadStrategy	Page load strategies for navigation.
PathSecurity	Provides protection against path traversal attacks in resource resolution.
PathSecurity.PathTraversalException	Exception thrown when a path traversal attempt is detected.
PerfContext	Interface for capturing custom performance events from Java code.
PerfEvent	Represents a performance event for Gatling integration.
PerfHook	Hook interface for performance testing integration (e.g., Gatling).
PkceGenerator	PKCE (Proof Key for Code Exchange) code verifier and challenge generator.
PooledDriverProvider	Driver provider that maintains a bounded pool of drivers.
PortUtils	Utilities for waiting on ports and HTTP endpoints.
ProcessBuilder	Builder for ProcessConfig.
ProcessConfig	Immutable configuration for process execution.
ProcessHandle	Main process wrapper exposed to JavaScript.
ProgressRunEvent	Progress event (PROGRESS).
ReportAssets	Imperative spec for one ext's report-asset contribution, built fluently inside Ext.onBoot(Suite) and handed to Suite.registerReportAssets(ReportAssets, ClassLoader) (see EXT.md § Report assets).
ReportAssets.Page	One nav-page (or other slot) contribution.
ResourceResolver
Result
Result.Failure	Represents a single failure in a match operation with structured data.
ResultListener	Interface for receiving test execution results as they stream in.
Results	Deprecated, for removal: This API element is subject to removal in a future version. Use SuiteResult instead.
RootResourceResolver	Resource resolver that resolves paths relative to a configured root.
RunCommand	The 'run' subcommand for executing Karate tests.
RunEvent	Base interface for runtime events fired during test execution.
RunEventType	Event types for the unified runtime event system.
RunListener	Unified listener interface for runtime events.
RunListenerFactory	Factory for creating per-thread RunListener instances.
Runner	Deprecated, for removal: This API element is subject to removal in a future version. Use Runner instead.
Runner	Main entry point for running Karate tests programmatically.
Runner.Builder	Deprecated, for removal: This API element is subject to removal in a future version. Use Runner.Builder instead.
Runner.Builder
RunUtils	Shared helpers for run-event JSON shaping — cross-run-stable slug computation and tag-text extraction.
SameSite	SameSite cookie attribute values per RFC 6265bis.
Scenario
ScenarioLockManager	Manages locks for parallel scenario execution.
ScenarioLockManager.LockHandle	Handle for releasing acquired locks.
ScenarioOutline
ScenarioResult
ScenarioRunEvent	Scenario-level events (SCENARIO_ENTER, SCENARIO_EXIT).
ScenarioRuntime
SecurityHeaders	Applies security headers to HTTP responses to protect against common web vulnerabilities.
ServerConfig	Configuration for the HTTP server including routing, sessions, and security settings.
ServerMarkupContext	Server-side context exposed to templates and API handlers.
ServerRequestCycle	Per-request lifecycle wrapper that provides isolated Engine instances.
ServerRequestHandler	Main request handler implementing routing for static files, API endpoints, and HTML templates.
ServerRequestHandler.RedirectException	Exception used internally to signal a redirect.
Session	Session state carrier.
SessionStore	Interface for session persistence.
SseConnection	Server-Sent Events connection wrapping a Netty channel.
SseHandler	Handler for Server-Sent Events (SSE) connections.
SslConfig	SSL/TLS configuration for both client and server contexts.
SslContextFactory	Factory for creating SSLContext instances from SslConfig.
SslUtils	SSL utilities for creating SSL contexts and self-signed certificates.
Step
StepExecutor
StepResult
StepResult.Embed	A named report embed, generalised to one-or-more StepResult.Parts plus optional meta (see EXT.md § Embeds).
StepResult.Part	One asset within an StepResult.Embed: either inline data (core writes the file and sets fileName) or a report-relative url (the ext wrote the asset itself, e.g. under ext/image/assets/).
StepResult.Status
StepRunEvent	Step-level events (STEP_ENTER, STEP_EXIT).
StepUtils	Static utility methods for step execution.
StepUtils.CallParts	The callable target and (optional) argument expression of a call step, e.g.
StepUtils.ParsedFeaturePath	Parsed result of a feature path with optional tag selector or line filter.
StepUtils.VarAndPath
Suite	Immutable suite configuration and execution engine.
SuiteResult
SuiteRunEvent	Suite-level events (SUITE_ENTER, SUITE_EXIT).
Table
Tag
TagSelector	Advanced tag selector supporting V1-compatible expressions.
TagSelector.Values	Values helper class for valuesFor('@tag') functionality.
TemplateFlowSignal	Signal thrown by ServerMarkupContext.redirect(String) and ServerMarkupContext.switchTemplate(String) to cleanly abort template rendering or API handler evaluation when a redirect or a template switch is requested.
TemplateFlowSignal.Kind
Validators
Value
Value.Type
W3cBrowserType	Enum-driven configuration for all W3C WebDriver browser types.
W3cDriver	W3C WebDriver protocol driver implementation.
W3cDriverOptions	W3C WebDriver configuration options.
W3cElement	W3C WebDriver Element implementation that holds a W3C element ID.
W3cKeys	W3C WebDriver Actions API keyboard input implementation.
W3cMouse	W3C-based implementation of mouse actions.
W3cSession	W3C WebDriver HTTP session client.
WsClient	Protocol-agnostic WebSocket client built on Netty.
WsClientHandler	Netty handler for WebSocket client connections.
WsClientOptions	Configuration for WebSocket client connections using builder pattern.
WsClientOptions.Builder
WsConnection	WebSocket connection wrapping a Netty channel.
WsException	Exception type for WebSocket errors with cause differentiation.
WsException.Type
WsFrame	Immutable wrapper for WebSocket frames (text, binary, control frames).
WsFrame.Type
WsHandler	Handler for WebSocket upgrade requests.