StatefulServiceBase Classe

Paquet:

microsoft.servicefabric.services.runtime

• java.lang.Object
• • microsoft.servicefabric.services.runtime.StatefulServiceBase

public class StatefulServiceBase

Représente la classe de base pour le service fiable avec état basé sur Microsoft Service Fabric.

Récapitulatif du constructeur

Constructeur	Description
StatefulServiceBase(StatefulServiceContext serviceContext, StateProviderReplica stateProviderReplica)	Crée un statefulService.

Résumé de la méthode

Modificateur et type	Méthode et description
CompletableFuture<?>	backupAsync(BackupDescription backupDescription) Effectue une sauvegarde de tous les états fiables gérés par ce StatefulServiceBase.
CompletableFuture<?>	backupAsync(BackupDescription backupDescription, Duration timeout, CancellationToken cancellationToken) Effectue une sauvegarde de tous les états fiables gérés par ce StatefulServiceBase.
List<ServiceReplicaListener>	createServiceReplicaListeners() Remplacez cette méthode pour fournir les écouteurs de communication pour le service réplica. Les points de terminaison retournés par l’écouteur de communication sont stockés sous la forme d’une chaîne JSON de ListenerName, paires de chaînes de point de terminaison comme {"Endpoints »:{"Listener1 »:"Endpoint1 »,"Listener2 »:"Endpoint2 » ...}}
Map<String, String>	getAddresses() Obtient la liste de toutes les adresses de ce service réplica en tant que paire clé-valeur (ListenerName, Endpoint).
StatefulServicePartition	getPartition() Partition de service à laquelle appartient le service actuel réplica.
StatefulServiceContext	getServiceContext() Obtient le contexte de service sous lequel ce service avec état fonctionne. Il fournit des informations telles que ReplicaId, PartitionId, ServiceName, etc.
StateProviderReplica	getStateProviderReplica()
void	onAbort() Notification indiquant que le service est en cours d’abandon. RunAsync peut s’exécuter simultanément avec l’exécution de cette méthode, car l’annulation n’est pas attendue sur le chemin d’abandon.
CompletableFuture<?>	onChangeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) Cette méthode est appelée comme dernière étape avant d’effectuer changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) . Remplacez cette méthode pour être informé que ChangeRole est terminé pour les composants internes de cette réplica.
CompletableFuture<?>	onCloseAsync(CancellationToken cancellationToken) Cette méthode est appelée comme dernière étape de fermeture du service. Remplacez cette méthode pour être averti que la fermeture est terminée pour les composants internes de cette réplica.
CompletableFuture<Boolean>	onDataLossAsync(RestoreContext context, CancellationToken cancellationToken) Cette méthode est appelée lors d’une perte de données suspectée. Vous pouvez remplacer cette méthode pour restaurer le service en cas de perte de données.
CompletableFuture<?>	onOpenAsync(ReplicaOpenMode openMode, CancellationToken cancellationToken) Cette méthode est appelée comme dernière étape de l’ouverture du service. Remplacez cette méthode pour être averti qu’Open est terminé pour les composants internes de cette réplica.
CompletableFuture<?>	runAsync(CancellationToken cancellationToken) Les services qui souhaitent implémenter une boucle de traitement qui s’exécute lorsqu’elle est primaire et a des status d’écriture, remplacent simplement cette méthode par leur logique.
void	setAddresses(Map<String, String> addresses) Définit la liste de toutes les adresses de ce service réplica en tant que paire clé-valeur (ListenerName, Endpoint).
void	setPartition(StatefulServicePartition partition) Partition de service à laquelle appartient le service actuel réplica.

Détails du constructeur

StatefulServiceBase

protected StatefulServiceBase(StatefulServiceContext serviceContext, StateProviderReplica stateProviderReplica)

Crée un statefulService.

Paramètres:

serviceContext - StatefulServiceContext qui décrit le contexte de service.

stateProviderReplica - StateProviderReplica qui représente un fournisseur d’état fiable réplica.

Détails de la méthode

backupAsync

public CompletableFuture backupAsync(BackupDescription backupDescription)

Effectue une sauvegarde de tous les états fiables gérés par ce StatefulServiceBase.

Paramètres:

backupDescription - BackupDescription décrivant la demande de sauvegarde.

Retours:

Tâche qui représente l’opération de sauvegarde asynchrone.

backupAsync

public CompletableFuture backupAsync(BackupDescription backupDescription, Duration timeout, CancellationToken cancellationToken)

Effectue une sauvegarde de tous les états fiables gérés par ce StatefulServiceBase.

Paramètres:

backupDescription - BackupDescription décrivant la demande de sauvegarde.

timeout - Délai d’expiration de cette opération.

