SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › http-3.0

Package http-3.0

This package contains 18 source unit(s) defining 18 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

Http30Authorization #sleela 2.5 (lib/http-3.0/Http30Authorization.sleela)

Http30Authorization class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
principalIdString principalId = ""No description in source.
capabilityString capability = ""No description in source.
authenticatedboolean authenticated = falseNo description in source.
authorizedboolean authorized = falseNo description in source.
allowAnonymousHealthboolean allowAnonymousHealth = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setPrincipalvoid setPrincipal(String id, boolean verified)No description in source.
grantCapabilityvoid grantCapability(String value)No description in source.
permitsProtectedRouteboolean permitsProtectedRoute()No description in source.
permitsHealthRouteboolean permitsHealthRoute()No description in source.

Http30BasketPolicy #sleela 2.5 (lib/http-3.0/Http30BasketPolicy.sleela)

Http30BasketPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
itemCountint itemCount = 14No description in source.
isoNumericCurrencyint isoNumericCurrency = 840No description in source.
blockBytesint blockBytes = 172No description in source.
requireCanonicalEncodingboolean requireCanonicalEncoding = trueNo description in source.
requireMacCoverageboolean requireMacCoverage = trueNo description in source.
valuesAreApplicationMetadataboolean valuesAreApplicationMetadata = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
validBlockboolean validBlock(int count, int bytes, int currency)No description in source.
safeDefaultsboolean safeDefaults()No description in source.

Http30ConnectionPolicy #sleela 2.5 (lib/http-3.0/Http30ConnectionPolicy.sleela)

Http30ConnectionPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
closeAfterResponseboolean closeAfterResponse = trueNo description in source.
rejectIncompleteBodyboolean rejectIncompleteBody = trueNo description in source.
rejectUnsupportedTransferEncodingboolean rejectUnsupportedTransferEncoding = trueNo description in source.
rejectDuplicateContentLengthboolean rejectDuplicateContentLength = trueNo description in source.
honorHeadWithoutSendingBodyboolean honorHeadWithoutSendingBody = trueNo description in source.
suppressBodyFor204boolean suppressBodyFor204 = trueNo description in source.
suppressBodyFor304boolean suppressBodyFor304 = trueNo description in source.
requestTimeoutMillisint requestTimeoutMillis = 10000No description in source.
bodyTimeoutMillisint bodyTimeoutMillis = 10000No description in source.
idleTimeoutMillisint idleTimeoutMillis = 10000No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
safeDefaultsboolean safeDefaults()No description in source.

Http30DownloadPolicy #sleela 2.5 (lib/http-3.0/Http30DownloadPolicy.sleela)

Http30DownloadPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
largeFileThresholdlong largeFileThreshold = 52428800No description in source.
requireAuthenticatedSessionboolean requireAuthenticatedSession = trueNo description in source.
bindResumeToFileIdentityboolean bindResumeToFileIdentity = trueNo description in source.
rejectPathSeparatorsboolean rejectPathSeparators = trueNo description in source.
rejectOffsetPastEndboolean rejectOffsetPastEnd = trueNo description in source.
verifyArtifactDigestboolean verifyArtifactDigest = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
requiresDownloadModeboolean requiresDownloadMode(long size)No description in source.
validRangeboolean validRange(long offset, long totalSize)No description in source.
safeDefaultsboolean safeDefaults()No description in source.

Http30DownloadState #sleela 2.5 (lib/http-3.0/Http30DownloadState.sleela)

Http30DownloadState class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
LARGE_FILE_THRESHOLDlong LARGE_FILE_THRESHOLD = 52428800No description in source.
sessionIdString sessionId = ""No description in source.
dateTimeString dateTime = ""No description in source.
fileIdString fileId = ""No description in source.
fileNameString fileName = ""No description in source.
indexlong index = 0No description in source.
offsetlong offset = 0No description in source.
totalSizelong totalSize = 0No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String session, String timestamp, String id,No description in source.
requiresDownloadModeboolean requiresDownloadMode(long size)No description in source.
isValidboolean isValid()No description in source.
remainingByteslong remainingBytes()No description in source.

