All Classes and Interfaces
Class
Description
Event handler for accepted permission requests.
Immutable snapshot of an
PermissionStatus.ACCEPTED permission with all fields that are required to stream
data.Accepts an inbound permission request from an AIIDA code.
Accepts an outbound permission request from an AIIDA code.
Accepts a permission request from an AIIDA code.
Handles
ACCEPTED permission events for permission requests whose data need is
AccountingPointDataNeed.Data need designed to request accounting point information about a customer from their MDA.
The result for accounting point data needs
Validated permission event for accounting-point data needs.
Address of the customer (not the PRM address).
Wrapper around the installation address as returned by the données générales API.
The main configuration for the AIIDA region connector.
Represents a generic status message for a permission
Result type for the calculation of AIIDA data-needs.
Stores the locally required information about a data need of a permission.
Sent by AIIDA to the EDDIE framework when the user accepted a permission request.
Sent by AIIDA to the EDDIE framework when a permission request is not accepted, i.e.
Represents a permission request that is sent to an AIIDA instance
Repository for selecting the aggregate permission request by using the SQL view.
Emitted when AIIDA reports that a permission request was rejected by the user or cannot be fulfilled, together with
an optional reason.
Streams the records of a permission to the streaming target (EP) and receives
PermissionCommands from it.Service for handling exceptions thrown during API calls to Energinet
The main configuration for the EDA region connector.
The repository for PermissionRequests.
Serializes and deserializes the
AttributeError to a JSON list in order to persist it to a database column.This class encapsulates the data needed to request authorization from a NIF (User).
Response DTO for ETA Plus Auth token exchange.
This is the base class for CIM formatter strategies.
Intended to be used in combination with
CustomValidationsGroup in GroupSequence annotation and be
applied to basic constraints like NotNull.A specialized class for ccmo-requests.
This data need is used to request the addition of a metering point to an already existing Collective Energy Sharing Unit (CESU).
Strategy interface to create a version-specific CIM RTD Envelope
The CIM document types supported by the
MessageSerde, each combined
with its CIM version and the concrete class used to deserialize it.The intent of this class is to abstract the Future Data polling procedure of each individual Region Connector.
Configuration for the CIM.
The supported versions of the CIM
A service that is used to request validated historical data for retransmission requests
Provides
ConnectionLimitCalculation.effectiveLimits() to calculate which limits apply when during the requested time frame and scope.A default connection limit of a permission, forming an append-only timeline scoped to the permission.
Thrown when attempting to use permission or data source that cannot be used for connection limit monitoring.
Manages which data source is monitored for connection limit violations of a permission.
Notifies users by email when a connection limit violation starts and when it ends.
A continuous period in which the measured power of a permission was outside its connection limits.
Periodically checks the latest measured data of assigned data sources against the effective connection limits of the
permissions and persists the resulting violations.
Dynamic connection state of an
PermissionStatus.ACCEPTED permission.Server-sent event, that the connection status of a permission has changed.
Publishes changes of the
ConnectionStatus of permissions as soon as an AiidaStreamer connects to or
disconnects from the EDDIE framework.Represents a generic status message for a permission
Subscribes to all events of an
EventBus and creates connection status messages based on an event.Derives the dynamic
ConnectionStatus of a permission at runtime.Contact coordinates of the customer.
This class represents the contract details returned by the Datadis API.
One element of the situation contractuelle API response
(
GET /situation_contrat_auto/v1/{usage_point_id}), which returns an array of these.Reads the situation contractuelle response whether Enedis wraps it in an array (what it actually
returns) or sends a bare object.
Envelope for the situation contractuelle response, so the connector can read it as a list while
tolerating a bare object payload.
This service routes retransmission messages between the region connectors.
CPRequestCR This can be used to request retransmission of consumption records in the specified timeframe
CPRequestResult, the enum represents the ResponseCodes described in the CR_REQ_PT process
Event emitted when a new permission request is created.
DTO returned after a permission request is successfully created.
Customer block of the situation contractuelle response.
Address holder nested under the customer block.
For validations that depend on other validations to be executed beforehand (e.g.
Used to by a region-connector to calculate start and end data of a data need, as well as reporting if it supports a
certain data need.
Implementation of the
DataNeedCalculationService that can be customized to fit the requirements of the region connector.The
DataNeedCalculationServiceRegistrar will be added to each region connector's own context and will
register the DataNeedCalculationService of each region connector to the common
DataNeedCalculationRouter.This interface is used by the region connectors to specify the supported configurations of data needs.
The AccountingPointDataNeedRule specifies one supported variant of the
AccountingPointDataNeed.If this rule is present in a
DataNeedRuleSet the region connector supports multiple data needs for creating permission requests.The CESUJoinRequestDataNeedRule specifies that the region connector supports
CESUJoinRequestDataNeed.The InboundAiidaDataNeedRule specifies one supported variant of the
AiidaDataNeed.The OutboundAiidaDataNeedRule specifies one supported variant of the
AiidaDataNeed.This interface is used by the region connector to specify supported data need types and its configurations.
The ValidatedHistoricalDataDataNeedRule specifies one supported variant of the
ValidatedHistoricalDataDataNeed.This interface specifies all data need rules that are supported by a certain region connector.
The
DataNeedRuleSetRegistrar will be added to each region connector's own context and will
register the DataNeedRuleSet of each region connector to the common
DataNeedRuleSetRouter.DataNeedService that reads data needs from a JSON file.
Service interface for retrieving data needs.
Information about the data source such as the country code, the region connector id, the metered data administrator id and the permission administrator id.
Data source information for the German (DE) ETA Plus region connector.
CIM v0.82 Accounting Point provider for the German ETA Plus connector.
Spring configuration for the German (DE) ETA Plus region connector.
Configuration for the German (DE) ETA Plus region connector.
Main Spring Boot Application configuration for the German (DE) ETA Plus
region connector.
JPA repository for permission events in the German (DE) region connector.
Permission request implementation for Germany (ETA Plus).
Repository interface for DePermissionRequest.
JPA Persistence configuration for the German (DE) ETA Plus region connector.
CIM v0.82 Validated Historical Data provider for the German ETA Plus connector (backwards compatible).
CIM v1.04 Validated Historical Data provider for the German ETA Plus connector.
Enum representing the distributor codes as defined in the Datadis API.
This class is for processing incoming master data by mapping it to
AccountingPointEnvelopeThis interface defines the methods that must be provided by classes that facilitate the communication with EDA.
Creates EDA
GroupingId values.A custom
PermissionTimeframeStrategy that differentiates between energy community data needs and all others.This class is for processing incoming consumption records by mapping it to ValidatedHistoricalDataMarketDocuments and
emitting it for all matching permission requests
Record holding the description of an error that occurred when an API of EDDIE was called.
The main configuration for the Enedis region connector.
The main configuration for the Energinet region connector.
Class containing the possible response status codes from the Energinet API.
Accepted event for AccountingPointDataNeeds
Accepted event for ValidatedHistoricalDataNeeds
Implementation of the ESMP DateTime.
Implementation of the ESMP Time Interval.
Deserialised payload of the accounting-point response from the ETA+ backend.
Client for the ETA Plus API.
Health indicator reporting the reachability of the ETA Plus PA/MDA API.
Exceptions thrown by
EtaPlusApiClient
during API communication with the ETA Plus system.Thrown when the ETA Plus API responds with HTTP 401 or 403 due to invalid credentials.
Thrown when the ETA Plus API response body cannot be deserialized into the expected DTO.
Thrown when the ETA Plus API responds with HTTP 400 (Bad Request).
Thrown when the ETA Plus API responds with HTTP 403 (Forbidden) on a resource
the bearer should normally authorise.
Thrown when the ETA Plus API responds with HTTP 404 (Not Found) for a
requested resource.
Thrown when the ETA Plus API responds with a 5xx server error.
Thrown when the HTTP request to ETA Plus times out (connect or response timeout).
Metered data fetched from the ETA Plus historical-readings endpoint for a single metering point.
One reading element from the ETA Plus historical-readings response.
Thrown when persisting an event to the outbox fails.
Thrown when the ETA Plus API response cannot be mapped to the domain model.
Thrown when a permission request cannot be found in the DE-ETA repository.
Thrown when the ETA Plus API responds with HTTP 429 (Too Many Requests).
Shared wire-string-to-CIM mappings used by both v0.82 and v1.04 intermediate VHD documents.
Main Region Connector implementation for Germany (ETA Plus).
Metadata for the ETA Plus (Germany) region connector.
Polls validated historical data for retransmission requests from the ETA Plus API.
Interface for a simple EventBus implementation.
The interface for event handlers.
Fallback converter for XML messages.
Contains all currently possible Granularities supported by at least one region connector.
Performs the handshake with the EDDIE framework that created a permission request: fetching its details and
reporting whether it was accepted, rejected, or cannot be fulfilled.
Identifies the handshake endpoint of a permission request at the EDDIE framework, as contained in the AIIDA code.
Headers that can be used by outbound-connectors.
Registry that adds all health indicators from child contexts to the parent health indicator contributor registry.
Interface for all the classes that have a permission request and a payload, such as IdentifiableMeterReading.
Record that pairs a permission request with its corresponding validated historical data payload.
Published after an inbound permission was accepted to create its inbound data source.
Supported mechanisms for provisioning inbound data.
Exceptions which may indicate that some configurations are missing or invalid.
Postal address of the installation (PRM).
A marker interface to differentiate between events that should be propagated to the eligible party.
Replacement for the
JacksonJsonFormatMapper which only works for Jackson2 and not Jackson3.A
MessageSerde that serializes to JSON.Wrapper class to avoid having to add JOSE dependencies to a module just to be able to catch a
JOSEException.Contains the data of an
AiidaRecordInternal event used to track the latest meter reading for a permission request.
Event handler that checks for fulfillment when the latest meter reading is updated.
Event emitted when a permission request is malformed (validation failed).
This Spring Configuration modifies the embedded webserver by opening a second port for the management api.
Defines the available data service types.
A component that can convert the measurement of a validated historical data market document.
This class contains the message code for the various messages we receive / send to EDA.
Requests for Energy communities.
A serde is a SERializer-DEserializer, which supports one or multiple formats to serialize and deserialize objects to and from.
Annotation used for marking methods to indicate that they process or interact
with a specific type of message stream.
A centralized hub for managing message streams between providers and receivers.
Describes the concrete type used to deserialize a document.
The
MetadataServiceRegistrar should be added to each region connector's own context and will
register the RegionConnector of each region connector to the common MetadataService.This class represents the metering data returned by the Datadis API.
Filter metering data by permission request start and end date to ensure only the requested data is returned.
Represents all the data needed to request metering data from Datadis.
A permission request that stores date information about the latest meter reading that was pulled or received.
A min-max envelope connector allows the eligible party to send reference energy curve min-max operating envelopes to a certain region-connector.
This service routes min-max envelope messages between the region connectors.
The
MinMaxEnvelopeRouterRegistrar should be added to each region connector's own context and will
register the RegionConnector of each region connector to the common MinMaxEnvelopeRouter.The model is only used to define the simulation scenarios, but are never created during runtime.
Request for activating MQTT client provisioning.
Connection details returned after MQTT provisioning is configured.
This event is only used for the internal polling mechanism.
Mapping for all processes steps and message codes for the CMNotification.
This configuration should be used to override the object mapper that is passed to the child instances from the core parent context.
Represents the JSON that is received from the Oesterreichs Energie Smart Meter Adapter.
An opaque envelope connector allows the eligible party to send opaque envelopes with any payload to a certain region-connector.
This service routes opaque envelopes between the region connectors.
The
OpaqueEnvelopeRouterRegistrar should be added to each region connector's own context and will
register the RegionConnector of each region connector to the common OpaqueEnvelopeRouterRegistrar.Adds the OpenAPI documentation URLs of all enabled region connectors to the OpenAPI documentation in the current
context, so that they can be accessed in the "Select a definition" drop down menu.
Organization customer.
Denotes a class as an outbound-connector.
Annotation that indicates that the annotated class should be included in each context of a region connector.
Annotation, that allows Outbound Connectors to define a
SecurityFilterChain.Implementation of the outbox pattern.
This data transfer object is expected by the updatePermission API endpoint.
Details of a permission request that was fetched from the EDDIE framework and validated, but is not yet accepted
and therefore not persisted.
Permission control signal sent by the eligible party to a certain region connector.
Enables or disables transmission for a permission.
Terminates a permission, causing the region connector to stop transmitting data for it and clean up any associated resources.
Adjusts the default energy consumption or production limits for a permission.
Adjusts the transmission schedule for a permission.
A permission command connector allows the eligible party to send permission commands to a certain region-connector.
This service routes permission commands between the region connectors.
The
PermissionCommandRouterRegistrar should be added to each region connector's own context and will
register the RegionConnector of each region connector to the common PermissionCommandRouterRegistrar.Handles
PermissionCommands that the EP sends to a streamer.Representation of a persisted permission returned by the REST API.
The
PermissionEventRepositoryRegistrar should be added to each region connector's own context and will
register the PermissionEventRepository of each region connector to the common PermissionEventService.This class converts a
PermissionEvent to a CIM compliant document and provides them via a Flux.Thrown to indicate that no permission with the specified ID is saved in this AIIDA instance.
Implements the status of the Permission Process Model.
A PermissionRequest represents the starting point of requesting the permission for data from an MDA.
REST controller for handling permission request creation for the German (DE) ETA Plus region connector.
Service for creating permission requests for the German (DE) ETA Plus region
connector.
DTO for creating a new permission request for the German (DE) ETA Plus region connector.
Static state of a permission.
Base class for persistable permission events in the German (DE) region connector.
Natural person customer.
Used to poll validated historical data.
Polls validated historical data from the ETA Plus API for active permission requests.
This record defines all information needed for a PontonXPAdapter to establish a connection to a Ponton XP Messenger.
Request for changing the provisioning type of an inbound permission.
Request for activating a provisioning mode that needs no client-supplied connection details.
A record that holds the raw data as directly received from the MDA and some metadata information.
Factory for creating
RawDataMessage instancesThis annotation allows the core to find region connector implementations during classpath scanning.
A region connector connects MDAs to EDDIE.
The
RegionConnectorConnectorElementProvider creates an HTTP GET mapping for the connector element javascript
file for each individual region connector.Annotation that indicates that the annotated class should be included in each context of a region connector.
Metadata for a
RegionConnector.Rejects a permission request from an AIIDA code.
Wraps the request in a cached request, since it is not able to get the request body twice.
This record represents a response code from EDA in the context of "Consent Management".
This enumeration contains all well known response codes with description that might be returned by a DSO in Austria.
Plaintext API key returned once after an inbound REST credential is rotated.
Wires the retransmission feature for the German (ETA Plus) region connector.
A retransmission connector allows the eligible party to request retransmission of data for a specific timeframe from a region-connector.
The
RetransmissionRouterRegistrar should be added to each region connector's own context and will
register the RegionConnectorRetransmissionService of each region connector to the common CoreRetransmissionRouter.Representation of the functional blocks used by the green button
This class provides methods that create a security config for region-connectors that require a manuel response by the
final customers.
Reads the PRM segments of
situation_contrat_auto regardless of which of the documented
candidate shapes Enedis actually returns.Factory to create
MessageSerde instances.Authorization details of a subscribed service.
Request body of the subscribed services API (
POST /subscribed_services/v1).Response of the subscribed services API (
POST /subscribed_services/v1).Using this annotation on a class or interface of a Bean that is instantiated in a child context causes the
same Bean instance to be registered in the parent context as well.
BeanPostProcessor that checks for all beans whether it (or any ancestor interfaces of the Bean) is annotated
with Shared.Simple permission event for the German (DE) region connector.
The simulation context contains information, which is not available during the
Model creation, but during the runtime phase.The simulation engine is used to execute test simulations.
Internal event used to trigger polling for future data.
Defines a single step in a scenario.
Bundles the dependencies shared by every
AiidaStreamer implementation.The StreamerManager manages the lifecycle of
AiidaStreamer.Registrar for stream providers and suppliers within a Spring application context.
Reads
subscribed_power from situation_contrat_auto whether Enedis returns a bare
scalar ("6") or the power object its Swagger defines ({"unit": "kW",
"value": "6"}).A single subscribed service as returned by the subscribed services API.
This class represents the supply data returned by the Datadis API.
DTO used to represent the supported
dataNeeds for a specific regionConnectorIdOverwrites the SwaggerController path to consider the url mapping of a DispatcherServlet, instead of always using the
same URL.
This handler terminates all permissions that are not needed anymore.
A termination connector receives permission market documents, which are intended to terminate an already accepted permission request.
This service routes termination messages between the region connectors.
The
TerminationRouterRegistrar should be added to each region connector's own context and will
register the RegionConnector of each region connector to the common TerminationRouter.Wires the permission request timeout feature for the German (ETA Plus) region connector.
Configuration to set the timeouts of permission requests.
Utility class to track different document types that can be consumed or produced by eddie
All the supported data models
The recipient of a specific document.
The document types that can be consumed or produced by eddie.
This exception indicates that a connection or transmission error occurred.
Class to differentiate between the unit types, since they are grouped together.
Request body to assign the data source monitored for connection limit violations of a permission.
Request body to update the settings of the current user.
Response of the données générales API (
GET /donnees_generales_auto/v1/{usage_point_id}).Reads the données générales response whether Enedis wraps it in an array or sends a bare object.
Envelope for the données générales response, so the connector can read it whether Enedis sends an
array or a bare object.
Used to indicate that the authorization was updated and should include meters now.
Per-user settings of an AIIDA user.
Event emitted when a permission request is validated.
A data need designed to request validated historical data from the MDA.
Result type for the calculation of validated historical data data-needs.
Central stream for validated historical data from ETA Plus.
A
MessageSerde implementation that produces CIM compliant XML.