cancellationToken - Jeton pour surveiller les requêtes d'annulation.

Retours:

Tâche qui représente l’opération de sauvegarde asynchrone.

createServiceReplicaListeners

protected List createServiceReplicaListeners()

Remplacez cette méthode pour fournir les écouteurs de communication pour le service réplica. Les points de terminaison retournés par l’écouteur de communication sont stockés sous la forme d’une chaîne JSON de ListenerName, paires de chaînes de point de terminaison comme {"Endpoints »:{"Listener1 »:"Endpoint1 »,"Listener2 »:"Endpoint2 » ...}}

Retours:

Liste de ServiceReplicaListeners

getAddresses

protected Map getAddresses()

Obtient la liste de toutes les adresses de ce service réplica en tant que paire clé-valeur (ListenerName, Endpoint).

Retours:

Une Map liste contenant la liste d’adresses en tant que paire clé-valeur (ListenerName, Point de terminaison).

getPartition

protected StatefulServicePartition getPartition()

Partition de service à laquelle appartient le service actuel réplica.

Retours:

StatefulServicePartition qui représente la partition à laquelle appartient ce service réplica.

getServiceContext

public StatefulServiceContext getServiceContext()

Obtient le contexte de service sous lequel ce service avec état fonctionne. Il fournit des informations telles que ReplicaId, PartitionId, ServiceName, etc.

Retours:

StatefulServiceContext qui décrit le contexte de service.

getStateProviderReplica

protected StateProviderReplica getStateProviderReplica()

onAbort

protected void onAbort()

Notification indiquant que le service est en cours d’abandon. RunAsync peut s’exécuter simultanément avec l’exécution de cette méthode, car l’annulation n’est pas attendue sur le chemin d’abandon.

onChangeRoleAsync

protected CompletableFuture onChangeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken)

Cette méthode est appelée comme dernière étape avant d’effectuer changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) . Remplacez cette méthode pour être informé que ChangeRole est terminé pour les composants internes de cette réplica.

Paramètres:

newRole - pour ce service réplica.

cancellationToken -

CancellationTokenobjet pour indiquer l’annulation status de l’opération.

Retours:

qui représente l’opération CompletableFuture en suspens.

onCloseAsync

protected CompletableFuture onCloseAsync(CancellationToken cancellationToken)

Cette méthode est appelée comme dernière étape de fermeture du service. Remplacez cette méthode pour être averti que la fermeture est terminée pour les composants internes de cette réplica.

Paramètres:

cancellationToken -

CancellationTokenobjet pour indiquer l’annulation status de l’opération.

Retours:

qui représente l’opération CompletableFuture en suspens.

onDataLossAsync

protected CompletableFuture onDataLossAsync(RestoreContext context, CancellationToken cancellationToken)

Cette méthode est appelée lors d’une perte de données suspectée. Vous pouvez remplacer cette méthode pour restaurer le service en cas de perte de données.

Paramètres:

context - RestoreContext à utiliser pour restaurer le service.

cancellationToken -

CancellationTokenobjet pour indiquer l’annulation status de l’opération.

Retours:

Tâche qui représente l’opération de restauration asynchrone. True indique que l’état a été restauré. False indique que l’état du réplica n’a pas été modifié.

onOpenAsync

protected CompletableFuture onOpenAsync(ReplicaOpenMode openMode, CancellationToken cancellationToken)

Cette méthode est appelée comme dernière étape de l’ouverture du service. Remplacez cette méthode pour être averti qu’Open est terminé pour les composants internes de cette réplica.

Paramètres:

openMode - pour ce service réplica.

cancellationToken -

CancellationTokenobjet pour indiquer l’annulation status de l’opération.

Retours:

qui représente l’opération CompletableFuture en suspens.

runAsync

protected CompletableFuture runAsync(CancellationToken cancellationToken)

Les services qui souhaitent implémenter une boucle de traitement qui s’exécute lorsqu’elle est primaire et a des status d’écriture, remplacent simplement cette méthode par leur logique.

Paramètres:

cancellationToken -

CancellationTokenobjet pour indiquer l’annulation status de l’opération.

Retours:

qui représente l’opération CompletableFuture en suspens.

setAddresses

protected void setAddresses(Map addresses)

Définit la liste de toutes les adresses de ce service réplica en tant que paire clé-valeur (ListenerName, Endpoint).

Paramètres:

addresses - Une Map liste contenant la liste d’adresses en tant que paire clé-valeur (ListenerName, Point de terminaison).

setPartition

protected void setPartition(StatefulServicePartition partition)

Partition de service à laquelle appartient le service actuel réplica.

Paramètres:

partition - StatefulServicePartition qui représente la partition à laquelle appartient ce service réplica.