API für Events

Event abonnieren

Die Beispiele verwenden den unter Installation erstellten gemeinsamen CloudApi-Client und gehören in die Methoden deines Plugins.

Subscription subscription = api.event().server().onStateChanged(event -> {
    String serverId = event.getServerId();
    // React to the state change.
});

Bewahre die zurückgegebene Subscription auf und schließe sie, wenn dein Plugin beendet wird. Der Leitfaden zur Event-Verarbeitung zeigt den vollständigen Plugin-Lebenszyklus und wie du aus einem Callback sicher mit deiner Serverplattform interagierst.

Event-Kategorie auswählen

Kategorie	Abonnementmethoden	Callback-Typen
`group()`	`onCreated`, `onUpdated`, `onDeleted`	`GroupCreatedEvent`, `GroupUpdatedEvent`, `GroupDeletedEvent`
`server()`	`onStarted`, `onStopped`, `onStateChanged`, `onUpdated`, `onDeleted`	`ServerStartedEvent`, `ServerStoppedEvent`, `ServerStateChangedEvent`, `ServerUpdatedEvent`, `ServerDeletedEvent`
`persistentServer()`	`onCreated`, `onStarted`, `onStopped`, `onUpdated`, `onDeleted`	`PersistentServerCreatedEvent`, `PersistentServerStartedEvent`, `PersistentServerStoppedEvent`, `PersistentServerUpdatedEvent`, `PersistentServerDeletedEvent`
`blueprint()`	`onCreated`, `onUpdated`, `onDeleted`	`BlueprintCreatedEvent`, `BlueprintUpdatedEvent`, `BlueprintDeletedEvent`

Server-Events beschreiben einzelne Serverinstanzen. Events für persistente Server beschreiben Änderungen am persistenten Server selbst, etwa wenn er aktualisiert wird oder eine Serverinstanz startet.

Zustand korrekt halten

Events informieren dich über eine Änderung; die Abfrage-APIs liefern den aktuellen Zustand. Abonnements empfangen nur Live-Events. Frage die Ressource daher beim Start deines Plugins ab oder wenn ein verpasstes Event zu einem falschen Zustand führen würde. Schließe jedes Abonnement, sobald du es nicht mehr benötigst. Sowohl close() als auch unsubscribe() beenden die zukünftige Zustellung und können mehrfach aufgerufen werden.

Callback-Daten auslesen

Jeder Callback stellt getNetworkId() und über getTimestamp() einen Zeitstempel im ISO-8601-Format bereit. Die übrigen Getter hängen vom Event-Typ ab. Verwende zur Identifizierung einer Ressource bevorzugt den Getter für ihre stabile ID. Manche Event-Payloads enthalten kein eingebettetes Modell. In diesem Fall werfen Modell-Getter wie getServer(), getGroup() und getBlueprint() eine IllegalStateException. Frage die passende Ressourcen-API ab, wenn du aktuelle Daten benötigst.

Getter von Server-Callbacks

Callback-Typ	Zusätzliche Getter
`ServerStartedEvent`	`getServerId()`, `getServerGroupId()`, `getServer()`
`ServerStoppedEvent`	`getServerId()`, `getServerGroupId()`, `getServer()`, `getCrashed()`, `getExitCode()` (`Integer` oder `null`), `getReason()` (`String` oder `null`)
`ServerStateChangedEvent`	`getServerId()`, `getOldState()`, `getNewState()`, `getServer()`
`ServerUpdatedEvent`	`getServerId()`, `getServerGroupId()`, `getServer()`
`ServerDeletedEvent`	`getServerId()`, `getServerGroupId()`, `getServer()`

Getter von Gruppen-Callbacks

Callback-Typ	Zusätzliche Getter
`GroupCreatedEvent`	`getServerGroupId()`, `getGroup()`
`GroupUpdatedEvent`	`getServerGroupId()`, `getGroup()`
`GroupDeletedEvent`	`getServerGroupId()`, `getName()` (`String` oder `null`)

Getter von Callbacks für persistente Server

Callback-Typ	Zusätzliche Getter
`PersistentServerCreatedEvent`	`getPersistentServerId()`, `getName()` (`String` oder `null`)
`PersistentServerStartedEvent`	`getPersistentServerId()`, `getServerId()` (`String` oder `null`)
`PersistentServerStoppedEvent`	`getPersistentServerId()`, `getServerId()` (`String` oder `null`)
`PersistentServerUpdatedEvent`	`getPersistentServerId()`, `getName()` (`String` oder `null`)
`PersistentServerDeletedEvent`	`getPersistentServerId()`, `getName()` (`String` oder `null`)

Getter von Blueprint-Callbacks

Callback-Typ	Zusätzliche Getter
`BlueprintCreatedEvent`	`getBlueprintId()`, `getBlueprint()`
`BlueprintUpdatedEvent`	`getBlueprintId()`, `getBlueprint()`
`BlueprintDeletedEvent`	`getBlueprintId()`, `getName()` (`String` oder `null`)

Getting Started

Cloud API

Guides

Event abonnieren

Event-Kategorie auswählen

Zustand korrekt halten

Callback-Daten auslesen

​Event abonnieren

​Event-Kategorie auswählen

​Zustand korrekt halten

​Callback-Daten auslesen

Event abonnieren

Event-Kategorie auswählen

Zustand korrekt halten

Callback-Daten auslesen