Module aeonics.core

Package aeonics.util

Interface Snapshotable

All Known Implementing Classes:

Action.Type, Config, Database.Type, Destination.Type, Endpoint.File.Type, Endpoint.Rest.Type, Endpoint.Type, Endpoint.Websocket.Type, Entity, Executor, Filter.Request, Filter.Response, Filter.Type, Flow.Type, Group.Type, Lifecycle, Logger, Manager.Type, Monitor, Network, Origin.Background, Origin.Basic.Type, Origin.NetworkClient, Origin.NetworkServer, Origin.Scheduled.Type, Origin.Type, Policy.Allow.Type, Policy.Deny.Type, Policy.TargetedAllow.Type, Policy.TargetedDeny.Type, Policy.TargetedPolicy.Type, Policy.Type, Probe.Type, Provider.Local.Type, Provider.Remote, Provider.Type, Queue.Type, Role.Type, Rule.And.Type, Rule.AskProviders.Type, Rule.Group.Type, Rule.MatchAll.Type, Rule.MatchAttribute.Type, Rule.MatchContext.Type, Rule.MatchNone.Type, Rule.Not.Type, Rule.Or.Type, Rule.Role.Type, Rule.Type, Rule.Xor.Type, Scheduler, Scheduler.Cron.Type, Security, Snapshot, Storage.Database.Type, Storage.File.Type, Storage.Memory.Type, Storage.Type, Timeout, Topic.Type, Translator, User.Type, Vault

public interface Snapshotable

Make a class serializable to a JSON-like Data structure to be used in the snapshot / restore mechanism. Although nothing prevents complex objects to be included in the export, it is recommended to only include scalar / list / map values.

The intent of this interface is to backup an Entity to stale data and be able to restore it later. To that extent, it is undoubtedly a form of serialization into a human-readable format.

Undernormal circumstances, the snapshot and restore behavior should be orchestrated by the Snapshot manager. The restore mechanism shall reuse the Factory.create(Data) method. This means that the snapshot data must comply with the Template.create(Data) entity creation mechanism.

You may include private data in the snapshot form as it is not intended to be visible by the user. The privacy and security of the snapshot data depends on the implementation of the snapshot manager.

Method Summary

Modifier and Type	Method	Description
Data	snapshot()	Renders this class instance to a simple data structure for snapshot.

Method Detail

snapshot

Data snapshot()

Renders this class instance to a simple data structure for snapshot. It is recommended to call the superclass implementation and append to it if necessary.

Returns:

a snapshot data representation of this class instance