Http30Envelope #sleela 2.5 (lib/http-3.0/Http30Envelope.sleela)

Http30Envelope class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
versionint version = 3No description in source.
flagsint flags = 0No description in source.
serviceIdlong serviceId = 0No description in source.
operationIdlong operationId = 0No description in source.
requestIdlong requestId = 0No description in source.
noncelong nonce = 0No description in source.
digestString digest = ""No description in source.
intactxlong intactx = 0No description in source.
basketHexString basketHex = ""No description in source.
payloadString payload = ""No description in source.
textualboolean textual = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
isValidboolean isValid()No description in source.
requiresIntegrityGateboolean requiresIntegrityGate()No description in source.

Http30Handshake #sleela 2.5 (lib/http-3.0/Http30Handshake.sleela)

Http30Handshake class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
localCapabilitiesint localCapabilities = 1No description in source.
peerCapabilitiesint peerCapabilities = 1No description in source.
selectedLevelint selectedLevel = 1No description in source.
macVerifiedboolean macVerified = falseNo description in source.
completeboolean complete = falseNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setLocalCapabilitiesvoid setLocalCapabilities(int value)No description in source.
setPeerCapabilitiesvoid setPeerCapabilities(int value)No description in source.
verifyOffervoid verifyOffer(boolean verified)No description in source.
negotiateint negotiate()No description in source.
isCompleteboolean isComplete()No description in source.

Http30Integrity #sleela 2.5 (lib/http-3.0/Http30Integrity.sleela)

Http30Integrity class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
digestVerifiedboolean digestVerified = falseNo description in source.
nonceFreshboolean nonceFresh = falseNo description in source.
intactxWithinThresholdboolean intactxWithinThreshold = falseNo description in source.
basketCanonicalboolean basketCanonical = falseNo description in source.
replayWindowInitializedboolean replayWindowInitialized = falseNo description in source.
nonceHighWaterlong nonceHighWater = 0No description in source.
acceptedPacketslong acceptedPackets = 0No description in source.
rejectedDigestlong rejectedDigest = 0No description in source.
rejectedReplaylong rejectedReplay = 0No description in source.
rejectedIntegritylong rejectedIntegrity = 0No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
recordDigestvoid recordDigest(boolean ok)No description in source.
recordNoncevoid recordNonce(long nonce)No description in source.
acceptNonceboolean acceptNonce(long nonce)No description in source.
recordIntactxvoid recordIntactx(boolean ok)No description in source.
recordBasketvoid recordBasket(boolean ok)No description in source.
permitsDispatchboolean permitsDispatch()No description in source.

Http30Limits #sleela 2.5 (lib/http-3.0/Http30Limits.sleela)

Http30Limits class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
maxEnvelopePayloadBytesint maxEnvelopePayloadBytes = 4096No description in source.
maxTextEnvelopeBytesint maxTextEnvelopeBytes = 16384No description in source.
maxServicesint maxServices = 64No description in source.
maxOperationsPerServiceint maxOperationsPerService = 64No description in source.
maxNameBytesint maxNameBytes = 63No description in source.
maxBasketItemsint maxBasketItems = 14No description in source.
macKeyBytesint macKeyBytes = 16No description in source.
digestBytesint digestBytes = 8No description in source.
intactxBytesint intactxBytes = 8No description in source.
nonceBytesint nonceBytes = 8No description in source.
basketBlockBytesint basketBlockBytes = 172No description in source.
requestTimeoutMillisint requestTimeoutMillis = 10000No description in source.
downloadResumeThresholdByteslong downloadResumeThresholdBytes = 52428800No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
validPayloadLengthboolean validPayloadLength(long n)No description in source.
validDictionarySizeboolean validDictionarySize(int services, int operations)No description in source.

