Index

A B C D E F G H I L M N P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

apiKey(String) - Method in class com.pain001.sdk.Pain001Client.Builder
An API key, sent as Authorization: Bearer <key>; null sends none.
ApiResponse - Record Class in com.pain001.sdk
ApiResponse(int, JsonNode) - Constructor for record class com.pain001.sdk.ApiResponse
Creates an instance of a ApiResponse record class.

B

baseUrl(String) - Method in class com.pain001.sdk.Pain001Client.Builder
The server's base URL, for example http://127.0.0.1:8000: http or https, with a host, and no query or fragment.
bindings() - Method in record class com.pain001.sdk.FaceInfo
Returns the value of the bindings record component.
body() - Method in record class com.pain001.sdk.ApiResponse
Returns the value of the body record component.
build() - Method in class com.pain001.sdk.Pain001Client.Builder
Builds the client.
build() - Method in class com.pain001.sdk.RetryPolicy.Builder
Builds the policy.
builder() - Static method in class com.pain001.sdk.Pain001Client
Starts a builder; Pain001Client.Builder.baseUrl is required.
builder() - Static method in class com.pain001.sdk.RetryPolicy
Starts a builder with the defaults: 3 attempts, 200 ms initial and 5 s maximum backoff.

C

check(String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/check with the default rungs.
check(String, String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/check: checks a pain.001 or pain.008 document.
CheckFinding - Record Class in com.pain001.sdk
One problem one rung of POST /api/v1/check found.
CheckFinding(String, String, String, String, String) - Constructor for record class com.pain001.sdk.CheckFinding
Creates an instance of a CheckFinding record class.
CheckResponse - Record Class in com.pain001.sdk
POST /api/v1/check: the verdict, the rungs that ran and every finding.
CheckResponse(String, boolean, int, int, List<String>, List<CheckFinding>) - Constructor for record class com.pain001.sdk.CheckResponse
Copies the lists so the record stays immutable.
com.pain001.sdk - package com.pain001.sdk
A typed Java client for the pain001 REST API (pain001 serve).

D

description() - Method in record class com.pain001.sdk.FaceInfo
Returns the value of the description record component.
detail() - Method in exception class com.pain001.sdk.Pain001ApiException
The parsed detail of the error body.

E

equals(Object) - Method in record class com.pain001.sdk.ApiResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.CheckFinding
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.CheckResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.FaceInfo
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.FaceResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.GenerateResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.HealthResponse
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.LossReport
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.RowError
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.pain001.sdk.ValidationResponse
Indicates whether some other object is "equal to" this one.
errors() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the errors record component.
errors() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the errors record component.

F

face() - Method in record class com.pain001.sdk.FaceResponse
Returns the value of the face record component.
face() - Method in record class com.pain001.sdk.LossReport
Returns the value of the face record component.
FaceInfo - Record Class in com.pain001.sdk
One face from GET /api/v1/faces.
FaceInfo(String, String, List<String>) - Constructor for record class com.pain001.sdk.FaceInfo
Copies the list so the record stays immutable.
FaceResponse - Record Class in com.pain001.sdk
POST /api/v1/faces/{face}: the target payload and its loss report.
FaceResponse(String, String, JsonNode, LossReport) - Constructor for record class com.pain001.sdk.FaceResponse
Creates an instance of a FaceResponse record class.
faces() - Method in class com.pain001.sdk.Pain001Client
GET /api/v1/faces: the faces the server can project to.
field() - Method in record class com.pain001.sdk.RowError
Returns the value of the field record component.
filename() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the filename record component.
findings() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the findings record component.
fromValue(String) - Static method in enum class com.pain001.sdk.MessageType
The constant whose wire value is value, if this SDK knows it.

G

generate(String, String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/ui/generate with no scheme.
generate(String, String, String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/ui/generate: generates the XML for an uploaded payment file.
GenerateResponse - Record Class in com.pain001.sdk
POST /api/v1/ui/generate (the server's UiGenerateResponse).
GenerateResponse(boolean, String, String, String, List<RowError>, List<JsonNode>) - Constructor for record class com.pain001.sdk.GenerateResponse
Copies the lists so the record stays immutable.
GenerationRefusedException - Exception Class in com.pain001.sdk
The server refused to generate a file from the data: HTTP 422 with success: false.
GenerationRefusedException(GenerateResponse, String, String) - Constructor for exception class com.pain001.sdk.GenerationRefusedException
Creates the exception.

H

hashCode() - Method in record class com.pain001.sdk.ApiResponse
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.CheckFinding
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.CheckResponse
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.FaceInfo
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.FaceResponse
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.GenerateResponse
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.HealthResponse
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.LossReport
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.RowError
Returns a hash code value for this object.
hashCode() - Method in record class com.pain001.sdk.ValidationResponse
Returns a hash code value for this object.
health() - Method in class com.pain001.sdk.Pain001Client
GET /api/v1/health: whether the server is up, and its version.
HealthResponse - Record Class in com.pain001.sdk
GET /api/v1/health.
HealthResponse(String, String, String) - Constructor for record class com.pain001.sdk.HealthResponse
Creates an instance of a HealthResponse record class.

I

initialBackoff() - Method in class com.pain001.sdk.RetryPolicy
The wait before the first retry, before jitter.
initialBackoff(Duration) - Method in class com.pain001.sdk.RetryPolicy.Builder
The wait before the first retry, before jitter (default 200 ms).
invalidRows() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the invalidRows record component.
isLossless() - Method in record class com.pain001.sdk.LossReport
Returns the value of the isLossless record component.
isSuccess() - Method in record class com.pain001.sdk.ApiResponse
Whether the status is 2xx.
isValid() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the isValid record component.

L

location() - Method in record class com.pain001.sdk.CheckFinding
Returns the value of the location record component.
lossRatio() - Method in record class com.pain001.sdk.LossReport
Returns the value of the lossRatio record component.
lossReport() - Method in record class com.pain001.sdk.FaceResponse
Returns the value of the lossReport record component.
LossReport - Record Class in com.pain001.sdk
What a face projection carried and what it did not, by indexed path.
LossReport(String, int, int, int, boolean, double, List<String>, List<String>) - Constructor for record class com.pain001.sdk.LossReport
Copies the lists so the record stays immutable.

M

mappedCount() - Method in record class com.pain001.sdk.LossReport
Returns the value of the mappedCount record component.
mappedPaths() - Method in record class com.pain001.sdk.LossReport
Returns the value of the mappedPaths record component.
maxAttempts() - Method in class com.pain001.sdk.RetryPolicy
The number of attempts in all, including the first.
maxAttempts(int) - Method in class com.pain001.sdk.RetryPolicy.Builder
The number of attempts in all, including the first (default 3); 1 disables retries.
maxBackoff() - Method in class com.pain001.sdk.RetryPolicy
The longest wait before any retry, and the longest Retry-After honoured.
maxBackoff(Duration) - Method in class com.pain001.sdk.RetryPolicy.Builder
The longest wait before any retry (default 5 s), and the longest Retry-After honoured.
message() - Method in record class com.pain001.sdk.CheckFinding
Returns the value of the message record component.
message() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the message record component.
message() - Method in record class com.pain001.sdk.HealthResponse
Returns the value of the message record component.
message() - Method in record class com.pain001.sdk.RowError
Returns the value of the message record component.
messageType() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the messageType record component.
MessageType - Enum Class in com.pain001.sdk
The ISO 20022 message types the server's MessageType enum lists at this SDK's version.

N

name() - Method in record class com.pain001.sdk.FaceInfo
Returns the value of the name record component.
NoDocumentException - Exception Class in com.pain001.sdk
generate got a 2xx answer that carries no XML document.
NoDocumentException(int, String, String) - Constructor for exception class com.pain001.sdk.NoDocumentException
Creates the exception.

P

PAIN_001_001_03 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.03.
PAIN_001_001_04 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.04.
PAIN_001_001_05 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.05.
PAIN_001_001_06 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.06.
PAIN_001_001_07 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.07.
PAIN_001_001_08 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.08.
PAIN_001_001_09 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.09.
PAIN_001_001_10 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.10.
PAIN_001_001_11 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.11.
PAIN_001_001_12 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.12.
PAIN_001_001_13 - Enum constant in enum class com.pain001.sdk.MessageType
pain.001.001.13.
PAIN_008_001_02 - Enum constant in enum class com.pain001.sdk.MessageType
pain.008.001.02.
PAIN_008_001_08 - Enum constant in enum class com.pain001.sdk.MessageType
pain.008.001.08.
Pain001ApiException - Exception Class in com.pain001.sdk
The server answered with a non-2xx status.
Pain001ApiException(int, JsonNode, String, String) - Constructor for exception class com.pain001.sdk.Pain001ApiException
Creates the exception.
Pain001Client - Class in com.pain001.sdk
A client for the pain001 REST API (pain001 serve).
Pain001Client.Builder - Class in com.pain001.sdk
Builds a Pain001Client.
passed() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the passed record component.
payload() - Method in record class com.pain001.sdk.FaceResponse
Returns the value of the payload record component.
projectFace(String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/faces/{face} with the edition detected and no bindings.
projectFace(String, String, String, Map<String, ?>) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/faces/{face}: projects a pain.001 document onto a target standard.

R

request(String, String, JsonNode) - Method in class com.pain001.sdk.Pain001Client
Sends one request and returns the status and parsed body, whatever the status.
response() - Method in exception class com.pain001.sdk.GenerationRefusedException
The decoded refusal.
retryPolicy(RetryPolicy) - Method in class com.pain001.sdk.Pain001Client.Builder
Retries GET calls under retryPolicy; null (the default) sends every request once.
RetryPolicy - Class in com.pain001.sdk
An opt-in retry policy for idempotent calls: GET only.
RetryPolicy.Builder - Class in com.pain001.sdk
Builds a RetryPolicy.
RowError - Record Class in com.pain001.sdk
One row-level validation error from validate or generate.
RowError(String, String, JsonNode) - Constructor for record class com.pain001.sdk.RowError
Creates an instance of a RowError record class.
rule() - Method in record class com.pain001.sdk.CheckFinding
Returns the value of the rule record component.
rung() - Method in record class com.pain001.sdk.CheckFinding
Returns the value of the rung record component.
rungs() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the rungs record component.

S

schemeViolations() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the schemeViolations record component.
schemeViolations() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the schemeViolations record component.
severity() - Method in record class com.pain001.sdk.CheckFinding
Returns the value of the severity record component.
status() - Method in record class com.pain001.sdk.ApiResponse
Returns the value of the status record component.
status() - Method in record class com.pain001.sdk.HealthResponse
Returns the value of the status record component.
status() - Method in exception class com.pain001.sdk.NoDocumentException
The 2xx HTTP status code the server answered.
status() - Method in exception class com.pain001.sdk.Pain001ApiException
The HTTP status code.
success() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the success record component.

T

timeout(Duration) - Method in class com.pain001.sdk.Pain001Client.Builder
The connect and per-request timeout; 30 seconds when not set.
toString() - Method in record class com.pain001.sdk.ApiResponse
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.CheckFinding
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.CheckResponse
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.FaceInfo
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.FaceResponse
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.GenerateResponse
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.HealthResponse
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.LossReport
Returns a string representation of this record class.
toString() - Method in enum class com.pain001.sdk.MessageType
 
toString() - Method in record class com.pain001.sdk.RowError
Returns a string representation of this record class.
toString() - Method in record class com.pain001.sdk.ValidationResponse
Returns a string representation of this record class.
totalRows() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the totalRows record component.
totalSourceElements() - Method in record class com.pain001.sdk.LossReport
Returns the value of the totalSourceElements record component.

U

unmappedCount() - Method in record class com.pain001.sdk.LossReport
Returns the value of the unmappedCount record component.
unmappedPaths() - Method in record class com.pain001.sdk.LossReport
Returns the value of the unmappedPaths record component.

V

validate(String, String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/ui/validate with no scheme.
validate(String, String, String, String) - Method in class com.pain001.sdk.Pain001Client
POST /api/v1/ui/validate: validates an uploaded payment file.
validationErrors() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the validationErrors record component.
ValidationResponse - Record Class in com.pain001.sdk
POST /api/v1/ui/validate.
ValidationResponse(boolean, int, int, int, List<RowError>, List<JsonNode>) - Constructor for record class com.pain001.sdk.ValidationResponse
Copies the lists so the record stays immutable.
validRows() - Method in record class com.pain001.sdk.ValidationResponse
Returns the value of the validRows record component.
value() - Method in enum class com.pain001.sdk.MessageType
The wire value.
value() - Method in record class com.pain001.sdk.RowError
Returns the value of the value record component.
valueOf(String) - Static method in enum class com.pain001.sdk.MessageType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.pain001.sdk.MessageType
Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class com.pain001.sdk.FaceResponse
Returns the value of the version record component.
version() - Method in record class com.pain001.sdk.HealthResponse
Returns the value of the version record component.
VERSION - Static variable in class com.pain001.sdk.Pain001Client
This SDK's version, sent as User-Agent: pain001-sdk-java/<version>.

W

warnings() - Method in record class com.pain001.sdk.CheckResponse
Returns the value of the warnings record component.

X

xml() - Method in record class com.pain001.sdk.GenerateResponse
Returns the value of the xml record component.
A B C D E F G H I L M N P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form