Package co.ankatech.ankasecure.sdk.exception

Class PqcTransportException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

co.ankatech.ankasecure.sdk.exception.AnkaSecureSdkException

co.ankatech.ankasecure.sdk.exception.PqcTransportException

All Implemented Interfaces:

Serializable

public final class PqcTransportException
extends AnkaSecureSdkException

A request under PQC transport was refused by the SDK, either because the response cannot be trusted as the server's answer, or because completing it would take a route that PQC transport does not protect and the caller did not choose that route.

With pqc.transport.enabled=true every response to a wrapped request is one of two things: a body encrypted under the session key (application/octet-stream, whatever its status), or a plaintext RFC 9457 problem (application/problem+json) on an error status, written before the transport layer could encrypt anything. Anything else is refused rather than handed to the caller as if it had been decrypted: a plaintext body on an encrypted channel is exactly what a tampering or misrouting intermediary would produce, and accepting it would silently remove the protection the caller enabled.

The streaming routes are protected by TLS only. Under PQC transport the SDK never chooses one on its own, whatever a size limit or a refusal suggests: PqcTransportException.Reason.STREAMING_NOT_CHOSEN names the streaming operation the caller can call explicitly.

Unchecked, like Http2RequiredException: it is raised from an OkHttp interceptor or from an operation's route selection and must reach the caller through the catch (ApiException | IOException) arms of the service layer unchanged. A refused response carries SdkErrorCode.IO, the code that failure carried before it was typed; a route the SDK will not choose carries SdkErrorCode.UNKNOWN, like the other client-side transport refusals. The message never carries a response body.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PqcTransportException.Reason	Why the request was refused.

Field Summary

Fields inherited from class co.ankatech.ankasecure.sdk.exception.AnkaSecureSdkException

MAX_RETRY_AFTER_SECONDS

Constructor Summary

Constructors

Constructor	Description
PqcTransportException(PqcTransportException.Reason reason, int httpStatus, String mediaType, Throwable cause)	A refused response.

Method Summary

Modifier and Type	Method	Description
PqcTransportException.Reason	getReason()
static PqcTransportException	streamingNotChosen(String streamingOperation, String why, int httpStatus, Throwable cause)	The refusal of a streaming route the caller did not choose.

Methods inherited from class co.ankatech.ankasecure.sdk.exception.AnkaSecureSdkException

getContext, getErrorCode, getHttpStatus, getResponseBody, getRetryAfterSeconds

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PqcTransportException

public PqcTransportException(PqcTransportException.Reason reason,
 int httpStatus,
 String mediaType,
 Throwable cause)

A refused response.

Parameters:

reason - PqcTransportException.Reason.UNENCRYPTED_RESPONSE or PqcTransportException.Reason.UNDECRYPTABLE_RESPONSE

httpStatus - the HTTP status of the refused response

mediaType - the media type the response declared, or null when it declared none

cause - the underlying failure, or null

Throws:

IllegalArgumentException - for PqcTransportException.Reason.STREAMING_NOT_CHOSEN, which streamingNotChosen(String, String, int, Throwable) builds

Method Details

streamingNotChosen

public static PqcTransportException streamingNotChosen(String streamingOperation,
 String why,
 int httpStatus,
 Throwable cause)

The refusal of a streaming route the caller did not choose.

Parameters:

streamingOperation - the SDK operation that sends this payload over the streaming route, e.g. encryptFileStream(String, Path, Path)

why - what pointed at the streaming route, one sentence

httpStatus - the status of the refusal that pointed there, or 0 when no request was sent

cause - that refusal, or null

Returns:

the refusal

getReason

public PqcTransportException.Reason getReason()

Returns:

why the request was refused