Http30Negotiation #sleela 2.5 (lib/http-3.0/Http30Negotiation.sleela)

Http30Negotiation class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
localGenerationString localGeneration = "3.0"No description in source.
peerGenerationString peerGeneration = ""No description in source.
peerAcceptString peerAccept = ""No description in source.
fallbackAllowedboolean fallbackAllowed = trueNo description in source.
requireIntegrityForUpgradeboolean requireIntegrityForUpgrade = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setPeerGenerationvoid setPeerGeneration(String value)No description in source.
setPeerAcceptvoid setPeerAccept(String value)No description in source.
allowFallbackvoid allowFallback(boolean value)No description in source.
selectedGenerationString selectedGeneration()No description in source.
isNegotiatedboolean isNegotiated()No description in source.
mayUpgradeWithIntegrityboolean mayUpgradeWithIntegrity(boolean integrityReady)No description in source.

Http30Request #sleela 2.5 (lib/http-3.0/Http30Request.sleela)

Http30Request class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
methodString method = "GET"No description in source.
targetString target = "/"No description in source.
protocolString protocol = "HTTP/1.0"No description in source.
logicalPortString logicalPort = ""No description in source.
serviceIdString serviceId = ""No description in source.
operationIdString operationId = ""No description in source.
bodyContentTypeString bodyContentType = ""No description in source.
bodyLengthlong bodyLength = 0No description in source.
validboolean valid = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setMethodvoid setMethod(String value)No description in source.
setTargetvoid setTarget(String value)No description in source.
setLogicalPortvoid setLogicalPort(String value)No description in source.
setServiceIdvoid setServiceId(String value)No description in source.
setOperationIdvoid setOperationId(String value)No description in source.
setBodyvoid setBody(String contentType, long length)No description in source.
rejectvoid reject()No description in source.
isValidboolean isValid()No description in source.
isGetboolean isGet()No description in source.
isHeadboolean isHead()No description in source.
isPostboolean isPost()No description in source.
versionString version()No description in source.

Http30Response #sleela 2.5 (lib/http-3.0/Http30Response.sleela)

Http30Response class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
protocolString protocol = "HTTP/1.0"No description in source.
statusCodeint statusCode = 200No description in source.
reasonString reason = "OK"No description in source.
contentTypeString contentType = "text/plain; charset=utf-8"No description in source.
bodyString body = ""No description in source.
generationString generation = "3.0"No description in source.
acceptedGenerationsString acceptedGenerations = "3.0, 2.1, 2.0"No description in source.
closeConnectionboolean closeConnection = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setStatusvoid setStatus(int code, String phrase)No description in source.
setContentTypevoid setContentType(String value)No description in source.
setBodyvoid setBody(String value)No description in source.
setGenerationvoid setGeneration(String value)No description in source.
setAcceptedGenerationsvoid setAcceptedGenerations(String value)No description in source.
keepConnectionOpenvoid keepConnectionOpen(boolean value)No description in source.
isSuccessfulboolean isSuccessful()No description in source.
mustCloseConnectionboolean mustCloseConnection()No description in source.

Http30RetryPolicy #sleela 2.5 (lib/http-3.0/Http30RetryPolicy.sleela)

Http30RetryPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
retryClassString retryClass = "READ"No description in source.
idempotencyKeyPresentboolean idempotencyKeyPresent = falseNo description in source.
streamResumableboolean streamResumable = falseNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setRetryClassvoid setRetryClass(String value)No description in source.
setIdempotencyKeyPresentvoid setIdempotencyKeyPresent(boolean value)No description in source.
setStreamResumablevoid setStreamResumable(boolean value)No description in source.
mayRetryAfterUncertainFailureboolean mayRetryAfterUncertainFailure()No description in source.

Http30Route #sleela 2.5 (lib/http-3.0/Http30Route.sleela)

