A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- active() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
Controls whether this field follows the active context.
- active() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
When true, this field mirrors the latest active framework context produced by JPostman execution, regardless of namespace.
- add() - Method in interface io.jpostman.annotations.JPostman.Info
-
Makes the next body/query/header customization add a new value instead of using the default set/resolve behavior.
- add() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Makes the next body/query/header customization use add semantics instead of set/resolve semantics.
- add(String, Object) - Method in class io.jpostman.Params
-
Adds or overwrites the key unconditionally.
- add(String, Object) - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Adds or replaces a parameter without requiring it to exist first.
- add(T) - Method in class io.jpostman.annotations.JPostman.Ref
-
Adds the supplied value to the current reference value.
- addRegexRule(String) - Method in class io.jpostman.secure.RedactionPolicy
-
Returns a new policy with an additional regex key redaction rule.
- addRegexRule(String, String) - Method in class io.jpostman.secure.RedactionPolicy
-
Returns a new policy with an additional regex key rule and value expression.
- addRequest(Request) - Method in class io.jpostman.Folder
-
Adds a request to this folder during collection parsing.
- address() - Method in class io.jpostman.vault.VaultSettings
-
Returns the Vault server address.
- addRules(String...) - Method in class io.jpostman.secure.RedactionPolicy
-
Returns a new policy with additional redaction rules.
- addTokens(Map<String, String>, String) - Static method in class io.jpostman.Params
-
Adds all Handlebars-style
{{token}}placeholders found in a text value to the supplied target map. - addTokens(Map<String, String>, Map<String, String>) - Static method in class io.jpostman.Params
-
Adds all Handlebars-style
{{token}}placeholders found in a map's keys and values to the supplied target map. - addValue(ApiSpec, String, Object) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
-
Adds one new environment value.
- afterAll(ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Completes class-scoped assertions and report output after user
@AfterAllmethods. - afterEach(ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- afterInvocation(IInvokedMethod, ITestResult) - Method in class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
-
Clears the current TestNG context after a JPostman-managed test method.
- all() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Returns all recorded execution infos in status order.
- allMatch(String, Class<V>, BiPredicate<V, Integer>, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that every value returned by the response path matches the predicate.
- allMatch(String, Class<V>, BiPredicate<V, Integer>, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- allMatch(String, Class<V>, BiPredicate<V, Integer>, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that every value returned by the response path matches the predicate.
- allMatch(String, BiPredicate<Object, Integer>, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that every numeric value returned by the response path matches the predicate.
- allMatch(String, BiPredicate<Object, Integer>, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- allMatch(String, BiPredicate<Object, Integer>, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that every numeric value returned by the response path matches the predicate.
- allMatch(String, Predicate<Number>, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that every numeric value returned by the response path matches the predicate.
- allMatch(String, Predicate<Number>, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- allMatch(String, Predicate<Number>, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that every numeric value returned by the response path matches the predicate.
- annotation - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
JPostman annotation represented by this info object, or empty string when none.
- annotation(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Updates the JPostman annotation represented by this invocation.
- annotationName() - Method in enum io.jpostman.codegen.model.JPostmanAnnotationType
- any(String...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagRules
-
Creates a condition that matches when any supplied value matches the current tag chain.
- any(String...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Creates a condition that matches when any supplied value matches the current runner request name.
- API_KEY - io.jpostman.schema.model.ApiAuthType
- ApiAuth - Class in io.jpostman.schema.model
-
Represents authentication metadata for an API operation without mixing auth into normal headers.
- ApiAuth() - Constructor for class io.jpostman.schema.model.ApiAuth
- ApiAuthLocation - Enum in io.jpostman.schema.model
-
Defines where an authentication value is applied when a request is executed.
- ApiAuthType - Enum in io.jpostman.schema.model
-
Defines the supported authentication strategies in the common API schema model.
- ApiBody - Class in io.jpostman.schema.model
-
Represents the request body template or example body for an API operation.
- ApiBody() - Constructor for class io.jpostman.schema.model.ApiBody
-
Creates a new ApiBody instance.
- ApiBody(ApiBodyType, String) - Constructor for class io.jpostman.schema.model.ApiBody
-
Creates a new ApiBody instance.
- ApiBodyType - Enum in io.jpostman.schema.model
-
Defines the supported request body content types in the common API schema model.
- ApiExample - Class in io.jpostman.schema.model
-
Represents example request values that can be used to populate environment variables.
- ApiExample() - Constructor for class io.jpostman.schema.model.ApiExample
- ApiExecutor - Interface in io.jpostman
-
Executes a parsed JPostman
Requestusing any HTTP/API testing framework. - ApiFolder - Class in io.jpostman.schema.model
-
Represents a logical folder or group of API operations.
- ApiFolder() - Constructor for class io.jpostman.schema.model.ApiFolder
- ApiHeader - Class in io.jpostman.schema.model
-
Represents one normal request header in the common API schema model.
- ApiHeader() - Constructor for class io.jpostman.schema.model.ApiHeader
-
Creates a new ApiHeader instance.
- ApiHeader(String, String, boolean) - Constructor for class io.jpostman.schema.model.ApiHeader
-
Creates a new ApiHeader instance.
- apiKey(String, String) - Method in class io.jpostman.Authentication
-
Configures header-based API-key authentication.
- ApiMethodNameAllocator - Class in io.jpostman.schema.util
-
Converts operation method names into valid, unique Java-style identifiers.
- ApiOperation - Class in io.jpostman.schema.model
-
Represents one normalized API operation parsed from OpenAPI, Swagger, Postman, or GraphQL.
- ApiOperation() - Constructor for class io.jpostman.schema.model.ApiOperation
- ApiOperationEnvScanner - Class in io.jpostman.schema.util
-
Scans one API operation for {{KEY}} placeholders and adds them to the environment map.
- ApiParam - Class in io.jpostman.schema.model
-
Represents one query or path-related parameter in the common API schema model.
- ApiParam() - Constructor for class io.jpostman.schema.model.ApiParam
-
Creates a new ApiParam instance.
- ApiParam(String, String, boolean) - Constructor for class io.jpostman.schema.model.ApiParam
-
Creates a new ApiParam instance.
- ApiParamLocation - Enum in io.jpostman.schema.model
-
Defines where an API parameter is sent.
- ApiProtocol - Enum in io.jpostman.schema.model
-
Defines the API protocol represented by an operation.
- ApiResponse - Class in io.jpostman
-
Framework-neutral HTTP response returned by JPostman executors.
- ApiResponse - Class in io.jpostman.schema.model
-
Represents one normalized API response parsed from OpenAPI, Swagger, Postman, or GraphQL metadata.
- ApiResponse() - Constructor for class io.jpostman.schema.model.ApiResponse
-
Creates a new ApiResponse instance.
- ApiResponse(int, String, byte[], Map<String, List<String>>) - Constructor for class io.jpostman.ApiResponse
-
Creates a response wrapper.
- ApiResponse(String, String) - Constructor for class io.jpostman.schema.model.ApiResponse
-
Creates a new ApiResponse instance.
- ApiSchemaCli - Class in io.jpostman.schema.cli
-
Command-line bridge used by RESTAGE Studio to parse API documents with the Java ApiSpecParser and export normalized models, Postman Collections, and Postman Environments.
- ApiSpec - Class in io.jpostman.schema.model
-
Common API document model used by JPostman importers.
- ApiSpec() - Constructor for class io.jpostman.schema.model.ApiSpec
- ApiSpecDetector - Class in io.jpostman.schema.parser
-
Detects the external document format before parsing it into the common model.
- ApiSpecEnvironmentUpdater - Class in io.jpostman.schema.env
-
Updates environment variables in the normalized ApiSpec model.
- ApiSpecEnvironmentUpdater() - Constructor for class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
- ApiSpecEnvironmentUpdateRequest - Class in io.jpostman.schema.env
-
Request model used to update environment keys and values in an existing ApiSpec model.
- ApiSpecEnvironmentUpdateRequest() - Constructor for class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
- ApiSpecEnvScanner - Class in io.jpostman.schema.util
-
Scans an entire API specification for {{KEY}} placeholders and base URL values.
- ApiSpecFormat - Enum in io.jpostman.schema.parser
-
Defines the supported input document formats.
- ApiSpecImporter - Interface in io.jpostman.schema.importer
-
Defines the contract for converting one external API document format into the common JPostman API schema model.
- ApiSpecParseException - Exception in io.jpostman.schema.parser
-
User-facing parse exception for API schema imports.
- ApiSpecParseException(ApiSpecFormat, String) - Constructor for exception io.jpostman.schema.parser.ApiSpecParseException
-
Creates a new ApiSpecParseException instance.
- ApiSpecParseException(ApiSpecFormat, String, Throwable) - Constructor for exception io.jpostman.schema.parser.ApiSpecParseException
-
Creates a new ApiSpecParseException instance.
- ApiSpecParser - Class in io.jpostman.schema.parser
-
Entry point for parsing pasted API documents into the common JPostman API schema model.
- ApiSpecParserOptions - Class in io.jpostman.schema.parser
-
Contains optional parser settings supplied by the UI or caller.
- ApiSpecParserOptions() - Constructor for class io.jpostman.schema.parser.ApiSpecParserOptions
- appendMethod(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Appends a method/executor display entry to the shared method chain and returns the zero-based index assigned to that entry.
- apply(Request) - Static method in class io.jpostman.httpclient.HttpClientExecutor
-
Creates a fluent executor for the supplied request.
- apply(Request) - Static method in class io.jpostman.playwright.PlaywrightExecutor
-
Creates a fluent Playwright executor for one request.
- apply(Request) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Creates a fluent JPostman-style REST Assured executor for the supplied request.
- apply(Request) - Static method in class io.jpostman.unirest.UnirestExecutor
-
Creates a fluent Unirest executor for the supplied request.
- apply(RequestProvider) - Static method in class io.jpostman.httpclient.HttpClientExecutor
-
Builds a request from the supplied
RequestProviderand delegates to the request-based method. - apply(RequestProvider) - Static method in class io.jpostman.playwright.PlaywrightExecutor
-
Builds a request from the supplied
RequestProviderand delegates to the request-based method. - apply(RequestProvider) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Builds a request from the supplied
RequestProviderand delegates to the request-based method. - apply(RequestProvider) - Static method in class io.jpostman.unirest.UnirestExecutor
-
Builds a request from the supplied
RequestProviderand delegates to the request-based method. - apply(Request, RequestSpecification) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Applies JPostman request headers and body settings to an existing REST Assured specification.
- apply(ApiOperation, Map<String, Object>) - Static method in class io.jpostman.schema.util.ExampleEnvValueApplier
-
Applies derived values to the supplied operation or specification.
- apply(ApiSpec) - Static method in class io.jpostman.schema.util.ApiMethodNameAllocator
-
Normalizes and de-duplicates method names across the entire specification.
- apply(ApiSpec) - Static method in class io.jpostman.schema.util.BaseUrlOverride
-
Applies derived values to the supplied operation or specification.
- applyRequestValues(Request, JPostmanInfo) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies request values collected in
JPostmanInfoto a request. - asByteArray() - Method in class io.jpostman.ApiResponse
- asByteArray() - Method in class io.jpostman.secure.SecureResponse
- asJson(Object...) - Static method in class io.jpostman.Params
-
Creates an ordered variable map and JSON-stringifies String values.
- asList(T...) - Static method in class io.jpostman.Params
-
Creates a mutable list from the supplied values.
- asMap() - Method in class io.jpostman.secure.SecureValues
-
Returns display values for safe output.
- asMap(Object...) - Static method in class io.jpostman.Params
-
Creates an ordered variable map from alternating key/value pairs.
- assertAll() - Method in class io.jpostman.junit.JUnitSoftAssertions
-
Verifies all collected soft assertions.
- assertAll() - Method in interface io.jpostman.secure.JPostmanSoftAssertions
- assertAll() - Method in class io.jpostman.testng.TestNgSoftAssertions
-
Verifies all collected soft assertions.
- assertContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- assertions() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Assertion files to load.
- assertions() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Optional assertion rule files to load for annotation assertions.
- assertions(Object) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- asserts() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Assertion section names.
- asserts() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Assertion section names.
- asserts() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Optional assertion rule sections to apply after response execution.
- asserts() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Optional assertion rule sections to apply after response execution.
- asserts() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Optional assertion rule sections to apply after response execution.
- asserts() - Method in class io.jpostman.junit.JUnitContext
-
Returns hard assertion helpers.
- asserts() - Method in interface io.jpostman.secure.JPostmanTestContext
- asserts() - Method in class io.jpostman.testng.TestNgContext
-
Returns hard assertion helpers.
- asserts(boolean) - Method in class io.jpostman.junit.JUnitContext
-
Returns hard assertion helpers.
- asserts(boolean) - Method in interface io.jpostman.secure.JPostmanTestContext
- asserts(boolean) - Method in class io.jpostman.testng.TestNgContext
-
Returns hard assertion helpers.
- asserts(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- assertWithLog(Runnable) - Method in class io.jpostman.junit.JUnitAssertions
-
Executes an assertion and wraps failures with optional secure log context.
- assertWithLog(Runnable) - Method in class io.jpostman.junit.JUnitSoftAssertions
- assertWithLog(Runnable) - Method in class io.jpostman.testng.TestNgAssertions
-
Executes an assertion and wraps failures with optional secure log context.
- assertWithLog(Runnable) - Method in class io.jpostman.testng.TestNgSoftAssertions
- asString(String) - Method in class io.jpostman.junit.JUnitContext
-
Returns the original value for the given key as a string.
- asString(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- asString(String) - Method in class io.jpostman.secure.SecureContext
-
Returns the value for the given key as a string.
- asString(String) - Method in class io.jpostman.testng.TestNgContext
-
Returns the original value for the given key as a string.
- attr() - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns the full runtime info object for direct access to execution attributes such as method, methodIndex, request, namespace, cache, and id.
- attr() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns this full runtime info object when callers use the compact
JPostman.Infofacade. - auth - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Auth-related values applied to the request when supported by the request builder.
- auth() - Method in class io.jpostman.httpclient.HttpClientExecutor
-
Starts fluent authentication/header configuration.
- auth() - Method in class io.jpostman.playwright.PlaywrightExecutor
-
Starts REST-Assured-style authentication configuration.
- auth() - Method in class io.jpostman.Request.RequestBuilder
-
Configures auth using a lambda-style nested builder.
- auth() - Method in class io.jpostman.restassured.RestAssuredExecutor
-
Starts fluent authentication/header configuration.
- auth() - Method in class io.jpostman.unirest.UnirestExecutor
-
Starts fluent authentication/header configuration.
- auth(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds auth values.
- auth(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds authentication values for the current JPostman execution.
- auth(Consumer<Request.RequestBuilder.ParamStep>) - Method in class io.jpostman.Request.RequestBuilder
-
Configures auth using a lambda-style nested builder.
- auth(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds auth values.
- auth(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds auth-related request values from an existing map when supported.
- Auth - Class in io.jpostman
-
Represents the authentication configuration of a Postman request or collection.
- authenticate(VaultSettings) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates with Vault using the configured auth method.
- authenticate(VaultSettings) - Method in interface io.jpostman.vault.VaultAuthenticator
-
Authenticates with Vault using the supplied settings and returns an authenticated client.
- authenticateUnsupported(VaultConfig, VaultSettings, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Handles unsupported authentication methods.
- authenticateWithAppRole(VaultConfig, Vault, String, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using AppRole auth.
- authenticateWithAppRole(VaultConfig, VaultSettings, Vault, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using AppRole auth from settings.
- authenticateWithGithub(VaultConfig, Vault, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using GitHub auth.
- authenticateWithGithub(VaultConfig, VaultSettings, Vault, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using GitHub auth from settings.
- authenticateWithJwt(VaultConfig, Vault, String, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using JWT auth.
- authenticateWithJwt(VaultConfig, VaultSettings, Vault, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using JWT auth from settings.
- authenticateWithLdap(VaultConfig, Vault, String, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using LDAP auth.
- authenticateWithLdap(VaultConfig, VaultSettings, Vault, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using LDAP auth from settings.
- authenticateWithToken(VaultConfig, VaultSettings) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using an existing Vault token from settings.
- authenticateWithToken(VaultConfig, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using an existing Vault token.
- authenticateWithUserPass(VaultConfig, Vault, String, String, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using Userpass auth.
- authenticateWithUserPass(VaultConfig, VaultSettings, Vault, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Authenticates using Userpass auth from settings.
- Authentication - Class in io.jpostman
-
REST-Assured-style authentication helper shared by JPostman executors.
- Authentication(ApiExecutor, Map<String, String>, Authentication.State) - Constructor for class io.jpostman.Authentication
-
Creates an authentication helper for an executor.
- Authentication.State - Class in io.jpostman
-
Mutable authentication state shared between
Authenticationand the executor using it. - authMethod() - Method in class io.jpostman.vault.VaultSettings
-
Returns the configured authentication method.
- authPath() - Method in class io.jpostman.vault.VaultSettings
-
Returns the configured authentication mount path.
- authToken() - Method in class io.jpostman.vault.VaultSettings
-
Returns the authenticated Vault token after login.
B
- BaseUrlOverride - Class in io.jpostman.schema.util
-
Applies {{BASE_URL}} replacement when URL override mode is enabled.
- basic(String, String) - Method in class io.jpostman.Authentication
-
Configures HTTP Basic authentication.
- BASIC - io.jpostman.schema.model.ApiAuthType
- bearer(String) - Method in class io.jpostman.Authentication
-
Configures HTTP bearer-token authentication.
- BEARER - io.jpostman.schema.model.ApiAuthType
- beforeAll(ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Fallback for JUnit engines that call beforeAll before post processing.
- beforeInvocation(IInvokedMethod, ITestResult) - Method in class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
-
Prepares and runs JPostman annotations before TestNG invokes a test or configuration method.
- beginAssertionCleanup(Object, Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Registers assertion cleanup for facade assertions executed from the user test body.
- body - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Mutable body values shared by methods in the same execution chain.
- body() - Method in class io.jpostman.Request.RequestBuilder
-
Configures body using a lambda-style nested builder.
- body(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds body values.
- body(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request body values using key/value pairs.
- body(Consumer<Request.RequestBuilder.ParamStep>) - Method in class io.jpostman.Request.RequestBuilder
-
Configures body using a lambda-style nested builder.
- body(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds body values.
- body(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request body values from an existing map.
- Body - Class in io.jpostman
-
Represents a Postman request body.
- bodyAdd - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Body values that should be added instead of set/resolved.
- build() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- build() - Method in interface io.jpostman.Params.Builder
- build() - Method in class io.jpostman.Request
- build() - Method in class io.jpostman.Request.RequestBuilder
-
Builds and returns the final
Request. - build() - Method in interface io.jpostman.RequestProvider
-
Builds the request that should be executed.
- build() - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Builds the redaction policy.
- build() - Method in class io.jpostman.secure.SecureRequest
-
Builds the real request by resolving stored values.
- build() - Method in class io.jpostman.secure.SecureValues.Builder
-
Builds the immutable registry.
- build(Environment) - Method in class io.jpostman.Request.RequestBuilder
-
Resolves all
{{variable}}tokens in URL, headers, body, and auth parameters using the given environment's enabled variable map. - build(Map<String, ?>) - Method in class io.jpostman.Request.RequestBuilder
-
Resolves all
{{variable}}tokens in the URL, headers, body, and auth parameters using the provided variable map. - builder() - Method in class io.jpostman.Auth
-
Returns a fluent builder pre-populated from this auth's parameter map.
- builder() - Method in class io.jpostman.Body
-
Returns a fluent builder pre-populated from this body.
- builder() - Method in class io.jpostman.Environment
-
Returns a fluent builder pre-populated with this environment's variables.
- builder() - Method in class io.jpostman.Header
-
Returns a fluent builder pre-populated from this header map.
- builder() - Method in class io.jpostman.Request
-
Returns a
Request.RequestBuilderpre-populated from this request. - builder() - Static method in class io.jpostman.secure.RedactionPolicy
-
Creates a redaction policy builder.
- builder() - Method in class io.jpostman.secure.SecureRequest
-
Creates a builder from the wrapped request.
- builder() - Static method in class io.jpostman.secure.SecureValues
-
Creates a value registry builder.
- builder() - Method in class io.jpostman.Url
-
Returns a fluent builder pre-populated from this URL and query parameters.
- builder(JPostmanAnnotationType) - Static method in class io.jpostman.codegen.model.JPostmanMethodSpec
- Builder() - Constructor for class io.jpostman.secure.RedactionPolicy.Builder
- Builder() - Constructor for class io.jpostman.secure.SecureValues.Builder
C
- cache() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Cache key for the method return value.
- cache() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Cache key for the method return value.
- cache() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Cache key for this request helper dependency.
- cache() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Cache key for this response dependency.
- cache() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns the cache key for this invocation, or empty string when disabled.
- cache() - Method in class io.jpostman.junit.JUnitContext
-
Returns the shared cache map.
- cache() - Method in class io.jpostman.secure.SecureContext
-
Returns the shared cache map.
- cache() - Method in class io.jpostman.testng.TestNgContext
-
Returns the shared cache map.
- cache(C, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Reads a cached value from the context.
- cache(C, String, Object) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Stores a cached value in the context.
- cache(JUnitContext, String) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Reads a cached value from the context.
- cache(JUnitContext, String, Object) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Stores a cached value in the context.
- cache(TestNgContext, String) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Reads a cached value from the context.
- cache(TestNgContext, String, Object) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Stores a cached value in the context.
- cache(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Updates the cache key for this invocation.
- cache(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- cache(String) - Method in class io.jpostman.junit.JUnitContext
-
Reads a cached value by key.
- cache(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- cache(String) - Method in class io.jpostman.secure.SecureContext
-
Reads a cached value by key.
- cache(String) - Method in class io.jpostman.testng.TestNgContext
-
Reads a cached value by key.
- cache(String, Class<T>) - Method in interface io.jpostman.annotations.JPostman.Test
-
Reads a cached value or cached response path and converts it to the requested Java type.
- cache(String, Object) - Method in class io.jpostman.junit.JUnitContext
-
Stores a value in the shared cache and returns this context.
- cache(String, Object) - Method in interface io.jpostman.secure.JPostmanTestContext
- cache(String, Object) - Method in class io.jpostman.testng.TestNgContext
-
Stores a value in the shared cache and returns this context.
- cache(String, Supplier<T>) - Method in class io.jpostman.secure.SecureContext
-
Returns a cached value, creating it when missing.
- cache(Supplier<T>) - Method in class io.jpostman.junit.JUnitContext
-
Returns a cached value using the caller method name as the cache key.
- cache(Supplier<T>) - Method in interface io.jpostman.secure.JPostmanTestContext
- cache(Supplier<T>) - Method in class io.jpostman.secure.SecureContext
-
Returns a cached value using the calling method name as the cache key.
- cache(Supplier<T>) - Method in class io.jpostman.testng.TestNgContext
-
Returns a cached value using the caller method name as the cache key.
- cache(Supplier<T>, String) - Method in class io.jpostman.junit.JUnitContext
-
Returns a cached value, creating it when missing.
- cache(Supplier<T>, String) - Method in interface io.jpostman.secure.JPostmanTestContext
- cache(Supplier<T>, String) - Method in class io.jpostman.testng.TestNgContext
-
Returns a cached value, creating it when missing.
- cacheClean(String...) - Method in class io.jpostman.junit.JUnitContext
-
Clears cached values.
- cacheClean(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- cacheClean(String...) - Method in class io.jpostman.secure.SecureContext
-
Clears cached values.
- cacheClean(String...) - Method in class io.jpostman.testng.TestNgContext
-
Clears cached values.
- cacheKeys(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Returns cache keys when the underlying context exposes its cache map.
- call() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Executes the request described by
JPostman.Callon the current test method. - call() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Executes the request described by
JPostman.Callon the current test method. - call(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- call(BiConsumer<C, JPostman.Info>) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Executes the request described by
JPostman.Callafter applying an optional request customization callback. - call(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Executes the request described by
JPostman.Callafter applying an optional request customization callback. - callerMethodName(int) - Static method in class io.jpostman.secure.SecureContext
-
Returns the caller method name.
- child(String, String[], String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- child(String, String[], String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- child(String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info that inherits blank namespace, folder, and request values from the parent.
- child(String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info that inherits blank namespace, folder, and request values from the parent, while allowing tags and executor to be selected for the child.
- child(String, String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info that inherits blank namespace, folder, and request values from the parent, while allowing tags, executor, and cache to be selected for the child.
- childExact(String, String[], String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- childExact(String, String[], String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- childExact(String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info without inheriting blank namespace, folder, or request values.
- childExact(String, String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info without inheriting blank namespace, folder, or request values, while allowing tags and executor to be selected for the child.
- childExact(String, String, String, String, String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates child invocation info without inheriting blank namespace, folder, or request values, while allowing tags, executor, and cache to be selected for the child.
- cleanFailure(Class<?>, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Creates a clean assertion failure for a test method.
- cleanFailure(Class<?>, Method, Throwable, boolean, boolean) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Creates a clean assertion failure with selectable verbosity.
- cleanFailure(Object, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates the same configured failure display used by JUnit for TestNG.
- cleanFailure(Object, Method, Throwable, String) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates the same configured failure display using a local log override.
- cleanJUnitFailure(Object, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates the same short stack-trace failure used by TestNG for JUnit failures.
- cleanRuntimeFailure(Class<?>, Method, Throwable, boolean, boolean) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Creates a clean assertion failure for assertions executed from inside a runtime
@JPostman.Calltest body. - cleanRuntimeFailure(Object, Method, Throwable, String) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates a runtime-call failure display that points at the actual assertion line inside the test body.
- cleanStack(Class<?>, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Builds a cleaned stack trace for a framework throwable.
- cleanThrowable(Class<?>, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Cleans a normal test-method or configuration-method failure without mutating the original throwable.
- cleanThrowable(Class<?>, Method, Throwable, boolean) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Cleans a normal throwable with selectable stack verbosity.
- cleanThrowable(Object, Method, Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates the same configured throwable display used by JUnit for TestNG.
- cleanThrowable(Object, Method, Throwable, String) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates the same configured throwable display using a local log override.
- clear() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Clears collected execution values but keeps the same report instance.
- clear() - Method in class io.jpostman.Authentication.State
-
Resets authentication state after an execution.
- clearAssertionMethod(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Clears retained assertion-origin metadata after class completion.
- clearCurrent() - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Clears the current context for the active test thread.
- clearCurrent() - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Clears the current context for the active test thread.
- clearCurrent() - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Clears the current context for the active test thread.
- clearCurrent() - Static method in class io.jpostman.junit.JUnitContext
-
Clears the current context from the running test thread.
- clearCurrent() - Static method in class io.jpostman.testng.TestNgContext
-
Clears the current context from the running test thread.
- close() - Method in class io.jpostman.annotations.JPostmanOutputs.Scope
- close() - Method in class io.jpostman.playwright.PlaywrightExecutor
-
Closes Playwright resources owned by this executor.
- collect(String, Map<String, Object>) - Static method in class io.jpostman.schema.util.EnvVarExtractor
-
Collects all {{KEY}} placeholders found in the supplied value.
- collection() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Postman collection location.
- collection() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
Postman collection location.
- collection() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Optional Postman collection location.
- collection() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
Optional Postman collection location.
- Collection - Class in io.jpostman
-
Loads a Postman Collection v2.1 JSON export and provides helpers to inspect folders, requests, and an optionally loaded environment.
- commandName() - Method in enum io.jpostman.codegen.model.JPostmanAnnotationType
- completeTestClass(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Completes class-scoped JPostman facilities after user class teardown.
- config() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
JPostman properties file location.
- config() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
JPostman properties file location.
- config() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Properties file to load context locations from.
- config() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
Properties file to load context locations from.
- configMapExists(String, String) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Checks whether a ConfigMap exists.
- containsKey(String) - Static method in class io.jpostman.schema.util.EnvVarExtractor
-
Returns whether the supplied value contains a {{KEY}} placeholder.
- context - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
- context - Variable in class io.jpostman.junit.JUnitAssertions
- context - Variable in class io.jpostman.testng.TestNgAssertions
- context() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the low-level JPostman context.
- context() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the loaded core JPostman context.
- context() - Method in class io.jpostman.junit.JUnitAssertions
-
Returns the owning context for continuing the fluent chain.
- context() - Method in interface io.jpostman.secure.JPostmanAssertions
- context() - Method in class io.jpostman.testng.TestNgAssertions
-
Returns the owning context for continuing the fluent chain.
- context(JPostmanContext) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates a copy of this info object associated with the @JPostmanContext annotation.
- context(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- context(Consumer<JUnitContext>) - Method in class io.jpostman.junit.JUnitContext
-
Applies custom logic to this context and returns this context.
- context(Consumer<TestNgContext>) - Method in class io.jpostman.testng.TestNgContext
-
Applies custom logic to this context and returns this context.
- contextType() - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Returns the framework context type handled by this bridge.
- contextType() - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Returns the framework context type handled by this bridge.
- contextType() - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Returns the framework context type handled by this bridge.
- convert(Object, Class<T>) - Static method in class io.jpostman.annotations.runtime.JPostmanCacheValueConverter
- COOKIE - io.jpostman.schema.model.ApiAuthLocation
- COOKIE - io.jpostman.schema.model.ApiParamLocation
- copy() - Method in class io.jpostman.junit.JUnitContext
-
Creates a copy of this JUnit context.
- copy() - Method in interface io.jpostman.secure.JPostmanTestContext
- copy() - Method in class io.jpostman.secure.SecureContext
-
Creates a copy of this secure context.
- copy() - Method in class io.jpostman.testng.TestNgContext
-
Creates a copy of this TestNG context.
- copy(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Creates a request/response-free copy of a configured framework context.
- copy(JUnitContext) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Creates a request/response-free copy of a configured framework context.
- copy(TestNgContext) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Creates a request/response-free copy of a configured framework context.
- copy(Map<String, ?>...) - Static method in class io.jpostman.Params
-
Creates a mutable ordered map by merging the supplied maps.
- copyCache(C, C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Copies cache entries from one context to another.
- create() - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Creates a new framework context.
- create() - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Creates a new framework context.
- create() - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Creates a new framework context.
- create() - Static method in class io.jpostman.httpclient.HttpClientExecutor
-
Creates a reusable executor with a cookie-enabled Java
HttpClient. - create() - Static method in class io.jpostman.junit.JUnitContext
-
Creates a new JUnit context.
- create() - Static method in class io.jpostman.playwright.PlaywrightExecutor
-
Creates a reusable Playwright executor with its own Playwright instance and API request context.
- create() - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Creates a reusable REST Assured executor with a shared cookie filter.
- create() - Static method in class io.jpostman.secure.SecureContext
-
Creates a secure context.
- create() - Static method in class io.jpostman.testng.TestNgContext
-
Creates a new TestNG context.
- create() - Static method in class io.jpostman.unirest.UnirestExecutor
-
Creates a reusable Unirest executor with a cookie-enabled Apache HTTP client.
- createConfigMap(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Creates a ConfigMap.
- created - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Timestamp when the execution chain info was created.
- created - Variable in class io.jpostman.annotations.runtime.JPostmanReport
-
Timestamp when this report object was created.
- createDefaultClient() - Method in class io.jpostman.kubernetes.KubernetesClientFactory
-
Creates a Kubernetes API client.
- createOrUpdateConfigMap(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Creates or updates a ConfigMap.
- createOrUpdateRepositorySecret(String, String, String, String) - Method in class io.jpostman.github.GitHubService
-
Creates or updates a repository Actions secret using a plaintext value.
- createOrUpdateRepositorySecret(String, String, String, String, String) - Method in class io.jpostman.github.GitHubService
-
Creates or updates a repository Actions secret using an already-encrypted value.
- createOrUpdateRepositoryVariable(String, String, String, String) - Method in class io.jpostman.github.GitHubService
-
Creates or updates one repository Actions variable.
- createOrUpdateSecret(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Creates or updates a Secret.
- createRepositoryVariable(String, String, String, String) - Method in class io.jpostman.github.GitHubService
-
Creates one repository Actions variable.
- createSecret(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Creates a Secret using string data.
- createVault(VaultSettings) - Method in class io.jpostman.vault.VaultClientFactory
-
Creates an authenticated Vault client using the configured authenticator.
- createVaultWithAuth(VaultSettings) - Method in class io.jpostman.vault.VaultClientFactory
-
Creates an authenticated Vault client using the configured authenticator.
- createVaultWithToken(VaultConfig, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Creates a Vault client configured with a token.
- ctx() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the latest active framework context.
- ctx() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the latest active framework context.
- ctx() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current context for this test thread.
- ctx() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current context for this test thread.
- ctx(String) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the framework context for a namespace.
- ctx(String) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the framework context for the supplied namespace.
- current() - Static method in class io.jpostman.junit.JUnitContext
-
Returns the JPostman context prepared for the current JUnit test method.
- current() - Static method in class io.jpostman.testng.TestNgContext
-
Returns the JPostman context prepared for the current TestNG test method.
- CURRENT_VERSION - Static variable in class io.jpostman.codegen.model.JPostmanMethodSpec
-
Current version of the code-generation model contract.
- CURRENT_VERSION - Static variable in class io.jpostman.schema.model.ApiSpec
D
- data - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
JPostman data section applied to this invocation, or empty string when none.
- data() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Data section name.
- data() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Data section name.
- data() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Data section name.
- data() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Data section name.
- data() - Method in annotation type io.jpostman.annotations.JPostmanCall
- data() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Optional data group or data section to apply before request execution.
- data() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Optional data group or data section to apply before request execution.
- data() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Optional data group or data section to apply before request execution.
- data(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Updates the JPostman data section represented by this invocation.
- data(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- dataload() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Data files to load.
- dataload() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Optional data files to load for annotation data resolvers.
- debug - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Local debug override for this invocation, or empty string to inherit context debug.
- debug() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Controls automatic annotation output.
- debug() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Controls automatic annotation output.
- debug(String...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates a copy of this info object with a local log output override.
- debug(String, Object...) - Method in class io.jpostman.JPostman.Context
-
Logs a DEBUG message using the context logger.
- DEFAULT_CONFIG - Static variable in class io.jpostman.annotations.runtime.JPostmanDataLoader
- DEFAULT_MASK - Static variable in class io.jpostman.secure.SecureValue
- DEFAULT_MAX_STACK_TRACE - Static variable in annotation type io.jpostman.junit.JPostmanJUnit
- defaultMountFor(String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Returns the default auth mount path for an auth method.
- defaults() - Static method in class io.jpostman.schema.parser.ApiSpecParserOptions
-
Creates parser options with default values.
- defaults() - Static method in class io.jpostman.secure.RedactionPolicy
-
Returns the default redaction policy.
- DefaultSliceExpressionFactory - Class in io.jpostman.secure
-
Default implementation for parsing and applying slice expressions.
- DefaultSliceExpressionFactory() - Constructor for class io.jpostman.secure.DefaultSliceExpressionFactory
-
Creates an empty parser instance.
- DefaultVaultAuthenticator - Class in io.jpostman.vault
-
Default Vault authenticator used by
VaultClientFactory. - DefaultVaultAuthenticator() - Constructor for class io.jpostman.vault.DefaultVaultAuthenticator
- deleteConfigMap(String, String) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Deletes a ConfigMap.
- deleteKey(ApiSpec, String) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
-
Deletes one environment key from the environment map only.
- deleteKv2Secret(String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Deletes a secret from a KV v2 mount.
- deleteKv2Secret(String, String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Deletes one key from a KV v2 secret by reading the secret, removing the key, and writing the updated data back to Vault.
- deleteRepositorySecret(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Deletes one repository Actions secret.
- deleteRepositoryVariable(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Deletes one repository Actions variable.
- deleteSecret(String) - Method in class io.jpostman.vault.VaultSecretService
-
Deletes a Vault logical path.
- deleteSecret(String, String) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Deletes a Secret.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Dependency method names or annotation ids.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostman.Executor
-
Dependency method names or annotation ids.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Dependency method names or annotation ids.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Dependency method names.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Dependency method names.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostmanCall
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostmanExecutor
-
Dependency method names or annotation ids to run before creating this executor.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Dependency method names or annotation ids to run before this request helper.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Dependency method names or annotation ids to run before this response.
- dependsOn() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Dependency method names to run before this runner.
- dependsOn(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- detect(String) - Static method in class io.jpostman.schema.parser.ApiSpecDetector
-
Detects the most likely API document format from the supplied content.
- diagnosticLog(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
- diagnosticLog(C, boolean, boolean) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Returns best-effort diagnostic output for the current context.
- duration() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns request execution duration in milliseconds.
- duration() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Returns total execution time in milliseconds.
E
- empty() - Static method in class io.jpostman.secure.SecureValues
-
Creates an empty value registry.
- enabled() - Method in annotation type io.jpostman.annotations.JPostman.Call
- enabled() - Method in annotation type io.jpostman.annotations.JPostman.Response
- enabled() - Method in annotation type io.jpostman.annotations.JPostman.Runner
- enabled() - Method in annotation type io.jpostman.annotations.JPostmanCall
-
Runs this call even when
JPostmanContext.skipAll()is enabled. - enabled() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Runs this response even when
JPostmanContext.skipAll()is enabled. - enabled() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Runs this runner even when
JPostmanContext.skipAll()is enabled. - enabled(Boolean) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- encryptSecret(String, String) - Method in class io.jpostman.github.GitHubService
-
Encrypts a plaintext secret using GitHub's Base64 encoded public key.
- end() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Marks request execution end time and calculates duration.
- end() - Method in class io.jpostman.Params
-
Produces the final object.
- end() - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Returns to the parent request builder without resolving local variables.
- end(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action only for the last executed request in the current runner.
- end(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action only for the last executed request in the current runner.
- end(Map<String, ?>) - Method in class io.jpostman.Params
-
Resolves only variables present in the local parameter map, then produces the final object.
- end(Map<String, ?>) - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Resolves this request part with local variables, then returns to the parent request builder.
- endAssertionCleanup() - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Clears assertion cleanup for the current test body.
- ended() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns the timestamp when request execution ended.
- entry(String) - Method in class io.jpostman.Environment
-
Looks up parameter metadata by key.
- environment() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Postman environment location.
- environment() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
Postman environment location.
- environment() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Optional Postman environment location.
- environment() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
Optional Postman environment location.
- Environment - Class in io.jpostman
-
Represents a Postman environment and its key/value variables.
- Environment(String) - Constructor for class io.jpostman.Environment
-
Creates an environment container with the supplied display name.
- EnvVarExtractor - Class in io.jpostman.schema.util
-
Extracts Postman-style {{KEY}} placeholders from strings.
- error(String, Object...) - Method in class io.jpostman.JPostman.Context
-
Logs an ERROR message using the context logger.
- ExampleEnvValueApplier - Class in io.jpostman.schema.util
-
Applies real example values back into the environment map for matching placeholders.
- exclude() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Request names to exclude.
- exclude() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Request names to exclude from this runner.
- exclude(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- execute(Request) - Static method in class io.jpostman.httpclient.HttpClientExecutor
-
Executes a request once with a default Java
HttpClient. - execute(Request) - Static method in class io.jpostman.playwright.PlaywrightExecutor
-
Executes a request once using a temporary Playwright executor.
- execute(Request) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Executes a request once using a default REST Assured specification and returns a framework-neutral response.
- execute(Request) - Static method in class io.jpostman.unirest.UnirestExecutor
-
Executes a request once using Unirest.
- execute(RequestProvider) - Static method in class io.jpostman.httpclient.HttpClientExecutor
-
Executes a request provided by a
RequestProvider. - execute(RequestProvider) - Static method in class io.jpostman.playwright.PlaywrightExecutor
-
Executes a request provided by a
RequestProvider. - execute(RequestProvider) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Executes a request provided by a
RequestProvider. - execute(RequestProvider) - Static method in class io.jpostman.unirest.UnirestExecutor
-
Executes a request provided by a
RequestProvider. - execute(Request, RequestSpecification) - Static method in class io.jpostman.restassured.RestAssuredExecutor
-
Executes a JPostman request using REST Assured and returns the native REST Assured
Response. - executor - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Executor selected for this invocation, or empty string for the default executor.
- executor() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Executor id.
- executor() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Default executor class name.
- executor() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Executor id.
- executor() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Executor id.
- executor() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Executor id.
- executor() - Method in annotation type io.jpostman.annotations.JPostmanCall
- executor() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Default API executor class for this context.
- executor() - Method in annotation type io.jpostman.annotations.JPostmanRequest
- executor() - Method in annotation type io.jpostman.annotations.JPostmanResponse
- executor() - Method in annotation type io.jpostman.annotations.JPostmanRunner
- executor(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- executor(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- executorClass() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Default executor class.
- exists(String) - Method in class io.jpostman.ApiResponse
-
Checks whether a value exists in the JSON response body using a simple dot/bracket path.
- exists(String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response contains the given path.
- exists(String) - Method in class io.jpostman.junit.JUnitContext
-
Checks whether the current secure response contains the given path.
- exists(String) - Method in interface io.jpostman.secure.JPostmanAssertions
- exists(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- exists(String) - Method in class io.jpostman.secure.SecureContext
-
Checks whether the current secure response contains the given path.
- exists(String) - Method in class io.jpostman.secure.SecureResponse
-
Checks whether a value exists in the JSON response body.
- exists(String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response contains the given path.
- exists(String) - Method in class io.jpostman.testng.TestNgContext
-
Checks whether the current secure response contains the given path.
- exists(String, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response contains the given path.
- exists(String, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- exists(String, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response contains the given path.
- export(ApiSpec, String) - Method in class io.jpostman.schema.cli.PostmanCollectionExporter
-
Converts an ApiSpec into a Postman Collection document.
- export(ApiSpec, String) - Method in class io.jpostman.schema.cli.PostmanEnvironmentExporter
-
Converts the ApiSpec environment map into a Postman Environment document.
- export(ApiSpec, String) - Method in class io.jpostman.schema.export.PostmanCollectionExporter
-
Converts an ApiSpec into a Postman Collection document.
- export(ApiSpec, String) - Method in class io.jpostman.schema.export.PostmanEnvironmentExporter
-
Converts the ApiSpec environment map into a Postman Environment document.
- extractJsonString(String, String) - Static method in class io.jpostman.github.GitHubService
-
Extracts a simple string field from a JSON object.
F
- fail(String) - Method in interface io.jpostman.annotations.JPostman.Assert
-
Immediately fails with the supplied custom message.
- failed - Variable in class io.jpostman.annotations.runtime.JPostmanReport
-
Failed top-level JPostman executions.
- failed(JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Records a failed top-level execution.
- filter() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Fields to keep in the context.
- filter() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Fields to keep in the context.
- filter() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Fields to keep in the context.
- filter() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Fields to keep in the context.
- filter() - Method in annotation type io.jpostman.annotations.JPostmanCall
- filter() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Optional response fields to keep before printing or verifying.
- filter() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Optional response fields to keep before printing or verifying.
- filter(C, String...) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies response field filtering to the context.
- filter(JUnitContext, String...) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Applies response field filtering to the context.
- filter(TestNgContext, String...) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Applies response field filtering to the context.
- filter(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- filter(String...) - Method in class io.jpostman.junit.JUnitContext
-
Adds response body filter rules.
- filter(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- filter(String...) - Method in class io.jpostman.secure.SecureContext
-
Adds response fields that should be included in filtered output.
- filter(String...) - Method in class io.jpostman.testng.TestNgContext
-
Adds response body filter rules.
- filter(String, List<String>) - Static method in class io.jpostman.secure.SecureText
-
Filters JSON text by keeping only fields that match the supplied rules.
- filter(List<String>) - Method in class io.jpostman.secure.SecureResponse
-
Sets response body filter rules.
- filtered() - Method in class io.jpostman.secure.SecureResponse
-
Returns the response body with configured filters applied.
- filterList(String...) - Method in class io.jpostman.junit.JUnitContext
-
Adds response list filter rules.
- filterList(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- filterList(String...) - Method in class io.jpostman.secure.SecureContext
-
Adds list filter rules that are applied inside matching JSON arrays while preserving parent response fields.
- filterList(String...) - Method in class io.jpostman.secure.SecureResponse
-
Sets list filter rules.
- filterList(String...) - Method in class io.jpostman.testng.TestNgContext
-
Adds response list filter rules.
- filterList(String, List<String>) - Static method in class io.jpostman.secure.SecureText
-
Applies list filter rules inside matching JSON arrays while preserving parent response fields.
- filterList(List<String>) - Method in class io.jpostman.secure.SecureResponse
-
Sets list filter rules.
- filterResponse(C, String...) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies response field filtering to an already available response and returns a context whose active response is the filtered response clone.
- findSourceLine(Class<?>, String) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Finds the source line number for a method in the local source tree.
- folder - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Postman folder associated with this invocation.
- folder() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Collection folder path from the collection root to the target folder.
- folder() - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns the current Postman folder name.
- folder() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostmanCall
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Collection folder path from the collection root to the target folder.
- folder() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Collection folder path from the collection root to the target folder.
- folder(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- folder(String) - Method in class io.jpostman.JPostman.Context
-
Looks up a folder by name.
- Folder - Class in io.jpostman
-
Represents a Postman collection folder and its direct request children.
- Folder(String) - Constructor for class io.jpostman.Folder
-
Creates a folder container.
- FORM_DATA - io.jpostman.schema.model.ApiBodyType
- formatDuration(long, boolean) - Static method in class io.jpostman.annotations.runtime.JPostmanInfo
- from(JsonObject) - Static method in class io.jpostman.Auth
-
Parse the
authobject from a Postman v2.1requestor collection root JSON object. - from(JsonObject) - Static method in class io.jpostman.Body
-
Parses the
bodysection from a Postman request JSON object. - from(JsonObject) - Static method in class io.jpostman.Header
-
Parse the
headerarray from a Postman v2.1requestobject. - from(JsonObject) - Static method in class io.jpostman.Url
-
Parses URL information from a Postman request object.
- from(ApiExecutor) - Method in class io.jpostman.junit.JUnitContext
-
Wraps the response returned by the given executor.
- from(ApiExecutor) - Method in interface io.jpostman.secure.JPostmanTestContext
- from(ApiExecutor) - Method in class io.jpostman.secure.SecureContext
-
Wraps the response returned by the given executor as a secure response.
- from(ApiExecutor) - Method in class io.jpostman.testng.TestNgContext
-
Wraps the response returned by the given executor.
- from(ApiResponse) - Method in class io.jpostman.junit.JUnitContext
-
Wraps an API response as a secure response.
- from(ApiResponse) - Method in interface io.jpostman.secure.JPostmanTestContext
- from(ApiResponse) - Method in class io.jpostman.secure.SecureContext
-
Wraps a response using this secure context.
- from(ApiResponse) - Static method in class io.jpostman.secure.SecureResponse
-
Starts wrapping a response.
- from(ApiResponse) - Method in class io.jpostman.testng.TestNgContext
-
Wraps an API response as a secure response.
- from(Request) - Method in class io.jpostman.junit.JUnitContext
-
Wraps a request as a secure request.
- from(Request) - Method in interface io.jpostman.secure.JPostmanTestContext
- from(Request) - Method in class io.jpostman.secure.SecureContext
-
Wraps a request using this secure context.
- from(Request) - Static method in class io.jpostman.secure.SecureRequest
-
Starts wrapping a request.
- from(Request) - Method in class io.jpostman.testng.TestNgContext
-
Wraps a request as a secure request.
- from(SecureContext) - Static method in class io.jpostman.junit.JUnitContext
-
Wraps an existing secure context.
- from(SecureContext) - Static method in class io.jpostman.testng.TestNgContext
-
Wraps an existing secure context.
- from(String, String, JsonObject) - Static method in class io.jpostman.Request
-
Build a
Requestfrom a Postman v2.1requestJSON object. - fromCommand(String) - Static method in enum io.jpostman.codegen.model.JPostmanAnnotationType
G
- get() - Method in class io.jpostman.annotations.JPostman.Ref
-
Returns the current value.
- get(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagRules
-
Returns a tag value by key.
- get(String) - Method in class io.jpostman.Auth
-
Returns a single auth parameter by key.
- get(String) - Method in class io.jpostman.Environment
-
Returns the enabled value for a key.
- get(String) - Method in class io.jpostman.Header
-
Returns an enabled header by name.
- get(String) - Method in class io.jpostman.junit.JUnitContext
-
Returns the original value for the given key.
- get(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- get(String) - Method in class io.jpostman.secure.SecureContext
-
Returns the current secure values.
- get(String) - Method in class io.jpostman.secure.SecureValues
-
Returns the stored value.
- get(String) - Method in class io.jpostman.testng.TestNgContext
-
Returns the original value for the given key.
- get(String) - Method in class io.jpostman.Url
-
Looks up an enabled query parameter by key.
- get(String) - Method in class io.jpostman.vault.VaultSettings
-
Resolves a setting from Java system properties first, then environment variables.
- get(String, String) - Method in class io.jpostman.vault.VaultSettings
-
Returns a setting from Java system properties or environment variables.
- getAdds() - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Returns new environment key/value pairs to add.
- getAllowedMethods() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the allowed methods.
- getAsserts() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getAuth() - Method in class io.jpostman.Request
- getAuth() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the auth.
- getBaseUrl() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the base url.
- getBaseUrl() - Method in class io.jpostman.schema.parser.ApiSpecParserOptions
-
Returns the base url.
- getBody() - Method in class io.jpostman.ApiResponse
- getBody() - Method in class io.jpostman.Request
- getBody() - Method in class io.jpostman.schema.model.ApiExample
-
Returns the body.
- getBody() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the body.
- getBody() - Method in class io.jpostman.schema.model.ApiResponse
-
Returns the response body template.
- getBody() - Method in class io.jpostman.secure.SecureResponse
- getCache() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getCode() - Method in class io.jpostman.schema.model.ApiResponse
-
Returns the response status code.
- getCollection() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the loaded collection.
- getCollection() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the loaded collection from the core context.
- getCollection() - Method in class io.jpostman.JPostman.Context
-
Returns the loaded Postman collection.
- getContent() - Method in class io.jpostman.schema.model.ApiBody
-
Returns the content.
- getContentType() - Method in class io.jpostman.schema.model.ApiResponse
-
Returns the response content type.
- getCookieFilter() - Method in class io.jpostman.restassured.RestAssuredExecutor
-
Returns the REST Assured cookie filter used by shared-session executors.
- getCookieManager() - Method in class io.jpostman.httpclient.HttpClientExecutor
-
Returns the cookie manager used by shared-session executors.
- getCookieStore() - Method in class io.jpostman.unirest.UnirestExecutor
-
Returns the cookie store used by shared-session executors.
- getCreatedAt() - Method in class io.jpostman.github.GitHubSecretMetadata
- getData() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getDeletes() - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Returns environment keys to delete from the environment map.
- getDependsOn() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getDescription() - Method in class io.jpostman.Request
- getDescription() - Method in class io.jpostman.schema.model.ApiBody
-
Returns the description.
- getDescription() - Method in class io.jpostman.schema.model.ApiFolder
-
Returns the description.
- getDescription() - Method in class io.jpostman.schema.model.ApiHeader
-
Returns the description.
- getDescription() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the description.
- getDescription() - Method in class io.jpostman.schema.model.ApiParam
-
Returns the description.
- getDescription() - Method in class io.jpostman.schema.model.ApiResponse
-
Returns the response description.
- getEnabled() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getEnvironment() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the loaded environment.
- getEnvironment() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the loaded environment from the core context.
- getEnvironment() - Method in class io.jpostman.Collection
- getEnvironment() - Method in class io.jpostman.JPostman.Context
-
Returns the loaded Postman environment.
- getEnvs() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the environment variable map collected from placeholders and examples.
- getExample() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the example.
- getExample() - Method in class io.jpostman.schema.model.ApiResponse
-
Returns the response example body.
- getExclude() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getExecutor() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getFilter() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getFolder() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getFolder() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the folder.
- getFolder(String) - Method in class io.jpostman.Collection
-
Looks up a folder by name, ignoring case.
- getFolderName() - Method in class io.jpostman.Request
- getFolders() - Method in class io.jpostman.Collection
- getFolders() - Method in class io.jpostman.schema.model.ApiFolder
-
Returns the folders.
- getFolders() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the folders.
- getFormat() - Method in exception io.jpostman.schema.parser.ApiSpecParseException
-
Returns the format.
- getGraphQlOperationType() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the graph ql operation type.
- getHeader() - Method in class io.jpostman.Request
- getHeaders() - Method in class io.jpostman.ApiResponse
- getHeaders() - Method in class io.jpostman.schema.model.ApiExample
-
Returns the headers.
- getHeaders() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the headers.
- getHeaders() - Method in class io.jpostman.secure.SecureResponse
- getId() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getInclude() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getLanguage() - Method in class io.jpostman.Body
- getLifecycle() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getLocation() - Method in class io.jpostman.schema.model.ApiAuth
-
Returns the location.
- getLog() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getMessage(JPostmanInfo, String...) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- getMethod() - Method in class io.jpostman.Request
- getMethod() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the method.
- getMethodName() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getMethodName() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the method name.
- getMode() - Method in class io.jpostman.Body
- getName() - Method in class io.jpostman.Collection
- getName() - Method in class io.jpostman.Environment
- getName() - Method in class io.jpostman.Folder
- getName() - Method in class io.jpostman.github.GitHubSecretMetadata
- getName() - Method in class io.jpostman.Request
- getName() - Method in class io.jpostman.schema.model.ApiAuth
-
Returns the name.
- getName() - Method in class io.jpostman.schema.model.ApiExample
-
Returns the name.
- getName() - Method in class io.jpostman.schema.model.ApiFolder
-
Returns the name.
- getName() - Method in class io.jpostman.schema.model.ApiHeader
-
Returns the name.
- getName() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the display name.
- getName() - Method in class io.jpostman.schema.model.ApiParam
-
Returns the name.
- getName() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the name.
- getNamespace() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getOperations() - Method in class io.jpostman.schema.model.ApiFolder
-
Returns the operations.
- getOperations() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the operations.
- getOriginal() - Method in class io.jpostman.Url
- getOverrideUrl() - Method in class io.jpostman.schema.parser.ApiSpecParserOptions
-
Returns the override url.
- getParam(String) - Method in class io.jpostman.Header
-
Looks up parameter metadata by key.
- getParam(String) - Method in class io.jpostman.Url
-
Looks up parameter metadata by key.
- getParams() - Method in class io.jpostman.Auth
- getParams() - Method in class io.jpostman.Environment
- getParams() - Method in class io.jpostman.Header
- getParams() - Method in class io.jpostman.Url
- getParsed() - Method in class io.jpostman.Body
-
Lazily parses the current raw body as JSON.
- getPath() - Method in class io.jpostman.schema.model.ApiExample
-
Returns the path.
- getPath() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the path.
- getProtocol() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the protocol.
- getQueryParams() - Method in class io.jpostman.schema.model.ApiExample
-
Returns the query params.
- getQueryParams() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the query params.
- getRaw() - Method in class io.jpostman.Auth
- getRaw() - Method in class io.jpostman.Body
- getRaw() - Method in class io.jpostman.Url
- getRenames() - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Returns environment key renames, where map key is the old name and map value is the new name.
- getRequest() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getRequest(String) - Method in class io.jpostman.Collection
-
Looks up a root-level request by name, ignoring case.
- getRequest(String) - Method in class io.jpostman.Folder
-
Looks up a request by name, ignoring case.
- getRequests() - Method in class io.jpostman.Collection
- getRequests() - Method in class io.jpostman.Folder
- getResponses() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns the responses.
- getRoot() - Method in class io.jpostman.Collection
- getRule() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getSkip() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getSoft() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getTags() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getType() - Method in class io.jpostman.Auth
-
Auth type — e.g.
- getType() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getType() - Method in class io.jpostman.schema.model.ApiAuth
-
Returns the type.
- getType() - Method in class io.jpostman.schema.model.ApiBody
-
Returns the type.
- getUpdatedAt() - Method in class io.jpostman.github.GitHubSecretMetadata
- getUrl() - Method in class io.jpostman.Request
- getUserMessage() - Method in exception io.jpostman.schema.parser.ApiSpecParseException
-
Returns the user message.
- getValue() - Method in class io.jpostman.Params.Entry
-
Returns the raw parameter value.
- getValue() - Method in class io.jpostman.schema.model.ApiAuth
-
Returns the value.
- getValue() - Method in class io.jpostman.schema.model.ApiHeader
-
Returns the value.
- getValue() - Method in class io.jpostman.schema.model.ApiParam
-
Returns the value.
- getValue(Map<String, String>, String) - Method in class io.jpostman.vault.VaultSecretService
-
Gets one value from an already-loaded secret data map.
- getValues() - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Returns environment value updates, where map key is the environment key and map value is the new environment value.
- getVerify() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
- getVersion() - Method in class io.jpostman.codegen.model.JPostmanMethodSpec
-
Returns the code-generation model version.
- getVersion() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns the API model contract version.
- GitHubPublicKey - Class in io.jpostman.github
-
GitHub repository public key used to encrypt Actions secrets.
- GitHubPublicKey(String, String) - Constructor for class io.jpostman.github.GitHubPublicKey
-
Creates a GitHub public key holder.
- GitHubSecretMetadata - Class in io.jpostman.github
-
Metadata for a GitHub Actions repository secret.
- GitHubSecretMetadata(String, String, String) - Constructor for class io.jpostman.github.GitHubSecretMetadata
- GitHubService - Class in io.jpostman.github
-
Service for GitHub Actions repository variables and secret metadata.
- GitHubService(String) - Constructor for class io.jpostman.github.GitHubService
-
Creates a service using the default GitHub REST API URL.
- GitHubService(String, String) - Constructor for class io.jpostman.github.GitHubService
-
Creates a service using a custom GitHub REST API URL.
- GRAPHQL - io.jpostman.schema.model.ApiBodyType
- GRAPHQL - io.jpostman.schema.model.ApiProtocol
- GRAPHQL - io.jpostman.schema.parser.ApiSpecFormat
- GraphQlImporter - Class in io.jpostman.schema.importer
-
Imports a GraphQL schema into the common JPostman API schema model.
- GraphQlImporter() - Constructor for class io.jpostman.schema.importer.GraphQlImporter
H
- handleAfterEachMethodExecutionException(ExtensionContext, Throwable) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- HANDLEBARS_TOKEN - Static variable in class io.jpostman.Params
- handleBeforeEachMethodExecutionException(ExtensionContext, Throwable) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- handleTestExecutionException(ExtensionContext, Throwable) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- has(String...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagRules
-
Creates a condition that matches only when all supplied values match the current tag chain.
- has(String...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Creates a condition that matches only when all supplied values match the current runner request name.
- hasAssertContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasCache(C, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Checks whether a cache entry exists for the given key.
- hasCall(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasExecutor(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasKey(String) - Method in class io.jpostman.junit.JUnitContext
-
Checks whether a plain or protected value key exists.
- hasKey(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- hasKey(String) - Method in class io.jpostman.testng.TestNgContext
-
Checks whether a plain or protected value key exists.
- hasReportContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasRequest(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasRequestValues() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns true when request customization values were added.
- hasResponse(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Returns whether the context currently has a response.
- hasResponse(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasRunner(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasSoftAssertContext(Class<?>) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasTag(String...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns
truewhen any requested tag exists inJPostmanInfo.tags. - hasTestContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- hasTestNg(Class<?>) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- header(String, String) - Method in class io.jpostman.httpclient.HttpClientExecutor
-
Adds or overrides a header for the next executed request.
- header(String, String) - Method in class io.jpostman.playwright.PlaywrightExecutor
-
Adds or overrides a header for the next executed request.
- header(String, String) - Method in class io.jpostman.restassured.RestAssuredExecutor
-
Adds or overrides a header for the next executed request.
- header(String, String) - Method in class io.jpostman.unirest.UnirestExecutor
-
Adds or overrides a header for the next executed request.
- Header - Class in io.jpostman
-
Represents the HTTP headers of a Postman request.
- Header() - Constructor for class io.jpostman.Header
- HEADER - io.jpostman.schema.model.ApiAuthLocation
- HEADER - io.jpostman.schema.model.ApiParamLocation
- headers - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Header values applied to the request.
- headers() - Method in class io.jpostman.Request.RequestBuilder
-
Configures headers using a lambda-style nested builder.
- headers(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds header values.
- headers(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request headers for the current JPostman execution.
- headers(String...) - Method in class io.jpostman.junit.JUnitContext
-
Adds protected header rules.
- headers(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- headers(String...) - Method in class io.jpostman.secure.RedactionPolicy
-
Adds header names whose values should be fully masked.
- headers(String...) - Method in class io.jpostman.secure.SecureContext
-
Adds protected header names whose values should be fully masked in logs.
- headers(String...) - Method in class io.jpostman.secure.SecureRequest
-
Adds protected header names whose values should be fully masked in logs.
- headers(String...) - Method in class io.jpostman.secure.SecureResponse
-
Adds protected header names whose values should be fully masked in logs.
- headers(String...) - Method in class io.jpostman.testng.TestNgContext
-
Adds protected header rules.
- headers(Consumer<Request.RequestBuilder.ParamStep>) - Method in class io.jpostman.Request.RequestBuilder
-
Configures headers using a lambda-style nested builder.
- headers(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds header values.
- headers(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request header values from an existing map.
- headersAdd - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Header values that should be added instead of set/resolved.
- headersFilter(String...) - Method in class io.jpostman.junit.JUnitContext
-
Adds response header filter rules.
- headersFilter(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- headersFilter(String...) - Method in class io.jpostman.secure.SecureContext
-
Sets response header filter rules.
- headersFilter(String...) - Method in class io.jpostman.secure.SecureResponse
-
Sets response header filter rules.
- headersFilter(String...) - Method in class io.jpostman.testng.TestNgContext
-
Adds response header filter rules.
- headersFilter(List<String>) - Method in class io.jpostman.secure.SecureResponse
-
Sets response header filter rules.
- HttpClientExecutor - Class in io.jpostman.httpclient
-
Java 11
HttpClientadapter for executing JPostman requests. - HttpClientExecutor(Request) - Constructor for class io.jpostman.httpclient.HttpClientExecutor
-
Creates an executor with a default Java
HttpClientand a 30-second request timeout. - HttpClientExecutor(Request, HttpClient, Duration) - Constructor for class io.jpostman.httpclient.HttpClientExecutor
-
Creates an executor with a caller-provided HTTP client and timeout.
I
- id - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Optional annotation id associated with this invocation, or empty string when none.
- id() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostman.Executor
-
Executor id.
- id() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostmanCall
- id() - Method in annotation type io.jpostman.annotations.JPostmanExecutor
-
Unique executor id referenced by
JPostmanResponse.executor()andJPostmanRunner.executor(). - id() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Optional annotation id used by dependsOn = "#id".
- id() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Optional annotation id used by dependsOn = "#id".
- id(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Updates the annotation id represented by this invocation.
- id(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- importSpec(String, ApiSpecParserOptions) - Method in interface io.jpostman.schema.importer.ApiSpecImporter
-
Parses the supplied document content and returns a normalized API specification.
- importSpec(String, ApiSpecParserOptions) - Method in class io.jpostman.schema.importer.GraphQlImporter
-
Parses the supplied document content and returns a normalized API specification.
- importSpec(String, ApiSpecParserOptions) - Method in class io.jpostman.schema.importer.OpenApiImporter
-
Parses the supplied document content and returns a normalized API specification.
- importSpec(String, ApiSpecParserOptions) - Method in class io.jpostman.schema.importer.PostmanImporter
-
Parses the supplied document content and returns a normalized API specification.
- include() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Request names to include.
- include() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Request names to include.
- include(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- includeLog - Variable in class io.jpostman.junit.JUnitAssertions
- includeLog - Variable in class io.jpostman.testng.TestNgAssertions
- info() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns the current execution info.
- info() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Returns the latest execution info and prints it using trace level.
- info() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns the current annotation execution information.
- info(boolean) - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Returns the latest execution info.
- info(String, Object...) - Method in class io.jpostman.JPostman.Context
-
Logs an INFO message using the context logger.
- infoSuffix(JPostmanInfo) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- inheritLocation(JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Inherits namespace, folder, and request values from another info object only when this info object does not already define them.
- interceptAfterAllMethod(InvocationInterceptor.Invocation<Void>, ReflectiveInvocationContext<Method>, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Cleans and prints failures thrown by
@AfterAll. - interceptBeforeAllMethod(InvocationInterceptor.Invocation<Void>, ReflectiveInvocationContext<Method>, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Cleans and prints failures thrown by
@BeforeAll. - interceptTestMethod(InvocationInterceptor.Invocation<Void>, ReflectiveInvocationContext<Method>, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- interceptTestMethod(InvocationInterceptor.Invocation<Void>, ReflectiveInvocationContext<Method>, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Runs JPostman request/response/runner annotations before the user test body.
- io.jpostman - package io.jpostman
- io.jpostman.annotations - package io.jpostman.annotations
- io.jpostman.annotations.runtime - package io.jpostman.annotations.runtime
- io.jpostman.annotations.testng - package io.jpostman.annotations.testng
- io.jpostman.codegen.cli - package io.jpostman.codegen.cli
- io.jpostman.codegen.model - package io.jpostman.codegen.model
- io.jpostman.codegen.render - package io.jpostman.codegen.render
- io.jpostman.github - package io.jpostman.github
- io.jpostman.httpclient - package io.jpostman.httpclient
- io.jpostman.junit - package io.jpostman.junit
- io.jpostman.kubernetes - package io.jpostman.kubernetes
- io.jpostman.playwright - package io.jpostman.playwright
- io.jpostman.restassured - package io.jpostman.restassured
- io.jpostman.schema.cli - package io.jpostman.schema.cli
- io.jpostman.schema.env - package io.jpostman.schema.env
- io.jpostman.schema.export - package io.jpostman.schema.export
- io.jpostman.schema.importer - package io.jpostman.schema.importer
- io.jpostman.schema.model - package io.jpostman.schema.model
- io.jpostman.schema.parser - package io.jpostman.schema.parser
- io.jpostman.schema.util - package io.jpostman.schema.util
- io.jpostman.secure - package io.jpostman.secure
- io.jpostman.testng - package io.jpostman.testng
- io.jpostman.unirest - package io.jpostman.unirest
- io.jpostman.vault - package io.jpostman.vault
- isEmpty() - Method in class io.jpostman.annotations.JPostman.Ref
-
Returns true when the reference has no usable value.
- isEmpty() - Method in class io.jpostman.Body
- isEmpty() - Method in class io.jpostman.Header
- isEmpty() - Method in class io.jpostman.Url
- isEnabled() - Method in class io.jpostman.Params.Entry
-
Returns whether this parameter is enabled.
- isEqual(Object, Object) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the actual value is equal to the expected value.
- isEqual(Object, Object) - Method in interface io.jpostman.secure.JPostmanAssertions
- isEqual(Object, Object) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the actual value is equal to the expected value.
- isEqual(Object, Object, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the actual value is equal to the expected value.
- isEqual(Object, Object, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isEqual(Object, Object, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the actual value is equal to the expected value.
- isFalse(boolean) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the condition is false.
- isFalse(boolean) - Method in interface io.jpostman.secure.JPostmanAssertions
- isFalse(boolean) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the condition is false.
- isFalse(boolean, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the condition is false.
- isFalse(boolean, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isFalse(boolean, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the condition is false.
- isHeaderProtected(String) - Method in class io.jpostman.secure.RedactionPolicy
-
Checks whether a header value should be fully masked.
- isInstalled() - Static method in class io.jpostman.annotations.JPostmanOutputs
-
Returns whether a custom output sink is active on the current thread.
- isJUnitSkip(Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Returns true when the throwable represents a JUnit skipped/aborted test.
- isNoAuth() - Method in class io.jpostman.Auth
- isNoAuth() - Method in class io.jpostman.Authentication.State
-
Returns whether request-level
Authorizationshould be skipped. - isNotEqual(Object, Object) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the actual value is not equal to the expected value.
- isNotEqual(Object, Object) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNotEqual(Object, Object) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the actual value is not equal to the expected value.
- isNotEqual(Object, Object, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the actual value is not equal to the expected value.
- isNotEqual(Object, Object, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNotEqual(Object, Object, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the actual value is not equal to the expected value.
- isNotNull(Object) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value is not null.
- isNotNull(Object) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNotNull(Object) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value is not null.
- isNotNull(Object, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value is not null.
- isNotNull(Object, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNotNull(Object, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value is not null.
- isNull() - Method in class io.jpostman.annotations.JPostman.Ref
-
Returns true when the reference value is null.
- isNull(Object) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value is null.
- isNull(Object) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNull(Object) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value is null.
- isNull(Object, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value is null.
- isNull(Object, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isNull(Object, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value is null.
- isOverrideUrl() - Method in class io.jpostman.schema.model.ApiSpec
-
Returns whether override url is enabled or true.
- isProtected() - Method in class io.jpostman.secure.SecureValue
- isProtectedKey(String) - Method in class io.jpostman.secure.RedactionPolicy
-
Checks whether a key is protected.
- isRequestAware() - Method in enum io.jpostman.codegen.model.JPostmanAnnotationType
- isRequired() - Method in class io.jpostman.schema.model.ApiHeader
-
Returns whether required is enabled or true.
- isRequired() - Method in class io.jpostman.schema.model.ApiParam
-
Returns whether required is enabled or true.
- isRunner() - Method in enum io.jpostman.codegen.model.JPostmanAnnotationType
- isRunnerBodyComplete(Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Returns true when the supplied throwable is the internal runner body control signal used to stop a fluent runner method after the active phase has been handled.
- isSecretValue(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns true when the supplied value was added through a secret JPostmanInfo method.
- isTrue(boolean) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the condition is true.
- isTrue(boolean) - Method in interface io.jpostman.secure.JPostmanAssertions
- isTrue(boolean) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the condition is true.
- isTrue(boolean, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the condition is true.
- isTrue(boolean, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- isTrue(boolean, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the condition is true.
- isUrlResolved() - Method in class io.jpostman.schema.model.ApiOperation
-
Returns whether url resolved is enabled or true.
J
- JavaTestMethodRenderer - Class in io.jpostman.codegen.render
-
Renders Java test method snippets that use JPostman annotations.
- JPostman - Class in io.jpostman.annotations
-
Compact JPostman annotation facade.
- JPostman - Class in io.jpostman
-
Convenience entry point for loading a Postman collection and, optionally, a Postman environment.
- JPostman.Assert - Interface in io.jpostman.annotations
-
Compact framework-neutral assertion facade backed by the latest active JPostman test context.
- JPostman.AssertContext - Annotation Type in io.jpostman.annotations
-
Injects an assertion facade backed by the latest active JPostman test context.
- JPostman.Asserts - Annotation Type in io.jpostman.annotations
-
Short alias for
JPostman.AssertContext. - JPostman.Call - Annotation Type in io.jpostman.annotations
-
Marks a test method that executes one request manually through
JPostman.Runtime.call()orJPostman.Runtime.call(BiConsumer). - JPostman.Context - Class in io.jpostman
-
Represents a loaded Postman collection with an optional environment.
- JPostman.Context - Annotation Type in io.jpostman.annotations
-
Loads and injects the main JPostman runtime context.
- JPostman.Executor - Annotation Type in io.jpostman.annotations
-
Marks a method as a JPostman executor.
- JPostman.Info - Interface in io.jpostman.annotations
-
Compact facade for execution info.
- JPostman.JUnit - Annotation Type in io.jpostman.annotations
-
Enables JPostman annotation support for JUnit 5.
- JPostman.Ref<T> - Class in io.jpostman.annotations
-
Small mutable reference for values that need to be updated inside Java lambdas and read after the fluent chain finishes.
- JPostman.Report - Interface in io.jpostman.annotations
-
Compact facade for the JPostman report.
- JPostman.ReportContext - Annotation Type in io.jpostman.annotations
-
Injects the JPostman report facade.
- JPostman.Request - Annotation Type in io.jpostman.annotations
-
Marks a method that prepares or modifies a request.
- JPostman.Response - Annotation Type in io.jpostman.annotations
-
Marks a method that executes and handles a response.
- JPostman.Runner - Annotation Type in io.jpostman.annotations
-
Marks a method that runs one or more collection requests.
- JPostman.Runtime<C> - Interface in io.jpostman.annotations
-
Runtime facade injected by
JPostman.Context. - JPostman.Test - Interface in io.jpostman.annotations
-
Compact framework-neutral test context facade.
- JPostman.TestContext - Annotation Type in io.jpostman.annotations
-
Injects a framework-specific test context.
- JPostman.TestNG - Annotation Type in io.jpostman.annotations
-
Enables JPostman annotation support for TestNG.
- JPostmanAnnotationEngine - Class in io.jpostman.annotations.runtime
-
Public entry point for JPostman annotation setup and execution.
- JPostmanAnnotationEngine() - Constructor for class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Creates an annotation engine instance.
- JPostmanAnnotationRunner<C> - Class in io.jpostman.annotations.runtime
-
Shared annotation execution flow for JUnit and TestNG.
- JPostmanAnnotationRunner(JPostmanFramework<C>) - Constructor for class io.jpostman.annotations.runtime.JPostmanAnnotationRunner
-
Creates a runner for the supplied framework bridge.
- JPostmanAnnotationRunner(JPostmanFramework<C>, Runnable) - Constructor for class io.jpostman.annotations.runtime.JPostmanAnnotationRunner
-
Creates a runner for the supplied framework bridge.
- JPostmanAnnotations - Class in io.jpostman.annotations.runtime
- JPostmanAnnotationType - Enum in io.jpostman.codegen.model
-
Supported JPostman method-level annotations for generated test methods.
- JPostmanAnnotationValidator - Class in io.jpostman.annotations.runtime
-
Validates annotation-based test classes before any test method executes.
- JPostmanAssertContext - Annotation Type in io.jpostman.annotations
-
Injects a framework-neutral assertion facade backed by the latest active JPostman test context.
- JPostmanAssertionError - Error in io.jpostman.secure
-
Assertion error that carries optional secure log context.
- JPostmanAssertionError(String, Throwable, String) - Constructor for error io.jpostman.secure.JPostmanAssertionError
-
Creates an assertion error with optional secure log context.
- JPostmanAssertions<C,A> - Interface in io.jpostman.secure
-
Shared assertion contract used by the JPostman TestNG and JUnit modules.
- JPostmanCacheValueConverter - Class in io.jpostman.annotations.runtime
-
Converts cached JSON scalar nodes into ordinary Java values.
- JPostmanCall - Annotation Type in io.jpostman.annotations
-
Marks a test method that will execute one annotated request manually through
JPostman.Runtime.call(...). - JPostmanCodegenCli - Class in io.jpostman.codegen.cli
-
Command-line entry point for generating JPostman annotation source snippets and JPostman runtime properties.
- JPostmanContext - Annotation Type in io.jpostman.annotations
-
Injects the loaded JPostman context.
- JPostmanDataLoader - Class in io.jpostman.annotations.runtime
-
Loads external INI data files declared by
JPostmanContext.dataload()or the config properties filedataload/dataload.<namespace>. - JPostmanExecutor - Annotation Type in io.jpostman.annotations
-
Marks a method that provides an
ApiExecutorfor annotation-based request execution. - JPostmanFramework<C> - Interface in io.jpostman.annotations.runtime
-
Small bridge between the shared annotation engine and a test framework context.
- JPostmanInfo - Class in io.jpostman.annotations.runtime
-
Runtime information shared across a JPostman annotation execution chain.
- JPostmanInfo(String[], String, String, String, String, String) - Constructor for class io.jpostman.annotations.runtime.JPostmanInfo
- JPostmanInfo(String, String, String, String) - Constructor for class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates a new top-level runtime info object using the Java method name and no annotation tags.
- JPostmanInfo(String, String, String, String, String) - Constructor for class io.jpostman.annotations.runtime.JPostmanInfo
- JPostmanInfo.TagCondition - Class in io.jpostman.annotations.runtime
-
Pending tag condition returned by
JPostmanInfo.TagRules.has(String...)andJPostmanInfo.TagRules.any(String...). - JPostmanInfo.TagRules - Class in io.jpostman.annotations.runtime
-
Fluent tag rule builder used by
JPostmanInfo.tags(). - JPostmanJUnit - Annotation Type in io.jpostman.junit
-
Enables JPostman JUnit test defaults.
- JPostmanJUnit.JPostmanJUnitExtension - Class in io.jpostman.junit
-
JUnit bridge for JPostman defaults, optional annotation runtime, current context cleanup, parameter resolution, and failure printing.
- JPostmanJUnitExtension - Class in io.jpostman.junit
-
JUnit 5 bridge for JPostman annotation execution.
- JPostmanJUnitExtension() - Constructor for class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- JPostmanJUnitExtension() - Constructor for class io.jpostman.junit.JPostmanJUnitExtension
- JPostmanMethodSpec - Class in io.jpostman.codegen.model
-
Framework-neutral method specification used to render JPostman source code.
- JPostmanMethodSpec.Builder - Class in io.jpostman.codegen.model
- JPostmanOutput - Interface in io.jpostman.annotations
-
Receives user-facing JPostman runtime output.
- JPostmanOutputs - Class in io.jpostman.annotations
-
Installs a scoped output sink for JPostman-generated messages.
- JPostmanOutputs.Scope - Class in io.jpostman.annotations
-
Scoped sink installation.
- JPostmanReport - Class in io.jpostman.annotations.runtime
-
Runtime report collected during JPostman annotation execution.
- JPostmanReport() - Constructor for class io.jpostman.annotations.runtime.JPostmanReport
- JPostmanReportContext - Annotation Type in io.jpostman.annotations
-
Injects a
JPostmanReportinto a test class field. - JPostmanRequest - Annotation Type in io.jpostman.annotations
-
Prepares request data before a request is executed.
- JPostmanResponse - Annotation Type in io.jpostman.annotations
-
Executes a prepared Postman request and exposes the response to the method body.
- JPostmanRunner - Annotation Type in io.jpostman.annotations
-
Executes multiple Postman requests from a collection folder before a test method runs.
- JPostmanRuntime<C> - Class in io.jpostman.annotations.runtime
-
Runtime view injected by
JPostmanContext. - JPostmanRuntime(JPostman.Context, String, Function<String, C>, Supplier<C>, Supplier<JPostmanInfo>) - Constructor for class io.jpostman.annotations.runtime.JPostmanRuntime
-
Creates a runtime view.
- JPostmanRuntime.RunnerCondition<C> - Class in io.jpostman.annotations.runtime
-
Pending runner condition returned by
JPostmanRuntime.RunnerRules.has(String...)andJPostmanRuntime.RunnerRules.any(String...). - JPostmanRuntime.RunnerRules<C> - Class in io.jpostman.annotations.runtime
-
Fluent request-name rule builder for
@JPostmanRunnertest bodies. - JPostmanSoftAssertions<C,A> - Interface in io.jpostman.secure
-
Shared soft assertion contract used by the JPostman TestNG and JUnit modules.
- JPostmanStackTraceCleaner - Class in io.jpostman.annotations.runtime
-
Builds short, clickable stack traces for annotation-driven failures.
- JPostmanTestAssertions - Interface in io.jpostman.annotations
-
Framework-neutral facade for hard assertions used by
JPostman.Test. - JPostmanTestContext<C,A,S> - Interface in io.jpostman.secure
-
Shared fluent test context contract used by the JPostman TestNG and JUnit modules.
- JPostmanTestContext - Annotation Type in io.jpostman.annotations
-
Injects a JPostman framework context into a test class field.
- JPostmanTestNG - Annotation Type in io.jpostman.testng
-
Marks a TestNG test class as a JPostman TestNG test.
- JPostmanTestNgAnnotationListener - Class in io.jpostman.annotations.testng
-
TestNG lifecycle bridge for the JPostman annotation engine.
- JPostmanTestNgAnnotationListener() - Constructor for class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
- JPostmanTestNgAnnotations - Annotation Type in io.jpostman.annotations.testng
-
Enables JPostman annotation-based execution for TestNG tests.
- JPostmanTestSoftAssertions - Interface in io.jpostman.annotations
-
Framework-neutral facade for soft assertions used by
JPostman.Test. - json(Object...) - Method in class io.jpostman.Params
-
Resolves variables using local key/value pairs where String values are JSON-stringified, then produces the final object.
- json(Object...) - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Resolves this request part using local key/value pairs and returns to the parent request builder.
- JSON - io.jpostman.schema.model.ApiBodyType
- jsonList(T...) - Static method in class io.jpostman.Params
-
Creates a mutable JSON-ready list from the supplied values.
- jsonMap(Object...) - Static method in class io.jpostman.Params
-
Creates a mutable ordered JSON-ready map from alternating String keys and typed values.
- JUnitAssertions<T extends JUnitAssertions<T>> - Class in io.jpostman.junit
-
Fluent JUnit assertions with optional secure log output.
- JUnitContext - Class in io.jpostman.junit
-
JUnit-friendly wrapper around
SecureContext. - JUnitPostmanFramework - Class in io.jpostman.annotations.runtime
-
JUnit implementation of the annotation framework bridge.
- JUnitPostmanFramework() - Constructor for class io.jpostman.annotations.runtime.JUnitPostmanFramework
- JUnitSoftAssertions - Class in io.jpostman.junit
-
Fluent soft assertions.
K
- key() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns the first tag in the current tag chain.
- key() - Method in class io.jpostman.github.GitHubPublicKey
-
Returns the Base64 encoded GitHub public key.
- keyId() - Method in class io.jpostman.github.GitHubPublicKey
-
Returns the GitHub public key id.
- KubernetesClientFactory - Class in io.jpostman.kubernetes
-
Creates Kubernetes API clients from kubeconfig or default configuration.
- KubernetesClientFactory() - Constructor for class io.jpostman.kubernetes.KubernetesClientFactory
- KubernetesConfigMapService - Class in io.jpostman.kubernetes
-
Service for reading and writing Kubernetes ConfigMaps.
- KubernetesConfigMapService(ApiClient) - Constructor for class io.jpostman.kubernetes.KubernetesConfigMapService
-
Creates a ConfigMap service.
- KubernetesConfigMapService(CoreV1Api) - Constructor for class io.jpostman.kubernetes.KubernetesConfigMapService
-
Creates a ConfigMap service.
- KubernetesSecretService - Class in io.jpostman.kubernetes
-
Service for reading and writing Kubernetes Secrets.
- KubernetesSecretService(ApiClient) - Constructor for class io.jpostman.kubernetes.KubernetesSecretService
-
Creates a Secret service.
- KubernetesSecretService(CoreV1Api) - Constructor for class io.jpostman.kubernetes.KubernetesSecretService
-
Creates a Secret service.
L
- lastAssertionMethod(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Returns the latest test method that used the injected assertion facade.
- lifecycle() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Enables request/response runner lifecycle callbacks.
- lifecycle() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Enables the new request/response runner lifecycle callback mode.
- lifecycle(Boolean) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- load(JsonObject) - Static method in class io.jpostman.Collection
-
Load a collection from an already parsed JSON object.
- load(JsonObject) - Static method in class io.jpostman.Environment
-
Load an environment from an already parsed JSON object.
- load(C, InputStream) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Loads secure rules into the framework context.
- load(JUnitContext, InputStream) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Loads secure rules into the framework context.
- load(TestNgContext, InputStream) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Loads secure rules into the framework context.
- load(InputStream) - Static method in class io.jpostman.Collection
-
Load a collection from an input stream.
- load(InputStream) - Static method in class io.jpostman.Environment
-
Loads a Postman environment from an input stream.
- load(InputStream) - Static method in class io.jpostman.JPostman
-
Loads a Postman collection from an input stream without an environment.
- load(InputStream) - Method in class io.jpostman.junit.JUnitContext
-
Loads secure rules from an input stream.
- load(InputStream) - Method in interface io.jpostman.secure.JPostmanTestContext
- load(InputStream) - Method in class io.jpostman.secure.SecureContext
-
Loads redaction rules from an input stream.
- load(InputStream) - Method in class io.jpostman.testng.TestNgContext
-
Loads secure rules from an input stream.
- load(InputStream, InputStream) - Static method in class io.jpostman.JPostman
-
Loads a Postman collection and an optional Postman environment from input streams.
- load(String) - Static method in class io.jpostman.Collection
-
Load a collection from a file path.
- load(String) - Static method in class io.jpostman.Environment
-
Loads a Postman environment from a file path and closes the file internally.
- loadEnvironment(InputStream) - Method in class io.jpostman.Collection
-
Load and attach a Postman environment from an input stream.
- loadEnvironment(String) - Method in class io.jpostman.Collection
-
Load and attach a Postman environment file to this collection.
- loadPolicy(InputStream) - Method in class io.jpostman.junit.JUnitContext
-
Loads secure policy profiles from an input stream.
- loadPolicy(InputStream) - Method in interface io.jpostman.secure.JPostmanTestContext
- loadPolicy(InputStream) - Method in class io.jpostman.secure.SecureContext
-
Loads secure policy profiles from an INI-style input stream.
- loadPolicy(InputStream) - Method in class io.jpostman.testng.TestNgContext
-
Loads secure policy profiles from an input stream.
- loadRules(C, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies a named secure rule section to the context.
- loadRules(JUnitContext, String) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Applies a named secure rule section to the context.
- loadRules(TestNgContext, String) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Applies a named secure rule section to the context.
- loadRules(String...) - Method in class io.jpostman.junit.JUnitContext
-
Applies named policy profiles and returns a copied context.
- loadRules(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- loadRules(String...) - Method in class io.jpostman.secure.SecureContext
-
Applies named policy profiles to a copied context.
- loadRules(String...) - Method in class io.jpostman.testng.TestNgContext
-
Applies named policy profiles and returns a copied context.
- location(String, String, String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Applies namespace, folder, and request overrides when the supplied values are not blank.
- log() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostman.Executor
-
Local automatic JPostman failure output mode.
- log() - Method in interface io.jpostman.annotations.JPostman.Info
-
Builds a readable multi-line log message with full execution info.
- log() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostmanCall
- log() - Method in annotation type io.jpostman.annotations.JPostmanExecutor
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Local automatic JPostman failure output mode.
- log() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Local automatic JPostman failure output mode.
- log() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Builds a readable multi-line log message with full current invocation values.
- log() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Builds a readable multi-line report summary.
- log() - Method in class io.jpostman.ApiResponse
-
Returns a readable response summary including status code, and body.
- log() - Method in class io.jpostman.JPostman.Context
-
Returns the SLF4J logger used by this context.
- log() - Method in class io.jpostman.junit.JUnitContext
-
Returns the secure log with resolved values.
- log() - Method in class io.jpostman.Request
-
Returns verbose diagnostic representation including details.
- log() - Method in interface io.jpostman.secure.JPostmanTestContext
- log() - Method in class io.jpostman.secure.SecureContext
-
Returns a secure log containing the latest wrapped request and response.
- log() - Method in class io.jpostman.secure.SecureRequest
-
Returns unresolved redacted debug output.
- log() - Method in class io.jpostman.secure.SecureResponse
-
Returns a readable response summary including status code and body.
- log() - Method in class io.jpostman.testng.TestNgContext
-
Returns the secure log with resolved values.
- log(boolean) - Method in interface io.jpostman.annotations.JPostman.Info
-
Builds a readable multi-line log message with optional full details.
- log(boolean) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Builds a readable multi-line log message with the current invocation values.
- log(boolean) - Method in class io.jpostman.ApiResponse
-
Returns a readable response summary including status code, headers, and body.
- log(boolean) - Method in class io.jpostman.junit.JUnitContext
-
Returns the secure log.
- log(boolean) - Method in interface io.jpostman.secure.JPostmanTestContext
- log(boolean) - Method in class io.jpostman.secure.SecureContext
-
Returns a secure log containing the latest wrapped request and response.
- log(boolean) - Method in class io.jpostman.secure.SecureRequest
-
Returns redacted debug output.
- log(boolean) - Method in class io.jpostman.secure.SecureResponse
-
Returns a readable response summary including status code, headers, and body.
- log(boolean) - Method in class io.jpostman.testng.TestNgContext
-
Returns the secure log.
- log(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- logDebug(Object...) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Logs a debug message.
- logDebug(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Writes a debug message using the loaded core context logger.
- logError(Object...) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Logs an error message.
- logError(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Writes an error message using the loaded core context logger.
- logger(Class<?>) - Method in class io.jpostman.JPostman.Context
-
Returns a copy of this context that uses the supplied class as its logger owner.
- logInfo(Object...) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Logs an info message.
- logInfo(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Writes an info message using the loaded core context logger.
- logs() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Controls automatic JPostman failure output.
- logs() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Controls automatic JPostman failure output.
- logTrace(Object...) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Logs a trace message.
- logTrace(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Writes a trace message using the loaded core context logger.
- logWarn(Object...) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Logs a warning message.
- logWarn(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Writes a warning message using the loaded core context logger.
M
- main(String[]) - Static method in class io.jpostman.codegen.cli.JPostmanCodegenCli
- main(String[]) - Static method in class io.jpostman.schema.cli.ApiSchemaCli
-
CLI entry point.
- map(Object...) - Method in class io.jpostman.Params
-
Resolves variables using local key/value pairs, then produces the final object.
- map(Object...) - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Resolves this request part using local key/value pairs and returns to the parent request builder.
- mask() - Method in class io.jpostman.secure.RedactionPolicy
-
Returns the mask used for protected values.
- mask() - Method in class io.jpostman.secure.SecureValue
- mask(SliceExpressionFactory, String, String) - Method in interface io.jpostman.secure.SliceExpressionFactory
-
Applies custom masking to a parsed slice expression.
- mask(String) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Sets the mask text.
- mask(String, String) - Method in class io.jpostman.secure.DefaultSliceExpressionFactory
-
Applies this slice expression to a value.
- mask(String, String) - Method in interface io.jpostman.secure.SliceExpressionFactory
-
Applies the parsed slice expression.
- method - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Java test/helper/executor method represented by this info object.
- method() - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns the Java test/helper/executor method represented by this info object.
- method(int) - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns an entry from the current execution method chain relative to the current invocation.
- method(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Marks this info object as the current invocation for the supplied method entry.
- method(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- methodIndex - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Zero-based index of the current invocation entry inside
JPostmanInfo.methods, or-1when this invocation has not been added to the method chain. - methodIndex(int) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Sets the current invocation index without appending another method entry.
- methods - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Ordered Java methods visited by this JPostman execution chain.
N
- name() - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Returns the framework name used in error messages.
- name() - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Returns the framework name used in error messages.
- name() - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Returns the framework name used in error messages.
- namespace - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Context namespace associated with this invocation.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Request namespace.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.Executor
-
Namespace where this executor interceptor applies.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Request namespace.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Response namespace.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Runner namespace.
- namespace() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
Context namespace.
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanCall
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanExecutor
-
Namespace where this executor interceptor applies.
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Context namespace to use.
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Context namespace to use.
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Context namespace to use.
- namespace() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
Context namespace to use.
- namespace() - Method in class io.jpostman.vault.VaultSettings
-
Returns the optional Vault Enterprise namespace.
- namespace(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- NO_CACHE - Static variable in annotation type io.jpostman.annotations.JPostmanRequest
-
Internal sentinel used to distinguish omitted cache from explicit cache = "".
- NO_CACHE - Static variable in annotation type io.jpostman.annotations.JPostmanResponse
-
Internal sentinel used to distinguish omitted cache from explicit cache = "".
- none() - Method in class io.jpostman.Authentication
-
Disables Authorization for this execution.
- NONE - io.jpostman.schema.model.ApiAuthType
- NONE - io.jpostman.schema.model.ApiBodyType
- notExists(String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response does not contain the given path.
- notExists(String) - Method in interface io.jpostman.secure.JPostmanAssertions
- notExists(String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response does not contain the given path.
- notExists(String, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response does not contain the given path.
- notExists(String, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- notExists(String, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response does not contain the given path.
O
- oauth2(String) - Method in class io.jpostman.Authentication
-
Configures OAuth2 bearer-token authentication.
- OAUTH2 - io.jpostman.schema.model.ApiAuthType
- onAfterClass(ITestClass) - Method in class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
-
Completes class-scoped soft assertions and report output after user @AfterClass methods.
- OPENAPI - io.jpostman.schema.parser.ApiSpecFormat
- OpenApiImporter - Class in io.jpostman.schema.importer
-
Imports OpenAPI 3.x and Swagger 2.0 documents into the common JPostman API schema model.
- OpenApiImporter() - Constructor for class io.jpostman.schema.importer.OpenApiImporter
- optional(String, String) - Static method in class io.jpostman.kubernetes.KubernetesClientFactory
- otherwise(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action when no previous
JPostmanRuntime.RunnerRules.has(String...)orJPostmanRuntime.RunnerRules.any(String...)condition matched in this rule chain. - otherwise(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action when no previous
JPostmanRuntime.RunnerRules.has(String...)orJPostmanRuntime.RunnerRules.any(String...)condition matched in this rule chain. - otherwise(Consumer<JPostmanInfo>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagRules
-
Runs the action when no previous
JPostmanInfo.TagRules.has(String...)orJPostmanInfo.TagRules.any(String...)condition matched in this rule chain.
P
- params() - Method in class io.jpostman.Auth
-
Returns unresolved
{{token}}names found in this auth configuration. - params() - Method in class io.jpostman.Body
-
Returns unresolved
{{token}}names found in this body. - params() - Method in class io.jpostman.Header
-
Returns unresolved
{{token}}names found in header names and values. - params() - Method in class io.jpostman.Request
-
Returns all unresolved
{{token}}names used by this request. - params() - Method in class io.jpostman.Url
-
Returns unresolved
{{token}}names found in the original URL. - Params<T> - Class in io.jpostman
-
Generic fluent builder for Postman parameter maps.
- Params.Builder<T> - Interface in io.jpostman
- Params.Entry - Class in io.jpostman
-
Stores one Postman parameter value together with its enabled/disabled state.
- parse() - Method in class io.jpostman.ApiResponse
-
Attempts to parse a raw string as JSON, returning
nullon failure. - parse() - Method in class io.jpostman.secure.SecureResponse
-
Attempts to parse a raw string as JSON, returning
nullon failure. - parse(String) - Method in class io.jpostman.ApiResponse
-
Attempts to parse a raw string as JSON, returning
nullon failure. - parse(String) - Static method in class io.jpostman.Body
-
Attempts to parse a raw string as JSON, returning
nullon failure. - parse(String) - Static method in class io.jpostman.schema.parser.ApiSpecParser
-
Parses the supplied API document into the common JPostman API schema model.
- parse(String) - Method in class io.jpostman.secure.DefaultSliceExpressionFactory
-
Parses a slice expression.
- parse(String) - Method in class io.jpostman.secure.SecureResponse
-
Attempts to parse a raw string as JSON, returning
nullon failure. - parse(String) - Method in interface io.jpostman.secure.SliceExpressionFactory
-
Parses a slice expression.
- parse(String, ApiSpecParserOptions) - Static method in class io.jpostman.schema.parser.ApiSpecParser
-
Parses the supplied API document into the common JPostman API schema model.
- parseShellExports(String) - Static method in class io.jpostman.github.GitHubService
-
Parses simple
export KEY=VALUEshell lines. - parseShellExports(String) - Static method in class io.jpostman.vault.VaultSecretService
-
Parses simple
export KEY=VALUEshell lines. - passed - Variable in class io.jpostman.annotations.runtime.JPostmanReport
-
Passed top-level JPostman executions.
- passed(JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Records a passed top-level execution.
- path - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Path variable values applied to the request when supported by the request builder.
- path(JsonElement, String) - Static method in class io.jpostman.Params
-
Reads a value from a JSON element using a simple dot/bracket path.
- path(C, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Reads a value from the current response using the framework context path helper.
- path(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds path values.
- path(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request path variable values using key/value pairs.
- path(String) - Method in class io.jpostman.ApiResponse
-
Reads a value from the JSON response body using a simple dot/bracket path.
- path(String) - Method in class io.jpostman.junit.JUnitContext
-
Reads a value from the current secure response using a simple path.
- path(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- path(String) - Method in class io.jpostman.secure.SecureContext
-
Returns a value from the current secure response.
- path(String) - Method in class io.jpostman.secure.SecureResponse
-
Reads a single value from the JSON response body.
- path(String) - Method in class io.jpostman.testng.TestNgContext
-
Reads a value from the current secure response using a simple path.
- path(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds path values.
- path(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds request path variable values from an existing map.
- PATH - io.jpostman.schema.model.ApiParamLocation
- pathElement(JsonElement, String) - Static method in class io.jpostman.Params
-
Reads a JSON element from a parsed JSON root using a simple dot/bracket path.
- pathEquals(String, Object) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value at the given response path is equal to the expected value.
- pathEquals(String, Object) - Method in interface io.jpostman.secure.JPostmanAssertions
- pathEquals(String, Object) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value at the given response path is equal to the expected value.
- pathEquals(String, Object, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value at the given response path is equal to the expected value.
- pathEquals(String, Object, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- pathEquals(String, Object, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value at the given response path is equal to the expected value.
- pathNotNull(String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value at the given response path is not null.
- pathNotNull(String) - Method in interface io.jpostman.secure.JPostmanAssertions
- pathNotNull(String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value at the given response path is not null.
- pathNotNull(String, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the value at the given response path is not null.
- pathNotNull(String, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- pathNotNull(String, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the value at the given response path is not null.
- paths(String) - Method in class io.jpostman.junit.JUnitContext
-
Reads all values from the current secure response that match a path rule.
- paths(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- paths(String) - Method in class io.jpostman.secure.SecureContext
-
Returns all values matching the given path rule from the current secure response.
- paths(String) - Method in class io.jpostman.secure.SecureResponse
-
Reads all values from the JSON response body that match a path rule.
- paths(String) - Method in class io.jpostman.testng.TestNgContext
-
Reads all values from the current secure response that match a path rule.
- plain(C, String, Object) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Stores a plain value in the framework context.
- plain(Environment) - Method in class io.jpostman.junit.JUnitContext
-
Adds plain values from an environment.
- plain(Environment) - Method in interface io.jpostman.secure.JPostmanTestContext
- plain(Environment) - Method in class io.jpostman.secure.SecureContext
-
Adds plain environment values for request resolution.
- plain(Environment) - Method in class io.jpostman.testng.TestNgContext
-
Adds plain values from an environment.
- plain(JUnitContext, String, Object) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Stores a plain value in the framework context.
- plain(TestNgContext, String, Object) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Stores a plain value in the framework context.
- plain(Object) - Static method in class io.jpostman.secure.SecureValue
-
Creates a plain value.
- plain(Object...) - Method in class io.jpostman.junit.JUnitContext
-
Adds plain key/value pairs.
- plain(Object...) - Method in interface io.jpostman.secure.JPostmanTestContext
- plain(Object...) - Method in class io.jpostman.secure.SecureContext
-
Adds plain values used for request resolution.
- plain(Object...) - Method in class io.jpostman.testng.TestNgContext
-
Adds plain key/value pairs.
- plain(String, Object) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds a plain value.
- plain(Map<String, ?>) - Method in class io.jpostman.junit.JUnitContext
-
Adds plain values from a map.
- plain(Map<String, ?>) - Method in interface io.jpostman.secure.JPostmanTestContext
- plain(Map<String, ?>) - Method in class io.jpostman.secure.SecureContext
-
Adds plain values used for request resolution.
- plain(Map<String, ?>) - Method in class io.jpostman.secure.SecureRequest
-
Adds plain values used for request resolution.
- plain(Map<String, ?>) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds plain values from a map.
- plain(Map<String, ?>) - Method in class io.jpostman.testng.TestNgContext
-
Adds plain values from a map.
- PlaywrightExecutor - Class in io.jpostman.playwright
-
This executor uses Playwright's API testing client only.
- PlaywrightExecutor(Playwright, APIRequestContext, boolean) - Constructor for class io.jpostman.playwright.PlaywrightExecutor
-
Creates a Playwright executor.
- POSTMAN - io.jpostman.schema.parser.ApiSpecFormat
- PostmanCollectionExporter - Class in io.jpostman.schema.cli
-
Exports the normalized ApiSpec model as a Postman Collection v2.1 document.
- PostmanCollectionExporter - Class in io.jpostman.schema.export
-
Exports the normalized ApiSpec model as a Postman Collection v2.1 document.
- PostmanCollectionExporter() - Constructor for class io.jpostman.schema.cli.PostmanCollectionExporter
- PostmanCollectionExporter() - Constructor for class io.jpostman.schema.export.PostmanCollectionExporter
- PostmanEnvironmentExporter - Class in io.jpostman.schema.cli
-
Exports normalized ApiSpec environment values as Postman Environment JSON.
- PostmanEnvironmentExporter - Class in io.jpostman.schema.export
-
Exports normalized ApiSpec environment values as Postman Environment JSON.
- PostmanEnvironmentExporter() - Constructor for class io.jpostman.schema.cli.PostmanEnvironmentExporter
- PostmanEnvironmentExporter() - Constructor for class io.jpostman.schema.export.PostmanEnvironmentExporter
- PostmanImporter - Class in io.jpostman.schema.importer
-
Imports Postman Collection documents into the common JPostman API schema model.
- PostmanImporter() - Constructor for class io.jpostman.schema.importer.PostmanImporter
- postProcessTestInstance(Object, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- postProcessTestInstance(Object, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnitExtension
-
Injects JPostman fields before JUnit calls non-static
@BeforeAll. - preemptive() - Method in class io.jpostman.Authentication
-
REST Assured compatibility method.
- pretty() - Method in class io.jpostman.ApiResponse
-
Returns the response body formatted for display.
- pretty() - Method in class io.jpostman.Body
-
Returns the body formatted for display.
- pretty() - Method in class io.jpostman.secure.SecureResponse
-
Returns the response body formatted for display.
- pretty(JsonElement) - Static method in class io.jpostman.Body
-
Formats a parsed JSON value for display.
- print() - Method in interface io.jpostman.annotations.JPostman.Info
-
Prints full execution info.
- print() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Prints
JPostmanInfo.log()using trace level. - print() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Prints the latest execution info using trace level.
- print() - Method in class io.jpostman.ApiResponse
-
Logs this body at TRACE level.
- print() - Method in class io.jpostman.Auth
-
Logs auth details at TRACE level.
- print() - Method in class io.jpostman.Body
-
Logs this body at TRACE level.
- print() - Method in class io.jpostman.Collection
-
Logs collection details at TRACE level.
- print() - Method in class io.jpostman.Environment
-
Logs the environment name and enabled variables.
- print() - Method in class io.jpostman.Folder
-
Logs this folder and its direct requests at TRACE level.
- print() - Method in class io.jpostman.Header
-
Logs headers at TRACE level.
- print() - Method in class io.jpostman.junit.JUnitContext
-
Prints the secure log with resolved values.
- print() - Method in class io.jpostman.Request
-
Logs detailed multi-line output including description, auth, headers, and body at TRACE level.
- print() - Method in interface io.jpostman.secure.JPostmanTestContext
- print() - Method in class io.jpostman.secure.SecureContext
-
Logs the current secure request and response output at TRACE level.
- print() - Method in class io.jpostman.secure.SecureRequest
-
Logs detailed multi-line output including description, auth, headers, and body at TRACE level.
- print() - Method in class io.jpostman.secure.SecureResponse
-
Logs this body at TRACE level.
- print() - Method in class io.jpostman.testng.TestNgContext
-
Prints the secure log with resolved values.
- print() - Method in class io.jpostman.Url
-
Logs URL details at TRACE level.
- print(boolean) - Method in interface io.jpostman.annotations.JPostman.Info
-
Prints execution info with optional full details.
- print(boolean) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Prints
JPostmanInfo.log(boolean)using trace level. - print(boolean) - Method in class io.jpostman.junit.JUnitContext
-
Prints the secure log.
- print(boolean) - Method in interface io.jpostman.secure.JPostmanTestContext
- print(boolean) - Method in class io.jpostman.secure.SecureContext
-
Logs the current secure request and response output at TRACE level.
- print(boolean) - Method in class io.jpostman.secure.SecureRequest
-
Logs detailed multi-line output including description, auth, headers, and body at TRACE level.
- print(boolean) - Method in class io.jpostman.testng.TestNgContext
-
Prints the secure log.
- printContext(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Prints the full framework context when supported.
- printFailures() - Method in annotation type io.jpostman.annotations.JPostman.JUnit
-
Prints cleaned failure stack traces for JUnit execution.
- printFailures() - Method in annotation type io.jpostman.junit.JPostmanJUnit
-
Enables printing test failures to the console.
- printRequest(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Prints only the current framework request when supported.
- printResponse(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Prints only the current framework response when supported.
- props(Environment, Set<String>) - Static method in class io.jpostman.Params
-
Creates a copy of environment values and overrides matching keys with non-empty system property values.
- props(Map<String, String>) - Static method in class io.jpostman.Params
-
Creates a copy of the supplied values and overrides matching keys with non-empty system property values.
- props(Map<String, String>, Set<String>) - Static method in class io.jpostman.Params
-
Creates a copy of the supplied values and overrides matching keys with non-empty system property values.
- protectedKeys() - Method in class io.jpostman.secure.RedactionPolicy
-
Returns the protected keys configured by this policy.
- protectKey(boolean, String...) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Adds protected keys.
- protectKey(String...) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Adds protected keys using normalized matching.
- protectRule(boolean, String) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Adds a protected field or JSON path rule.
- protectRule(String) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Adds a protected field or JSON path rule.
Q
- query - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Query string values applied to the request URL.
- query(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds query values.
- query(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds query string values using key/value pairs.
- query(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds query values.
- query(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds query string values from an existing map.
- QUERY - io.jpostman.schema.model.ApiAuthLocation
- QUERY - io.jpostman.schema.model.ApiParamLocation
- queryAdd - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Query values that should be added instead of set/resolved.
R
- raw(String) - Method in class io.jpostman.Environment
-
Returns the stored value for a key, even when the entry is disabled.
- RAW - io.jpostman.schema.model.ApiBodyType
- readConfigMap(String, String) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Reads a ConfigMap as key/value pairs.
- readConfigMapShellExports(String, String, String) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Reads one ConfigMap value and parses shell export lines from it.
- readConfigMapValue(String, String, String) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Reads one ConfigMap value.
- readKv2Secret(String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads a secret from a KV v2 mount.
- readKv2Secret(String, String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads one value from a KV v2 secret.
- readKv2ShellExports(String, String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads a KV v2 secret, gets a shell script value from the given key, and returns exported variables from that script.
- readRepositorySecret(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Reads repository secret metadata.
- readRepositorySecretPublicKey(String, String) - Method in class io.jpostman.github.GitHubService
-
Reads the repository public key used to encrypt Actions secrets.
- readRepositoryShellExports(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Reads one repository Actions variable and parses shell export lines from it.
- readRepositoryVariable(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Reads one repository Actions variable value.
- readSecret(String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads a Vault logical path.
- readSecret(String, String) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Reads a Secret as UTF-8 key/value pairs.
- readSecret(String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads one value from a Vault secret.
- readSecretShellExports(String, String, String) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Reads one Secret value and parses shell export lines from it.
- readSecretValue(String, String, String) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Reads one Secret value.
- readShellExports(String, String) - Method in class io.jpostman.vault.VaultSecretService
-
Reads a Vault logical path, gets a shell script value from the given key, and returns exported variables from that script.
- recordFinalFailure(Object, Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Records the final framework result after deferred assertions are flushed.
- recordFinalSkip(Object, Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Records a final framework skip after annotation execution.
- redact(String...) - Method in class io.jpostman.junit.JUnitContext
-
Adds redaction rules.
- redact(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- redact(String...) - Method in class io.jpostman.secure.SecureContext
-
Adds request fields that should be redacted.
- redact(String...) - Method in class io.jpostman.secure.SecureRequest
-
Adds request fields that should be redacted.
- redact(String...) - Method in class io.jpostman.secure.SecureResponse
-
Adds response fields that should be protected.
- redact(String...) - Method in class io.jpostman.testng.TestNgContext
-
Adds redaction rules.
- redact(String, RedactionPolicy) - Static method in class io.jpostman.secure.SecureText
-
Redacts text using key, slice, and JSON path rules only.
- redact(String, SecureValues, RedactionPolicy) - Static method in class io.jpostman.secure.SecureText
-
Redacts protected values, protected placeholders, key assignments, JSON fields, and JSON paths.
- redactionPolicy() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current redaction policy.
- redactionPolicy() - Method in interface io.jpostman.secure.JPostmanTestContext
- redactionPolicy() - Method in class io.jpostman.secure.SecureContext
-
Returns the redaction policy.
- redactionPolicy() - Method in class io.jpostman.secure.SecureRequest
-
Returns the current redaction policy.
- redactionPolicy() - Method in class io.jpostman.secure.SecureResponse
-
Returns the current redaction policy.
- redactionPolicy() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current redaction policy.
- redactionPolicy(RedactionPolicy) - Method in class io.jpostman.junit.JUnitContext
-
Sets the redaction policy.
- redactionPolicy(RedactionPolicy) - Method in interface io.jpostman.secure.JPostmanTestContext
- redactionPolicy(RedactionPolicy) - Method in class io.jpostman.secure.SecureContext
-
Sets the redaction policy.
- redactionPolicy(RedactionPolicy) - Method in class io.jpostman.secure.SecureRequest
-
Sets the redaction policy.
- redactionPolicy(RedactionPolicy) - Method in class io.jpostman.secure.SecureResponse
-
Sets the redaction policy used for key-based redaction.
- redactionPolicy(RedactionPolicy) - Method in class io.jpostman.testng.TestNgContext
-
Sets the redaction policy.
- RedactionPolicy - Class in io.jpostman.secure
-
Defines which keys, fields, and JSON paths should be redacted.
- RedactionPolicy.Builder - Class in io.jpostman.secure
- redactRegex(String) - Method in class io.jpostman.junit.JUnitContext
-
Adds a regex key redaction rule.
- redactRegex(String) - Method in interface io.jpostman.secure.JPostmanTestContext
- redactRegex(String) - Method in class io.jpostman.secure.SecureContext
-
Adds a redaction rule for keys that match the given regular expression.
- redactRegex(String) - Method in class io.jpostman.testng.TestNgContext
-
Adds a regex key redaction rule.
- redactRegex(String, String) - Method in class io.jpostman.junit.JUnitContext
-
Adds a regex key redaction rule with a value expression.
- redactRegex(String, String) - Method in interface io.jpostman.secure.JPostmanTestContext
- redactRegex(String, String) - Method in class io.jpostman.secure.SecureContext
-
Adds a redaction rule for keys that match the given regular expression and applies the given value expression to the matched values.
- redactRegex(String, String) - Method in class io.jpostman.testng.TestNgContext
-
Adds a regex key redaction rule with a value expression.
- ref() - Method in interface io.jpostman.annotations.JPostman.Info
-
Creates an empty mutable reference that can be updated inside Java lambdas.
- ref() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- ref(T) - Method in interface io.jpostman.annotations.JPostman.Info
-
Creates a mutable reference with an initial value.
- ref(T) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
- Ref() - Constructor for class io.jpostman.annotations.JPostman.Ref
-
Creates an empty reference.
- Ref(T) - Constructor for class io.jpostman.annotations.JPostman.Ref
-
Creates a reference with an initial value.
- removeKey(String) - Method in class io.jpostman.Environment
-
Removes parameter metadata by key.
- removeRules(String...) - Method in class io.jpostman.secure.RedactionPolicy
-
Returns a new policy without the supplied redaction rules.
- renameKey(ApiSpec, String, String) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
-
Renames one environment key and updates every exact {{oldKey}} token usage in the model.
- render(JPostmanMethodSpec) - Static method in class io.jpostman.codegen.render.JavaTestMethodRenderer
- render(JPostmanMethodSpec, boolean) - Static method in class io.jpostman.codegen.render.JavaTestMethodRenderer
- reportContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- repositorySecretExists(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Checks whether a repository Actions secret exists.
- repositoryVariableExists(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Checks whether one repository Actions variable exists.
- request - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Postman request associated with this invocation.
- request() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Collection request name.
- request() - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns the current Postman request name.
- request() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Collection request name.
- request() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Collection request name.
- request() - Method in annotation type io.jpostman.annotations.JPostmanCall
- request() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Postman request name to prepare.
- request() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Postman request name to prepare and execute.
- request() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Returns the current runner request name.
- request() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current secure request.
- request() - Method in interface io.jpostman.secure.JPostmanTestContext
- request() - Method in class io.jpostman.secure.SecureContext
-
Returns the current secure request stored in this context.
- request() - Method in class io.jpostman.secure.SecureRequest
-
Returns the wrapped request.
- request() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current secure request.
- request(C, Request) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies a Postman request to the context.
- request(C, Request, JPostmanInfo) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Applies a Postman request to the context after applying request values from
JPostmanInfo. - request(JUnitContext, Request) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Applies a Postman request to the context.
- request(Request) - Method in class io.jpostman.junit.JUnitContext
-
Stores the given request as the current secure request.
- request(Request) - Method in interface io.jpostman.secure.JPostmanTestContext
- request(Request) - Method in class io.jpostman.secure.SecureContext
-
Wraps the given request and stores it in this secure context.
- request(Request) - Method in class io.jpostman.testng.TestNgContext
-
Stores the given request as the current secure request.
- request(TestNgContext, Request) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Applies a Postman request to the context.
- request(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- request(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- request(String) - Method in class io.jpostman.JPostman.Context
-
Finds a request by name from the loaded collection.
- request(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action before each executed request in the current runner.
- request(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action before each executed request in the current runner.
- Request - Class in io.jpostman
-
Represents an HTTP request.
- REQUEST - io.jpostman.codegen.model.JPostmanAnnotationType
- Request.RequestBuilder - Class in io.jpostman
-
Fluent builder wrapping a copied
Request. - Request.RequestBuilder.ParamStep - Class in io.jpostman
-
Nested builder step used for headers, queries, body, and auth.
- RequestBuilder(Request) - Constructor for class io.jpostman.Request.RequestBuilder
- requestId - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Annotation id that originally selected the current Postman request, or empty when the request was selected without an annotation id.
- requestId(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Updates the annotation id that owns the current Postman request location.
- RequestProvider - Interface in io.jpostman
-
Provides a request for execution.
- resolve(Environment) - Method in class io.jpostman.Request
-
Returns this request's unresolved token map filled from enabled environment parameters when matching keys exist.
- resolve(Map<String, ?>) - Method in class io.jpostman.Params
-
Substitutes all
{{key}}tokens using the supplied variable map. - resolve(Map<String, String>) - Method in class io.jpostman.Environment
-
Resolves the supplied unresolved token map using this environment's enabled parameters.
- resolve(Map<String, String>, Map<String, String>) - Static method in class io.jpostman.Params
-
Fills an unresolved token map from the supplied parameter map.
- resolveParameter(ParameterContext, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
- response() - Method in interface io.jpostman.ApiExecutor
-
Executes the request already associated with this executor and returns a framework-neutral response.
- response() - Method in class io.jpostman.httpclient.HttpClientExecutor
-
Executes the request currently associated with this executor.
- response() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current secure response.
- response() - Method in class io.jpostman.playwright.PlaywrightExecutor
-
Executes the request currently associated with this executor.
- response() - Method in class io.jpostman.restassured.RestAssuredExecutor
-
Executes the request associated with this executor and returns a framework-neutral response.
- response() - Method in interface io.jpostman.secure.JPostmanTestContext
- response() - Method in class io.jpostman.secure.SecureContext
-
Returns the current secure response stored in this context.
- response() - Method in class io.jpostman.secure.SecureResponse
-
Returns the wrapped response.
- response() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current secure response.
- response() - Method in class io.jpostman.unirest.UnirestExecutor
-
Executes the request currently associated with this executor.
- response(C, ApiExecutor) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Executes the request using the supplied executor and stores the response.
- response(ApiExecutor) - Method in class io.jpostman.junit.JUnitContext
-
Stores the response returned by the given executor as the current secure response.
- response(ApiExecutor) - Method in interface io.jpostman.secure.JPostmanTestContext
- response(ApiExecutor) - Method in class io.jpostman.secure.SecureContext
-
Wraps the response returned by the given executor and stores it in this secure context.
- response(ApiExecutor) - Method in class io.jpostman.testng.TestNgContext
-
Stores the response returned by the given executor as the current secure response.
- response(ApiResponse) - Method in class io.jpostman.junit.JUnitContext
-
Stores the given response as the current secure response.
- response(ApiResponse) - Method in interface io.jpostman.secure.JPostmanTestContext
- response(ApiResponse) - Method in class io.jpostman.secure.SecureContext
-
Wraps the given API response and stores it in this secure context.
- response(ApiResponse) - Method in class io.jpostman.testng.TestNgContext
-
Stores the given response as the current secure response.
- response(JUnitContext, ApiExecutor) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Executes the request using the supplied executor and stores the response.
- response(TestNgContext, ApiExecutor) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Executes the request using the supplied executor and stores the response.
- response(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- response(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action after every executed response in the current runner.
- response(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action after every executed response in the current runner.
- response(Function<JUnitContext, ?>) - Method in class io.jpostman.junit.JUnitContext
-
Builds the response from the current JUnit context.
- response(Function<SecureContext, ApiResponse>) - Method in class io.jpostman.secure.SecureContext
-
Executes the response using the current context.
- response(Function<TestNgContext, ?>) - Method in class io.jpostman.testng.TestNgContext
-
Builds the response from the current JUnit context.
- RESPONSE - io.jpostman.codegen.model.JPostmanAnnotationType
- REST - io.jpostman.schema.model.ApiProtocol
- RestAssuredExecutor - Class in io.jpostman.restassured
-
Optional REST Assured adapter for executing JPostman requests.
- reveal() - Method in class io.jpostman.secure.SecureValue
- reveal(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns the real value stored behind a secret JPostmanInfo value wrapper.
- rootCause(Throwable) - Static method in class io.jpostman.annotations.runtime.JPostmanStackTraceCleaner
-
Returns the root cause, unwrapping reflection wrappers.
- rule() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Rules section name.
- rule() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Rules section name.
- rule() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Rules section name.
- rule() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Rules section name.
- rule() - Method in annotation type io.jpostman.annotations.JPostmanCall
- rule() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Secure rule section to load before preparing the request.
- rule() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Optional secure rule section for response filtering and masking.
- rule() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Optional secure rule section for response filtering and masking.
- rule(String) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- rules() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Rules file location.
- rules() - Method in annotation type io.jpostman.annotations.JPostman.TestContext
-
Rules file location.
- rules() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Optional secure rules location.
- rules() - Method in annotation type io.jpostman.annotations.JPostmanTestContext
-
Optional secure rules location.
- run(Object, Method) - Method in class io.jpostman.annotations.runtime.JPostmanAnnotationRunner
-
Runs JPostman annotations for a single test method.
- run(IHookCallBack, ITestResult) - Method in class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
-
Runs JPostman test annotations inside TestNG's hookable invocation path.
- runJUnit(Object, Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Runs JPostman annotation support for a JUnit test method.
- runJUnit(Object, Method, Runnable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Runs JPostman annotation support for a JUnit test method and optionally invokes a callback around each top-level @JPostmanRunner request.
- runner() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Returns fluent request-name rules for a
JPostman.Runnertest body. - runner() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Returns fluent request-name rules for a
JPostman.Runnertest body. - runner(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- RUNNER - io.jpostman.codegen.model.JPostmanAnnotationType
- runnerRequest(String) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates a new independent info chain for one
@JPostmanRunnercollection request. - runTestNg(Object, Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Runs JPostman annotation support for a TestNG test method.
- runTestNg(Object, Method, Runnable) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Runs JPostman annotation support for a TestNG test method and optionally invokes a callback around each top-level @JPostmanRunner request.
S
- sauth(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure auth values.
- sauth(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret authentication values using key/value pairs.
- sauth(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure auth values.
- sauth(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret auth-related request values from an existing map when supported.
- sbody(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure body values.
- sbody(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request body values using key/value pairs.
- sbody(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure body values.
- sbody(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request body values from an existing map.
- scan(ApiOperation, Map<String, Object>) - Static method in class io.jpostman.schema.util.ApiOperationEnvScanner
-
Scans the supplied model object and records discovered environment placeholders.
- scan(ApiSpec) - Static method in class io.jpostman.schema.util.ApiSpecEnvScanner
-
Scans the supplied model object and records discovered environment placeholders.
- secret(C, Object) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Loads all environment values into the framework context as secrets.
- secret(C, String, Object) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Stores a secret value in the framework context.
- secret(Environment) - Method in class io.jpostman.junit.JUnitContext
-
Adds protected values from an environment.
- secret(Environment) - Method in interface io.jpostman.secure.JPostmanTestContext
- secret(Environment) - Method in class io.jpostman.secure.SecureContext
-
Adds protected environment values for request resolution.
- secret(Environment) - Method in class io.jpostman.testng.TestNgContext
-
Adds protected values from an environment.
- secret(JUnitContext, Object) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Loads all environment values into the framework context as secrets.
- secret(JUnitContext, String, Object) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Stores a secret value in the framework context.
- secret(TestNgContext, Object) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Loads all environment values into the framework context as secrets.
- secret(TestNgContext, String, Object) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Stores a secret value in the framework context.
- secret(Object) - Static method in class io.jpostman.secure.SecureValue
-
Creates a protected value using the default mask.
- secret(Object...) - Method in class io.jpostman.junit.JUnitContext
-
Adds protected key/value pairs.
- secret(Object...) - Method in interface io.jpostman.secure.JPostmanTestContext
- secret(Object...) - Method in class io.jpostman.secure.SecureContext
-
Adds protected values used for request resolution.
- secret(Object...) - Method in class io.jpostman.testng.TestNgContext
-
Adds protected key/value pairs.
- secret(Object, String) - Static method in class io.jpostman.secure.SecureValue
-
Creates a protected value using a custom mask.
- secret(String, Object) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds a protected value.
- secret(Map<String, ?>) - Method in class io.jpostman.junit.JUnitContext
-
Adds protected values from a map.
- secret(Map<String, ?>) - Method in interface io.jpostman.secure.JPostmanTestContext
- secret(Map<String, ?>) - Method in class io.jpostman.secure.SecureContext
-
Adds protected values used for request resolution.
- secret(Map<String, ?>) - Method in class io.jpostman.secure.SecureRequest
-
Adds protected values used for request resolution.
- secret(Map<String, ?>) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds protected values from a map.
- secret(Map<String, ?>) - Method in class io.jpostman.testng.TestNgContext
-
Adds protected values from a map.
- secretExists(String, String) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Checks whether a Secret exists.
- secretHeaders() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns header names whose values were added through sheaders(...).
- secrets(Map<String, ?>) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds protected values from a map.
- secretValues() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns raw values that were added through sbody/squery/sheaders/spath/sauth.
- secure() - Method in class io.jpostman.junit.JUnitContext
-
Returns the wrapped secure context.
- secure() - Method in class io.jpostman.testng.TestNgContext
-
Returns the wrapped secure context.
- SecureContext - Class in io.jpostman.secure
-
Reusable secure configuration for multiple requests.
- SecureContext.CachedFailureException - Exception in io.jpostman.secure
-
Indicates that creating a cached value failed earlier.
- secureLog() - Method in error io.jpostman.secure.JPostmanAssertionError
-
Returns the secure log attached to this assertion error.
- SecureRequest - Class in io.jpostman.secure
-
Provides a secure wrapper around a request.
- SecureResponse - Class in io.jpostman.secure
-
Secret-safe wrapper around a JPostman
ApiResponse. - SecureText - Class in io.jpostman.secure
-
Utility methods for redacting protected values from strings.
- SecureValue - Class in io.jpostman.secure
-
Stores one value with display masking support.
- SecureValues - Class in io.jpostman.secure
-
Ordered registry of plain and protected values.
- SecureValues.Builder - Class in io.jpostman.secure
-
Builder for
SecureValues. - self() - Method in class io.jpostman.junit.JUnitAssertions
- self() - Method in class io.jpostman.testng.TestNgAssertions
- send(String, String, String, int...) - Method in class io.jpostman.github.GitHubService
-
Sends an authenticated request to the GitHub REST API.
- sendRaw(String, String, String) - Method in class io.jpostman.github.GitHubService
-
Sends an authenticated request and returns the raw response.
- session() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Reuses executor state when supported by the configured executor.
- session() - Method in annotation type io.jpostman.annotations.JPostman.Executor
-
Reuses executor state when supported.
- session() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Enables session executor mode for the context default executor.
- session() - Method in annotation type io.jpostman.annotations.JPostmanExecutor
-
Reuse the executor instance returned by this method during the current annotation runner execution.
- set(String, Object) - Method in class io.jpostman.Params
-
Updates an existing key.
- set(String, Object) - Method in class io.jpostman.Request.RequestBuilder.ParamStep
-
Updates an existing parameter and throws when the key is missing.
- set(T) - Method in class io.jpostman.annotations.JPostman.Ref
-
Updates the current value and returns this reference for fluent use.
- setAdds(Map<String, Object>) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Sets new environment key/value pairs to add.
- setAllowedMethods(List<String>) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the allowed methods.
- setAuth(ApiAuth) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the auth.
- setBaseUrl(String) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the base url.
- setBaseUrl(String) - Method in class io.jpostman.schema.parser.ApiSpecParserOptions
-
Sets the base url.
- setBody(ApiBody) - Method in class io.jpostman.schema.model.ApiExample
-
Sets the body.
- setBody(ApiBody) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the body.
- setBody(ApiBody) - Method in class io.jpostman.schema.model.ApiResponse
-
Sets the response body template.
- setCode(String) - Method in class io.jpostman.schema.model.ApiResponse
-
Sets the response status code.
- setContent(String) - Method in class io.jpostman.schema.model.ApiBody
-
Sets the content.
- setContentType(String) - Method in class io.jpostman.schema.model.ApiResponse
-
Sets the response content type.
- setCurrent(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Sets the current context for the active test thread.
- setCurrent(JUnitContext) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Sets the current context for the active test thread.
- setCurrent(JUnitContext) - Static method in class io.jpostman.junit.JUnitContext
-
Sets the current context for the running test thread.
- setCurrent(TestNgContext) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Sets the current context for the active test thread.
- setCurrent(TestNgContext) - Static method in class io.jpostman.testng.TestNgContext
-
Sets the current context for the running test thread.
- setDeletes(List<String>) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Sets environment keys to delete.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiBody
-
Sets the description.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiFolder
-
Sets the description.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiHeader
-
Sets the description.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the description.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiParam
-
Sets the description.
- setDescription(String) - Method in class io.jpostman.schema.model.ApiResponse
-
Sets the response description.
- setEnabled(boolean) - Method in class io.jpostman.Params.Entry
-
Enables or disables this parameter.
- setEnvs(Map<String, Object>) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the envs.
- setExample(ApiBody) - Method in class io.jpostman.schema.model.ApiResponse
-
Sets the response example body.
- setExample(ApiExample) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the example.
- setFolder(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the folder.
- setFolders(List<ApiFolder>) - Method in class io.jpostman.schema.model.ApiFolder
-
Sets the folders.
- setFolders(List<ApiFolder>) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the folders.
- setGraphQlOperationType(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the graph ql operation type.
- setHeaders(List<ApiHeader>) - Method in class io.jpostman.schema.model.ApiExample
-
Sets the headers.
- setHeaders(List<ApiHeader>) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the headers.
- setLocation(ApiAuthLocation) - Method in class io.jpostman.schema.model.ApiAuth
-
Sets the location.
- setMethod(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the method.
- setMethodName(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the method name.
- setName(String) - Method in class io.jpostman.schema.model.ApiAuth
-
Sets the name.
- setName(String) - Method in class io.jpostman.schema.model.ApiExample
-
Sets the name.
- setName(String) - Method in class io.jpostman.schema.model.ApiFolder
-
Sets the name.
- setName(String) - Method in class io.jpostman.schema.model.ApiHeader
-
Sets the name.
- setName(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the display name.
- setName(String) - Method in class io.jpostman.schema.model.ApiParam
-
Sets the name.
- setName(String) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the name.
- setOperations(List<ApiOperation>) - Method in class io.jpostman.schema.model.ApiFolder
-
Sets the operations.
- setOperations(List<ApiOperation>) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the operations.
- setOverrideUrl(boolean) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the override url.
- setOverrideUrl(Boolean) - Method in class io.jpostman.schema.parser.ApiSpecParserOptions
-
Sets the override url.
- setPath(String) - Method in class io.jpostman.schema.model.ApiExample
-
Sets the path.
- setPath(String) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the path.
- setProtocol(ApiProtocol) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the protocol.
- setQueryParams(List<ApiParam>) - Method in class io.jpostman.schema.model.ApiExample
-
Sets the query params.
- setQueryParams(List<ApiParam>) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the query params.
- setRenames(Map<String, String>) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Sets environment key renames.
- setRequest(Request) - Method in class io.jpostman.httpclient.HttpClientExecutor
-
Sets the request to execute.
- setRequest(Request) - Method in class io.jpostman.playwright.PlaywrightExecutor
-
Sets the request to execute.
- setRequest(Request) - Method in class io.jpostman.restassured.RestAssuredExecutor
-
Sets the request to execute.
- setRequest(Request) - Method in class io.jpostman.unirest.UnirestExecutor
-
Sets the request to execute.
- setRequired(boolean) - Method in class io.jpostman.schema.model.ApiHeader
-
Sets the required.
- setRequired(boolean) - Method in class io.jpostman.schema.model.ApiParam
-
Sets the required.
- setResponses(List<ApiResponse>) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the responses.
- setType(ApiAuthType) - Method in class io.jpostman.schema.model.ApiAuth
-
Sets the type.
- setType(ApiBodyType) - Method in class io.jpostman.schema.model.ApiBody
-
Sets the type.
- setup(Object) - Method in class io.jpostman.annotations.runtime.JPostmanAnnotationRunner
-
Prepares a test instance before framework lifecycle methods run.
- setupJUnit(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Prepares JPostman annotation support for a JUnit test instance.
- setupTestNg(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationEngine
-
Prepares JPostman annotation support for a TestNG test instance.
- setUrlResolved(boolean) - Method in class io.jpostman.schema.model.ApiOperation
-
Sets the url resolved.
- setValue(String) - Method in class io.jpostman.schema.model.ApiAuth
-
Sets the value.
- setValue(String) - Method in class io.jpostman.schema.model.ApiHeader
-
Sets the value.
- setValue(String) - Method in class io.jpostman.schema.model.ApiParam
-
Sets the value.
- setValues(Map<String, Object>) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdateRequest
-
Sets environment value updates.
- setVersion(String) - Method in class io.jpostman.schema.model.ApiSpec
-
Sets the API model contract version.
- sheaders(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure header values.
- sheaders(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request headers using key/value pairs.
- sheaders(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure header values.
- sheaders(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request header values from an existing map.
- shouldApplyRequestHeader(String) - Method in class io.jpostman.Authentication.State
-
Determines whether a header parsed from the Postman request should be applied.
- singleKey(String) - Static method in class io.jpostman.schema.util.EnvVarExtractor
-
Returns the placeholder key when the whole value is exactly one {{KEY}} token.
- skip() - Method in annotation type io.jpostman.annotations.JPostman.Call
- skip() - Method in annotation type io.jpostman.annotations.JPostman.Request
- skip() - Method in annotation type io.jpostman.annotations.JPostman.Response
- skip() - Method in annotation type io.jpostman.annotations.JPostman.Runner
- skip() - Method in annotation type io.jpostman.annotations.JPostmanCall
- skip() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Skips the configured request when it is discovered by a runner or request dependency.
- skip() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Skips this response/test execution before dependencies or request execution run.
- skip() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Skips this runner/test execution before dependencies or request execution run.
- skip(Boolean) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- skipAll() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Skips all JPostman response and runner test executions by default.
- skipAll() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Skips all JPostman response and runner test executions by default.
- skipException(JPostmanInfo, String...) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Creates a framework-specific skip/abort exception.
- skipException(JPostmanInfo, String...) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Creates a framework-specific skip/abort exception.
- skipException(JPostmanInfo, String...) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Creates a framework-specific skip/abort exception.
- skipped - Variable in class io.jpostman.annotations.runtime.JPostmanReport
-
Skipped top-level JPostman executions.
- skipped(JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Records a skipped top-level execution.
- sliceExpressionFactory(SliceExpressionFactory) - Method in class io.jpostman.secure.RedactionPolicy.Builder
-
Sets a custom slice expression factory.
- SliceExpressionFactory - Interface in io.jpostman.secure
-
Factory and strategy for parsing and applying slice expressions.
- soft() - Method in annotation type io.jpostman.annotations.JPostman.AssertContext
-
Enables class-scoped soft assertion mode.
- soft() - Method in annotation type io.jpostman.annotations.JPostman.Asserts
-
Enables class-scoped soft assertion mode.
- soft() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Enables soft assertion mode.
- soft() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Enables soft assertion mode.
- soft() - Method in annotation type io.jpostman.annotations.JPostmanAssertContext
-
Enables class-scoped soft assertion mode.
- soft() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Whether to use soft assertion verification.
- soft() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Whether to use soft assertion verification.
- soft() - Method in class io.jpostman.junit.JUnitContext
-
Returns soft assertion helpers.
- soft() - Method in interface io.jpostman.secure.JPostmanTestContext
- soft() - Method in class io.jpostman.testng.TestNgContext
-
Returns soft assertion helpers.
- soft(boolean) - Method in interface io.jpostman.annotations.JPostman.Assert
-
Switches this facade to soft assertion mode.
- soft(boolean) - Method in class io.jpostman.junit.JUnitContext
-
Returns soft assertion helpers.
- soft(boolean) - Method in interface io.jpostman.secure.JPostmanTestContext
- soft(boolean) - Method in class io.jpostman.testng.TestNgContext
-
Returns soft assertion helpers.
- soft(C, boolean) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Enables soft assertion collection for the supplied context.
- soft(JUnitContext, boolean) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Enables soft assertion collection for the supplied context.
- soft(TestNgContext, boolean) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Enables soft assertion collection for the supplied context.
- soft(Boolean) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- softAssertions(Object) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- spath(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure path values.
- spath(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request path variable values using key/value pairs.
- spath(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure path values.
- spath(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret request path variable values from an existing map.
- squery(Object...) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure query values.
- squery(Object...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret query string values using key/value pairs.
- squery(Map<String, ?>) - Method in interface io.jpostman.annotations.JPostman.Info
-
Adds secure query values.
- squery(Map<String, ?>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Adds secret query string values from an existing map.
- sslConfig(boolean, String) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Creates SSL configuration for the Vault driver.
- sslConfig(VaultSettings) - Method in class io.jpostman.vault.DefaultVaultAuthenticator
-
Creates SSL configuration from Vault settings.
- start() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Marks request execution start time.
- start(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action once before the first executed request in the current runner.
- start(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerRules
-
Runs the action once before the first executed request in the current runner.
- started() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Returns the timestamp when request execution started.
- State() - Constructor for class io.jpostman.Authentication.State
- statusCode() - Method in class io.jpostman.ApiResponse
- statusCode() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current secure response status code.
- statusCode() - Method in interface io.jpostman.secure.JPostmanTestContext
- statusCode() - Method in class io.jpostman.secure.SecureContext
-
Returns the current secure response status code.
- statusCode() - Method in class io.jpostman.secure.SecureResponse
- statusCode() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current secure response status code.
- statusCode(int) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response has the expected status code.
- statusCode(int) - Method in interface io.jpostman.secure.JPostmanAssertions
- statusCode(int) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response has the expected status code.
- statusCode(int, String) - Method in class io.jpostman.junit.JUnitAssertions
-
Asserts that the current secure response has the expected status code.
- statusCode(int, String) - Method in interface io.jpostman.secure.JPostmanAssertions
- statusCode(int, String) - Method in class io.jpostman.testng.TestNgAssertions
-
Asserts that the current secure response has the expected status code.
- statusCode(Object, Object, int, JPostmanInfo) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Invokes a framework assertion object's
statusCodeassertion while passing the current JPostman location when supported. - statusCode(Object, Object, int, JPostmanInfo, boolean, boolean, String) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- statusCodeAsserted - Variable in class io.jpostman.junit.JUnitAssertions
- statusCodeAsserted - Variable in class io.jpostman.testng.TestNgAssertions
- substituteVars(String, Map<String, ?>) - Static method in class io.jpostman.Params
-
Replaces all
{{key}}tokens invaluewith entries fromvarsusing Handlebars. - summary() - Method in interface io.jpostman.annotations.JPostman.Report
-
Prints the report summary.
- summary() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Prints
JPostmanReport.log()using trace level. - supportsParameter(ParameterContext, ExtensionContext) - Method in class io.jpostman.junit.JPostmanJUnit.JPostmanJUnitExtension
T
- tags - Variable in class io.jpostman.annotations.runtime.JPostmanInfo
-
Current annotation tags for this invocation.
- tags() - Method in annotation type io.jpostman.annotations.JPostman.Call
-
Tags used by this manual call.
- tags() - Method in interface io.jpostman.annotations.JPostman.Info
-
Returns tag-based rules for the current execution.
- tags() - Method in annotation type io.jpostman.annotations.JPostman.Request
-
Tags used to select this method.
- tags() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Tags used to select this method.
- tags() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Tags used to select this runner.
- tags() - Method in annotation type io.jpostman.annotations.JPostmanCall
- tags() - Method in annotation type io.jpostman.annotations.JPostmanRequest
-
Logical tags for this request helper.
- tags() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Logical tags for this response execution.
- tags() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Logical tags for this runner execution.
- tags() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Starts fluent tag-conditional actions for this invocation.
- tags(String...) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- test() - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Alias for
JPostman.Runtime.ctx(). - test() - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Alias for
JPostmanRuntime.ctx(). - test(String) - Method in interface io.jpostman.annotations.JPostman.Runtime
-
Alias for
JPostman.Runtime.ctx(String). - test(String) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime
-
Alias for
JPostmanRuntime.ctx(String). - testContext(Field) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotations
- TestNgAssertions<T extends TestNgAssertions<?>> - Class in io.jpostman.testng
-
Fluent TestNG assertions with optional secure log output.
- TestNgContext - Class in io.jpostman.testng
-
TestNG-friendly wrapper around
SecureContext. - TestNgPostmanFramework - Class in io.jpostman.annotations.testng
-
TestNG implementation of the annotation framework bridge.
- TestNgPostmanFramework() - Constructor for class io.jpostman.annotations.testng.TestNgPostmanFramework
- TestNgSoftAssertions - Class in io.jpostman.testng
-
Fluent soft assertions.
- then(BiConsumer<C, JPostman.Info>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerCondition
-
Runs the action when the condition matched and passes both the active context and current execution info.
- then(BiConsumer<JPostmanInfo, JPostmanInfo.TagRules>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagCondition
-
Runs the action when the condition matched and passes both the current
JPostmanInfoand its fluent tag helper. - then(Consumer<C>) - Method in class io.jpostman.annotations.runtime.JPostmanRuntime.RunnerCondition
-
Runs the action when the condition matched and returns the parent builder.
- then(Consumer<JPostmanInfo>) - Method in class io.jpostman.annotations.runtime.JPostmanInfo.TagCondition
-
Runs the action when the condition matched and returns the parent builder.
- toDebugString() - Method in class io.jpostman.Auth
-
Returns verbose diagnostic representation including details.
- toDebugString() - Method in class io.jpostman.Body
-
Returns verbose diagnostic representation including details.
- toDebugString() - Method in class io.jpostman.Collection
-
Returns verbose diagnostic representation including details.
- toDebugString() - Method in class io.jpostman.Environment
-
Returns verbose diagnostic representation including enabled variables.
- toDebugString() - Method in class io.jpostman.Folder
-
Returns verbose diagnostic representation including details.
- toDebugString() - Method in class io.jpostman.Header
-
Returns verbose diagnostic representation including enabled headers.
- toDebugString() - Method in class io.jpostman.Url
-
Returns verbose diagnostic representation including details.
- toJson() - Method in interface io.jpostman.annotations.JPostman.Info
-
Converts values in the last body/query/header/path/auth group to JSON literal strings.
- toJson() - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Converts values in the last body/query/header/path/auth group to JSON literal strings.
- toString() - Method in class io.jpostman.ApiResponse
- toString() - Method in class io.jpostman.Auth
- toString() - Method in class io.jpostman.Body
- toString() - Method in class io.jpostman.Collection
- toString() - Method in class io.jpostman.Environment
- toString() - Method in class io.jpostman.Folder
- toString() - Method in class io.jpostman.Header
- toString() - Method in class io.jpostman.Params.Entry
- toString() - Method in class io.jpostman.Request
- toString() - Method in class io.jpostman.secure.SecureRequest
-
Returns unresolved redacted request summary.
- toString() - Method in class io.jpostman.secure.SecureValue
- toString() - Method in class io.jpostman.secure.SecureValues
-
Returns a display-safe string with one key/value pair per line.
- toString() - Method in class io.jpostman.Url
- total() - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Returns the total number of recorded top-level executions.
- toUrl() - Method in class io.jpostman.Request
- trace(String, Object...) - Method in class io.jpostman.JPostman.Context
-
Logs a TRACE message using the context logger.
- transform(ITestAnnotation, Class, Constructor, Method) - Method in class io.jpostman.annotations.testng.JPostmanTestNgAnnotationListener
-
Validates TestNG @Test methods before TestNG attempts native parameter injection.
U
- unheaders(String...) - Method in class io.jpostman.junit.JUnitContext
-
Removes protected header rules.
- unheaders(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- unheaders(String...) - Method in class io.jpostman.secure.RedactionPolicy
-
Removes protected header names.
- unheaders(String...) - Method in class io.jpostman.secure.SecureContext
-
Removes protected header names.
- unheaders(String...) - Method in class io.jpostman.secure.SecureRequest
-
Removes protected header names.
- unheaders(String...) - Method in class io.jpostman.secure.SecureResponse
-
Removes protected header names.
- unheaders(String...) - Method in class io.jpostman.testng.TestNgContext
-
Removes protected header rules.
- UnirestExecutor - Class in io.jpostman.unirest
-
Optional Unirest adapter for executing JPostman requests.
- UNKNOWN - io.jpostman.schema.parser.ApiSpecFormat
- unredact(String...) - Method in class io.jpostman.junit.JUnitContext
-
Removes redaction rules.
- unredact(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- unredact(String...) - Method in class io.jpostman.secure.SecureContext
-
Removes fields from redaction.
- unredact(String...) - Method in class io.jpostman.secure.SecureRequest
-
Removes request fields from redaction.
- unredact(String...) - Method in class io.jpostman.testng.TestNgContext
-
Removes redaction rules.
- unsecret(String...) - Method in class io.jpostman.junit.JUnitContext
-
Converts protected values to plain values by key.
- unsecret(String...) - Method in interface io.jpostman.secure.JPostmanTestContext
- unsecret(String...) - Method in class io.jpostman.secure.SecureContext
-
Converts protected values to plain values by key.
- unsecret(String...) - Method in class io.jpostman.secure.SecureValues.Builder
-
Converts protected values to plain values by key.
- unsecret(String...) - Method in class io.jpostman.testng.TestNgContext
-
Converts protected values to plain values by key.
- unwrap(Object) - Static method in class io.jpostman.annotations.runtime.JPostmanCacheValueConverter
-
Unwraps JSON null and primitive objects without introducing a hard Gson dependency into the annotations module.
- update(JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JPostmanReport
-
Stores the latest execution info without changing status counters.
- update(ApiSpec, ApiSpecEnvironmentUpdateRequest) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
-
Applies key renames first, adds new keys second, applies value changes third, then deletes keys.
- updateConfigMap(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesConfigMapService
-
Updates an existing ConfigMap.
- updateRepositoryVariable(String, String, String, String) - Method in class io.jpostman.github.GitHubService
-
Updates one repository Actions variable.
- updateSecret(String, String, Map<String, String>) - Method in class io.jpostman.kubernetes.KubernetesSecretService
-
Updates an existing Secret using string data.
- updateValue(ApiSpec, String, Object) - Method in class io.jpostman.schema.env.ApiSpecEnvironmentUpdater
-
Updates one environment value only.
- url() - Method in class io.jpostman.Request.RequestBuilder
-
Enters the URL/query-parameter builder step.
- url(Consumer<Request.RequestBuilder.ParamStep>) - Method in class io.jpostman.Request.RequestBuilder
-
Configures the URL/query parameters using a lambda-style nested builder.
- Url - Class in io.jpostman
-
Represents a request URL and its query parameters.
- Url(String) - Constructor for class io.jpostman.Url
-
Creates a URL from a raw URL string.
- use(JPostmanOutput) - Static method in class io.jpostman.annotations.JPostmanOutputs
-
Installs an output sink until the returned scope is closed.
V
- validateTestClass(Class<?>) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationValidator
-
Validates all JPostman annotation usage in the supplied test class.
- validateTestMethod(Method) - Static method in class io.jpostman.annotations.runtime.JPostmanAnnotationValidator
-
Validates a single framework test method.
- value(C, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Resolves a plain or secret value from the framework context.
- valueOf(String) - Static method in enum io.jpostman.codegen.model.JPostmanAnnotationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.model.ApiAuthLocation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.model.ApiAuthType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.model.ApiBodyType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.model.ApiParamLocation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.model.ApiProtocol
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.jpostman.schema.parser.ApiSpecFormat
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.jpostman.codegen.model.JPostmanAnnotationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in class io.jpostman.junit.JUnitContext
-
Returns the current secure values.
- values() - Static method in enum io.jpostman.schema.model.ApiAuthLocation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.jpostman.schema.model.ApiAuthType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.jpostman.schema.model.ApiBodyType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.jpostman.schema.model.ApiParamLocation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.jpostman.schema.model.ApiProtocol
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.jpostman.schema.parser.ApiSpecFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Method in interface io.jpostman.secure.JPostmanTestContext
- values() - Method in class io.jpostman.secure.SecureContext
-
Returns the current secure values.
- values() - Method in class io.jpostman.testng.TestNgContext
-
Returns the current secure values.
- values(SecureValues) - Method in class io.jpostman.secure.SecureRequest
-
Adds secure values used for request resolution.
- values(SecureValues) - Method in class io.jpostman.secure.SecureResponse
-
Sets secure values used for value-based redaction.
- values(SecureValues) - Method in class io.jpostman.secure.SecureValues.Builder
-
Adds values from an existing registry.
- variables() - Method in class io.jpostman.Request.RequestBuilder
-
Returns variables used by
Request.RequestBuilder.build(). - VaultAuthenticator - Interface in io.jpostman.vault
-
Strategy interface for authenticating with Vault and returning an authenticated client.
- VaultClientFactory - Class in io.jpostman.vault
-
Factory for creating authenticated Vault clients.
- VaultClientFactory() - Constructor for class io.jpostman.vault.VaultClientFactory
-
Creates a factory that uses
DefaultVaultAuthenticator. - VaultClientFactory(VaultAuthenticator) - Constructor for class io.jpostman.vault.VaultClientFactory
-
Creates a factory with a custom authenticator.
- vaultGitHubToken - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultJwt - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultJwtRole - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultLdapPassword - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultLdapUsername - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultPassword - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultRoleId - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultSecretId - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- VaultSecretService - Class in io.jpostman.vault
-
Service for reading, writing, and deleting Vault key/value secrets.
- VaultSecretService(Vault) - Constructor for class io.jpostman.vault.VaultSecretService
-
Creates a secret service using an authenticated Vault client.
- VaultSettings - Class in io.jpostman.vault
-
Configuration object used to create and authenticate a Vault client.
- VaultSettings(String, String, String) - Constructor for class io.jpostman.vault.VaultSettings
-
Creates Vault settings.
- VaultSettings(String, String, String, String) - Constructor for class io.jpostman.vault.VaultSettings
-
Creates Vault settings.
- vaultSslFile - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultSslVerify - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultToken - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- vaultUsername - Variable in class io.jpostman.vault.DefaultVaultAuthenticator
- verify() - Method in annotation type io.jpostman.annotations.JPostman.Response
-
Expected HTTP status code.
- verify() - Method in annotation type io.jpostman.annotations.JPostman.Runner
-
Expected HTTP status code.
- verify() - Method in annotation type io.jpostman.annotations.JPostmanResponse
-
Expected HTTP status code.
- verify() - Method in annotation type io.jpostman.annotations.JPostmanRunner
-
Expected HTTP status code for each executed request.
- verify() - Method in class io.jpostman.junit.JUnitAssertions
-
Verifies status code
200and returns the test context. - verify() - Method in class io.jpostman.junit.JUnitContext
-
Verifies the current response with status code
200. - verify() - Method in interface io.jpostman.secure.JPostmanAssertions
- verify() - Method in interface io.jpostman.secure.JPostmanTestContext
- verify() - Method in class io.jpostman.testng.TestNgAssertions
-
Verifies status code
200and returns the test context. - verify() - Method in class io.jpostman.testng.TestNgContext
-
Verifies the current response with status code
200. - verify(int) - Method in class io.jpostman.junit.JUnitAssertions
-
Verifies the expected status code and returns the test context.
- verify(int) - Method in class io.jpostman.junit.JUnitContext
-
Verifies the current response with the expected status code.
- verify(int) - Method in class io.jpostman.junit.JUnitSoftAssertions
-
Verifies all collected soft assertions and returns the test context.
- verify(int) - Method in interface io.jpostman.secure.JPostmanAssertions
- verify(int) - Method in interface io.jpostman.secure.JPostmanTestContext
- verify(int) - Method in class io.jpostman.testng.TestNgAssertions
-
Verifies the expected status code and returns the test context.
- verify(int) - Method in class io.jpostman.testng.TestNgContext
-
Verifies the current response with the expected status code.
- verify(int) - Method in class io.jpostman.testng.TestNgSoftAssertions
-
Verifies all collected soft assertions and returns the test context.
- verify(C, int, boolean, boolean) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Verifies the response status code.
- verify(C, int, boolean, boolean, JPostmanInfo) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Verifies the response status code and includes current annotation location in the assertion message when the underlying assertion API supports custom messages.
- verify(C, int, boolean, boolean, JPostmanInfo, String) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
- verify(JUnitContext, int, boolean, boolean) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Verifies the response status code.
- verify(JUnitContext, int, boolean, boolean, JPostmanInfo) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
-
Verifies the response status code and includes current annotation location in the assertion message when the underlying assertion API supports custom messages.
- verify(JUnitContext, int, boolean, boolean, JPostmanInfo, String) - Method in class io.jpostman.annotations.runtime.JUnitPostmanFramework
- verify(TestNgContext, int, boolean, boolean) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Verifies the response status code.
- verify(TestNgContext, int, boolean, boolean, JPostmanInfo) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
-
Verifies the response status code and includes current annotation location in the assertion message when the underlying assertion API supports custom messages.
- verify(TestNgContext, int, boolean, boolean, JPostmanInfo, String) - Method in class io.jpostman.annotations.testng.TestNgPostmanFramework
- verify(Integer) - Method in class io.jpostman.codegen.model.JPostmanMethodSpec.Builder
- verifyAssertionObject(Object) - Static method in interface io.jpostman.annotations.runtime.JPostmanFramework
- verifyAssertions(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Verifies pending hard assertions for the supplied context.
- verifySoftAssertions(C) - Method in interface io.jpostman.annotations.runtime.JPostmanFramework
-
Verifies pending soft assertions for the supplied context.
- verifyStatusCode() - Method in annotation type io.jpostman.annotations.JPostman.Context
-
Default expected HTTP status code.
- verifyStatusCode() - Method in annotation type io.jpostman.annotations.JPostmanContext
-
Default HTTP status code used when a response or runner does not specify
verify.
W
- warn(String, Object...) - Method in class io.jpostman.JPostman.Context
-
Logs a WARN message using the context logger.
- withTags(String...) - Method in class io.jpostman.annotations.runtime.JPostmanInfo
-
Creates a copy of this info object with additional tags appended to the current tag chain.
- wrap(AssertionError) - Method in class io.jpostman.junit.JUnitAssertions
-
Wraps an assertion error with optional secure log context.
- wrap(AssertionError) - Method in class io.jpostman.testng.TestNgAssertions
-
Wraps an assertion error with optional secure log context.
- wrap(AssertionError, String) - Static method in error io.jpostman.secure.JPostmanAssertionError
-
Wraps an assertion error with optional secure log context.
- write(String) - Method in interface io.jpostman.annotations.JPostmanOutput
-
Writes one complete JPostman output message.
- write(String) - Static method in class io.jpostman.annotations.JPostmanOutputs
-
Sends text to the installed sink.
- write(String, String, Object...) - Static method in class io.jpostman.annotations.JPostmanOutputs
-
Sends a leveled message to the installed sink.
- writeKv2Secret(String, String, Map<String, String>) - Method in class io.jpostman.vault.VaultSecretService
-
Writes a secret to a KV v2 mount.
- writeSecret(String, Map<String, String>) - Method in class io.jpostman.vault.VaultSecretService
-
Writes key/value pairs to a Vault logical path.
X
- X_WWW_FORM_URLENCODED - io.jpostman.schema.model.ApiBodyType
All Classes All Packages