Index (Portaki Module SDK (Java) 0.4.0 API)

A B C D E F G H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

app.portaki.sdk.event - package app.portaki.sdk.event
app.portaki.sdk.gateway - package app.portaki.sdk.gateway
app.portaki.sdk.module - package app.portaki.sdk.module
app.portaki.sdk.module.backend - package app.portaki.sdk.module.backend: Contrats d'exécution côté serveur pour les modules hôte (actions nommées, jobs, intégrations externes, …) — types et SPI génériques, sans logique métier d'un module donné.
app.portaki.sdk.module.backend.http - package app.portaki.sdk.module.backend.http
assertEventAllowed(String, String) - Method in class app.portaki.sdk.gateway.ScopeValidation
assertScope(String) - Method in class app.portaki.sdk.gateway.GatewayModuleContext
assertScope(String, String, Set<String>) - Method in class app.portaki.sdk.gateway.ScopeValidation

B

body() - Method in record class app.portaki.sdk.module.WebhookResponse: Returns the value of the body record component.

C

checkinAt() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns the value of the checkinAt record component.
code() - Method in exception class app.portaki.sdk.module.backend.ModuleBackendException
commandNames() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns the value of the commandNames record component.
config() - Method in class app.portaki.sdk.gateway.GatewayModuleContext

D

data() - Method in record class app.portaki.sdk.gateway.PortakiModuleEvent: Returns the value of the data record component.

E

emptySuccess() - Static method in record class app.portaki.sdk.module.backend.HostModuleRunResult
equals(Object) - Method in record class app.portaki.sdk.event.StayCreatedEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.gateway.PortakiModuleEvent: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.module.backend.HostModuleAction: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class app.portaki.sdk.module.WebhookResponse: Indicates whether some other object is "equal to" this one.
event() - Method in class app.portaki.sdk.gateway.ModuleEventWrapper
EventNotDeclaredException - Exception Class in app.portaki.sdk.gateway
EventNotDeclaredException(String, String) - Constructor for exception class app.portaki.sdk.gateway.EventNotDeclaredException

F

failed() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the failed record component.
fetch(String) - Static method in class app.portaki.sdk.module.backend.http.SafeHttpsUtf8Fetcher

G

GatewayModuleContext - Class in app.portaki.sdk.gateway
GatewayModuleContext(String, String, String, UUID, Set<String>, Map<String, Object>, Consumer<PortakiModuleEvent>, ScopeValidation) - Constructor for class app.portaki.sdk.gateway.GatewayModuleContext
get(String) - Method in interface app.portaki.sdk.module.backend.PortakiHostModuleBackendRegistry
guestEmail() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns the value of the guestEmail record component.

H

hashCode() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.gateway.PortakiModuleEvent: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.module.backend.HostModuleAction: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Returns a hash code value for this object.
hashCode() - Method in record class app.portaki.sdk.module.WebhookResponse: Returns a hash code value for this object.
HostModuleAction - Record Class in app.portaki.sdk.module.backend: Action callable sur le backend d'un module (sync planifiée, bouton « Synchroniser », webhook, …).
HostModuleAction(String) - Constructor for record class app.portaki.sdk.module.backend.HostModuleAction: Creates an instance of a HostModuleAction record class.
HostModuleRunResult - Record Class in app.portaki.sdk.module.backend: Résultat générique d'une action backend (compteurs agrégés + résumé lisible humain / logs).
HostModuleRunResult(boolean, int, int, int, String) - Constructor for record class app.portaki.sdk.module.backend.HostModuleRunResult
HostModuleRunResult(boolean, int, int, int, String, String) - Constructor for record class app.portaki.sdk.module.backend.HostModuleRunResult: Creates an instance of a HostModuleRunResult record class.

I

itemsTotal() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the itemsTotal record component.

M