Http30Route class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
logicalPortString logicalPort = ""No description in source.
serviceIdString serviceId = ""No description in source.
operationIdString operationId = ""No description in source.
routeNameString routeName = ""No description in source.
enabledboolean enabled = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String port, String service, String operation, String name)No description in source.
isCompleteboolean isComplete()No description in source.
matchesboolean matches(String port, String service, String operation)No description in source.

Http30SecurityPolicy #sleela 2.5 (lib/http-3.0/Http30SecurityPolicy.sleela)

Http30SecurityPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
requireProtectedTransportboolean requireProtectedTransport = trueNo description in source.
requireAuthenticatedPeerboolean requireAuthenticatedPeer = trueNo description in source.
requireAuthorizationForProtectedRoutesboolean requireAuthorizationForProtectedRoutes = trueNo description in source.
requireKeyedDigestboolean requireKeyedDigest = trueNo description in source.
requireNonceReplayGuardboolean requireNonceReplayGuard = trueNo description in source.
requireIntegrityCheckboolean requireIntegrityCheck = trueNo description in source.
requireBasketValidationboolean requireBasketValidation = trueNo description in source.
failClosedOnDowngradeboolean failClosedOnDowngrade = trueNo description in source.
trustForwardedHeadersboolean trustForwardedHeaders = falseNo description in source.
redactCredentialsInLogsboolean redactCredentialsInLogs = trueNo description in source.
macString mac = "SipHash-2-4 per-connection keyed MAC (as documented in native core)"No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
permitsProtectedRouteboolean permitsProtectedRoute(boolean authenticated, boolean authorized, boolean digestValid, boolean nonceFresh, boolean intactxValid, boolean basketValid)No description in source.
safeDefaultsboolean safeDefaults()No description in source.

Http30TimingPolicy #sleela 2.5 (lib/http-3.0/Http30TimingPolicy.sleela)

Http30TimingPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
minimumGapNanoslong minimumGapNanos = 0No description in source.
latenessNanoslong latenessNanos = 0No description in source.
balanceNanoslong balanceNanos = 0No description in source.
observedPacketslong observedPackets = 0No description in source.
latePacketslong latePackets = 0No description in source.
overRatePacketslong overRatePackets = 0No description in source.
unbalancedPacketslong unbalancedPackets = 0No description in source.
timingIsAdvisoryboolean timingIsAdvisory = trueNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(long minGap, long lateness, long balance)No description in source.
recordvoid record(long lateCount, long rateCount, long balanceCount)No description in source.
mayRejectOnTimingAloneboolean mayRejectOnTimingAlone()No description in source.

Http30Validation #sleela 2.5 (lib/http-3.0/Http30Validation.sleela)

Http30Validation class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
validMethodboolean validMethod(String value)No description in source.
validTargetboolean validTarget(String value)No description in source.
validProtocolboolean validProtocol(String value)No description in source.
validBodyLengthboolean validBodyLength(long value)No description in source.
validHeaderCountboolean validHeaderCount(int value)No description in source.
requiresNativeValidationboolean requiresNativeValidation()No description in source.

SLPackage #sleela 2.5 (lib/http-3.0/SLPackage.sleela)

SLPackage class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
packageNameString packageNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name)No description in source.
nameString name()No description in source.
generationString generation()No description in source.
nativeTransportString nativeTransport()No description in source.
applicationEnvelopeAvailableboolean applicationEnvelopeAvailable()No description in source.
keyedDigestAvailableboolean keyedDigestAvailable()No description in source.
nonceReplayGuardAvailableboolean nonceReplayGuardAvailable()No description in source.
intactxCheckAvailableboolean intactxCheckAvailable()No description in source.
basketSchemaAvailableboolean basketSchemaAvailable()No description in source.
iETFHttp3TransportAvailableboolean iETFHttp3TransportAvailable()No description in source.
requiresProtectedTransportboolean requiresProtectedTransport()No description in source.
availableboolean available()No description in source.