manifest(String) - Method in class app.portaki.sdk.gateway.ScopeValidation
ModuleBackendException - Exception Class in app.portaki.sdk.module.backend: Erreur métier ou technique pendant l'exécution d'un backend de module (fetch distant, parsing, quota…).
ModuleBackendException(String, String) - Constructor for exception class app.portaki.sdk.module.backend.ModuleBackendException
ModuleBackendException(String, String, Throwable) - Constructor for exception class app.portaki.sdk.module.backend.ModuleBackendException
ModuleContext - Interface in app.portaki.sdk.module: Contexte runtime pour des handlers côté client / intégration (extensions, webhooks sortants, …).
ModuleEventWrapper - Class in app.portaki.sdk.gateway
ModuleEventWrapper(String, UUID, String, PortakiModuleEvent) - Constructor for class app.portaki.sdk.gateway.ModuleEventWrapper
ModuleHostContext - Record Class in app.portaki.sdk.module.backend: Contexte minimal transmis au backend d'un module hôte (auth et périmètre déjà validés par l'API).
ModuleHostContext(UUID, UUID, String) - Constructor for record class app.portaki.sdk.module.backend.ModuleHostContext: Creates an instance of a ModuleHostContext record class.
moduleId() - Method in class app.portaki.sdk.gateway.GatewayModuleContext
moduleId() - Method in class app.portaki.sdk.gateway.ModuleEventWrapper
moduleId() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns the value of the moduleId record component.
moduleId() - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Returns the value of the moduleId record component.
moduleId() - Method in interface app.portaki.sdk.module.backend.PortakiHostModuleBackend: Identifiant stable du module (aligné sur portaki.module.json, ex.
ModuleManifestSnapshot - Record Class in app.portaki.sdk.gateway
ModuleManifestSnapshot(String, List<String>, List<String>, List<String>, List<String>) - Constructor for record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Creates an instance of a ModuleManifestSnapshot record class.

N

name() - Method in record class app.portaki.sdk.gateway.PortakiModuleEvent: Returns the value of the name record component.

O

of(String, List<String>, List<String>, List<String>, List<String>) - Static method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot
ok() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the ok record component.
ok() - Static method in record class app.portaki.sdk.module.WebhookResponse
OnEvent - Annotation Interface in app.portaki.sdk.module

P

PortakiCommandHandler - Annotation Interface in app.portaki.sdk.gateway
PortakiEventHandler - Annotation Interface in app.portaki.sdk.gateway
PortakiHostModule - Annotation Interface in app.portaki.sdk.module.backend: Marque une classe comme implémentation backend d'un module hôte (découverte DI, registre, …).
PortakiHostModuleBackend - Interface in app.portaki.sdk.module.backend: Backend serveur d'un module hôte.
PortakiHostModuleBackendRegistry - Interface in app.portaki.sdk.module.backend: Résout le backend d'un module hôte.
PortakiModule - Annotation Interface in app.portaki.sdk.module
PortakiModuleEvent - Record Class in app.portaki.sdk.gateway
PortakiModuleEvent(String, Map<String, Object>) - Constructor for record class app.portaki.sdk.gateway.PortakiModuleEvent: Creates an instance of a PortakiModuleEvent record class.
PortakiQueryHandler - Annotation Interface in app.portaki.sdk.gateway
propertyId() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns the value of the propertyId record component.
propertyId() - Method in class app.portaki.sdk.gateway.GatewayModuleContext
propertyId() - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Returns the value of the propertyId record component.
publish(PortakiModuleEvent) - Method in class app.portaki.sdk.gateway.GatewayModuleContext
publishedEventNames() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns the value of the publishedEventNames record component.

Q

queryNames() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns the value of the queryNames record component.

R

run(ModuleHostContext, HostModuleAction, String) - Method in interface app.portaki.sdk.module.backend.PortakiHostModuleBackend: Exécute une action nommée avec la configuration module déjà en clair (secrets déchiffrés côté API).

S

SafeHttpsUtf8Fetcher - Class in app.portaki.sdk.module.backend.http: GET HTTPS en texte UTF-8 avec garde-fous SSRF (réseaux privés, taille max).
scope() - Element in annotation interface app.portaki.sdk.gateway.PortakiCommandHandler
scope() - Element in annotation interface app.portaki.sdk.gateway.PortakiQueryHandler
ScopeNotDeclaredException - Exception Class in app.portaki.sdk.gateway
ScopeNotDeclaredException(String, String) - Constructor for exception class app.portaki.sdk.gateway.ScopeNotDeclaredException
ScopeNotGrantedException - Exception Class in app.portaki.sdk.gateway
ScopeNotGrantedException(String, String) - Constructor for exception class app.portaki.sdk.gateway.ScopeNotGrantedException
scopes() - Method in class app.portaki.sdk.gateway.GatewayModuleContext
scopes() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns the value of the scopes record component.
ScopeValidation - Class in app.portaki.sdk.gateway
ScopeValidation(Map<String, ModuleManifestSnapshot>) - Constructor for class app.portaki.sdk.gateway.ScopeValidation
status() - Method in record class app.portaki.sdk.module.WebhookResponse: Returns the value of the status record component.
StayCreatedEvent - Record Class in app.portaki.sdk.event: Payload shape for StayCreatedEvent (aligned with domain event).
StayCreatedEvent(UUID, UUID, UUID, Instant, String) - Constructor for record class app.portaki.sdk.event.StayCreatedEvent: Creates an instance of a StayCreatedEvent record class.
stayId() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns the value of the stayId record component.
stayId() - Method in class app.portaki.sdk.gateway.GatewayModuleContext
stayId() - Method in class app.portaki.sdk.gateway.ModuleEventWrapper
succeeded() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the succeeded record component.
summary() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the summary record component.
SYNC - Static variable in record class app.portaki.sdk.module.backend.HostModuleAction

T

tenantId() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns the value of the tenantId record component.
tenantId() - Method in class app.portaki.sdk.gateway.ModuleEventWrapper
tenantId() - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Returns the value of the tenantId record component.
tenantIdInternal() - Method in class app.portaki.sdk.gateway.GatewayModuleContext
toString() - Method in record class app.portaki.sdk.event.StayCreatedEvent: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.gateway.ModuleManifestSnapshot: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.gateway.PortakiModuleEvent: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.module.backend.HostModuleAction: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.module.backend.ModuleHostContext: Returns a string representation of this record class.
toString() - Method in record class app.portaki.sdk.module.WebhookResponse: Returns a string representation of this record class.

U

UnknownModuleException - Exception Class in app.portaki.sdk.gateway
UnknownModuleException(String) - Constructor for exception class app.portaki.sdk.gateway.UnknownModuleException
updatedPlainConfigJson() - Method in record class app.portaki.sdk.module.backend.HostModuleRunResult: Returns the value of the updatedPlainConfigJson record component.

V

value() - Element in annotation interface app.portaki.sdk.gateway.PortakiCommandHandler
value() - Element in annotation interface app.portaki.sdk.gateway.PortakiEventHandler
value() - Element in annotation interface app.portaki.sdk.gateway.PortakiQueryHandler
value() - Method in record class app.portaki.sdk.module.backend.HostModuleAction: Returns the value of the value record component.
value() - Element in annotation interface app.portaki.sdk.module.backend.PortakiHostModule: Identifiant du module, aligné sur portaki.module.json (ex.
value() - Element in annotation interface app.portaki.sdk.module.OnEvent
value() - Element in annotation interface app.portaki.sdk.module.PortakiModule

W

WebhookResponse - Record Class in app.portaki.sdk.module
WebhookResponse(int, String) - Constructor for record class app.portaki.sdk.module.WebhookResponse: Creates an instance of a WebhookResponse record class.

A B C D E F G H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form