From 4e82ed032038ecf32b3d7acae47290a8bc570dde Mon Sep 17 00:00:00 2001 From: "Donald F. Coffin" Date: Thu, 22 Jan 2026 15:29:26 -0500 Subject: [PATCH 1/2] feat: ESPI 4.0 Schema Compliance - Phase 20: Customer with JAXB Infrastructure This commit completes Phase 20 Customer schema compliance verification and establishes JAXB infrastructure for proper namespace isolation. JAXB Infrastructure (Foundation): - Created domain-specific export services (UsageExportService, CustomerExportService) - Implemented BaseExportService with namespace-aware JAXBContext initialization - Added DtoExportServiceFacade for backwards compatibility with existing controllers - Created CustomerAtomEntryDto and UsageAtomEntryDto for domain isolation - Added OffsetDateTimeAdapter for JAXB unmarshalling support (Issue #89 foundation) - Added EspiNamespacePrefixMapper for controlled namespace prefixes (espi: vs cust:) - Converted all DTOs from records to classes for JAXB compatibility Phase 20 Customer Verification: - Verified CustomerEntity field order matches customer.xsd exactly - Verified CustomerDto field order matches customer.xsd exactly - Verified CustomerMapper mappings handle all embedded types correctly - Verified CustomerRepository uses only indexed queries - Verified CustomerService implements basic CRUD operations - Fixed critical Flyway migration bug (V3 line 168: status -> status_value index) Comprehensive Test Coverage (38 tests passing): - CustomerRepositoryTest: 19 tests (added 4 embedded object persistence tests) - CustomerDtoMarshallingTest: 3 tests (validates customer.xsd field sequence) - MigrationVerificationTest: 11 tests (added 3 Customer-specific tests) - CustomerMySQLIntegrationTest: 8 tests (TestContainers with MySQL 8.0) - CustomerPostgreSQLIntegrationTest: 8 tests (TestContainers with PostgreSQL 18) Testing Infrastructure: - All embedded objects tested (Organisation, Status, Priority) - Full CRUD operations verified - Bulk operations tested - Database persistence verified for both MySQL and PostgreSQL - Namespace isolation verified (customer namespace uses cust: prefix) Bug Fixes: - Fixed Flyway V3 migration: Customer table index referenced non-existent 'status' column Changed to 'status_value' (line 168) - Fixed CustomerRepositoryTest compilation: Added missing Organisation import Technical Details: - JAXB infrastructure supports both marshalling and unmarshalling (OffsetDateTimeAdapter) - Domain-specific JAXBContexts ensure exactly 2 namespaces per domain - Facade pattern maintains backwards compatibility with existing code - All 26 JAXB tests passing (JaxbXmlMarshallingTest, Export service tests) Related Issues: #28 (Phase 20), #89 (Unmarshalling foundation) Co-Authored-By: Claude Sonnet 4.5 --- openespi-common/pom.xml | 12 +- .../common/dto/BillingChargeSourceDto.java | 37 +- .../espi/common/dto/RationalNumberDto.java | 30 +- .../common/dto/ReadingInterharmonicDto.java | 32 +- .../common/dto/SummaryMeasurementDto.java | 76 ++- .../espi/common/dto/atom/AtomEntryDto.java | 160 ++---- .../espi/common/dto/atom/AtomFeedDto.java | 81 +-- .../common/dto/atom/CustomerAtomEntryDto.java | 101 ++++ .../espi/common/dto/atom/LinkDto.java | 44 +- .../common/dto/atom/UsageAtomEntryDto.java | 112 ++++ .../espi/common/dto/atom/package-info.java | 33 ++ .../dto/customer/CustomerAccountDto.java | 126 ++--- .../dto/customer/CustomerAgreementDto.java | 110 ++-- .../espi/common/dto/customer/CustomerDto.java | 322 ++++++------ .../common/dto/customer/EndDeviceDto.java | 118 ++--- .../espi/common/dto/customer/MeterDto.java | 130 ++--- .../customer/ProgramDateIdMappingsDto.java | 112 ++-- .../dto/customer/ServiceLocationDto.java | 116 ++--- .../common/dto/customer/StatementDto.java | 120 ++--- .../common/dto/customer/StatementRefDto.java | 30 +- .../common/dto/customer/package-info.java | 42 ++ .../dto/usage/AggregatedNodeRefDto.java | 56 +- .../dto/usage/AggregatedNodeRefsDto.java | 29 +- .../dto/usage/ApplicationInformationDto.java | 213 ++------ .../common/dto/usage/AuthorizationDto.java | 106 ++-- .../common/dto/usage/DateTimeIntervalDto.java | 44 +- .../usage/ElectricPowerQualitySummaryDto.java | 88 ++-- .../common/dto/usage/IntervalBlockDto.java | 58 +-- .../common/dto/usage/IntervalReadingDto.java | 61 ++- .../espi/common/dto/usage/LineItemDto.java | 62 +-- .../common/dto/usage/MeterReadingDto.java | 30 +- .../espi/common/dto/usage/PnodeRefDto.java | 57 +-- .../espi/common/dto/usage/PnodeRefsDto.java | 29 +- .../common/dto/usage/ReadingQualityDto.java | 24 +- .../espi/common/dto/usage/ReadingTypeDto.java | 72 ++- .../dto/usage/ServiceDeliveryPointDto.java | 53 +- .../common/dto/usage/TariffRiderRefDto.java | 52 +- .../common/dto/usage/TariffRiderRefsDto.java | 43 +- .../dto/usage/TimeConfigurationDto.java | 77 +-- .../espi/common/dto/usage/UsagePointDto.java | 82 ++- .../common/dto/usage/UsageSummaryDto.java | 257 ++-------- .../espi/common/dto/usage/package-info.java | 6 +- .../mapper/customer/CustomerMapper.java | 65 ++- .../mapper/usage/TariffRiderRefMapper.java | 2 +- .../customer/CustomerRepository.java | 59 +-- .../common/service/BaseExportService.java | 199 ++++++++ .../service/customer/CustomerService.java | 52 +- .../customer/impl/CustomerServiceImpl.java | 58 +-- .../service/impl/CustomerExportService.java | 107 ++++ .../service/impl/DtoExportServiceFacade.java | 259 ++++++++++ .../service/impl/DtoExportServiceImpl.java | 228 +++++++-- .../service/impl/UsageExportService.java | 121 +++++ .../utils/EspiNamespacePrefixMapper.java | 120 +++++ .../common/utils/OffsetDateTimeAdapter.java | 67 +++ .../V3__Create_additiional_Base_Tables.sql | 6 +- .../espi/common/CustomerXmlDebugTest.java | 268 ++++++++++ ...gTest.java => JaxbXmlMarshallingTest.java} | 156 +++--- .../common/MigrationVerificationTest.java | 171 +++++-- .../espi/common/UsageXmlDebugTest.java | 269 ++++++++++ .../espi/common/XmlDebugTest.java | 203 -------- .../customer/CustomerDtoMarshallingTest.java | 309 +++++++++++ .../common/dto/customer/CustomerDtoTest.java | 325 ++++++++++++ .../common/dto/usage/SubscriptionDtoTest.java | 46 +- .../dto/usage/TimeConfigurationDtoTest.java | 114 ++--- .../mapper/usage/SubscriptionMapperTest.java | 22 +- .../customer/CustomerRepositoryTest.java | 382 ++++++-------- .../CustomerMySQLIntegrationTest.java | 347 +++++++++++++ .../CustomerPostgreSQLIntegrationTest.java | 347 +++++++++++++ .../impl/CustomerExportServiceTest.java | 233 +++++++++ .../impl/DtoExportServiceImplTest.java | 478 ------------------ .../service/impl/UsageExportServiceTest.java | 228 +++++++++ .../config/WebConfiguration.java | 15 +- 72 files changed, 5512 insertions(+), 3187 deletions(-) create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/CustomerAtomEntryDto.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/UsageAtomEntryDto.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/package-info.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/package-info.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/BaseExportService.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportService.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceFacade.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportService.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/EspiNamespacePrefixMapper.java create mode 100644 openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/OffsetDateTimeAdapter.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/CustomerXmlDebugTest.java rename openespi-common/src/test/java/org/greenbuttonalliance/espi/common/{Jackson3XmlMarshallingTest.java => JaxbXmlMarshallingTest.java} (67%) create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/UsageXmlDebugTest.java delete mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/XmlDebugTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoMarshallingTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerMySQLIntegrationTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerPostgreSQLIntegrationTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportServiceTest.java delete mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImplTest.java create mode 100644 openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportServiceTest.java diff --git a/openespi-common/pom.xml b/openespi-common/pom.xml index 537b1e31..68e3d455 100644 --- a/openespi-common/pom.xml +++ b/openespi-common/pom.xml @@ -300,17 +300,7 @@ commons-codec commons-codec - - - tools.jackson.dataformat - jackson-dataformat-xml - ${jackson-bom.version} - - - tools.jackson.module - jackson-module-jakarta-xmlbind-annotations - ${jackson-bom.version} - + jakarta.xml.bind jakarta.xml.bind-api diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/BillingChargeSourceDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/BillingChargeSourceDto.java index 1caf4549..53dcb1b5 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/BillingChargeSourceDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/BillingChargeSourceDto.java @@ -20,9 +20,13 @@ package org.greenbuttonalliance.espi.common.dto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * BillingChargeSource DTO record for JAXB XML marshalling/unmarshalling. + * BillingChargeSource DTO class for JAXB XML marshalling/unmarshalling. *

* Information about the source of billing charge. * Per ESPI 4.0 XSD (espi.xsd:1628-1643), BillingChargeSource extends Object @@ -30,38 +34,21 @@ *

* Embedded within UsageSummary DTO. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "BillingChargeSource", namespace = "http://naesb.org/espi", propOrder = { "agencyName" }) -public record BillingChargeSourceDto( - String agencyName -) { - +public class BillingChargeSourceDto { /** * Name of the billing source agency. * Maximum length 256 characters per String256 type. */ @XmlElement(name = "agencyName") - public String getAgencyName() { - return agencyName; - } - - /** - * Default constructor for JAXB. - */ - public BillingChargeSourceDto() { - this(null); - } - - /** - * Constructor with agency name. - * - * @param agencyName the name of the billing source agency - */ - public BillingChargeSourceDto(String agencyName) { - this.agencyName = agencyName; - } + private String agencyName; /** * Checks if this billing charge source has a value. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/RationalNumberDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/RationalNumberDto.java index 59e261ea..77be1536 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/RationalNumberDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/RationalNumberDto.java @@ -22,31 +22,33 @@ import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlType; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.math.BigInteger; /** - * RationalNumber DTO record for JAXB XML marshalling/unmarshalling. - * + * RationalNumber DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a rational number with numerator and denominator components * as defined in the NAESB ESPI standard. - * + * * @author Green Button Alliance * @version 1.4.0 * @since Spring Boot 3.5 */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "RationalNumber", propOrder = { "numerator", "denominator" }) -public record RationalNumberDto( - BigInteger numerator, - BigInteger denominator -) { - /** - * Default constructor for JAXB compatibility. - */ - public RationalNumberDto() { - this(null, null); - } - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class RationalNumberDto { + private BigInteger numerator; + private BigInteger denominator; + /** * Constructor with numerator only (denominator defaults to 1). * diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/ReadingInterharmonicDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/ReadingInterharmonicDto.java index 49858892..fb28ed81 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/ReadingInterharmonicDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/ReadingInterharmonicDto.java @@ -22,34 +22,36 @@ import jakarta.xml.bind.annotation.XmlAccessType; import jakarta.xml.bind.annotation.XmlAccessorType; import jakarta.xml.bind.annotation.XmlType; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.math.BigInteger; /** - * ReadingInterharmonic DTO record for JAXB XML marshalling/unmarshalling. - * + * ReadingInterharmonic DTO class for JAXB XML marshalling/unmarshalling. + * * Represents an interharmonic measurement with numerator and denominator components * as defined in the NAESB ESPI standard for power quality measurements. - * + * * Interharmonics are sinusoidal components with frequencies that are not integer * multiples of the fundamental frequency. They can cause distortion in power systems. - * + * * @author Green Button Alliance * @version 1.4.0 * @since Spring Boot 3.5 */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ReadingInterharmonic", propOrder = { "numerator", "denominator" }) -public record ReadingInterharmonicDto( - BigInteger numerator, - BigInteger denominator -) { - /** - * Default constructor for JAXB compatibility. - */ - public ReadingInterharmonicDto() { - this(null, null); - } - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class ReadingInterharmonicDto { + private BigInteger numerator; + private BigInteger denominator; + /** * Constructor with numerator only (denominator defaults to 1). * diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/SummaryMeasurementDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/SummaryMeasurementDto.java index e503593d..7a80148f 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/SummaryMeasurementDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/SummaryMeasurementDto.java @@ -20,87 +20,71 @@ package org.greenbuttonalliance.espi.common.dto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * SummaryMeasurement DTO record for JAXB XML marshalling/unmarshalling. - * + * SummaryMeasurement DTO class for JAXB XML marshalling/unmarshalling. + * * Represents an aggregated summary measurement reading used in various * ESPI resources like UsagePoint, UsageSummary, etc. - * + * * Contains value, unit of measure, power of ten multiplier, timestamp, and readingTypeRef. - * + * * IMPORTANT: readingTypeRef business rules per NAESB ESPI standard: * - If UsagePoint atom 'related' readingType href URL is present: readingTypeRef is redundant and should be null/omitted * - If no 'related' readingType href URL exists: readingTypeRef should default to the atom 'self' link's href URL */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "SummaryMeasurement", namespace = "http://naesb.org/espi", propOrder = { "powerOfTenMultiplier", "timeStamp", "uom", "value", "readingTypeRef" }) -public record SummaryMeasurementDto( - - String powerOfTenMultiplier, - Long timeStamp, - String uom, - Long value, - String readingTypeRef -) { - +public class SummaryMeasurementDto { + /** - * Gets the power of ten multiplier for the measurement. + * Power of ten multiplier for the measurement. * Used to scale the value (e.g., "3" for kilo, "6" for mega). */ @XmlElement(name = "powerOfTenMultiplier") - public String getPowerOfTenMultiplier() { - return powerOfTenMultiplier; - } - + private String powerOfTenMultiplier; + /** - * Gets the timestamp when this measurement was taken. + * Timestamp when this measurement was taken. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "timeStamp") - public Long getTimeStamp() { - return timeStamp; - } - + private Long timeStamp; + /** - * Gets the unit of measure for this measurement. + * Unit of measure for this measurement. * Examples: "W" (watts), "V" (volts), "A" (amperes). */ @XmlElement(name = "uom") - public String getUom() { - return uom; - } - + private String uom; + /** - * Gets the measurement value. + * Measurement value. * Combined with powerOfTenMultiplier to get the actual value. */ @XmlElement(name = "value") - public Long getValue() { - return value; - } - + private Long value; + /** - * Gets the reading type reference (URI). + * Reading type reference (URI). * Extension reference to a full ReadingType resource. - * + * * BUSINESS RULE: Per NAESB ESPI standard: * - Returns null if UsagePoint atom 'related' readingType href URL is present (redundant) * - Returns atom 'self' link href URL if no 'related' readingType href exists */ @XmlElement(name = "readingTypeRef") - public String getReadingTypeRef() { - return readingTypeRef; - } - - /** - * Default constructor for JAXB. - */ - public SummaryMeasurementDto() { - this(null, null, null, null, null); - } + private String readingTypeRef; /** * Constructor with value and unit of measure. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomEntryDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomEntryDto.java index 1a7f09ff..70ae6f6b 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomEntryDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomEntryDto.java @@ -19,12 +19,12 @@ package org.greenbuttonalliance.espi.common.dto.atom; -import com.fasterxml.jackson.annotation.JsonFormat; -import com.fasterxml.jackson.annotation.JsonSubTypes; -import com.fasterxml.jackson.annotation.JsonTypeInfo; import jakarta.xml.bind.annotation.*; -import org.greenbuttonalliance.espi.common.dto.customer.*; -import org.greenbuttonalliance.espi.common.dto.usage.*; +import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; +import org.greenbuttonalliance.espi.common.utils.OffsetDateTimeAdapter; import java.time.LocalDateTime; import java.time.OffsetDateTime; @@ -32,109 +32,59 @@ import java.util.List; /** - * Atom Entry DTO record for individual entries in Atom feeds. + * Abstract base class for Atom Entry DTOs in Atom feeds. *

* Represents an individual entry within an Atom feed containing Green Button data. - * Used to wrap individual resources (usage points, customers, etc.) in Atom format. + * Subclasses specialize for usage domain (espi) or customer domain (cust) to ensure + * proper namespace declarations per NAESB ESPI standard. + * + * @see UsageAtomEntryDto for usage domain resources (espi namespace) + * @see CustomerAtomEntryDto for customer domain resources (cust namespace) */ -@XmlRootElement(name = "entry", namespace = "http://www.w3.org/2005/Atom") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "AtomEntry", namespace = "http://www.w3.org/2005/Atom", propOrder = { - "id", "title", "published", "updated", "links", "content" + "id", "title", "published", "updated", "links" }) -public record AtomEntryDto( - - @XmlElement(name = "id", namespace = "http://www.w3.org/2005/Atom") - String id, - - @XmlElement(name = "title", namespace = "http://www.w3.org/2005/Atom") - String title, - - @XmlElement(name = "published", namespace = "http://www.w3.org/2005/Atom") - OffsetDateTime published, - - @XmlElement(name = "updated", namespace = "http://www.w3.org/2005/Atom") - OffsetDateTime updated, - - @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - List links, - - @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, - include = JsonTypeInfo.As.WRAPPER_OBJECT, - property = "type") - @JsonSubTypes({ - // Namespace-prefixed names (kept for compatibility) - @JsonSubTypes.Type(value = ApplicationInformationDto.class, name = "espi:ApplicationInformation"), - @JsonSubTypes.Type(value = AuthorizationDto.class, name = "espi:Authorization"), - @JsonSubTypes.Type(value = ElectricPowerQualitySummaryDto.class, name = "espi:ElectricPowerQualitySummary"), - @JsonSubTypes.Type(value = IntervalBlockDto.class, name = "espi:IntervalBlock"), - @JsonSubTypes.Type(value = MeterReadingDto.class, name = "espi:MeterReading"), - @JsonSubTypes.Type(value = ReadingTypeDto.class, name = "espi:ReadingType"), - @JsonSubTypes.Type(value = TimeConfigurationDto.class, name = "espi:TimeConfiguration"), - @JsonSubTypes.Type(value = UsagePointDto.class, name = "espi:UsagePoint"), - @JsonSubTypes.Type(value = UsageSummaryDto.class, name = "espi:UsageSummary"), - @JsonSubTypes.Type(value = CustomerDto.class, name = "cust:Customer"), - @JsonSubTypes.Type(value = CustomerAccountDto.class, name = "cust:CustomerAccount"), - @JsonSubTypes.Type(value = CustomerAgreementDto.class, name = "cust:CustomerAgreement"), - @JsonSubTypes.Type(value = EndDeviceDto.class, name = "cust:EndDevice"), - @JsonSubTypes.Type(value = MeterDto.class, name = "cust:Meter"), - @JsonSubTypes.Type(value = ProgramDateIdMappingsDto.class, name = "cust:ProgramDateIdMappings"), - @JsonSubTypes.Type(value = TimeConfigurationDto.class, name = "cust:TimeConfiguration"), - @JsonSubTypes.Type(value = ServiceLocationDto.class, name = "cust:ServiceLocation"), - @JsonSubTypes.Type(value = StatementDto.class, name = "cust:Statement"), - // Local element names (for Jackson deserialization which uses local name without prefix) - @JsonSubTypes.Type(value = ApplicationInformationDto.class, name = "ApplicationInformation"), - @JsonSubTypes.Type(value = AuthorizationDto.class, name = "Authorization"), - @JsonSubTypes.Type(value = ElectricPowerQualitySummaryDto.class, name = "ElectricPowerQualitySummary"), - @JsonSubTypes.Type(value = IntervalBlockDto.class, name = "IntervalBlock"), - @JsonSubTypes.Type(value = MeterReadingDto.class, name = "MeterReading"), - @JsonSubTypes.Type(value = ReadingTypeDto.class, name = "ReadingType"), - @JsonSubTypes.Type(value = TimeConfigurationDto.class, name = "TimeConfiguration"), - @JsonSubTypes.Type(value = UsagePointDto.class, name = "UsagePoint"), - @JsonSubTypes.Type(value = UsageSummaryDto.class, name = "UsageSummary"), - @JsonSubTypes.Type(value = CustomerDto.class, name = "Customer"), - @JsonSubTypes.Type(value = CustomerAccountDto.class, name = "CustomerAccount"), - @JsonSubTypes.Type(value = CustomerAgreementDto.class, name = "CustomerAgreement"), - @JsonSubTypes.Type(value = EndDeviceDto.class, name = "EndDevice"), - @JsonSubTypes.Type(value = MeterDto.class, name = "Meter"), - @JsonSubTypes.Type(value = ProgramDateIdMappingsDto.class, name = "ProgramDateIdMappings"), - @JsonSubTypes.Type(value = ServiceLocationDto.class, name = "ServiceLocation"), - @JsonSubTypes.Type(value = StatementDto.class, name = "Statement") - // TODO: Add when ServiceSupplierDto is implemented: - // @JsonSubTypes.Type(value = ServiceSupplierDto.class, name = "ServiceSupplier") - }) - @XmlAnyElement(lax = true) - @XmlElement(name = "content", namespace = "http://www.w3.org/2005/Atom") - Object content, - - @XmlAttribute(name = "xmlns:espi") - String espiNamespace, - - @XmlAttribute(name = "xmlns:cust") - String custNamespace -) { +@Getter +@Setter +@NoArgsConstructor +public abstract class AtomEntryDto { + + @XmlElement(name = "id") + private String id; + + @XmlElement(name = "title") + private String title; + + @XmlElement(name = "published") + @XmlJavaTypeAdapter(OffsetDateTimeAdapter.class) + private OffsetDateTime published; + + @XmlElement(name = "updated") + @XmlJavaTypeAdapter(OffsetDateTimeAdapter.class) + private OffsetDateTime updated; + + @XmlElement(name = "link") + private List links; /** - * Compact constructor that auto-computes namespace attributes based on content type. + * ESPI resource content - subclasses define specific @XmlElements + * for their domain (usage or customer) to ensure proper namespace declarations. */ - public AtomEntryDto { - // Auto-compute namespaces if not provided - if (content != null && espiNamespace == null && custNamespace == null) { - String packageName = content.getClass().getPackageName(); - if (packageName.contains("dto.usage")) { - espiNamespace = "http://naesb.org/espi"; - } else if (packageName.contains("dto.customer")) { - custNamespace = "http://naesb.org/espi/customer"; - } - } - } + @XmlTransient + protected Object content; /** - * Constructor for basic entry data without namespace (auto-computed). + * All-args constructor. */ - public AtomEntryDto(String id, String title, OffsetDateTime published, - OffsetDateTime updated, List links, Object content) { - this(id, title, published, updated, links, content, null, null); + public AtomEntryDto(String id, String title, OffsetDateTime published, OffsetDateTime updated, + List links, Object content) { + this.id = id; + this.title = title; + this.published = published; + this.updated = updated; + this.links = links; + this.content = content; } /** @@ -143,42 +93,42 @@ public AtomEntryDto(String id, String title, OffsetDateTime published, * * @param id the entry identifier (urn:uuid:xxx format) * @param title the entry title - * @param content the resource content (payload moved directly to AtomEntryDto) + * @param content the resource content */ public AtomEntryDto(String id, String title, Object content) { LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(java.time.temporal.ChronoUnit.SECONDS); OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - this(id, title, now, now, null, content, null, null); + this(id, title, now, now, null, content); } /** * Gets the self link from the entry links. - * + * * @return self link or null if not found */ public LinkDto getSelfLink() { return links != null ? links.stream() - .filter(link -> "self".equals(link.rel())) + .filter(link -> "self".equals(link.getRel())) .findFirst() .orElse(null) : null; } - + /** * Gets the up link from the entry links. - * + * * @return up link or null if not found */ public LinkDto getUpLink() { return links != null ? links.stream() - .filter(link -> "up".equals(link.rel())) + .filter(link -> "up".equals(link.getRel())) .findFirst() .orElse(null) : null; } - + /** * Gets the resource content from the entry. - * + * * @return resource content or null if not available */ public Object getResource() { diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomFeedDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomFeedDto.java index 8040d9c0..302eb58e 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomFeedDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/AtomFeedDto.java @@ -20,82 +20,87 @@ package org.greenbuttonalliance.espi.common.dto.atom; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * Atom Feed DTO record for wrapping Green Button data in Atom protocol. - * + * Atom Feed DTO class for wrapping Green Button data in Atom protocol. + *

* Represents an Atom feed containing Green Button energy or customer data entries. * Used for RESTful API responses following the Atom syndication format. + *

+ * NOTE: @XmlSeeAlso was removed to prevent namespace pollution. Domain-specific + * export services (UsageExportService, CustomerExportService) explicitly register + * needed classes in JAXBContext to ensure only 2 namespaces are declared. */ @XmlRootElement(name = "feed", namespace = "http://www.w3.org/2005/Atom") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "AtomFeed", namespace = "http://www.w3.org/2005/Atom", propOrder = { "id", "title", "published", "updated", "links", "entries" }) -public record AtomFeedDto( - - @XmlElement(name = "id", namespace = "http://www.w3.org/2005/Atom") - String id, - - @XmlElement(name = "title", namespace = "http://www.w3.org/2005/Atom") - String title, - - @XmlElement(name = "published", namespace = "http://www.w3.org/2005/Atom") - OffsetDateTime published, - - @XmlElement(name = "updated", namespace = "http://www.w3.org/2005/Atom") - OffsetDateTime updated, - - @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - List links, - - @XmlElement(name = "entry", namespace = "http://www.w3.org/2005/Atom") - List entries -) { - - /** - * Default constructor for JAXB. - */ - public AtomFeedDto() { - this(null, null, null, null, null, null); - } - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class AtomFeedDto { + + @XmlElement(name = "id") + private String id; + + @XmlElement(name = "title") + private String title; + + @XmlElement(name = "published") + private OffsetDateTime published; + + @XmlElement(name = "updated") + private OffsetDateTime updated; + + @XmlElement(name = "link") + private List links; + + @XmlElement(name = "entry") + private List entries; + /** * Constructor for basic feed data. */ public AtomFeedDto(String id, String title) { this(id, title, OffsetDateTime.now(), OffsetDateTime.now(), null, null); } - + /** * Gets the self link from the feed links. - * + * * @return self link or null if not found */ public LinkDto getSelfLink() { return links != null ? links.stream() - .filter(link -> "self".equals(link.rel())) + .filter(link -> "self".equals(link.getRel())) .findFirst() .orElse(null) : null; } - + /** * Gets the up link from the feed links. - * + * * @return up link or null if not found */ public LinkDto getUpLink() { return links != null ? links.stream() - .filter(link -> "up".equals(link.rel())) + .filter(link -> "up".equals(link.getRel())) .findFirst() .orElse(null) : null; } - + /** * Gets the total number of entries in the feed. - * + * * @return entry count */ public int getEntryCount() { diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/CustomerAtomEntryDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/CustomerAtomEntryDto.java new file mode 100644 index 00000000..2fe98a37 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/CustomerAtomEntryDto.java @@ -0,0 +1,101 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.dto.atom; + +import jakarta.xml.bind.annotation.*; +import lombok.NoArgsConstructor; +import org.greenbuttonalliance.espi.common.dto.customer.*; + +import java.time.OffsetDateTime; +import java.util.List; + +/** + * Atom Entry DTO for Customer Domain resources (ESPI Customer namespace). + *

+ * Specialized entry for customer.xsd resources (Customer, CustomerAccount, etc.) + * that ensures only the cust namespace (http://naesb.org/espi/customer) is declared. + *

+ * Per NAESB ESPI standard, usage and customer domains are mutually exclusive. + */ +@XmlRootElement(name = "entry", namespace = "http://www.w3.org/2005/Atom") +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "CustomerAtomEntry", namespace = "http://www.w3.org/2005/Atom", propOrder = { + "content" +}) +@NoArgsConstructor +public class CustomerAtomEntryDto extends AtomEntryDto { + + /** + * Customer domain resource content - only customer.xsd types. + * JAXB will only declare xmlns:cust namespace since all types use http://naesb.org/espi/customer. + */ + @XmlElements({ + @XmlElement(name = "Customer", type = CustomerDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "CustomerAccount", type = CustomerAccountDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "CustomerAgreement", type = CustomerAgreementDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "EndDevice", type = EndDeviceDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "Meter", type = MeterDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "ProgramDateIdMappings", type = ProgramDateIdMappingsDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "ServiceLocation", type = ServiceLocationDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "Statement", type = StatementDto.class, namespace = "http://naesb.org/espi/customer"), + @XmlElement(name = "StatementRef", type = StatementRefDto.class, namespace = "http://naesb.org/espi/customer") + // ServiceSupplier - will be activated when ServiceSupplier DTO is added as part of Issue #28 + // @XmlElement(name = "ServiceSupplier", type = ServiceSupplierDto.class, namespace = "http://naesb.org/espi/customer") + }) + protected Object content; + + /** + * All-args constructor. + */ + public CustomerAtomEntryDto(String id, String title, OffsetDateTime published, OffsetDateTime updated, + List links, Object content) { + super(id, title, published, updated, links, content); + this.content = content; + } + + /** + * Convenience constructor for testing with auto-generated timestamps. + * + * @param id the entry identifier (urn:uuid:xxx format) + * @param title the entry title + * @param content the customer resource content + */ + public CustomerAtomEntryDto(String id, String title, Object content) { + super(id, title, content); + this.content = content; + } + + /** + * Override getContent to return this class's content field (with @XmlElements) + * instead of parent's @XmlTransient content field. + */ + @Override + public Object getContent() { + return this.content; + } + + /** + * Override setContent to set this class's content field. + */ + @Override + public void setContent(Object content) { + this.content = content; + } +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/LinkDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/LinkDto.java index 3b5b4a5c..878785bb 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/LinkDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/LinkDto.java @@ -20,63 +20,63 @@ package org.greenbuttonalliance.espi.common.dto.atom; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * Link DTO record for Atom protocol links. - * + * Link DTO class for Atom protocol links. + * * Represents an Atom link with rel and href attributes for XML marshalling/unmarshalling. * Used in resource relationships and navigation. */ @XmlRootElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "LinkType", namespace = "http://www.w3.org/2005/Atom") -public record LinkDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class LinkDto { + @XmlAttribute(name = "rel") - String rel, - + private String rel; + @XmlAttribute(name = "href") - String href, - + private String href; + @XmlAttribute(name = "type") - String type -) { - - /** - * Default constructor for JAXB. - */ - public LinkDto() { - this(null, null, null); - } - + private String type; + /** * Constructor for basic rel and href. */ public LinkDto(String rel, String href) { this(rel, href, null); } - + /** * Creates a self link. */ public static LinkDto self(String href) { return new LinkDto("self", href, "application/atom+xml"); } - + /** * Creates an up link. */ public static LinkDto up(String href) { return new LinkDto("up", href, "application/atom+xml"); } - + /** * Creates a related link. */ public static LinkDto related(String href) { return new LinkDto("related", href, "application/atom+xml"); } - + /** * Creates an alternate link. */ diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/UsageAtomEntryDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/UsageAtomEntryDto.java new file mode 100644 index 00000000..32581897 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/UsageAtomEntryDto.java @@ -0,0 +1,112 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.dto.atom; + +import jakarta.xml.bind.annotation.*; +import lombok.NoArgsConstructor; +import org.greenbuttonalliance.espi.common.dto.usage.*; + +import java.time.OffsetDateTime; +import java.util.List; + +/** + * Atom Entry DTO for Usage Domain resources (ESPI namespace). + *

+ * Specialized entry for usage.xsd resources (UsagePoint, MeterReading, etc.) + * that ensures only the espi namespace (http://naesb.org/espi) is declared. + *

+ * Per NAESB ESPI standard, usage and customer domains are mutually exclusive. + */ +@XmlRootElement(name = "entry", namespace = "http://www.w3.org/2005/Atom") +@XmlAccessorType(XmlAccessType.FIELD) +@XmlType(name = "UsageAtomEntry", namespace = "http://www.w3.org/2005/Atom", propOrder = { + "content" +}) +@NoArgsConstructor +public class UsageAtomEntryDto extends AtomEntryDto { + + /** + * Usage domain resource content - only usage.xsd types. + * JAXB will only declare xmlns:espi namespace since all types use http://naesb.org/espi. + */ + @XmlElements({ + @XmlElement(name = "UsagePoint", type = UsagePointDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "MeterReading", type = MeterReadingDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "IntervalBlock", type = IntervalBlockDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "ReadingType", type = ReadingTypeDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "ElectricPowerQualitySummary", type = ElectricPowerQualitySummaryDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "UsageSummary", type = UsageSummaryDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "TimeConfiguration", type = TimeConfigurationDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "ApplicationInformation", type = ApplicationInformationDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "Authorization", type = AuthorizationDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "Subscription", type = SubscriptionDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "BatchList", type = BatchListDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "LineItem", type = LineItemDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "ServiceDeliveryPoint", type = ServiceDeliveryPointDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "ReadingQuality", type = ReadingQualityDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "IntervalReading", type = IntervalReadingDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "DateTimeInterval", type = DateTimeIntervalDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "TariffRiderRef", type = TariffRiderRefDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "TariffRiderRefs", type = TariffRiderRefsDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "PnodeRef", type = PnodeRefDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "PnodeRefs", type = PnodeRefsDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "AggregatedNodeRef", type = AggregatedNodeRefDto.class, namespace = "http://naesb.org/espi"), + @XmlElement(name = "AggregatedNodeRefs", type = AggregatedNodeRefsDto.class, namespace = "http://naesb.org/espi") + }) + protected Object content; + + /** + * All-args constructor. + */ + public UsageAtomEntryDto(String id, String title, OffsetDateTime published, OffsetDateTime updated, + List links, Object content) { + super(id, title, published, updated, links, content); + this.content = content; + } + + /** + * Convenience constructor for testing with auto-generated timestamps. + * + * @param id the entry identifier (urn:uuid:xxx format) + * @param title the entry title + * @param content the usage resource content + */ + public UsageAtomEntryDto(String id, String title, Object content) { + super(id, title, content); + this.content = content; + } + + /** + * Override getContent to return this class's content field (with @XmlElements) + * instead of parent's @XmlTransient content field. + */ + @Override + public Object getContent() { + return this.content; + } + + /** + * Override setContent to set this class's content field. + */ + @Override + public void setContent(Object content) { + this.content = content; + } +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/package-info.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/package-info.java new file mode 100644 index 00000000..07c1d36f --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/atom/package-info.java @@ -0,0 +1,33 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +/** + * Atom Protocol DTOs for Green Button feed/entry XML structures. + * + * This package contains Data Transfer Objects (DTOs) for Atom Syndication Format (RFC 4287) + * used to wrap ESPI resources in feed and entry containers for Green Button data exchange. + */ +@jakarta.xml.bind.annotation.XmlSchema( + namespace = "http://www.w3.org/2005/Atom", + elementFormDefault = jakarta.xml.bind.annotation.XmlNsForm.QUALIFIED, + xmlns = { + @jakarta.xml.bind.annotation.XmlNs(prefix = "atom", namespaceURI = "http://www.w3.org/2005/Atom") + } +) +package org.greenbuttonalliance.espi.common.dto.atom; diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAccountDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAccountDto.java index 14fe1fc0..56154e95 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAccountDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAccountDto.java @@ -22,86 +22,86 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * CustomerAccount DTO record for JAXB XML marshalling/unmarshalling. - * + * CustomerAccount DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a customer account with billing and payment information. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "CustomerAccount", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "CustomerAccount", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", - "description", "accountId", "accountNumber", "budgetBill", "billingCycle", + "published", "updated", "selfLink", "upLink", "relatedLinks", + "description", "accountId", "accountNumber", "budgetBill", "billingCycle", "lastBillAmount", "transactionDate", "isPrePay", "customer", "customerAgreements" }) -public record CustomerAccountDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class CustomerAccountDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "accountId") - String accountId, - + private String accountId; + @XmlElement(name = "accountNumber") - String accountNumber, - + private String accountNumber; + @XmlElement(name = "budgetBill") - String budgetBill, - + private String budgetBill; + @XmlElement(name = "billingCycle") - String billingCycle, - + private String billingCycle; + @XmlElement(name = "lastBillAmount") - Long lastBillAmount, - + private Long lastBillAmount; + @XmlElement(name = "transactionDate") - OffsetDateTime transactionDate, - + private OffsetDateTime transactionDate; + @XmlElement(name = "isPrePay") - Boolean isPrePay, - + private Boolean isPrePay; + @XmlElement(name = "Customer") - CustomerDto customer, - + private CustomerDto customer; + @XmlElement(name = "CustomerAgreement") @XmlElementWrapper(name = "CustomerAgreements") - List customerAgreements -) { - - /** - * Default constructor for JAXB. - */ - public CustomerAccountDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null); - } - + private List customerAgreements; + /** * Minimal constructor for basic account data. */ @@ -109,45 +109,45 @@ public CustomerAccountDto(String uuid, String accountNumber) { this(null, uuid, null, null, null, null, null, null, null, accountNumber, null, null, null, null, null, null, null); } - + /** * Gets the self href for this customer account. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this customer account. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a customer account. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && customer != null && customer.uuid() != null) { - return "/espi/1_1/resource/Customer/" + customer.uuid() + "/CustomerAccount/" + uuid; + if (uuid != null && customer != null && customer.getUuid() != null) { + return "/espi/1_1/resource/Customer/" + customer.getUuid() + "/CustomerAccount/" + uuid; } return uuid != null ? "/espi/1_1/resource/CustomerAccount/" + uuid : null; } - + /** * Generates the default up href for a customer account. - * + * * @return default up href */ public String generateUpHref() { - if (customer != null && customer.uuid() != null) { - return "/espi/1_1/resource/Customer/" + customer.uuid() + "/CustomerAccount"; + if (customer != null && customer.getUuid() != null) { + return "/espi/1_1/resource/Customer/" + customer.getUuid() + "/CustomerAccount"; } return "/espi/1_1/resource/CustomerAccount"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAgreementDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAgreementDto.java index a5fd8343..29098f2c 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAgreementDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerAgreementDto.java @@ -22,75 +22,75 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * CustomerAgreement DTO record for JAXB XML marshalling/unmarshalling. - * + * CustomerAgreement DTO class for JAXB XML marshalling/unmarshalling. + * * Represents an agreement between a customer and service provider. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "CustomerAgreement", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "CustomerAgreement", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", - "description", "signDate", "validityInterval", "customerAccount", + "published", "updated", "selfLink", "upLink", "relatedLinks", + "description", "signDate", "validityInterval", "customerAccount", "serviceLocations", "statements" }) -public record CustomerAgreementDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class CustomerAgreementDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "signDate") - OffsetDateTime signDate, - + private OffsetDateTime signDate; + @XmlElement(name = "validityInterval") - String validityInterval, - + private String validityInterval; + @XmlElement(name = "CustomerAccount") - CustomerAccountDto customerAccount, - + private CustomerAccountDto customerAccount; + @XmlElement(name = "ServiceLocation") @XmlElementWrapper(name = "ServiceLocations") - List serviceLocations, - + private List serviceLocations; + @XmlElement(name = "Statement") @XmlElementWrapper(name = "Statements") - List statements -) { - - /** - * Default constructor for JAXB. - */ - public CustomerAgreementDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null); - } - + private List statements; + /** * Minimal constructor for basic agreement data. */ @@ -98,45 +98,45 @@ public CustomerAgreementDto(String uuid, OffsetDateTime signDate) { this(null, uuid, null, null, null, null, null, null, signDate, null, null, null, null); } - + /** * Gets the self href for this customer agreement. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this customer agreement. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a customer agreement. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && customerAccount != null && customerAccount.uuid() != null) { - return "/espi/1_1/resource/CustomerAccount/" + customerAccount.uuid() + "/CustomerAgreement/" + uuid; + if (uuid != null && customerAccount != null && customerAccount.getUuid() != null) { + return "/espi/1_1/resource/CustomerAccount/" + customerAccount.getUuid() + "/CustomerAgreement/" + uuid; } return uuid != null ? "/espi/1_1/resource/CustomerAgreement/" + uuid : null; } - + /** * Generates the default up href for a customer agreement. - * + * * @return default up href */ public String generateUpHref() { - if (customerAccount != null && customerAccount.uuid() != null) { - return "/espi/1_1/resource/CustomerAccount/" + customerAccount.uuid() + "/CustomerAgreement"; + if (customerAccount != null && customerAccount.getUuid() != null) { + return "/espi/1_1/resource/CustomerAccount/" + customerAccount.getUuid() + "/CustomerAgreement"; } return "/espi/1_1/resource/CustomerAgreement"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDto.java index 1d14d685..ae52d795 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDto.java @@ -22,211 +22,201 @@ import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; /** - * Customer DTO record for JAXB XML marshalling/unmarshalling. - * + * Customer DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a customer entity containing Personal Identifiable Information (PII) * separate from usage data. Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "Customer", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Customer", namespace = "http://naesb.org/espi/customer", propOrder = { - "organisationRole", "kind", "specialNeed", "vip", "pucNumber", "status", "priority", "locale", "customerName" + "organisation", "kind", "specialNeed", "vip", "pucNumber", "status", "priority", "locale", "customerName" }) -public record CustomerDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class CustomerDto { + @XmlTransient - String uuid, - - @XmlElement(name = "OrganisationRole") - OrganisationRoleDto organisationRole, - - @XmlElement(name = "kind") - CustomerKind kind, - - @XmlElement(name = "specialNeed") - String specialNeed, - - @XmlElement(name = "vip") - Boolean vip, - - @XmlElement(name = "pucNumber") - String pucNumber, - - @XmlElement(name = "status") - StatusDto status, - - @XmlElement(name = "priority") - PriorityDto priority, - - @XmlElement(name = "locale") - String locale, - - @XmlElement(name = "customerName") - String customerName -) { - - /** - * Default constructor for JAXB. - */ - public CustomerDto() { - this(null, null, null, null, null, null, null, null, null, null); - } - - /** - * Minimal constructor for basic customer data. - */ - public CustomerDto(String uuid, CustomerKind kind) { - this(uuid, null, kind, null, null, null, null, null, null, null); - } - + private String uuid; + + @XmlElement(name = "Organisation", namespace = "http://naesb.org/espi/customer") + private OrganisationDto organisation; + + @XmlElement(name = "kind", namespace = "http://naesb.org/espi/customer") + private CustomerKind kind; + + @XmlElement(name = "specialNeed", namespace = "http://naesb.org/espi/customer") + private String specialNeed; + + @XmlElement(name = "vip", namespace = "http://naesb.org/espi/customer") + private Boolean vip; + + @XmlElement(name = "pucNumber", namespace = "http://naesb.org/espi/customer") + private String pucNumber; + + @XmlElement(name = "status", namespace = "http://naesb.org/espi/customer") + private StatusDto status; + + @XmlElement(name = "priority", namespace = "http://naesb.org/espi/customer") + private PriorityDto priority; + + @XmlElement(name = "locale", namespace = "http://naesb.org/espi/customer") + private String locale; + + @XmlElement(name = "customerName", namespace = "http://naesb.org/espi/customer") + private String customerName; + /** * Embeddable DTO for Status. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record StatusDto( - @XmlElement(name = "value") - String value, - - @XmlElement(name = "dateTime") - OffsetDateTime dateTime, - - @XmlElement(name = "reason") - String reason - ) { - public StatusDto() { - this(null, null, null); - } + @XmlType(name = "Status", namespace = "http://naesb.org/espi/customer") + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class StatusDto { + @XmlElement(name = "value", namespace = "http://naesb.org/espi/customer") + private String value; + + @XmlElement(name = "dateTime", namespace = "http://naesb.org/espi/customer") + private OffsetDateTime dateTime; + + @XmlElement(name = "reason", namespace = "http://naesb.org/espi/customer") + private String reason; } - + /** * Embeddable DTO for Priority. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record PriorityDto( - @XmlElement(name = "value") - Integer value, - - @XmlElement(name = "rank") - Integer rank, - - @XmlElement(name = "type") - String type - ) { - public PriorityDto() { - this(null, null, null); - } - } - - /** - * Embeddable DTO for OrganisationRole. - */ - @XmlAccessorType(XmlAccessType.FIELD) - public static record OrganisationRoleDto( - @XmlElement(name = "organisation") - OrganisationDto organisation - ) { - public OrganisationRoleDto() { - this(null); - } + @XmlType(name = "Priority", namespace = "http://naesb.org/espi/customer") + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class PriorityDto { + @XmlElement(name = "value", namespace = "http://naesb.org/espi/customer") + private Integer value; + + @XmlElement(name = "rank", namespace = "http://naesb.org/espi/customer") + private Integer rank; + + @XmlElement(name = "type", namespace = "http://naesb.org/espi/customer") + private String type; } - + /** * Embeddable DTO for Organisation. + * Field order matches customer.xsd:1096-1125. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record OrganisationDto( - @XmlElement(name = "organisationName") - String organisationName, - - @XmlElement(name = "streetAddress") - StreetAddressDto streetAddress, - - @XmlElement(name = "postalAddress") - StreetAddressDto postalAddress, - - @XmlElement(name = "phone1") - PhoneNumberDto phone1, - - @XmlElement(name = "phone2") - PhoneNumberDto phone2, - - @XmlElement(name = "electronicAddress") - ElectronicAddressDto electronicAddress - ) { - public OrganisationDto() { - this(null, null, null, null, null, null); - } + @XmlType(name = "Organisation", namespace = "http://naesb.org/espi/customer", propOrder = { + "streetAddress", "postalAddress", "phone1", "phone2", "electronicAddress", "organisationName" + }) + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class OrganisationDto { + @XmlElement(name = "streetAddress", namespace = "http://naesb.org/espi/customer") + private StreetAddressDto streetAddress; + + @XmlElement(name = "postalAddress", namespace = "http://naesb.org/espi/customer") + private StreetAddressDto postalAddress; + + @XmlElement(name = "phone1", namespace = "http://naesb.org/espi/customer") + private PhoneNumberDto phone1; + + @XmlElement(name = "phone2", namespace = "http://naesb.org/espi/customer") + private PhoneNumberDto phone2; + + @XmlElement(name = "electronicAddress", namespace = "http://naesb.org/espi/customer") + private ElectronicAddressDto electronicAddress; + + @XmlElement(name = "organisationName", namespace = "http://naesb.org/espi/customer") + private String organisationName; } - + /** * Embeddable DTO for StreetAddress. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record StreetAddressDto( - @XmlElement(name = "streetDetail") - String streetDetail, - - @XmlElement(name = "townDetail") - String townDetail, - - @XmlElement(name = "stateOrProvince") - String stateOrProvince, - - @XmlElement(name = "postalCode") - String postalCode, - - @XmlElement(name = "country") - String country - ) { - public StreetAddressDto() { - this(null, null, null, null, null); - } + @XmlType(name = "StreetAddress", namespace = "http://naesb.org/espi/customer") + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class StreetAddressDto { + @XmlElement(name = "streetDetail", namespace = "http://naesb.org/espi/customer") + private String streetDetail; + + @XmlElement(name = "townDetail", namespace = "http://naesb.org/espi/customer") + private String townDetail; + + @XmlElement(name = "stateOrProvince", namespace = "http://naesb.org/espi/customer") + private String stateOrProvince; + + @XmlElement(name = "postalCode", namespace = "http://naesb.org/espi/customer") + private String postalCode; + + @XmlElement(name = "country", namespace = "http://naesb.org/espi/customer") + private String country; } - + /** * Embeddable DTO for PhoneNumber. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record PhoneNumberDto( - @XmlElement(name = "areaCode") - String areaCode, - - @XmlElement(name = "cityCode") - String cityCode, - - @XmlElement(name = "localNumber") - String localNumber, - - @XmlElement(name = "extension") - String extension - ) { - public PhoneNumberDto() { - this(null, null, null, null); - } + @XmlType(name = "PhoneNumber", namespace = "http://naesb.org/espi/customer") + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class PhoneNumberDto { + @XmlElement(name = "areaCode", namespace = "http://naesb.org/espi/customer") + private String areaCode; + + @XmlElement(name = "cityCode", namespace = "http://naesb.org/espi/customer") + private String cityCode; + + @XmlElement(name = "localNumber", namespace = "http://naesb.org/espi/customer") + private String localNumber; + + @XmlElement(name = "extension", namespace = "http://naesb.org/espi/customer") + private String extension; } - + /** * Embeddable DTO for ElectronicAddress. */ @XmlAccessorType(XmlAccessType.FIELD) - public static record ElectronicAddressDto( - @XmlElement(name = "email1") - String email1, - - @XmlElement(name = "email2") - String email2, - - @XmlElement(name = "web") - String web, - - @XmlElement(name = "radio") - String radio - ) { - public ElectronicAddressDto() { - this(null, null, null, null); - } + @XmlType(name = "ElectronicAddress", namespace = "http://naesb.org/espi/customer") + @Getter + @Setter + @NoArgsConstructor + @AllArgsConstructor + public static class ElectronicAddressDto { + @XmlElement(name = "email1", namespace = "http://naesb.org/espi/customer") + private String email1; + + @XmlElement(name = "email2", namespace = "http://naesb.org/espi/customer") + private String email2; + + @XmlElement(name = "web", namespace = "http://naesb.org/espi/customer") + private String web; + + @XmlElement(name = "radio", namespace = "http://naesb.org/espi/customer") + private String radio; } } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/EndDeviceDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/EndDeviceDto.java index 3ee28a7a..2155254d 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/EndDeviceDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/EndDeviceDto.java @@ -22,79 +22,79 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * EndDevice DTO record for JAXB XML marshalling/unmarshalling. - * + * EndDevice DTO class for JAXB XML marshalling/unmarshalling. + * * Represents an end device such as a meter or other measurement equipment. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "EndDevice", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "EndDevice", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", - "description", "amrSystem", "installCode", "isPan", "installDate", + "published", "updated", "selfLink", "upLink", "relatedLinks", + "description", "amrSystem", "installCode", "isPan", "installDate", "removedDate", "serialNumber", "serviceLocation" }) -public record EndDeviceDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class EndDeviceDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "amrSystem") - String amrSystem, - + private String amrSystem; + @XmlElement(name = "installCode") - String installCode, - + private String installCode; + @XmlElement(name = "isPan") - Boolean isPan, - + private Boolean isPan; + @XmlElement(name = "installDate") - OffsetDateTime installDate, - + private OffsetDateTime installDate; + @XmlElement(name = "removedDate") - OffsetDateTime removedDate, - + private OffsetDateTime removedDate; + @XmlElement(name = "serialNumber") - String serialNumber, - + private String serialNumber; + @XmlElement(name = "ServiceLocation") - ServiceLocationDto serviceLocation -) { - - /** - * Default constructor for JAXB. - */ - public EndDeviceDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null); - } - + private ServiceLocationDto serviceLocation; + /** * Minimal constructor for basic device data. */ @@ -102,45 +102,45 @@ public EndDeviceDto(String uuid, String serialNumber) { this(null, uuid, null, null, null, null, null, null, null, null, null, null, null, serialNumber, null); } - + /** * Gets the self href for this end device. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this end device. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for an end device. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && serviceLocation != null && serviceLocation.uuid() != null) { - return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.uuid() + "/EndDevice/" + uuid; + if (uuid != null && serviceLocation != null && serviceLocation.getUuid() != null) { + return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.getUuid() + "/EndDevice/" + uuid; } return uuid != null ? "/espi/1_1/resource/EndDevice/" + uuid : null; } - + /** * Generates the default up href for an end device. - * + * * @return default up href */ public String generateUpHref() { - if (serviceLocation != null && serviceLocation.uuid() != null) { - return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.uuid() + "/EndDevice"; + if (serviceLocation != null && serviceLocation.getUuid() != null) { + return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.getUuid() + "/EndDevice"; } return "/espi/1_1/resource/EndDevice"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/MeterDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/MeterDto.java index 77afb926..b8237967 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/MeterDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/MeterDto.java @@ -22,91 +22,91 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * Meter DTO record for JAXB XML marshalling/unmarshalling. - * + * Meter DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a meter device extending EndDevice with meter-specific functionality. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "Meter", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Meter", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", - "description", "amrSystem", "installCode", "isPan", "installDate", + "published", "updated", "selfLink", "upLink", "relatedLinks", + "description", "amrSystem", "installCode", "isPan", "installDate", "removedDate", "serialNumber", "formNumber", "kh", "meterMultiplier", "serviceLocation" }) -public record MeterDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class MeterDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + // EndDevice fields @XmlElement(name = "amrSystem") - String amrSystem, - + private String amrSystem; + @XmlElement(name = "installCode") - String installCode, - + private String installCode; + @XmlElement(name = "isPan") - Boolean isPan, - + private Boolean isPan; + @XmlElement(name = "installDate") - OffsetDateTime installDate, - + private OffsetDateTime installDate; + @XmlElement(name = "removedDate") - OffsetDateTime removedDate, - + private OffsetDateTime removedDate; + @XmlElement(name = "serialNumber") - String serialNumber, - + private String serialNumber; + // Meter-specific fields @XmlElement(name = "formNumber") - String formNumber, - + private String formNumber; + @XmlElement(name = "kh") - Double kh, - + private Double kh; + @XmlElement(name = "meterMultiplier") - Double meterMultiplier, - + private Double meterMultiplier; + @XmlElement(name = "ServiceLocation") - ServiceLocationDto serviceLocation -) { - - /** - * Default constructor for JAXB. - */ - public MeterDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, null); - } - + private ServiceLocationDto serviceLocation; + /** * Minimal constructor for basic meter data. */ @@ -114,45 +114,45 @@ public MeterDto(String uuid, String serialNumber, String formNumber) { this(null, uuid, null, null, null, null, null, null, null, null, null, null, null, serialNumber, formNumber, null, null, null); } - + /** * Gets the self href for this meter. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this meter. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a meter. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && serviceLocation != null && serviceLocation.uuid() != null) { - return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.uuid() + "/Meter/" + uuid; + if (uuid != null && serviceLocation != null && serviceLocation.getUuid() != null) { + return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.getUuid() + "/Meter/" + uuid; } return uuid != null ? "/espi/1_1/resource/Meter/" + uuid : null; } - + /** * Generates the default up href for a meter. - * + * * @return default up href */ public String generateUpHref() { - if (serviceLocation != null && serviceLocation.uuid() != null) { - return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.uuid() + "/Meter"; + if (serviceLocation != null && serviceLocation.getUuid() != null) { + return "/espi/1_1/resource/ServiceLocation/" + serviceLocation.getUuid() + "/Meter"; } return "/espi/1_1/resource/Meter"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ProgramDateIdMappingsDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ProgramDateIdMappingsDto.java index ac042eac..64a3cafa 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ProgramDateIdMappingsDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ProgramDateIdMappingsDto.java @@ -22,76 +22,76 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * ProgramDateIdMappings DTO record for JAXB XML marshalling/unmarshalling. - * + * ProgramDateIdMappings DTO class for JAXB XML marshalling/unmarshalling. + * * Represents mappings between program dates and identifiers. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "ProgramDateIdMappings", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ProgramDateIdMappings", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", + "published", "updated", "selfLink", "upLink", "relatedLinks", "description", "programId", "programDate", "mappingId", "mappingType", "isActive", "customer" }) -public record ProgramDateIdMappingsDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class ProgramDateIdMappingsDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "programId") - String programId, - + private String programId; + @XmlElement(name = "programDate") - OffsetDateTime programDate, - + private OffsetDateTime programDate; + @XmlElement(name = "mappingId") - String mappingId, - + private String mappingId; + @XmlElement(name = "mappingType") - String mappingType, - + private String mappingType; + @XmlElement(name = "isActive") - Boolean isActive, - + private Boolean isActive; + @XmlElement(name = "Customer") - CustomerDto customer -) { - - /** - * Default constructor for JAXB. - */ - public ProgramDateIdMappingsDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null); - } - + private CustomerDto customer; + /** * Minimal constructor for basic mapping data. */ @@ -99,45 +99,45 @@ public ProgramDateIdMappingsDto(String uuid, String programId, String mappingId) this(null, uuid, null, null, null, null, null, null, programId, null, mappingId, null, null, null); } - + /** * Gets the self href for this mapping. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this mapping. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a program date mapping. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && customer != null && customer.uuid() != null) { - return "/espi/1_1/resource/Customer/" + customer.uuid() + "/ProgramDateIdMappings/" + uuid; + if (uuid != null && customer != null && customer.getUuid() != null) { + return "/espi/1_1/resource/Customer/" + customer.getUuid() + "/ProgramDateIdMappings/" + uuid; } return uuid != null ? "/espi/1_1/resource/ProgramDateIdMappings/" + uuid : null; } - + /** * Generates the default up href for a program date mapping. - * + * * @return default up href */ public String generateUpHref() { - if (customer != null && customer.uuid() != null) { - return "/espi/1_1/resource/Customer/" + customer.uuid() + "/ProgramDateIdMappings"; + if (customer != null && customer.getUuid() != null) { + return "/espi/1_1/resource/Customer/" + customer.getUuid() + "/ProgramDateIdMappings"; } return "/espi/1_1/resource/ProgramDateIdMappings"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ServiceLocationDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ServiceLocationDto.java index 4095b252..d419e74f 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ServiceLocationDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/ServiceLocationDto.java @@ -22,79 +22,79 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * ServiceLocation DTO record for JAXB XML marshalling/unmarshalling. - * + * ServiceLocation DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a physical location where utility services are delivered. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "ServiceLocation", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ServiceLocation", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", + "published", "updated", "selfLink", "upLink", "relatedLinks", "description", "accessMethod", "needsInspection", "siteAccessProblem", "positionAddress", "geoInfoReference", "direction", "customerAgreement" }) -public record ServiceLocationDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class ServiceLocationDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "accessMethod") - String accessMethod, - + private String accessMethod; + @XmlElement(name = "needsInspection") - Boolean needsInspection, - + private Boolean needsInspection; + @XmlElement(name = "siteAccessProblem") - String siteAccessProblem, - + private String siteAccessProblem; + @XmlElement(name = "positionAddress") - String positionAddress, - + private String positionAddress; + @XmlElement(name = "geoInfoReference") - String geoInfoReference, - + private String geoInfoReference; + @XmlElement(name = "direction") - String direction, - + private String direction; + @XmlElement(name = "CustomerAgreement") - CustomerAgreementDto customerAgreement -) { - - /** - * Default constructor for JAXB. - */ - public ServiceLocationDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null); - } - + private CustomerAgreementDto customerAgreement; + /** * Minimal constructor for basic location data. */ @@ -102,45 +102,45 @@ public ServiceLocationDto(String uuid, String positionAddress) { this(null, uuid, null, null, null, null, null, null, null, null, null, positionAddress, null, null, null); } - + /** * Gets the self href for this service location. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this service location. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a service location. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && customerAgreement != null && customerAgreement.uuid() != null) { - return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.uuid() + "/ServiceLocation/" + uuid; + if (uuid != null && customerAgreement != null && customerAgreement.getUuid() != null) { + return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.getUuid() + "/ServiceLocation/" + uuid; } return uuid != null ? "/espi/1_1/resource/ServiceLocation/" + uuid : null; } - + /** * Generates the default up href for a service location. - * + * * @return default up href */ public String generateUpHref() { - if (customerAgreement != null && customerAgreement.uuid() != null) { - return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.uuid() + "/ServiceLocation"; + if (customerAgreement != null && customerAgreement.getUuid() != null) { + return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.getUuid() + "/ServiceLocation"; } return "/espi/1_1/resource/ServiceLocation"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementDto.java index f7495440..a04c70b3 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementDto.java @@ -22,83 +22,83 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.OffsetDateTime; import java.util.List; /** - * Statement DTO record for JAXB XML marshalling/unmarshalling. - * + * Statement DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a billing statement or document for a customer agreement. * Supports Atom protocol XML wrapping. */ @XmlRootElement(name = "Statement", namespace = "http://naesb.org/espi/customer") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Statement", namespace = "http://naesb.org/espi/customer", propOrder = { - "id", "uuid", "published", "updated", "selfLink", "upLink", "relatedLinks", + "published", "updated", "selfLink", "upLink", "relatedLinks", "description", "createdDateTime", "lastModifiedDateTime", "revisionNumber", "subject", "docStatus", "type", "customerAgreement", "statementRefs" }) -public record StatementDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class StatementDto { + @XmlTransient - Long id, - + private Long id; + @XmlAttribute(name = "mRID") - String uuid, - + private String uuid; + @XmlElement(name = "published") - OffsetDateTime published, - + private OffsetDateTime published; + @XmlElement(name = "updated") - OffsetDateTime updated, - + private OffsetDateTime updated; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") @XmlElementWrapper(name = "links", namespace = "http://www.w3.org/2005/Atom") - List relatedLinks, - + private List relatedLinks; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto selfLink, - + private LinkDto selfLink; + @XmlElement(name = "link", namespace = "http://www.w3.org/2005/Atom") - LinkDto upLink, - + private LinkDto upLink; + @XmlElement(name = "description") - String description, - + private String description; + @XmlElement(name = "createdDateTime") - OffsetDateTime createdDateTime, - + private OffsetDateTime createdDateTime; + @XmlElement(name = "lastModifiedDateTime") - OffsetDateTime lastModifiedDateTime, - + private OffsetDateTime lastModifiedDateTime; + @XmlElement(name = "revisionNumber") - String revisionNumber, - + private String revisionNumber; + @XmlElement(name = "subject") - String subject, - + private String subject; + @XmlElement(name = "docStatus") - String docStatus, - + private String docStatus; + @XmlElement(name = "type") - String type, - + private String type; + @XmlElement(name = "CustomerAgreement") - CustomerAgreementDto customerAgreement, - + private CustomerAgreementDto customerAgreement; + @XmlElement(name = "StatementRef") @XmlElementWrapper(name = "StatementRefs") - List statementRefs -) { - - /** - * Default constructor for JAXB. - */ - public StatementDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null); - } - + private List statementRefs; + /** * Minimal constructor for basic statement data. */ @@ -106,45 +106,45 @@ public StatementDto(String uuid, String subject) { this(null, uuid, null, null, null, null, null, null, null, null, null, subject, null, null, null, null); } - + /** * Gets the self href for this statement. - * + * * @return self href string */ public String getSelfHref() { - return selfLink != null ? selfLink.href() : null; + return selfLink != null ? selfLink.getHref() : null; } - + /** * Gets the up href for this statement. - * + * * @return up href string */ public String getUpHref() { - return upLink != null ? upLink.href() : null; + return upLink != null ? upLink.getHref() : null; } - + /** * Generates the default self href for a statement. - * + * * @return default self href */ public String generateSelfHref() { - if (uuid != null && customerAgreement != null && customerAgreement.uuid() != null) { - return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.uuid() + "/Statement/" + uuid; + if (uuid != null && customerAgreement != null && customerAgreement.getUuid() != null) { + return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.getUuid() + "/Statement/" + uuid; } return uuid != null ? "/espi/1_1/resource/Statement/" + uuid : null; } - + /** * Generates the default up href for a statement. - * + * * @return default up href */ public String generateUpHref() { - if (customerAgreement != null && customerAgreement.uuid() != null) { - return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.uuid() + "/Statement"; + if (customerAgreement != null && customerAgreement.getUuid() != null) { + return "/espi/1_1/resource/CustomerAgreement/" + customerAgreement.getUuid() + "/Statement"; } return "/espi/1_1/resource/Statement"; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementRefDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementRefDto.java index 3775e523..28c3d208 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementRefDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/StatementRefDto.java @@ -20,11 +20,15 @@ package org.greenbuttonalliance.espi.common.dto.customer; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.time.OffsetDateTime; /** - * StatementRef DTO record for JAXB XML marshalling/unmarshalling. + * StatementRef DTO class for JAXB XML marshalling/unmarshalling. * * Represents a reference to a statement document. * @@ -41,30 +45,26 @@ @XmlType(name = "StatementRef", namespace = "http://naesb.org/espi/customer", propOrder = { "referenceId", "referenceType", "referenceDate", "referenceUrl", "statement" }) -public record StatementRefDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class StatementRefDto { @XmlElement(name = "referenceId") - String referenceId, + private String referenceId; @XmlElement(name = "referenceType") - String referenceType, + private String referenceType; @XmlElement(name = "referenceDate") - OffsetDateTime referenceDate, + private OffsetDateTime referenceDate; @XmlElement(name = "referenceUrl") - String referenceUrl, + private String referenceUrl; @XmlElement(name = "Statement") - StatementDto statement -) { - - /** - * Default constructor for JAXB. - */ - public StatementRefDto() { - this(null, null, null, null, null); - } + private StatementDto statement; /** * Minimal constructor for basic reference data. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/package-info.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/package-info.java new file mode 100644 index 00000000..d3ccec87 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/customer/package-info.java @@ -0,0 +1,42 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +/** + * ESPI Customer DTOs for Green Button customer information exchange. + * + * This package contains Data Transfer Objects (DTOs) for NAESB ESPI customer-related resources + * including Customer, CustomerAccount, ServiceLocation, and related PII data. + * These DTOs are used for JAXB XML marshalling/unmarshalling in Green Button implementations. + * + * Customer data contains Personally Identifiable Information (PII) and is defined in a separate + * namespace (http://naesb.org/espi/customer) from usage data per NAESB ESPI 4.0 specification. + */ +@jakarta.xml.bind.annotation.XmlSchema( + namespace = "http://naesb.org/espi/customer", + elementFormDefault = jakarta.xml.bind.annotation.XmlNsForm.QUALIFIED, + xmlns = { + // Declare Atom with explicit atom prefix for CustomerAtomEntryDto + @jakarta.xml.bind.annotation.XmlNs(prefix = "atom", namespaceURI = "http://www.w3.org/2005/Atom"), + // Customer namespace uses cust prefix + @jakarta.xml.bind.annotation.XmlNs(prefix = "cust", namespaceURI = "http://naesb.org/espi/customer") + } +) +package org.greenbuttonalliance.espi.common.dto.customer; + +import jakarta.xml.bind.annotation.XmlNs; diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefDto.java index ae7f6a7f..df4708a8 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefDto.java @@ -20,12 +20,16 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.ArrayList; import java.util.List; /** - * AggregatedNodeRef DTO record for JAXB XML marshalling/unmarshalling. + * AggregatedNodeRef DTO class for JAXB XML marshalling/unmarshalling. * * Represents a reference to an aggregated node in the electrical grid. * Used within UsagePoint to specify aggregated pricing/load zones. @@ -34,70 +38,50 @@ * * Part of the NAESB ESPI UsagePoint structure for aggregated node references. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "AggregatedNodeRef", namespace = "http://naesb.org/espi", propOrder = { "anodeType", "ref", "startEffectiveDate", "endEffectiveDate", "pnodeRef" }) -public record AggregatedNodeRefDto( +public class AggregatedNodeRefDto { - String anodeType, - String ref, - Long startEffectiveDate, - Long endEffectiveDate, - List pnodeRef -) { - /** * Type of the aggregated node. * Indicates the category or classification of the aggregated node. */ @XmlElement(name = "anodeType") - public String getAnodeType() { - return anodeType; - } - + private String anodeType; + /** * Reference to the aggregated node identifier. */ @XmlElement(name = "ref") - public String getRef() { - return ref; - } - + private String ref; + /** * Start effective date for the aggregated node reference validity. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "startEffectiveDate") - public Long getStartEffectiveDate() { - return startEffectiveDate; - } - + private Long startEffectiveDate; + /** * End effective date for the aggregated node reference validity. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "endEffectiveDate") - public Long getEndEffectiveDate() { - return endEffectiveDate; - } - + private Long endEffectiveDate; + /** * Pricing node references associated with this aggregated node. * Contains the underlying pricing nodes that contribute to the aggregated node. * Per ESPI 4.0 XSD (espi.xsd:1597), supports 0 to many pricing node references. */ @XmlElement(name = "pnodeRef") - public List getPnodeRef() { - return pnodeRef != null ? pnodeRef : new ArrayList<>(); - } - - /** - * Default constructor for JAXB. - */ - public AggregatedNodeRefDto() { - this(null, null, null, null, new ArrayList<>()); - } + private List pnodeRef; /** * Constructor with aggregated node reference and type. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefsDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefsDto.java index 0adb7bd7..8e4be0b5 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefsDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AggregatedNodeRefsDto.java @@ -20,33 +20,34 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.ArrayList; import java.util.Arrays; import java.util.List; /** - * AggregatedNodeRefs DTO record for JAXB XML marshalling/unmarshalling. - * + * AggregatedNodeRefs DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a collection of aggregated node references for a UsagePoint. * Used to specify multiple aggregated pricing/load zones that may apply. - * + * * Follows NAESB ESPI specification for AggregatedNodeRefs complex type. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "AggregatedNodeRefs", namespace = "http://naesb.org/espi") -public record AggregatedNodeRefsDto( - - List aggregatedNodeRefs -) { - +public class AggregatedNodeRefsDto { + /** * List of aggregated node references. * Each reference contains aggregated node ID and validity period. */ @XmlElement(name = "AggregatedNodeRef") - public List getAggregatedNodeRefs() { - return aggregatedNodeRefs; - } + private List aggregatedNodeRefs; /** * Default constructor for JAXB. @@ -108,7 +109,7 @@ public List getValidRefs() { */ public List getRefsByRef(String ref) { return aggregatedNodeRefs.stream() - .filter(aggNodeRef -> ref.equals(aggNodeRef.ref())) + .filter(aggNodeRef -> ref.equals(aggNodeRef.getRef())) .toList(); } @@ -120,7 +121,7 @@ public List getRefsByRef(String ref) { */ public boolean hasRef(String ref) { return aggregatedNodeRefs.stream() - .anyMatch(aggNodeRef -> ref.equals(aggNodeRef.ref())); + .anyMatch(aggNodeRef -> ref.equals(aggNodeRef.getRef())); } /** diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ApplicationInformationDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ApplicationInformationDto.java index aaf5e5fd..a6188196 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ApplicationInformationDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ApplicationInformationDto.java @@ -20,17 +20,25 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * ApplicationInformation DTO record for JAXB XML marshalling/unmarshalling. + * ApplicationInformation DTO class for JAXB XML marshalling/unmarshalling. * * Represents OAuth 2.0 application information for third-party access * to Green Button data. * * Field order strictly matches ESPI 4.0 XSD schema sequence (espi.xsd lines 62-246). */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "ApplicationInformation", namespace = "http://naesb.org/espi") -@XmlAccessorType(XmlAccessType.PROPERTY) +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ApplicationInformation", namespace = "http://naesb.org/espi", propOrder = { // Core identification "dataCustodianId", @@ -86,240 +94,117 @@ // Deprecated (kept for backward compatibility) "dataCustodianScopeSelectionScreenURI" }) -public record ApplicationInformationDto( +public class ApplicationInformationDto { // Internal UUID (not in XSD) - String uuid, + @XmlTransient + private String uuid; // 1. dataCustodianId - Required - String dataCustodianId, + private String dataCustodianId; // 2. dataCustodianApplicationStatus - Required - Short dataCustodianApplicationStatus, + private Short dataCustodianApplicationStatus; // 3. thirdPartyApplicationDescription - Optional - String thirdPartyApplicationDescription, + private String thirdPartyApplicationDescription; // 4. thirdPartyApplicationStatus - Optional - Short thirdPartyApplicationStatus, + private Short thirdPartyApplicationStatus; // 5. thirdPartyApplicationType - Optional - Short thirdPartyApplicationType, + private Short thirdPartyApplicationType; // 6. thirdPartyApplicationUse - Optional - Short thirdPartyApplicationUse, + private Short thirdPartyApplicationUse; // 7. thirdPartyPhone - Optional - String thirdPartyPhone, + private String thirdPartyPhone; // 8. authorizationServerUri - Optional - String authorizationServerUri, + private String authorizationServerUri; // 9. thirdPartyNotifyUri - Required - String thirdPartyNotifyURI, + private String thirdPartyNotifyURI; // 10. authorizationServerAuthorizationEndpoint - Required - String authorizationServerAuthorizationEndpoint, + private String authorizationServerAuthorizationEndpoint; // 11. authorizationServerRegistrationEndpoint - Optional - String authorizationServerRegistrationEndpoint, + private String authorizationServerRegistrationEndpoint; // 12. authorizationServerTokenEndpoint - Required - String authorizationServerTokenEndpoint, + private String authorizationServerTokenEndpoint; // 13. dataCustodianBulkRequestURI - Required - String dataCustodianBulkRequestURI, + private String dataCustodianBulkRequestURI; // 14. dataCustodianResourceEndpoint - Required - String dataCustodianResourceEndpoint, + private String dataCustodianResourceEndpoint; // 15. thirdPartyScopeSelectionScreenURI - Optional - String thirdPartyScopeSelectionScreenURI, + private String thirdPartyScopeSelectionScreenURI; // 16. thirdPartyUserPortalScreenURI - Optional - String thirdPartyUserPortalScreenURI, + private String thirdPartyUserPortalScreenURI; // 17. client_secret - Required - String clientSecret, + private String clientSecret; // 18. logo_uri - Optional - String logoUri, + private String logoUri; // 19. client_name - Required - String clientName, + private String clientName; // 20. client_uri - Optional - String clientUri, + private String clientUri; // 21. redirect_uri - Required (maxOccurs="unbounded") - String redirectUri, + private String redirectUri; // 22. client_id - Required - String clientId, + private String clientId; // 23. tos_uri - Optional - String tosUri, + private String tosUri; // 24. policy_uri - Optional - String policyUri, + private String policyUri; // 25. software_id - Required - String softwareId, + private String softwareId; // 26. software_version - Required - String softwareVersion, + private String softwareVersion; // 27. client_id_issued_at - Required - Long clientIdIssuedAt, + private Long clientIdIssuedAt; // 28. client_secret_expires_at - Required - Long clientSecretExpiresAt, + private Long clientSecretExpiresAt; // 29. contacts - Optional (maxOccurs="unbounded") - String contacts, + private String contacts; // 30. token_endpoint_auth_method - Required - String tokenEndpointAuthMethod, + private String tokenEndpointAuthMethod; // 31. scope - Required (maxOccurs="unbounded") - String scopes, + private String scopes; // 32. grant_types - Required (minOccurs="2") - String grantTypes, + private String grantTypes; // 33. response_types - Required - String responseTypes, + private String responseTypes; // 34. registration_client_uri - Required - String registrationClientUri, + private String registrationClientUri; // 35. registration_access_token - Required - String registrationAccessToken, + private String registrationAccessToken; // 36. dataCustodianScopeSelectionScreenURI - Deprecated - String dataCustodianScopeSelectionScreenURI -) { - - /** - * Default constructor for JAXB. - * Creates an ApplicationInformationDto with all fields set to null. - * The canonical constructor with all fields is automatically provided by the record declaration. - */ - public ApplicationInformationDto() { - this(null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, - null); - } - - // JAXB property accessors - must match propOrder sequence - - @XmlElement(name = "dataCustodianId", namespace = "http://naesb.org/espi") - public String getDataCustodianId() { return dataCustodianId; } - - @XmlElement(name = "dataCustodianApplicationStatus", namespace = "http://naesb.org/espi") - public Short getDataCustodianApplicationStatus() { return dataCustodianApplicationStatus; } - - @XmlElement(name = "thirdPartyApplicationDescription", namespace = "http://naesb.org/espi") - public String getThirdPartyApplicationDescription() { return thirdPartyApplicationDescription; } - - @XmlElement(name = "thirdPartyApplicationStatus", namespace = "http://naesb.org/espi") - public Short getThirdPartyApplicationStatus() { return thirdPartyApplicationStatus; } - - @XmlElement(name = "thirdPartyApplicationType", namespace = "http://naesb.org/espi") - public Short getThirdPartyApplicationType() { return thirdPartyApplicationType; } - - @XmlElement(name = "thirdPartyApplicationUse", namespace = "http://naesb.org/espi") - public Short getThirdPartyApplicationUse() { return thirdPartyApplicationUse; } - - @XmlElement(name = "thirdPartyPhone", namespace = "http://naesb.org/espi") - public String getThirdPartyPhone() { return thirdPartyPhone; } - - @XmlElement(name = "authorizationServerUri", namespace = "http://naesb.org/espi") - public String getAuthorizationServerUri() { return authorizationServerUri; } - - @XmlElement(name = "thirdPartyNotifyURI", namespace = "http://naesb.org/espi") - public String getThirdPartyNotifyURI() { return thirdPartyNotifyURI; } - - @XmlElement(name = "authorizationServerAuthorizationEndpoint", namespace = "http://naesb.org/espi") - public String getAuthorizationServerAuthorizationEndpoint() { return authorizationServerAuthorizationEndpoint; } - - @XmlElement(name = "authorizationServerRegistrationEndpoint", namespace = "http://naesb.org/espi") - public String getAuthorizationServerRegistrationEndpoint() { return authorizationServerRegistrationEndpoint; } - - @XmlElement(name = "authorizationServerTokenEndpoint", namespace = "http://naesb.org/espi") - public String getAuthorizationServerTokenEndpoint() { return authorizationServerTokenEndpoint; } - - @XmlElement(name = "dataCustodianBulkRequestURI", namespace = "http://naesb.org/espi") - public String getDataCustodianBulkRequestURI() { return dataCustodianBulkRequestURI; } - - @XmlElement(name = "dataCustodianResourceEndpoint", namespace = "http://naesb.org/espi") - public String getDataCustodianResourceEndpoint() { return dataCustodianResourceEndpoint; } - - @XmlElement(name = "thirdPartyScopeSelectionScreenURI", namespace = "http://naesb.org/espi") - public String getThirdPartyScopeSelectionScreenURI() { return thirdPartyScopeSelectionScreenURI; } - - @XmlElement(name = "thirdPartyUserPortalScreenURI", namespace = "http://naesb.org/espi") - public String getThirdPartyUserPortalScreenURI() { return thirdPartyUserPortalScreenURI; } - - @XmlElement(name = "client_secret", namespace = "http://naesb.org/espi") - public String getClientSecret() { return clientSecret; } - - @XmlElement(name = "logo_uri", namespace = "http://naesb.org/espi") - public String getLogoUri() { return logoUri; } - - @XmlElement(name = "client_name", namespace = "http://naesb.org/espi") - public String getClientName() { return clientName; } - - @XmlElement(name = "client_uri", namespace = "http://naesb.org/espi") - public String getClientUri() { return clientUri; } - - @XmlElement(name = "redirect_uri", namespace = "http://naesb.org/espi") - public String getRedirectUri() { return redirectUri; } - - @XmlElement(name = "client_id", namespace = "http://naesb.org/espi") - public String getClientId() { return clientId; } - - @XmlElement(name = "tos_uri", namespace = "http://naesb.org/espi") - public String getTosUri() { return tosUri; } - - @XmlElement(name = "policy_uri", namespace = "http://naesb.org/espi") - public String getPolicyUri() { return policyUri; } - - @XmlElement(name = "software_id", namespace = "http://naesb.org/espi") - public String getSoftwareId() { return softwareId; } - - @XmlElement(name = "software_version", namespace = "http://naesb.org/espi") - public String getSoftwareVersion() { return softwareVersion; } - - @XmlElement(name = "client_id_issued_at", namespace = "http://naesb.org/espi") - public Long getClientIdIssuedAt() { return clientIdIssuedAt; } - - @XmlElement(name = "client_secret_expires_at", namespace = "http://naesb.org/espi") - public Long getClientSecretExpiresAt() { return clientSecretExpiresAt; } - - @XmlElement(name = "contacts", namespace = "http://naesb.org/espi") - public String getContacts() { return contacts; } - - @XmlElement(name = "token_endpoint_auth_method", namespace = "http://naesb.org/espi") - public String getTokenEndpointAuthMethod() { return tokenEndpointAuthMethod; } - - @XmlElement(name = "scope", namespace = "http://naesb.org/espi") - public String getScopes() { return scopes; } - - @XmlElement(name = "grant_types", namespace = "http://naesb.org/espi") - public String getGrantTypes() { return grantTypes; } - - @XmlElement(name = "response_types", namespace = "http://naesb.org/espi") - public String getResponseTypes() { return responseTypes; } - - @XmlElement(name = "registration_client_uri", namespace = "http://naesb.org/espi") - public String getRegistrationClientUri() { return registrationClientUri; } - - @XmlElement(name = "registration_access_token", namespace = "http://naesb.org/espi") - public String getRegistrationAccessToken() { return registrationAccessToken; } - - @XmlElement(name = "dataCustodianScopeSelectionScreenURI", namespace = "http://naesb.org/espi") - public String getDataCustodianScopeSelectionScreenURI() { return dataCustodianScopeSelectionScreenURI; } + private String dataCustodianScopeSelectionScreenURI; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AuthorizationDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AuthorizationDto.java index faffacac..6e22cde2 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AuthorizationDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/AuthorizationDto.java @@ -21,17 +21,25 @@ import io.swagger.v3.oas.annotations.media.Schema; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * Authorization DTO record for JAXB XML marshalling/unmarshalling. + * Authorization DTO class for JAXB XML marshalling/unmarshalling. * * Represents OAuth 2.0 authorization for third-party access to Green Button data. * Complies with NAESB ESPI 4.0 XSD specification. * * @see NAESB ESPI 4.0 */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "Authorization", namespace = "http://naesb.org/espi") -@XmlAccessorType(XmlAccessType.PROPERTY) +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Authorization", namespace = "http://naesb.org/espi", propOrder = { "authorizedPeriod", // ESPI 4.0 XSD sequence "publishedPeriod", @@ -47,121 +55,112 @@ "authorizationUri", "customerResourceURI" // NEW - PII subscription URI }) -public record AuthorizationDto( +public class AuthorizationDto { // UUID (not in XSD - internal use only) @XmlTransient - String uuid, + private String uuid; // XSD-compliant fields (in order) @Schema(description = "Period during which this authorization is valid", example = "{\"start\": 1704067200, \"duration\": 31536000}") - DateTimeIntervalDto authorizedPeriod, + private DateTimeIntervalDto authorizedPeriod; @Schema(description = "Period during which data was published", example = "{\"start\": 1704067200, \"duration\": 31536000}") - DateTimeIntervalDto publishedPeriod, + private DateTimeIntervalDto publishedPeriod; @Schema(description = "Authorization status (1=ACTIVE, 2=REVOKED, 3=EXPIRED, 4=PENDING)", example = "1") - Short status, + private Short status; @Schema(description = "Expiration timestamp (epoch seconds)", example = "1735689600") - Long expiresIn, + private Long expiresIn; @Schema(description = "OAuth2 grant type", example = "authorization_code", allowableValues = {"authorization_code", "client_credentials", "refresh_token"}) - String grantType, + private String grantType; @Schema(description = "OAuth2 scope defining permissions", example = "FB=1_3_4_5_13_14_39;IntervalDuration=3600", required = true) - String scope, + private String scope; @Schema(description = "OAuth2 token type", example = "Bearer", allowableValues = {"Bearer"}) - String tokenType, + private String tokenType; @Schema(description = "OAuth2 error code if authorization failed", example = "invalid_grant") - String error, + private String error; @Schema(description = "Human-readable error description", example = "The provided authorization grant is invalid") - String errorDescription, + private String errorDescription; @Schema(description = "URI with more information about the error", example = "https://example.com/oauth/errors/invalid_grant") - String errorUri, + private String errorUri; @Schema(description = "URI for accessing the authorized energy usage resource", example = "https://api.example.com/espi/1_1/resource/Batch/Subscription/12345", required = true) - String resourceURI, + private String resourceURI; @Schema(description = "URI for managing this authorization", example = "https://api.example.com/espi/1_1/resource/Authorization/67890", required = true) - String authorizationUri, + private String authorizationUri; @Schema(description = "URI for accessing PII data the Third Party is authorized to access. Points to PII resource subscription endpoint with different namespace than resourceURI.", example = "https://api.example.com/customer/espi/1_1/resource/Batch/RetailCustomer/12345") - String customerResourceURI, + private String customerResourceURI; // OAuth2 implementation fields (not in ESPI XSD - marked as @XmlTransient) @XmlTransient @Schema(description = "OAuth2 access token (not included in XML for security)", example = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...") - String accessToken, + private String accessToken; @XmlTransient @Schema(description = "OAuth2 refresh token (not included in XML for security)", example = "def50200...") - String refreshToken, + private String refreshToken; @XmlTransient @Schema(description = "OAuth2 authorization code (temporary, not in XML)", example = "abc123xyz") - String authorizationCode, + private String authorizationCode; @XmlTransient @Schema(description = "OAuth2 state parameter for CSRF protection (not in ESPI XSD)", example = "xyz789") - String state, + private String state; @XmlTransient @Schema(description = "OAuth2 response type (not in ESPI XSD)", example = "code") - String responseType, + private String responseType; @XmlTransient @Schema(description = "Third party application identifier (not in ESPI XSD)", example = "ThirdPartyApp") - String thirdParty, + private String thirdParty; @XmlTransient @Schema(description = "Application information ID (relationship, not in XSD)", example = "550e8400-e29b-41d4-a716-446655440000") - String applicationInformationId, + private String applicationInformationId; @XmlTransient @Schema(description = "Retail customer ID (relationship, not in XSD for privacy)", example = "660e8400-e29b-41d4-a716-446655440000") - String retailCustomerId -) { - - /** - * Default constructor for JAXB. - */ - public AuthorizationDto() { - this(null, null, null, null, null, null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null); - } + private String retailCustomerId; /** * Constructor for basic authorization (XSD-compliant fields only). @@ -173,45 +172,6 @@ public AuthorizationDto(String scope, Short status, String resourceURI, String a // JAXB property accessors for XSD-compliant fields (in propOrder sequence) - @XmlElement(name = "authorizedPeriod", namespace = "http://naesb.org/espi") - public DateTimeIntervalDto getAuthorizedPeriod() { return authorizedPeriod; } - - @XmlElement(name = "publishedPeriod", namespace = "http://naesb.org/espi") - public DateTimeIntervalDto getPublishedPeriod() { return publishedPeriod; } - - @XmlElement(name = "status", namespace = "http://naesb.org/espi", required = true) - public Short getStatus() { return status; } - - @XmlElement(name = "expires_at", namespace = "http://naesb.org/espi", required = true) - public Long getExpiresIn() { return expiresIn; } - - @XmlElement(name = "grant_type", namespace = "http://naesb.org/espi") - public String getGrantType() { return grantType; } - - @XmlElement(name = "scope", namespace = "http://naesb.org/espi", required = true) - public String getScope() { return scope; } - - @XmlElement(name = "token_type", namespace = "http://naesb.org/espi", required = true) - public String getTokenType() { return tokenType; } - - @XmlElement(name = "error", namespace = "http://naesb.org/espi") - public String getError() { return error; } - - @XmlElement(name = "error_description", namespace = "http://naesb.org/espi") - public String getErrorDescription() { return errorDescription; } - - @XmlElement(name = "error_uri", namespace = "http://naesb.org/espi") - public String getErrorUri() { return errorUri; } - - @XmlElement(name = "resourceURI", namespace = "http://naesb.org/espi", required = true) - public String getResourceURI() { return resourceURI; } - - @XmlElement(name = "authorizationURI", namespace = "http://naesb.org/espi", required = true) - public String getAuthorizationUri() { return authorizationUri; } - - @XmlElement(name = "customerResourceURI", namespace = "http://naesb.org/espi") - public String getCustomerResourceURI() { return customerResourceURI; } - // OAuth2 implementation field accessors (marked @XmlTransient, not in XML output) public String getUuid() { return uuid; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/DateTimeIntervalDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/DateTimeIntervalDto.java index 7ea7b7ab..17d571b2 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/DateTimeIntervalDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/DateTimeIntervalDto.java @@ -20,13 +20,18 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.time.Instant; import java.time.OffsetDateTime; import java.time.ZoneOffset; /** - * DateTimeInterval DTO record for JAXB XML marshalling/unmarshalling. - * + * DateTimeInterval DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a time interval with start and duration. * Used in various Green Button resources for time-based data. */ @@ -35,46 +40,49 @@ @XmlType(name = "DateTimeInterval", namespace = "http://naesb.org/espi", propOrder = { "start", "duration" }) -public record DateTimeIntervalDto( - - @XmlElement(name = "start") - Long start, - - @XmlElement(name = "duration") - Long duration -) { - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class DateTimeIntervalDto { + + @XmlElement(name = "start", namespace = "http://naesb.org/espi") + private Long start; + + @XmlElement(name = "duration", namespace = "http://naesb.org/espi") + private Long duration; + /** * Gets the start time as OffsetDateTime. - * + * * @return start time as OffsetDateTime or null */ public OffsetDateTime getStartDateTime() { return start != null ? Instant.ofEpochSecond(start.longValue()).atOffset(ZoneOffset.UTC) : null; } - + /** * Gets the end time as epoch seconds. - * + * * @return end time or null if start or duration is null */ public Long getEnd() { return start != null && duration != null ? start + duration : null; } - + /** * Gets the end time as OffsetDateTime. - * + * * @return end time as OffsetDateTime or null */ public OffsetDateTime getEndDateTime() { Long end = getEnd(); return end != null ? Instant.ofEpochSecond(end.longValue()).atOffset(ZoneOffset.UTC) : null; } - + /** * Factory method for creating from OffsetDateTime. - * + * * @param startDateTime the start time as OffsetDateTime * @param duration the duration in seconds * @return new DateTimeIntervalDto instance diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ElectricPowerQualitySummaryDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ElectricPowerQualitySummaryDto.java index d2334cde..bed77d2f 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ElectricPowerQualitySummaryDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ElectricPowerQualitySummaryDto.java @@ -20,15 +20,19 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import org.greenbuttonalliance.espi.common.dto.usage.DateTimeIntervalDto; /** - * ElectricPowerQualitySummary DTO record for JAXB XML marshalling/unmarshalling. - * + * ElectricPowerQualitySummary DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a comprehensive summary of power quality events for electric power delivery. * Contains information about voltage quality, frequency variations, interruptions, * flicker, harmonics, and other power quality metrics as defined by the NAESB ESPI 1.0 specification. - * + * * All power quality measurements follow IEC standards for power quality measurement and assessment. */ @XmlRootElement(name = "ElectricPowerQualitySummary", namespace = "http://naesb.org/espi") @@ -39,13 +43,17 @@ "shortInterruptions", "summaryInterval", "supplyVoltageDips", "supplyVoltageImbalance", "supplyVoltageVariations", "tempOvervoltage" }) -public record ElectricPowerQualitySummaryDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class ElectricPowerQualitySummaryDto { @XmlTransient - Long id, + private Long id; @XmlAttribute(name = "mRID") - String uuid, + private String uuid; /** * Flicker PLT (Long-term) measurement. @@ -54,8 +62,8 @@ public record ElectricPowerQualitySummaryDto( * Unit: dimensionless (0.0 to 20.0 typical range) */ @XmlElement(name = "flickerPlt") - Long flickerPlt, - + private Long flickerPlt; + /** * Flicker PST (Short-term) measurement. * Represents short-term flicker severity as per IEC 61000-4-15. @@ -63,32 +71,32 @@ public record ElectricPowerQualitySummaryDto( * Unit: dimensionless (0.0 to 20.0 typical range) */ @XmlElement(name = "flickerPst") - Long flickerPst, - + private Long flickerPst; + /** * Total harmonic distortion for voltage. * Represents the harmonic content in the voltage waveform. * Unit: percentage of fundamental frequency (stored as basis points, e.g., 500 = 5.00%) */ @XmlElement(name = "harmonicVoltage") - Long harmonicVoltage, - + private Long harmonicVoltage; + /** * Number of long interruptions during the summary period. * Interruptions lasting longer than 3 minutes as per IEEE 1159. * Unit: count */ @XmlElement(name = "longInterruptions") - Long longInterruptions, - + private Long longInterruptions; + /** * RMS voltage of the mains supply. * Represents the effective voltage value. * Unit: millivolts (mV) */ @XmlElement(name = "mainsVoltage") - Long mainsVoltage, - + private Long mainsVoltage; + /** * Measurement protocol identifier. * Indicates the standard or method used for measurements. @@ -99,88 +107,78 @@ public record ElectricPowerQualitySummaryDto( * - 4: IEC 61000-4-30 (General power quality) */ @XmlElement(name = "measurementProtocol") - Short measurementProtocol, - + private Short measurementProtocol; + /** * Power frequency measurement. * Nominal frequency is typically 50Hz or 60Hz. * Unit: millihertz (mHz) - e.g., 60000 for 60.000 Hz */ @XmlElement(name = "powerFrequency") - Long powerFrequency, - + private Long powerFrequency; + /** * Number of rapid voltage changes during the summary period. * Voltage changes exceeding specified thresholds per IEC 61000-4-15. * Unit: count */ @XmlElement(name = "rapidVoltageChanges") - Long rapidVoltageChanges, - + private Long rapidVoltageChanges; + /** * Number of short interruptions during the summary period. * Interruptions lasting between 0.5 seconds and 3 minutes per IEEE 1159. * Unit: count */ @XmlElement(name = "shortInterruptions") - Long shortInterruptions, - + private Long shortInterruptions; + /** * Summary interval for this power quality summary. * Time period covered by these measurements. * Typically covers 24-hour periods for daily summaries. */ @XmlElement(name = "summaryInterval") - DateTimeIntervalDto summaryInterval, - + private DateTimeIntervalDto summaryInterval; + /** * Number of supply voltage dips during the summary period. * Temporary reductions in RMS voltage below 90% of nominal per IEC 61000-4-11. * Unit: count */ @XmlElement(name = "supplyVoltageDips") - Long supplyVoltageDips, - + private Long supplyVoltageDips; + /** * Supply voltage imbalance measurement. * Represents asymmetry in three-phase voltage systems per IEC 61000-4-27. * Unit: percentage of positive sequence component (stored as basis points) */ @XmlElement(name = "supplyVoltageImbalance") - Long supplyVoltageImbalance, - + private Long supplyVoltageImbalance; + /** * Supply voltage variations measurement. * Long-term voltage magnitude variations from nominal per IEC 61000-4-30. * Unit: percentage deviation from nominal (stored as basis points) */ @XmlElement(name = "supplyVoltageVariations") - Long supplyVoltageVariations, - + private Long supplyVoltageVariations; + /** * Temporary overvoltage events count. * Voltage increases above 110% of nominal for limited duration per IEEE 1159. * Unit: count */ @XmlElement(name = "tempOvervoltage") - Long tempOvervoltage, - + private Long tempOvervoltage; + /** * Reference to the usage point this power quality summary belongs to. * Represents the logical relationship to the measurement point. */ @XmlTransient - Long usagePointId - -) { - - /** - * Default constructor for JAXB. - */ - public ElectricPowerQualitySummaryDto() { - this(null, null, null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null); - } + private Long usagePointId; /** * Constructor with basic identification. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalBlockDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalBlockDto.java index a608a6f2..490e7161 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalBlockDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalBlockDto.java @@ -20,10 +20,15 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + import java.util.List; /** - * IntervalBlock DTO record for JAXB XML marshalling/unmarshalling. + * IntervalBlock DTO class for JAXB XML marshalling/unmarshalling. * * Represents a time sequence of readings of the same ReadingType. * Contains a date/time interval and a collection of interval readings. @@ -38,63 +43,56 @@ @XmlType(name = "IntervalBlock", namespace = "http://naesb.org/espi", propOrder = { "interval", "intervalReadings" }) -public record IntervalBlockDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class IntervalBlockDto { @XmlTransient - Long id, + private Long id; @XmlTransient - String uuid, + private String uuid; - @XmlElement(name = "interval") - DateTimeIntervalDto interval, + @XmlElement(name = "interval", namespace = "http://naesb.org/espi") + private DateTimeIntervalDto interval; - @XmlElement(name = "IntervalReading") - List intervalReadings -) { - - /** - * Default constructor for JAXB. - */ - public IntervalBlockDto() { - this(null, null, null, null); - } + @XmlElement(name = "IntervalReading", namespace = "http://naesb.org/espi") + private List intervalReadings; /** - * Minimal constructor for basic interval block data. - */ - public IntervalBlockDto(String uuid, DateTimeIntervalDto interval) { - this(null, uuid, interval, null); - } - - /** - * Constructor with interval and readings. + * Convenience constructor for creating interval block with uuid, interval, and readings. + * + * @param uuid the resource identifier + * @param interval the time interval + * @param intervalReadings the list of readings */ public IntervalBlockDto(String uuid, DateTimeIntervalDto interval, List intervalReadings) { this(null, uuid, interval, intervalReadings); } - + /** * Generates the default self href for an interval block. - * + * * @return default self href */ public String generateSelfHref() { return uuid != null ? "/espi/1_1/resource/IntervalBlock/" + uuid : null; } - + /** * Generates the default up href for an interval block. - * + * * @return default up href */ public String generateUpHref() { return "/espi/1_1/resource/IntervalBlock"; } - + /** * Gets the total number of interval readings. - * + * * @return interval reading count */ public int getIntervalReadingCount() { diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalReadingDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalReadingDto.java index 14c2aa6c..d35baaa6 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalReadingDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/IntervalReadingDto.java @@ -20,11 +20,15 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.List; /** - * IntervalReading DTO record for JAXB XML marshalling/unmarshalling. + * IntervalReading DTO class for JAXB XML marshalling/unmarshalling. * * Represents specific readings of a measurement within an interval block. * Contains the actual energy values, costs, and reading quality information. @@ -37,46 +41,39 @@ @XmlType(name = "IntervalReading", namespace = "http://naesb.org/espi", propOrder = { "cost", "readingQualities", "timePeriod", "value", "consumptionTier", "tou", "cpp" }) -public record IntervalReadingDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class IntervalReadingDto { - @XmlElement(name = "cost") - Long cost, + @XmlElement(name = "cost", namespace = "http://naesb.org/espi") + private Long cost; - @XmlElement(name = "ReadingQuality") - List readingQualities, + @XmlElement(name = "ReadingQuality", namespace = "http://naesb.org/espi") + private List readingQualities; - @XmlElement(name = "timePeriod") - DateTimeIntervalDto timePeriod, + @XmlElement(name = "timePeriod", namespace = "http://naesb.org/espi") + private DateTimeIntervalDto timePeriod; - @XmlElement(name = "value") - Long value, + @XmlElement(name = "value", namespace = "http://naesb.org/espi") + private Long value; - @XmlElement(name = "consumptionTier") - Integer consumptionTier, + @XmlElement(name = "consumptionTier", namespace = "http://naesb.org/espi") + private Integer consumptionTier; - @XmlElement(name = "tou") - Integer tou, + @XmlElement(name = "tou", namespace = "http://naesb.org/espi") + private Integer tou; - @XmlElement(name = "cpp") - Integer cpp -) { + @XmlElement(name = "cpp", namespace = "http://naesb.org/espi") + private Integer cpp; /** - * Default constructor for JAXB. - */ - public IntervalReadingDto() { - this(null, null, null, null, null, null, null); - } - - /** - * Minimal constructor for basic interval reading data. - */ - public IntervalReadingDto(Long value, DateTimeIntervalDto timePeriod) { - this(null, null, timePeriod, value, null, null, null); - } - - /** - * Constructor for interval reading with cost information. + * Convenience constructor for basic reading with value, cost, and time period. + * + * @param value the reading value + * @param cost the cost + * @param timePeriod the time period */ public IntervalReadingDto(Long value, Long cost, DateTimeIntervalDto timePeriod) { this(cost, null, timePeriod, value, null, null, null); diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/LineItemDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/LineItemDto.java index 0829de43..cd26536d 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/LineItemDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/LineItemDto.java @@ -20,10 +20,14 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import org.greenbuttonalliance.espi.common.dto.SummaryMeasurementDto; /** - * LineItem DTO record for JAXB XML marshalling/unmarshalling. + * LineItem DTO class for JAXB XML marshalling/unmarshalling. * * Represents a line item of detail for additional cost. * Contains billing line item details including amount, rounding, timestamp, @@ -34,97 +38,69 @@ * * Part of the NAESB ESPI UsageSummary structure for detailed cost breakdowns. */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "LineItem", namespace = "http://naesb.org/espi") -@XmlAccessorType(XmlAccessType.PROPERTY) +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "LineItem", namespace = "http://naesb.org/espi", propOrder = { "amount", "rounding", "dateTime", "note", "measurement", "itemKind", "unitCost", "itemPeriod" }) -public record LineItemDto( - Long amount, - Long rounding, - Long dateTime, - String note, - SummaryMeasurementDto measurement, - Integer itemKind, - Long unitCost, - DateTimeIntervalDto itemPeriod -) { +public class LineItemDto { /** * Cost of line item in currency minor units (e.g., cents). */ @XmlElement(name = "amount") - public Long getAmount() { - return amount; - } + private Long amount; /** * Rounding adjustment applied to the line item amount. */ @XmlElement(name = "rounding") - public Long getRounding() { - return rounding; - } + private Long rounding; /** * Significant date/time for this line item. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "dateTime") - public Long getDateTime() { - return dateTime; - } + private Long dateTime; /** * Comment or description of the line item. */ @XmlElement(name = "note") - public String getNote() { - return note; - } + private String note; /** * Relevant measurement for the line item (extension field). * Contains measurement value, unit, multiplier, and reading type reference. */ @XmlElement(name = "measurement") - public SummaryMeasurementDto getMeasurement() { - return measurement; - } + private SummaryMeasurementDto measurement; /** * Classification of the line item (extension field). * ItemKind enumeration values (e.g., 1=Energy Generation Fee, 2=Energy Delivery Fee, etc.). */ @XmlElement(name = "itemKind") - public Integer getItemKind() { - return itemKind; - } + private Integer itemKind; /** * Per unit cost (extension field). * Cost per unit of measurement. */ @XmlElement(name = "unitCost") - public Long getUnitCost() { - return unitCost; - } + private Long unitCost; /** * Time period covered by this line item (extension field). * Supports pricing changes in the middle of a billing period. */ @XmlElement(name = "itemPeriod") - public DateTimeIntervalDto getItemPeriod() { - return itemPeriod; - } - - /** - * Default constructor for JAXB. - */ - public LineItemDto() { - this(null, null, null, null, null, null, null, null); - } + private DateTimeIntervalDto itemPeriod; /** * Constructor with basic line item information. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/MeterReadingDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/MeterReadingDto.java index ed20abe9..1238f992 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/MeterReadingDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/MeterReadingDto.java @@ -20,9 +20,13 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * MeterReading DTO record for JAXB XML marshalling/unmarshalling. + * MeterReading DTO class for JAXB XML marshalling/unmarshalling. * * Represents a meter reading - a set of values obtained from the meter. * Per ESPI 4.0 specification, MeterReading extends IdentifiedObject but @@ -36,22 +40,18 @@ @XmlRootElement(name = "MeterReading", namespace = "http://naesb.org/espi") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "MeterReading", namespace = "http://naesb.org/espi") -public record MeterReadingDto( - +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class MeterReadingDto { + @XmlTransient - Long id, - + private Long id; + @XmlTransient - String uuid -) { - - /** - * Default constructor for JAXB. - */ - public MeterReadingDto() { - this(null, null); - } - + private String uuid; + /** * Minimal constructor for basic meter reading data. */ diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefDto.java index 29b9c667..b2fa41d4 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefDto.java @@ -20,69 +20,56 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * PnodeRef DTO record for JAXB XML marshalling/unmarshalling. - * + * PnodeRef DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a reference to a pricing node in the electrical grid. * Used within UsagePoint to specify pricing locations for energy costs. - * + * * Part of the NAESB ESPI UsagePoint structure for pricing node references. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "PnodeRef", namespace = "http://naesb.org/espi", propOrder = { "apnodeType", "ref", "startEffectiveDate", "endEffectiveDate" }) -public record PnodeRefDto( - - String apnodeType, - String ref, - Long startEffectiveDate, - Long endEffectiveDate -) { - +public class PnodeRefDto { + /** * Type of the aggregated pricing node. * Indicates the category or classification of the pricing node. */ @XmlElement(name = "apnodeType") - public String getApnodeType() { - return apnodeType; - } - + private String apnodeType; + /** * Reference to the pricing node identifier. */ @XmlElement(name = "ref") - public String getRef() { - return ref; - } - + private String ref; + /** * Start effective date for the pricing node reference validity. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "startEffectiveDate") - public Long getStartEffectiveDate() { - return startEffectiveDate; - } - + private Long startEffectiveDate; + /** * End effective date for the pricing node reference validity. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "endEffectiveDate") - public Long getEndEffectiveDate() { - return endEffectiveDate; - } - - /** - * Default constructor for JAXB. - */ - public PnodeRefDto() { - this(null, null, null, null); - } - + private Long endEffectiveDate; + /** * Constructor with pricing node reference and type. */ diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefsDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefsDto.java index 7560c3af..e92ce227 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefsDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/PnodeRefsDto.java @@ -20,33 +20,34 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.ArrayList; import java.util.Arrays; import java.util.List; /** - * PnodeRefs DTO record for JAXB XML marshalling/unmarshalling. - * + * PnodeRefs DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a collection of pricing node references for a UsagePoint. * Used to specify multiple pricing locations that may apply to energy costs. - * + * * Follows NAESB ESPI specification for PnodeRefs complex type. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "PnodeRefs", namespace = "http://naesb.org/espi") -public record PnodeRefsDto( - - List pnodeRefs -) { - +public class PnodeRefsDto { + /** * List of pricing node references. * Each reference contains pricing node ID and validity period. */ @XmlElement(name = "PnodeRef") - public List getPnodeRefs() { - return pnodeRefs; - } + private List pnodeRefs; /** * Default constructor for JAXB. @@ -108,7 +109,7 @@ public List getValidRefs() { */ public List getRefsByRef(String ref) { return pnodeRefs.stream() - .filter(pnodeRef -> ref.equals(pnodeRef.ref())) + .filter(pnodeRef -> ref.equals(pnodeRef.getRef())) .toList(); } @@ -120,7 +121,7 @@ public List getRefsByRef(String ref) { */ public boolean hasRef(String ref) { return pnodeRefs.stream() - .anyMatch(pnodeRef -> ref.equals(pnodeRef.ref())); + .anyMatch(pnodeRef -> ref.equals(pnodeRef.getRef())); } /** diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingQualityDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingQualityDto.java index cce47b99..b3d60126 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingQualityDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingQualityDto.java @@ -20,9 +20,13 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * ReadingQuality DTO record for JAXB XML marshalling/unmarshalling. + * ReadingQuality DTO class for JAXB XML marshalling/unmarshalling. * * Represents quality indicators for readings, providing information about * the accuracy, validation status, and reliability of meter readings. @@ -35,16 +39,12 @@ @XmlType(name = "ReadingQuality", namespace = "http://naesb.org/espi", propOrder = { "quality" }) -public record ReadingQualityDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class ReadingQualityDto { - @XmlElement(name = "quality") - String quality -) { - - /** - * Default constructor for JAXB. - */ - public ReadingQualityDto() { - this(null); - } + @XmlElement(name = "quality", namespace = "http://naesb.org/espi") + private String quality; } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingTypeDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingTypeDto.java index a0964cfd..54d265cb 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingTypeDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ReadingTypeDto.java @@ -20,11 +20,15 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import org.greenbuttonalliance.espi.common.dto.RationalNumberDto; import org.greenbuttonalliance.espi.common.dto.ReadingInterharmonicDto; /** - * ReadingType DTO record for JAXB XML marshalling/unmarshalling. + * ReadingType DTO class for JAXB XML marshalling/unmarshalling. * * Represents comprehensive characteristics associated with all readings included in a MeterReading. * Contains metadata about the type of measurements including commodity, data qualifier, @@ -34,6 +38,10 @@ * This DTO supports the complete range of ESPI reading type attributes for electricity, * gas, water, and other commodity measurements with full pricing and time-of-use support. */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "ReadingType", namespace = "http://naesb.org/espi") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ReadingType", namespace = "http://naesb.org/espi", propOrder = { @@ -42,17 +50,17 @@ "powerOfTenMultiplier", "timeAttribute", "tou", "uom", "cpp", "interharmonic", "measuringPeriod", "argument" }) -public record ReadingTypeDto( +public class ReadingTypeDto { @XmlTransient - Long id, + private Long id; @XmlTransient // @XmlAttribute(name = "mRID") - String uuid, - - @XmlElement(name = "description") - String description, + private String uuid; + + @XmlTransient + private String description; /** * Accumulation behavior describing how readings accumulate over time. @@ -65,7 +73,7 @@ public record ReadingTypeDto( * - BULK_QUANTITY: Total amount in storage */ @XmlElement(name = "accumulationBehaviour") - String accumulationBehaviour, + private String accumulationBehaviour; /** * Commodity being measured. @@ -80,7 +88,7 @@ public record ReadingTypeDto( * - REFUSE: Waste management */ @XmlElement(name = "commodity") - String commodity, + private String commodity; /** * Consumption tier for tiered pricing structures. @@ -89,7 +97,7 @@ public record ReadingTypeDto( * Typical values: 1, 2, 3, etc. representing pricing tiers */ @XmlElement(name = "consumptionTier") - String consumptionTier, + private String consumptionTier; /** * Currency code for monetary readings. @@ -97,7 +105,7 @@ public record ReadingTypeDto( * Only present for cost/price reading types. */ @XmlElement(name = "currency") - String currency, + private String currency; /** * Data qualifier describing the nature of the reading value. @@ -111,7 +119,7 @@ public record ReadingTypeDto( * - PROJECTED: Future projected value */ @XmlElement(name = "dataQualifier") - String dataQualifier, + private String dataQualifier; /** * Default quality indicator for readings of this type. @@ -124,7 +132,7 @@ public record ReadingTypeDto( * - DERIVED: Calculated from other readings */ @XmlElement(name = "defaultQuality") - String defaultQuality, + private String defaultQuality; /** * Direction of energy flow for electrical measurements. @@ -138,7 +146,7 @@ public record ReadingTypeDto( * - TOTAL: Total energy (forward plus reverse) */ @XmlElement(name = "flowDirection") - String flowDirection, + private String flowDirection; /** * Length of the measurement interval in seconds. @@ -153,7 +161,7 @@ public record ReadingTypeDto( * - 2592000: Monthly intervals (approximate) */ @XmlElement(name = "intervalLength") - Long intervalLength, + private Long intervalLength; /** * Kind of measurement being performed. @@ -172,7 +180,7 @@ public record ReadingTypeDto( * - CARBON: Carbon emissions */ @XmlElement(name = "kind") - String kind, + private String kind; /** * Phase information for electrical measurements. @@ -186,7 +194,7 @@ public record ReadingTypeDto( * - NET: Net measurement across all phases */ @XmlElement(name = "phase") - String phase, + private String phase; /** * Power of ten multiplier for the unit of measure. @@ -201,7 +209,7 @@ public record ReadingTypeDto( * - NONE: 10^0 (no scaling) */ @XmlElement(name = "powerOfTenMultiplier") - String powerOfTenMultiplier, + private String powerOfTenMultiplier; /** * Time attribute describing the time period of interest. @@ -217,7 +225,7 @@ public record ReadingTypeDto( * - PREVIOUS: Previous period value */ @XmlElement(name = "timeAttribute") - String timeAttribute, + private String timeAttribute; /** * Time-of-use indicator. @@ -230,7 +238,7 @@ public record ReadingTypeDto( * - 0: No TOU pricing */ @XmlElement(name = "tou") - String tou, + private String tou; /** * Unit of measure for the readings. @@ -252,7 +260,7 @@ public record ReadingTypeDto( * - GAL: Gallons (water volume) */ @XmlElement(name = "uom") - String uom, + private String uom; /** * Critical peak pricing indicator. @@ -264,7 +272,7 @@ public record ReadingTypeDto( * - 2: Peak pricing warning */ @XmlElement(name = "cpp") - String cpp, + private String cpp; /** * Interharmonic information for power quality measurements. @@ -277,7 +285,7 @@ public record ReadingTypeDto( * - Frequency domain analysis */ @XmlElement(name = "interharmonic") - ReadingInterharmonicDto interharmonic, + private ReadingInterharmonicDto interharmonic; /** * Measuring period for the readings. @@ -290,7 +298,7 @@ public record ReadingTypeDto( * - CUMULATIVE: Cumulative totals */ @XmlElement(name = "measuringPeriod") - String measuringPeriod, + private String measuringPeriod; /** * Rational number argument for complex calculations. @@ -302,21 +310,11 @@ public record ReadingTypeDto( * - Scaling factors for display */ @XmlElement(name = "argument") - RationalNumberDto argument - -) { - - /** - * Default constructor for JAXB. - */ - public ReadingTypeDto() { - this(null, null, null, null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null); - } - + private RationalNumberDto argument; + /** * Constructor with basic identification. - * + * * @param id the database identifier * @param uuid the unique resource identifier * @param description human-readable description diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ServiceDeliveryPointDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ServiceDeliveryPointDto.java index 0fb10976..1e3622f8 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ServiceDeliveryPointDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/ServiceDeliveryPointDto.java @@ -20,9 +20,13 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * ServiceDeliveryPoint DTO record for JAXB XML marshalling/unmarshalling. + * ServiceDeliveryPoint DTO class for JAXB XML marshalling/unmarshalling. * * Represents a physical location where energy services are delivered to a customer. * This is typically associated with a physical address and represents the endpoint @@ -31,61 +35,44 @@ * ServiceDeliveryPoint is an embedded element within UsagePoint and contains only * ESPI business data - no Atom metadata (links, timestamps) as it's not a standalone resource. */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "ServiceDeliveryPoint", namespace = "http://naesb.org/espi") -@XmlAccessorType(XmlAccessType.PROPERTY) +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "ServiceDeliveryPoint", namespace = "http://naesb.org/espi", propOrder = { "name", "tariffProfile", "customerAgreement", "tariffRiderRefs" }) -public record ServiceDeliveryPointDto( - - String name, - String tariffProfile, - String customerAgreement, - TariffRiderRefsDto tariffRiderRefs -) { +public class ServiceDeliveryPointDto { /** * The name is any free human readable and possibly non unique text * naming the service delivery point object. */ @XmlElement(name = "name") - public String getName() { - return name; - } - + private String name; + /** - * A schedule of charges; structure associated with Tariff that allows + * A schedule of charges; structure associated with Tariff that allows * the definition of complex tariff structures such as step and time of use. */ @XmlElement(name = "tariffProfile") - public String getTariffProfile() { - return tariffProfile; - } - + private String tariffProfile; + /** - * Agreement between the customer and the ServiceSupplier to pay for + * Agreement between the customer and the ServiceSupplier to pay for * service at a specific service location. */ @XmlElement(name = "customerAgreement") - public String getCustomerAgreement() { - return customerAgreement; - } - + private String customerAgreement; + /** * List of rate options applied to the base tariff profile. * Contains enrollment status and effective dates for each rider. */ @XmlElement(name = "tariffRiderRefs") - public TariffRiderRefsDto getTariffRiderRefs() { - return tariffRiderRefs; - } - - /** - * Default constructor for JAXB. - */ - public ServiceDeliveryPointDto() { - this(null, null, null, null); - } + private TariffRiderRefsDto tariffRiderRefs; /** * Minimal constructor for basic service delivery point data. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefDto.java index c542a362..ea250a78 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefDto.java @@ -20,60 +20,50 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * TariffRiderRef DTO record for JAXB XML marshalling/unmarshalling. - * - * Represents a single tariff rider reference containing rate options applied + * TariffRiderRef DTO class for JAXB XML marshalling/unmarshalling. + * + * Represents a single tariff rider reference containing rate options applied * to the base tariff profile, enrollment status, and effective date. - * + * * Part of the NAESB ESPI ServiceDeliveryPoint structure for customer billing arrangements. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "TariffRiderRef", namespace = "http://naesb.org/espi", propOrder = { "riderType", "enrollmentStatus", "effectiveDate" }) -public record TariffRiderRefDto( - - String riderType, - String enrollmentStatus, - Long effectiveDate -) { - +public class TariffRiderRefDto { + /** * Rate options applied to the base tariff profile. * Examples: "TIME_OF_USE_PEAK", "NET_METERING", "DEMAND_RESPONSE", "GREEN_TARIFF" */ @XmlElement(name = "riderType") - public String getRiderType() { - return riderType; - } - + private String riderType; + /** * Retail Customer's Tariff Rider enrollment status. * Examples: "ENROLLED", "PENDING", "CANCELLED", "SUSPENDED" */ @XmlElement(name = "enrollmentStatus") - public String getEnrollmentStatus() { - return enrollmentStatus; - } - + private String enrollmentStatus; + /** * Effective date of Retail Customer's Tariff Rider enrollment status. * Stored as epoch seconds (TimeType in ESPI). */ @XmlElement(name = "effectiveDate") - public Long getEffectiveDate() { - return effectiveDate; - } - - /** - * Default constructor for JAXB. - */ - public TariffRiderRefDto() { - this(null, null, null); - } - + private Long effectiveDate; + /** * Constructor with rider type and enrollment status. * Effective date defaults to current time. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefsDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefsDto.java index a016406e..9a35fccb 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefsDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TariffRiderRefsDto.java @@ -20,35 +20,36 @@ package org.greenbuttonalliance.espi.common.dto.usage; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.ArrayList; import java.util.Arrays; import java.util.List; /** - * TariffRiderRefs DTO record for JAXB XML marshalling/unmarshalling. - * + * TariffRiderRefs DTO class for JAXB XML marshalling/unmarshalling. + * * Represents a collection of tariff rider references containing rate options - * applied to the base tariff profile. Used within ServiceDeliveryPoint to + * applied to the base tariff profile. Used within ServiceDeliveryPoint to * describe customer-specific billing arrangements and rate riders. - * + * * Follows NAESB ESPI specification for TariffRiderRefs complex type. */ -@XmlAccessorType(XmlAccessType.PROPERTY) +@Getter +@Setter +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "TariffRiderRefs", namespace = "http://naesb.org/espi") -public record TariffRiderRefsDto( - - List tariffRiderRefs -) { - +public class TariffRiderRefsDto { + /** * List of tariff rider references. * Each rider contains riderType, enrollmentStatus, and effectiveDate. * Supports multiple rate options per service delivery point. */ @XmlElement(name = "TariffRiderRef") - public List getTariffRiderRefs() { - return tariffRiderRefs; - } + private List tariffRiderRefs; /** * Default constructor for JAXB. @@ -110,32 +111,32 @@ public List getActiveRiders() { */ public List getRidersByStatus(String status) { return tariffRiderRefs.stream() - .filter(rider -> status.equals(rider.enrollmentStatus())) + .filter(rider -> status.equals(rider.getEnrollmentStatus())) .toList(); } - + /** * Gets tariff riders by rider type. - * + * * @param riderType rider type to filter by * @return list of tariff riders with matching type */ public List getRidersByType(String riderType) { return tariffRiderRefs.stream() - .filter(rider -> riderType.equals(rider.riderType())) + .filter(rider -> riderType.equals(rider.getRiderType())) .toList(); } - + /** * Checks if a specific rider type is enrolled. - * + * * @param riderType rider type to check * @return true if rider type is enrolled */ public boolean hasEnrolledRider(String riderType) { return tariffRiderRefs.stream() - .anyMatch(rider -> riderType.equals(rider.riderType()) && - "ENROLLED".equals(rider.enrollmentStatus())); + .anyMatch(rider -> riderType.equals(rider.getRiderType()) && + "ENROLLED".equals(rider.getEnrollmentStatus())); } /** diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDto.java index 12d433b5..ed3d7a00 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDto.java @@ -19,13 +19,17 @@ package org.greenbuttonalliance.espi.common.dto.usage; -import io.swagger.v3.oas.annotations.media.Schema; import jakarta.xml.bind.annotation.*; import jakarta.xml.bind.annotation.adapters.HexBinaryAdapter; import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * TimeConfiguration DTO record for JAXB XML marshalling/unmarshalling. + * TimeConfiguration DTO class for JAXB XML marshalling/unmarshalling. * * Represents time configuration parameters including timezone offset and * daylight saving time rules for energy metering systems. @@ -43,42 +47,55 @@ "dstStartRule", "tzOffset" }) -public record TimeConfigurationDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class TimeConfigurationDto { + /** + * Internal DTO identifier (not serialized to XML). + */ @XmlTransient - @Schema(description = "Internal DTO identifier (not serialized to XML)") - Long id, + private Long id; + /** + * Resource identifier (mRID). + */ @XmlTransient - @Schema(description = "Resource identifier (mRID)", example = "550e8400-e29b-41d4-a716-446655440000") - String uuid, + private String uuid; + /** + * Rule to calculate end of daylight savings time in the current year. + * Result of dstEndRule must be greater than result of dstStartRule. + */ @XmlElement(name = "dstEndRule", type = String.class) @XmlJavaTypeAdapter(HexBinaryAdapter.class) - @Schema(description = "Rule to calculate end of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.", example = "...") - byte[] dstEndRule, + @Getter(AccessLevel.NONE) + private byte[] dstEndRule; + /** + * Daylight savings time offset from local standard time in seconds. + */ @XmlElement(name = "dstOffset") - @Schema(description = "Daylight savings time offset from local standard time in seconds", example = "3600") - Long dstOffset, + private Long dstOffset; + /** + * Rule to calculate start of daylight savings time in the current year. + * Result of dstEndRule must be greater than result of dstStartRule. + */ @XmlElement(name = "dstStartRule", type = String.class) @XmlJavaTypeAdapter(HexBinaryAdapter.class) - @Schema(description = "Rule to calculate start of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.", example = "...") - byte[] dstStartRule, - - @XmlElement(name = "tzOffset") - @Schema(description = "Local time zone offset from UTC in seconds. Does not include any daylight savings time offsets. Positive values are east of UTC, negative values are west of UTC.", example = "-28800") - Long tzOffset - -) { + @Getter(AccessLevel.NONE) + private byte[] dstStartRule; /** - * Default constructor for JAXB. + * Local time zone offset from UTC in seconds. + * Does not include any daylight savings time offsets. + * Positive values are east of UTC, negative values are west of UTC. */ - public TimeConfigurationDto() { - this(null, null, null, null, null, null); - } + @XmlElement(name = "tzOffset") + private Long tzOffset; /** * Constructor with timezone offset only. @@ -99,27 +116,27 @@ public TimeConfigurationDto(String uuid, Long tzOffset) { this(null, uuid, null, null, null, tzOffset); } + // Custom getters for defensive copying of byte arrays + /** - * Override dstEndRule getter to return cloned array for defensive copying. + * Gets the dstEndRule with defensive copying. * * @return cloned byte array or null */ - @Override - public byte[] dstEndRule() { + public byte[] getDstEndRule() { return dstEndRule != null ? dstEndRule.clone() : null; } /** - * Override dstStartRule getter to return cloned array for defensive copying. + * Gets the dstStartRule with defensive copying. * * @return cloned byte array or null */ - @Override - public byte[] dstStartRule() { + public byte[] getDstStartRule() { return dstStartRule != null ? dstStartRule.clone() : null; } - // Utility methods (no @XmlTransient needed with FIELD access) + // Computed property getters /** * Gets the timezone offset in hours. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsagePointDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsagePointDto.java index 46080d19..73b296d1 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsagePointDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsagePointDto.java @@ -28,9 +28,13 @@ import jakarta.xml.bind.annotation.*; import jakarta.xml.bind.annotation.adapters.HexBinaryAdapter; import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; /** - * UsagePoint DTO record for JAXB XML marshalling/unmarshalling. + * UsagePoint DTO class for JAXB XML marshalling/unmarshalling. * * Represents a logical point on a network at which consumption or production * is either physically measured (e.g., metered) or estimated (e.g., unmetered street lights). @@ -46,169 +50,163 @@ "ratedPower", "readCycle", "readRoute", "serviceDeliveryRemark", "servicePriority", "pnodeRefs", "aggregatedNodeRefs" }) -public record UsagePointDto( +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor +public class UsagePointDto { @XmlTransient - String uuid, + private String uuid; @XmlElement(name = "roleFlags", type = String.class) @XmlJavaTypeAdapter(HexBinaryAdapter.class) - byte[] roleFlags, + private byte[] roleFlags; @XmlElement(name = "ServiceCategory") - ServiceCategory serviceCategory, + private ServiceCategory serviceCategory; @XmlElement(name = "status") - Short status, + private Short status; @XmlElement(name = "ServiceDeliveryPoint") - ServiceDeliveryPointDto serviceDeliveryPoint, + private ServiceDeliveryPointDto serviceDeliveryPoint; /** * Lifecycle states of the metering installation with respect to readiness for billing via AMI reads. * Per ESPI 4.0 XSD: [extension] AmiBillingReadyKind enum. */ @XmlElement(name = "amiBillingReady") - AmiBillingReadyKind amiBillingReady, + private AmiBillingReadyKind amiBillingReady; /** * True if there is a reason to suspect that a previous billing may have been performed with erroneous data. * Per ESPI 4.0 XSD: [extension] boolean field. */ @XmlElement(name = "checkBilling") - Boolean checkBilling, + private Boolean checkBilling; /** * State of the usage point with respect to connection to the network. * Per ESPI 4.0 XSD: [extension] UsagePointConnectedKind enum. */ @XmlElement(name = "connectionState") - UsagePointConnectedKind connectionState, + private UsagePointConnectedKind connectionState; /** * Estimated load for the usage point as SummaryMeasurement. */ @XmlElement(name = "estimatedLoad") - SummaryMeasurementDto estimatedLoad, + private SummaryMeasurementDto estimatedLoad; /** * True if grounded. * Per ESPI 4.0 XSD: [extension] boolean field. */ @XmlElement(name = "grounded") - Boolean grounded, + private Boolean grounded; /** * True if this usage point is a service delivery point. * Per ESPI 4.0 XSD: [extension] boolean field. */ @XmlElement(name = "isSdp") - Boolean isSdp, + private Boolean isSdp; /** * True if this usage point is virtual (no physical location exists). * Per ESPI 4.0 XSD: [extension] boolean field. */ @XmlElement(name = "isVirtual") - Boolean isVirtual, + private Boolean isVirtual; /** * True if minimal or zero usage is expected at this usage point. * Per ESPI 4.0 XSD: [extension] boolean field. */ @XmlElement(name = "minimalUsageExpected") - Boolean minimalUsageExpected, + private Boolean minimalUsageExpected; /** * Nominal service voltage for the usage point as SummaryMeasurement. */ @XmlElement(name = "nominalServiceVoltage") - SummaryMeasurementDto nominalServiceVoltage, + private SummaryMeasurementDto nominalServiceVoltage; /** * Outage region in which this usage point is located. * Per ESPI 4.0 XSD: [extension] String256 field. */ @XmlElement(name = "outageRegion") - String outageRegion, + private String outageRegion; /** * Phase code indicating number of wires and specific nominal phases. * Per ESPI 4.0 XSD: [extension] PhaseCodeKind enum. */ @XmlElement(name = "phaseCode") - PhaseCodeKind phaseCode, + private PhaseCodeKind phaseCode; /** * Rated current for the usage point as SummaryMeasurement. */ @XmlElement(name = "ratedCurrent") - SummaryMeasurementDto ratedCurrent, + private SummaryMeasurementDto ratedCurrent; /** * Rated power for the usage point as SummaryMeasurement. */ @XmlElement(name = "ratedPower") - SummaryMeasurementDto ratedPower, + private SummaryMeasurementDto ratedPower; /** * Cycle day on which the meter will normally be read. * Per ESPI 4.0 XSD: [extension] String256 field. */ @XmlElement(name = "readCycle") - String readCycle, + private String readCycle; /** * Route identifier for meter reading purposes. * Per ESPI 4.0 XSD: [extension] String256 field. */ @XmlElement(name = "readRoute") - String readRoute, + private String readRoute; /** * Remarks about this usage point. * Per ESPI 4.0 XSD: [extension] String256 field. */ @XmlElement(name = "serviceDeliveryRemark") - String serviceDeliveryRemark, + private String serviceDeliveryRemark; /** * Priority of service for this usage point. * Per ESPI 4.0 XSD: [extension] String32 field. */ @XmlElement(name = "servicePriority") - String servicePriority, + private String servicePriority; /** * Array of pricing node references. */ @XmlElement(name = "pnodeRefs") - PnodeRefsDto pnodeRefs, + private PnodeRefsDto pnodeRefs; /** * Array of aggregated node references. */ @XmlElement(name = "aggregatedNodeRefs") - AggregatedNodeRefsDto aggregatedNodeRefs, + private AggregatedNodeRefsDto aggregatedNodeRefs; @XmlTransient - Object meterReadings, // List - temporarily Object for compilation + private Object meterReadings; // List - temporarily Object for compilation @XmlTransient - Object usageSummaries, // List - temporarily Object for compilation + private Object usageSummaries; // List - temporarily Object for compilation @XmlTransient - Object electricPowerQualitySummaries // List - temporarily Object for compilation - -) { - - /** - * Default constructor for JAXB. - */ - public UsagePointDto() { - this(null, null, null, null, null, null, null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, null, null, null, null); - } + private Object electricPowerQualitySummaries; // List - temporarily Object for compilation /** * Minimal constructor for basic usage point data. @@ -242,12 +240,12 @@ public UsagePointDto(String uuid, ServiceCategory serviceCategory, } /** - * Override roleFlags getter to return cloned array for defensive copying. + * Override getRoleFlags to return cloned array for defensive copying. + * Lombok @Getter will be overridden by this explicit method. * * @return cloned byte array or null */ - @Override - public byte[] roleFlags() { + public byte[] getRoleFlags() { return roleFlags != null ? roleFlags.clone() : null; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsageSummaryDto.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsageSummaryDto.java index c69a25ce..5423bd4e 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsageSummaryDto.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/UsageSummaryDto.java @@ -24,11 +24,15 @@ import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; import jakarta.xml.bind.annotation.*; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; import java.time.OffsetDateTime; import java.util.List; /** - * UsageSummary DTO record for JAXB XML marshalling/unmarshalling. + * UsageSummary DTO class for JAXB XML marshalling/unmarshalling. *

* Represents aggregated usage data for a usage point. * Per ESPI 4.0 XSD (espi.xsd:806-939), UsageSummary extends IdentifiedObject @@ -36,8 +40,12 @@ *

* Supports Atom protocol XML wrapping with published, updated, and link metadata. */ +@Getter +@Setter +@NoArgsConstructor +@AllArgsConstructor @XmlRootElement(name = "UsageSummary", namespace = "http://naesb.org/espi") -@XmlAccessorType(XmlAccessType.PROPERTY) +@XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "UsageSummary", namespace = "http://naesb.org/espi", propOrder = { "billingPeriod", "billLastPeriod", "billToDate", "costAdditionalLastPeriod", "costAdditionalDetailLastPeriod", "currency", @@ -48,276 +56,85 @@ "ratchetDemand", "ratchetDemandPeriod", "statusTimeStamp", "commodity", "tariffProfile", "readCycle", "tariffRiderRefs", "billingChargeSource" }) -public record UsageSummaryDto( +public class UsageSummaryDto { @XmlTransient - Long id, + private Long id; @XmlAttribute(name = "mRID") - String uuid, - - DateTimeIntervalDto billingPeriod, - Long billLastPeriod, - Long billToDate, - Long costAdditionalLastPeriod, - List costAdditionalDetailLastPeriod, - String currency, - SummaryMeasurementDto overallConsumptionLastPeriod, - SummaryMeasurementDto currentBillingPeriodOverAllConsumption, - SummaryMeasurementDto currentDayLastYearNetConsumption, - SummaryMeasurementDto currentDayNetConsumption, - SummaryMeasurementDto currentDayOverallConsumption, - SummaryMeasurementDto peakDemand, - SummaryMeasurementDto previousDayLastYearOverallConsumption, - SummaryMeasurementDto previousDayNetConsumption, - SummaryMeasurementDto previousDayOverallConsumption, - String qualityOfReading, - SummaryMeasurementDto ratchetDemand, - DateTimeIntervalDto ratchetDemandPeriod, - Long statusTimeStamp, - Integer commodity, - String tariffProfile, - String readCycle, - TariffRiderRefsDto tariffRiderRefs, - BillingChargeSourceDto billingChargeSource -) { + private String uuid; - /** - * The billing period to which the included measurements apply. - * May also be an off-bill arbitrary period. - */ @XmlElement(name = "billingPeriod") - public DateTimeIntervalDto getBillingPeriod() { - return billingPeriod; - } + private DateTimeIntervalDto billingPeriod; - /** - * The amount of the bill for the referenced billingPeriod in hundred-thousandths - * of the currency specified in the ReadingType (e.g., 840 = USD). - */ @XmlElement(name = "billLastPeriod") - public Long getBillLastPeriod() { - return billLastPeriod; - } + private Long billLastPeriod; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the bill amount as of the date the summary is generated, - * in hundred-thousandths of the currency. - */ @XmlElement(name = "billToDate") - public Long getBillToDate() { - return billToDate; - } + private Long billToDate; - /** - * Additional charges from the referenced billingPeriod, in hundred-thousandths - * of the currency specified in the ReadingType. - */ @XmlElement(name = "costAdditionalLastPeriod") - public Long getCostAdditionalLastPeriod() { - return costAdditionalLastPeriod; - } + private Long costAdditionalLastPeriod; - /** - * Additional charges from the referenced billingPeriod which in total add up - * to costAdditionalLastPeriod. - * Extension field. - */ @XmlElement(name = "costAdditionalDetailLastPeriod") - public List getCostAdditionalDetailLastPeriod() { - return costAdditionalDetailLastPeriod; - } + private List costAdditionalDetailLastPeriod; - /** - * The ISO 4217 code indicating the currency applicable to the bill amounts - * in the summary. - */ @XmlElement(name = "currency") - public String getCurrency() { - return currency; - } + private String currency; - /** - * The amount of energy consumed for the referenced billingPeriod. - * Extension field. - */ @XmlElement(name = "overallConsumptionLastPeriod") - public SummaryMeasurementDto getOverallConsumptionLastPeriod() { - return overallConsumptionLastPeriod; - } + private SummaryMeasurementDto overallConsumptionLastPeriod; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the total consumption for the billing period. - */ @XmlElement(name = "currentBillingPeriodOverAllConsumption") - public SummaryMeasurementDto getCurrentBillingPeriodOverAllConsumption() { - return currentBillingPeriodOverAllConsumption; - } + private SummaryMeasurementDto currentBillingPeriodOverAllConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the amount of energy consumed one year ago interpreted - * as same day of week same week of year (see ISO 8601) based on the day of the statusTimeStamp. - */ @XmlElement(name = "currentDayLastYearNetConsumption") - public SummaryMeasurementDto getCurrentDayLastYearNetConsumption() { - return currentDayLastYearNetConsumption; - } + private SummaryMeasurementDto currentDayLastYearNetConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, net consumption for the current day (delivered - received) - * based on the day of the statusTimeStamp. - */ @XmlElement(name = "currentDayNetConsumption") - public SummaryMeasurementDto getCurrentDayNetConsumption() { - return currentDayNetConsumption; - } + private SummaryMeasurementDto currentDayNetConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, overall energy consumption for the current day, - * based on the day of the statusTimeStamp. - */ @XmlElement(name = "currentDayOverallConsumption") - public SummaryMeasurementDto getCurrentDayOverallConsumption() { - return currentDayOverallConsumption; - } + private SummaryMeasurementDto currentDayOverallConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, peak demand recorded for the current period. - */ @XmlElement(name = "peakDemand") - public SummaryMeasurementDto getPeakDemand() { - return peakDemand; - } + private SummaryMeasurementDto peakDemand; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the amount of energy consumed on the previous day - * one year ago interpreted as same day of week same week of year (see ISO 8601) - * based on the day of the statusTimestamp. - */ @XmlElement(name = "previousDayLastYearOverallConsumption") - public SummaryMeasurementDto getPreviousDayLastYearOverallConsumption() { - return previousDayLastYearOverallConsumption; - } + private SummaryMeasurementDto previousDayLastYearOverallConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, net consumption for the previous day relative to - * the day of the statusTimestamp. - */ @XmlElement(name = "previousDayNetConsumption") - public SummaryMeasurementDto getPreviousDayNetConsumption() { - return previousDayNetConsumption; - } + private SummaryMeasurementDto previousDayNetConsumption; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the total consumption for the previous day based - * on the day of the statusTimestamp. - */ @XmlElement(name = "previousDayOverallConsumption") - public SummaryMeasurementDto getPreviousDayOverallConsumption() { - return previousDayOverallConsumption; - } + private SummaryMeasurementDto previousDayOverallConsumption; - /** - * Indication of the quality of the summary readings. - * QualityOfReading enumeration value. - */ @XmlElement(name = "qualityOfReading") - public String getQualityOfReading() { - return qualityOfReading; - } + private String qualityOfReading; - /** - * If the summary contains data from a current period beyond the end of the - * referenced billingPeriod, the current ratchet demand value for the ratchet - * demand over the ratchetDemandPeriod. - */ @XmlElement(name = "ratchetDemand") - public SummaryMeasurementDto getRatchetDemand() { - return ratchetDemand; - } + private SummaryMeasurementDto ratchetDemand; - /** - * The period over which the ratchet demand applies. - */ @XmlElement(name = "ratchetDemandPeriod") - public DateTimeIntervalDto getRatchetDemandPeriod() { - return ratchetDemandPeriod; - } + private DateTimeIntervalDto ratchetDemandPeriod; - /** - * Date/Time status of this UsageSummary. - * Required field - TimeType (epoch seconds). - */ @XmlElement(name = "statusTimeStamp") - public Long getStatusTimeStamp() { - return statusTimeStamp; - } + private Long statusTimeStamp; - /** - * The commodity for this summary report. - * CommodityKind enumeration value. - * Extension field. - */ @XmlElement(name = "commodity") - public Integer getCommodity() { - return commodity; - } + private Integer commodity; - /** - * A schedule of charges; structure associated with Tariff that allows the - * definition of complex tariff structures such as step and time of use. - * Extension field, maximum length 256 characters. - */ @XmlElement(name = "tariffProfile") - public String getTariffProfile() { - return tariffProfile; - } + private String tariffProfile; - /** - * Cycle day on which the meter for this usage point will normally be read. - * Usually correlated with the billing cycle. - * Extension field, maximum length 256 characters. - */ @XmlElement(name = "readCycle") - public String getReadCycle() { - return readCycle; - } + private String readCycle; - /** - * List of rate options applied to the base tariff profile. - * Extension field. - */ @XmlElement(name = "tariffRiderRefs") - public TariffRiderRefsDto getTariffRiderRefs() { - return tariffRiderRefs; - } + private TariffRiderRefsDto tariffRiderRefs; - /** - * Source of Billing Charge. - * Extension field. - */ @XmlElement(name = "billingChargeSource") - public BillingChargeSourceDto getBillingChargeSource() { - return billingChargeSource; - } - - /** - * Default constructor for JAXB. - */ - public UsageSummaryDto() { - this(null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, - null, null, null, null, null, null, null, null, null, null); - } + private BillingChargeSourceDto billingChargeSource; /** * Minimal constructor for basic usage summary data. diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/package-info.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/package-info.java index 02fbf24b..88307430 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/package-info.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/dto/usage/package-info.java @@ -28,8 +28,10 @@ namespace = "http://naesb.org/espi", elementFormDefault = jakarta.xml.bind.annotation.XmlNsForm.QUALIFIED, xmlns = { - @XmlNs(prefix = "espi", namespaceURI = "http://naesb.org/espi"), - @XmlNs(prefix = "", namespaceURI = "http://www.w3.org/2005/Atom") + // Declare Atom with explicit atom prefix for UsageAtomEntryDto + @jakarta.xml.bind.annotation.XmlNs(prefix = "atom", namespaceURI = "http://www.w3.org/2005/Atom"), + // ESPI usage namespace uses espi prefix + @jakarta.xml.bind.annotation.XmlNs(prefix = "espi", namespaceURI = "http://naesb.org/espi") } ) package org.greenbuttonalliance.espi.common.dto.usage; diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/customer/CustomerMapper.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/customer/CustomerMapper.java index 105fb913..4639a77b 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/customer/CustomerMapper.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/customer/CustomerMapper.java @@ -54,7 +54,7 @@ public interface CustomerMapper extends BaseMapperUtils { * @param entity the customer entity * @return the customer DTO */ - @Mapping(target = "organisationRole", source = ".", qualifiedByName = "mapOrganisationRole") + @Mapping(target = "organisation", source = ".", qualifiedByName = "mapOrganisation") @Mapping(target = "kind", source = "kind") @Mapping(target = "specialNeed", source = "specialNeed") @Mapping(target = "vip", source = "vip") @@ -72,7 +72,7 @@ public interface CustomerMapper extends BaseMapperUtils { * @param dto the customer DTO * @return the customer entity */ - @Mapping(target = "organisation", source = "organisationRole", qualifiedByName = "mapOrganisation") + @Mapping(target = "organisation", source = "organisation", qualifiedByName = "mapOrganisationFromDto") @Mapping(target = "phoneNumbers", ignore = true) @Mapping(target = "kind", source = "kind") @Mapping(target = "specialNeed", source = "specialNeed") @@ -88,51 +88,50 @@ public interface CustomerMapper extends BaseMapperUtils { CustomerEntity toEntity(CustomerDto dto); /** - * Maps CustomerEntity with PhoneNumberEntity list to OrganisationRoleDto. + * Maps CustomerEntity with PhoneNumberEntity list to OrganisationDto. * Combines embedded Organisation data with separate phone number entities. + * Field order matches customer.xsd:1096-1125. */ - @Named("mapOrganisationRole") - default CustomerDto.OrganisationRoleDto mapOrganisationRole(CustomerEntity entity) { + @Named("mapOrganisation") + default CustomerDto.OrganisationDto mapOrganisation(CustomerEntity entity) { if (entity == null || entity.getOrganisation() == null) { return null; } - + Organisation org = entity.getOrganisation(); List phoneNumbers = entity.getPhoneNumbers(); - + // Extract phone numbers by type CustomerDto.PhoneNumberDto phone1 = extractPhoneByType(phoneNumbers, PhoneNumberEntity.PhoneType.PRIMARY); CustomerDto.PhoneNumberDto phone2 = extractPhoneByType(phoneNumbers, PhoneNumberEntity.PhoneType.SECONDARY); - - CustomerDto.OrganisationDto orgDto = new CustomerDto.OrganisationDto( - org.getOrganisationName(), + + // Constructor order: streetAddress, postalAddress, phone1, phone2, electronicAddress, organisationName + return new CustomerDto.OrganisationDto( mapStreetAddress(org.getStreetAddress()), mapStreetAddress(org.getPostalAddress()), phone1, phone2, - mapElectronicAddress(org.getElectronicAddress()) + mapElectronicAddress(org.getElectronicAddress()), + org.getOrganisationName() ); - - return new CustomerDto.OrganisationRoleDto(orgDto); } /** - * Maps OrganisationRoleDto to Organisation entity (without phone numbers). + * Maps OrganisationDto to Organisation entity (without phone numbers). * Phone numbers are handled separately via PhoneNumberEntity. */ - @Named("mapOrganisation") - default Organisation mapOrganisation(CustomerDto.OrganisationRoleDto organisationRole) { - if (organisationRole == null || organisationRole.organisation() == null) { + @Named("mapOrganisationFromDto") + default Organisation mapOrganisationFromDto(CustomerDto.OrganisationDto orgDto) { + if (orgDto == null) { return null; } - - CustomerDto.OrganisationDto orgDto = organisationRole.organisation(); + Organisation org = new Organisation(); - org.setOrganisationName(orgDto.organisationName()); - org.setStreetAddress(mapStreetAddressFromDto(orgDto.streetAddress())); - org.setPostalAddress(mapStreetAddressFromDto(orgDto.postalAddress())); - org.setElectronicAddress(mapElectronicAddressFromDto(orgDto.electronicAddress())); - + org.setOrganisationName(orgDto.getOrganisationName()); + org.setStreetAddress(mapStreetAddressFromDto(orgDto.getStreetAddress())); + org.setPostalAddress(mapStreetAddressFromDto(orgDto.getPostalAddress())); + org.setElectronicAddress(mapElectronicAddressFromDto(orgDto.getElectronicAddress())); + // Phone numbers are @Transient in Organisation and managed separately return org; } @@ -152,11 +151,11 @@ default CustomerDto.StreetAddressDto mapStreetAddress(Organisation.StreetAddress default Organisation.StreetAddress mapStreetAddressFromDto(CustomerDto.StreetAddressDto dto) { if (dto == null) return null; Organisation.StreetAddress address = new Organisation.StreetAddress(); - address.setStreetDetail(dto.streetDetail()); - address.setTownDetail(dto.townDetail()); - address.setStateOrProvince(dto.stateOrProvince()); - address.setPostalCode(dto.postalCode()); - address.setCountry(dto.country()); + address.setStreetDetail(dto.getStreetDetail()); + address.setTownDetail(dto.getTownDetail()); + address.setStateOrProvince(dto.getStateOrProvince()); + address.setPostalCode(dto.getPostalCode()); + address.setCountry(dto.getCountry()); return address; } @@ -173,10 +172,10 @@ default CustomerDto.ElectronicAddressDto mapElectronicAddress(Organisation.Elect default Organisation.ElectronicAddress mapElectronicAddressFromDto(CustomerDto.ElectronicAddressDto dto) { if (dto == null) return null; Organisation.ElectronicAddress address = new Organisation.ElectronicAddress(); - address.setEmail1(dto.email1()); - address.setEmail2(dto.email2()); - address.setWeb(dto.web()); - address.setRadio(dto.radio()); + address.setEmail1(dto.getEmail1()); + address.setEmail2(dto.getEmail2()); + address.setWeb(dto.getWeb()); + address.setRadio(dto.getRadio()); return address; } diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/usage/TariffRiderRefMapper.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/usage/TariffRiderRefMapper.java index bb44ac3e..e2e5af3c 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/usage/TariffRiderRefMapper.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/mapper/usage/TariffRiderRefMapper.java @@ -86,7 +86,7 @@ default List tariffRiderRefsDtoToEntityList(TariffRiderRef if (refsDto == null) { return null; } - return toEntityList(refsDto.tariffRiderRefs()); + return toEntityList(refsDto.getTariffRiderRefs()); } /** diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepository.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepository.java index 6774f89e..82bb79d5 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepository.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepository.java @@ -20,14 +20,9 @@ package org.greenbuttonalliance.espi.common.repositories.customer; import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; -import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; import org.springframework.data.jpa.repository.JpaRepository; -import org.springframework.data.jpa.repository.Query; -import org.springframework.data.repository.query.Param; import org.springframework.stereotype.Repository; -import java.util.List; -import java.util.Optional; import java.util.UUID; /** @@ -35,56 +30,12 @@ *

* Provides Customer schema specific query methods for Customer PII data access. * Customer data is separated from Usage data for privacy and compliance reasons. + *

+ * Per ESPI 4.0 API specification, only findById is supported (provided by JpaRepository). + * Removed queries: findByCustomerName, findByKind, findByPucNumber, findVipCustomers, + * findCustomersWithSpecialNeeds, findByLocale, findByPriorityRange, findByOrganisationName */ @Repository public interface CustomerRepository extends JpaRepository { - - - /** - * Find customer by customer name (case insensitive). - */ - @Query("SELECT c FROM CustomerEntity c WHERE UPPER(c.customerName) = UPPER(:customerName)") - Optional findByCustomerName(@Param("customerName") String customerName); - - /** - * Find customers by kind. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.kind = :kind") - List findByKind(@Param("kind") CustomerKind kind); - - /** - * Find customers by PUC number. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.pucNumber = :pucNumber") - Optional findByPucNumber(@Param("pucNumber") String pucNumber); - - /** - * Find customers with VIP status. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.vip = true") - List findVipCustomers(); - - /** - * Find customers with special needs. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.specialNeed IS NOT NULL AND c.specialNeed != '' AND c.specialNeed != 'NONE'") - List findCustomersWithSpecialNeeds(); - - /** - * Find customers by locale. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.locale = :locale") - List findByLocale(@Param("locale") String locale); - - /** - * Find customers by priority value range. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.priority.value BETWEEN :minPriority AND :maxPriority") - List findByPriorityRange(@Param("minPriority") Integer minPriority, @Param("maxPriority") Integer maxPriority); - - /** - * Find customers by organisation name. - */ - @Query("SELECT c FROM CustomerEntity c WHERE c.organisation.organisationName = :organisationName") - List findByOrganisationName(@Param("organisationName") String organisationName); + // Only default JpaRepository methods are supported (findById, findAll, save, delete, etc.) } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/BaseExportService.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/BaseExportService.java new file mode 100644 index 00000000..0c2b9f4a --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/BaseExportService.java @@ -0,0 +1,199 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service; + +import jakarta.annotation.PostConstruct; +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; +import lombok.extern.slf4j.Slf4j; + +import java.io.OutputStream; +import java.nio.charset.StandardCharsets; +import java.util.Set; + +/** + * Abstract base class for domain-specific XML export services. + *

+ * Provides common JAXB marshaller configuration for ESPI XML output with proper + * namespace handling. Subclasses implement domain-specific JAXBContext initialization + * to ensure only required namespaces are declared (2 namespace limit for JAXB 3.x). + *

+ * Design rationale: + * - JAXB 3.x cannot reliably predict default namespace with 3+ schemas + * - Each subclass registers exactly 2 namespaces: Atom + domain (espi OR cust) + * - This allows Atom to be the default namespace consistently + * + * @see UsageExportService for usage domain (Atom + espi namespaces) + * @see CustomerExportService for customer domain (Atom + cust namespaces) + */ +@Slf4j +public abstract class BaseExportService { + + /** + * XML declaration and stylesheet processing instruction for ESPI feeds. + */ + protected static final String XML_HEADER = """ + + + """; + + /** + * Cached JAXBContext for this domain. + * Initialized once at service startup via @PostConstruct. + */ + private JAXBContext jaxbContext; + + /** + * Gets the domain-specific JAXBContext. + *

+ * Subclasses must register exactly 2 namespaces: + * 1. Atom namespace (http://www.w3.org/2005/Atom) + * 2. Domain namespace (espi OR cust) + *

+ * Example for usage domain: + * 

+     * return JAXBContext.newInstance(
+     *     // Atom classes
+     *     UsageAtomEntryDto.class,
+     *     LinkDto.class,
+     *     // Usage domain classes ONLY
+     *     UsagePointDto.class,
+     *     MeterReadingDto.class,
+     *     // ... (NO customer domain classes)
+     * );
+     *
+ * + * @return JAXBContext configured for this domain + * @throws JAXBException if context creation fails + */ + protected abstract JAXBContext createJAXBContext() throws JAXBException; + + /** + * Returns the set of namespaces for this domain. + *

+ * Must return exactly 2 namespaces: + * - Atom: http://www.w3.org/2005/Atom + * - Domain: http://naesb.org/espi OR http://naesb.org/espi/customer + * + * @return set of 2 namespace URIs + */ + protected abstract Set getDomainNamespaces(); + + /** + * Initializes the JAXBContext at service startup. + * This one-time initialization improves performance by avoiding repeated context creation. + */ + @PostConstruct + protected void initializeJAXBContext() { + try { + this.jaxbContext = createJAXBContext(); + log.info("Initialized JAXBContext for {} with namespaces: {}", + this.getClass().getSimpleName(), getDomainNamespaces()); + } catch (JAXBException e) { + log.error("Failed to initialize JAXBContext for {}: {}", + this.getClass().getSimpleName(), e.getMessage(), e); + throw new RuntimeException("Failed to initialize export service", e); + } + } + + /** + * Public initialization method for testing purposes. + * Allows tests to manually initialize the service without Spring context. + * In production, this is called automatically by @PostConstruct. + */ + public void init() { + initializeJAXBContext(); + } + + /** + * Creates a configured JAXB Marshaller for this domain. + *

+ * Configuration: + * - Formatted output with proper indentation + * - UTF-8 encoding + * - Namespace prefixes defined in package-info.java files (atom:, espi:, cust:) + * - Only domain namespaces are declared + *

+ * Note: Namespace prefix control is achieved via @XmlSchema declarations in package-info.java + * files rather than a custom NamespacePrefixMapper. This is simpler and more maintainable. + * + * @return configured Marshaller instance + * @throws JAXBException if marshaller creation fails + */ + protected Marshaller createMarshaller() throws JAXBException { + if (jaxbContext == null) { + throw new IllegalStateException("JAXBContext not initialized. Ensure @PostConstruct was called."); + } + + Marshaller marshaller = jaxbContext.createMarshaller(); + + // Standard JAXB formatting properties + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false); + + return marshaller; + } + + /** + * Exports a DTO to XML format. + * + * @param dto the DTO to export (AtomEntryDto, AtomFeedDto, or ESPI resource DTO) + * @param stream the output stream to write XML to + * @throws RuntimeException if marshalling fails + */ + public void exportDto(Object dto, OutputStream stream) { + try { + Marshaller marshaller = createMarshaller(); + marshaller.marshal(dto, stream); + log.debug("Successfully exported DTO of type: {}", dto.getClass().getSimpleName()); + } catch (JAXBException e) { + log.error("Failed to marshal DTO: {}", e.getMessage(), e); + throw new RuntimeException("Failed to export DTO", e); + } + } + + /** + * Exports a DTO to XML format with XML header. + *

+ * Use this method for feed exports that require the XML declaration + * and stylesheet processing instruction. + * + * @param dto the DTO to export + * @param stream the output stream to write XML to + * @throws RuntimeException if export fails + */ + public void exportDtoWithHeader(Object dto, OutputStream stream) { + try { + // Write XML header + stream.write(XML_HEADER.getBytes(StandardCharsets.UTF_8)); + + // Marshal the DTO + Marshaller marshaller = createMarshaller(); + marshaller.marshal(dto, stream); + + log.debug("Successfully exported DTO with header: {}", dto.getClass().getSimpleName()); + } catch (Exception e) { + log.error("Failed to export DTO with header: {}", e.getMessage(), e); + throw new RuntimeException("Failed to export DTO with header", e); + } + } +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/CustomerService.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/CustomerService.java index 647ac558..0dfd11d8 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/CustomerService.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/CustomerService.java @@ -20,7 +20,6 @@ package org.greenbuttonalliance.espi.common.service.customer; import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; -import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; import java.util.List; import java.util.Optional; @@ -28,10 +27,14 @@ /** * Service interface for Customer PII data management. - * + * * Handles Customer schema operations with proper separation from Usage data. * Customer data contains Personally Identifiable Information (PII) and requires * special handling according to NAESB REQ.21 ESPI standards. + *

+ * Per ESPI 4.0 API specification, only basic CRUD operations are supported. + * Removed methods: findByCustomerName, findByKind, findByPucNumber, findVipCustomers, + * findCustomersWithSpecialNeeds, findByLocale, findByPriorityRange, findByOrganisationName, countByKind */ public interface CustomerService { @@ -45,46 +48,6 @@ public interface CustomerService { */ Optional findById(UUID id); - /** - * Find customer by customer name. - */ - Optional findByCustomerName(String customerName); - - /** - * Find customers by kind. - */ - List findByKind(CustomerKind kind); - - /** - * Find customer by PUC number. - */ - Optional findByPucNumber(String pucNumber); - - /** - * Find VIP customers. - */ - List findVipCustomers(); - - /** - * Find customers with special needs. - */ - List findCustomersWithSpecialNeeds(); - - /** - * Find customers by locale. - */ - List findByLocale(String locale); - - /** - * Find customers by priority range. - */ - List findByPriorityRange(Integer minPriority, Integer maxPriority); - - /** - * Find customers by organisation name. - */ - List findByOrganisationName(String organisationName); - /** * Save customer. */ @@ -104,9 +67,4 @@ public interface CustomerService { * Count total customers. */ long countCustomers(); - - /** - * Count customers by kind. - */ - long countByKind(CustomerKind kind); } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/impl/CustomerServiceImpl.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/impl/CustomerServiceImpl.java index f98050c3..0360494d 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/impl/CustomerServiceImpl.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/customer/impl/CustomerServiceImpl.java @@ -21,7 +21,6 @@ import lombok.RequiredArgsConstructor; import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; -import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; import org.greenbuttonalliance.espi.common.repositories.customer.CustomerRepository; import org.greenbuttonalliance.espi.common.service.customer.CustomerService; import org.springframework.stereotype.Service; @@ -33,8 +32,9 @@ /** * Service implementation for Customer PII data management. - * + * * Provides business logic for Customer schema operations with proper PII handling. + * Per ESPI 4.0 API specification, only basic CRUD operations are supported. */ @Service @Transactional @@ -55,54 +55,6 @@ public Optional findById(UUID id) { return customerRepository.findById(id); } - @Override - @Transactional(readOnly = true) - public Optional findByCustomerName(String customerName) { - return customerRepository.findByCustomerName(customerName); - } - - @Override - @Transactional(readOnly = true) - public List findByKind(CustomerKind kind) { - return customerRepository.findByKind(kind); - } - - @Override - @Transactional(readOnly = true) - public Optional findByPucNumber(String pucNumber) { - return customerRepository.findByPucNumber(pucNumber); - } - - @Override - @Transactional(readOnly = true) - public List findVipCustomers() { - return customerRepository.findVipCustomers(); - } - - @Override - @Transactional(readOnly = true) - public List findCustomersWithSpecialNeeds() { - return customerRepository.findCustomersWithSpecialNeeds(); - } - - @Override - @Transactional(readOnly = true) - public List findByLocale(String locale) { - return customerRepository.findByLocale(locale); - } - - @Override - @Transactional(readOnly = true) - public List findByPriorityRange(Integer minPriority, Integer maxPriority) { - return customerRepository.findByPriorityRange(minPriority, maxPriority); - } - - @Override - @Transactional(readOnly = true) - public List findByOrganisationName(String organisationName) { - return customerRepository.findByOrganisationName(organisationName); - } - @Override public CustomerEntity save(CustomerEntity customer) { // Generate UUID if not present @@ -128,10 +80,4 @@ public boolean existsById(UUID id) { public long countCustomers() { return customerRepository.count(); } - - @Override - @Transactional(readOnly = true) - public long countByKind(CustomerKind kind) { - return customerRepository.findByKind(kind).size(); - } } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportService.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportService.java new file mode 100644 index 00000000..2715972e --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportService.java @@ -0,0 +1,107 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service.impl; + +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import org.greenbuttonalliance.espi.common.service.BaseExportService; +import org.springframework.stereotype.Service; + +import java.util.Set; + +/** + * Export service for ESPI Customer Domain resources. + *

+ * This service handles XML marshalling for customer domain resources defined in customer.xsd, + * including Customer, CustomerAccount, CustomerAgreement, ServiceLocation, Meter, etc. + *

+ * Namespace configuration: + * - Atom namespace (http://www.w3.org/2005/Atom) - default namespace + * - Customer namespace (http://naesb.org/espi/customer) - with "cust:" prefix + *

+ * This service does NOT register usage domain classes (UsagePointDto, MeterReadingDto, etc.) + * to prevent xmlns:espi namespace pollution. Per NAESB ESPI standard, usage and customer + * domains are mutually exclusive. + *

+ * Expected XML output: + * 

+ * <entry xmlns="http://www.w3.org/2005/Atom" xmlns:cust="http://naesb.org/espi/customer">
+ *   <id>urn:uuid:...</id>
+ *   <title>Customer</title>
+ *   <cust:Customer>
+ *     ...
+ *   </cust:Customer>
+ * </entry>
+ *
+ */ +@Service("customerExportService") +public class CustomerExportService extends BaseExportService { + + private static final String ATOM_NAMESPACE = "http://www.w3.org/2005/Atom"; + private static final String CUSTOMER_NAMESPACE = "http://naesb.org/espi/customer"; + + /** + * Creates JAXBContext with ONLY Atom + Customer domain classes. + *

+ * Registers exactly 2 namespaces: + * 1. Atom namespace (for entry, feed, link elements) + * 2. Customer namespace (for customer domain resources) + *

+ * Does NOT register: + * - UsageAtomEntryDto (would bring in espi namespace) + * - Usage domain DTOs (UsagePointDto, MeterReadingDto, etc.) + * + * @return JAXBContext configured for customer domain + * @throws JAXBException if context creation fails + */ + @Override + protected JAXBContext createJAXBContext() throws JAXBException { + return JAXBContext.newInstance( + // Atom protocol classes + org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto.class, // Customer-specific entry + org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto.class, + org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, + + // Customer domain classes (http://naesb.org/espi/customer) - from customer.xsd + org.greenbuttonalliance.espi.common.dto.customer.CustomerDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAccountDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAgreementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.EndDeviceDto.class, + org.greenbuttonalliance.espi.common.dto.customer.MeterDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ProgramDateIdMappingsDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ServiceLocationDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementRefDto.class + + // ❌ NO UsageAtomEntryDto + // ❌ NO Usage domain DTOs (would bring in xmlns:espi) + ); + } + + /** + * Returns the 2 namespaces for customer domain. + * + * @return set containing Atom and Customer namespaces + */ + @Override + protected Set getDomainNamespaces() { + return Set.of(ATOM_NAMESPACE, CUSTOMER_NAMESPACE); + } +} \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceFacade.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceFacade.java new file mode 100644 index 00000000..0c800fb4 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceFacade.java @@ -0,0 +1,259 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service.impl; + +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.greenbuttonalliance.espi.common.domain.usage.UsagePointEntity; +import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto; +import org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; +import org.greenbuttonalliance.espi.common.mapper.usage.UsagePointMapper; +import org.greenbuttonalliance.espi.common.repositories.usage.UsagePointRepository; +import org.greenbuttonalliance.espi.common.service.DtoExportService; +import org.greenbuttonalliance.espi.common.service.EspiIdGeneratorService; +import org.springframework.context.annotation.Primary; +import org.springframework.stereotype.Service; + +import java.io.OutputStream; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +/** + * Facade implementation of DtoExportService that delegates to domain-specific export services. + *

+ * This facade provides backwards compatibility with the existing DtoExportService interface + * while leveraging the new domain-specific export services (UsageExportService, CustomerExportService) + * for proper namespace isolation. + *

+ * Domain detection logic: + * - Inspects DTO package name to determine domain + * - Usage domain: .dto.usage → delegates to UsageExportService + * - Customer domain: .dto.customer → delegates to CustomerExportService + * - AtomEntry subtypes: UsageAtomEntryDto vs CustomerAtomEntryDto + *

+ * This is the primary bean for DtoExportService (marked with @Primary). + * Existing controllers and services continue to use the DtoExportService interface + * without code changes. + */ +@Slf4j +@Service +@Primary +@RequiredArgsConstructor +public class DtoExportServiceFacade implements DtoExportService { + + private final UsageExportService usageExportService; + private final CustomerExportService customerExportService; + private final UsagePointRepository usagePointRepository; + private final UsagePointMapper usagePointMapper; + private final EspiIdGeneratorService espiIdGeneratorService; + + @Override + public void exportUsagePointEntry(UUID usagePointId, OutputStream stream) { + Optional entity = usagePointRepository.findById(usagePointId); + if (entity.isPresent()) { + exportUsagePointEntry(entity.get(), stream); + } else { + log.warn("Usage point not found: {}", usagePointId); + } + } + + @Override + public void exportUsagePointsFeedByIds(List usagePointIds, OutputStream stream) { + List entities = new ArrayList<>(); + for (UUID id : usagePointIds) { + usagePointRepository.findById(id).ifPresent(entities::add); + } + exportUsagePointsFeed(entities, stream); + } + + @Override + public void exportUsagePointEntry(UsagePointEntity usagePoint, OutputStream stream) { + try { + // Convert entity to DTO + UsagePointDto dto = usagePointMapper.toDto(usagePoint); + + // Create Atom entry + AtomEntryDto entry = createAtomEntry("Usage Point " + usagePoint.getId(), dto); + + // Export as XML using domain-specific service + exportDto(entry, stream); + + } catch (Exception e) { + log.error("Failed to export usage point entry: {}", e.getMessage(), e); + } + } + + @Override + public void exportUsagePointsFeed(List usagePoints, OutputStream stream) { + try { + List entries = new ArrayList<>(); + + // Convert each entity to DTO and create entry + for (UsagePointEntity entity : usagePoints) { + UsagePointDto dto = usagePointMapper.toDto(entity); + AtomEntryDto entry = createAtomEntry("Usage Point " + entity.getId(), dto); + entries.add(entry); + } + + // Create feed + AtomFeedDto feed = createAtomFeed("Usage Points", entries); + + // Export as XML using domain-specific service + exportAtomFeed(feed, stream); + + } catch (Exception e) { + log.error("Failed to export usage points feed: {}", e.getMessage(), e); + } + } + + /** + * Exports any DTO as XML by delegating to the appropriate domain-specific service. + *

+ * Domain detection: + * 1. Check if DTO is AtomEntryDto subtype (UsageAtomEntryDto vs CustomerAtomEntryDto) + * 2. If AtomFeedDto, inspect first entry to determine domain + * 3. Otherwise, check DTO package name (.dto.usage vs .dto.customer) + * + * @param dto the DTO to export + * @param stream output stream for XML + */ + @Override + public void exportDto(Object dto, OutputStream stream) { + String domain = detectDomain(dto); + + switch (domain) { + case "usage" -> usageExportService.exportDto(dto, stream); + case "customer" -> customerExportService.exportDto(dto, stream); + default -> { + log.warn("Unable to determine domain for DTO: {}. Defaulting to usage domain.", + dto.getClass().getName()); + usageExportService.exportDto(dto, stream); + } + } + } + + @Override + public void exportAtomFeed(AtomFeedDto atomFeedDto, OutputStream stream) { + String domain = detectDomain(atomFeedDto); + + switch (domain) { + case "usage" -> usageExportService.exportDtoWithHeader(atomFeedDto, stream); + case "customer" -> customerExportService.exportDtoWithHeader(atomFeedDto, stream); + default -> { + log.warn("Unable to determine domain for feed. Defaulting to usage domain."); + usageExportService.exportDtoWithHeader(atomFeedDto, stream); + } + } + } + + @Override + public AtomFeedDto createAtomFeed(String title, List entries) { + OffsetDateTime now = OffsetDateTime.now(); + + return new AtomFeedDto( + UUID.randomUUID().toString(), // id + title, // title + now, // published + now, // updated + null, // links + entries // entries + ); + } + + @Override + public AtomEntryDto createAtomEntry(String title, Object resource) { + java.time.LocalDateTime localDateTime = java.time.LocalDateTime.now() + .truncatedTo(java.time.temporal.ChronoUnit.SECONDS); + java.time.OffsetDateTime now = localDateTime.atOffset(java.time.ZoneOffset.UTC) + .toZonedDateTime().toOffsetDateTime(); + + // Generate a UUID5 using title and resource type as the base + String resourceType = resource.getClass().getSimpleName(); + UUID uuid5 = espiIdGeneratorService.generateSubscriptionId(resourceType, title); + String entryId = "urn:uuid:" + uuid5.toString(); + + // Determine which AtomEntry subclass to use based on resource package + // Per NAESB ESPI standard, usage and customer domains are mutually exclusive + String packageName = resource.getClass().getPackage().getName(); + if (packageName.contains(".dto.customer")) { + // Customer domain resource → CustomerAtomEntryDto (declares xmlns:cust only) + return new CustomerAtomEntryDto(entryId, title, now, now, null, resource); + } else { + // Usage domain resource → UsageAtomEntryDto (declares xmlns:espi only) + return new UsageAtomEntryDto(entryId, title, now, now, null, resource); + } + } + + /** + * Detects the domain (usage vs customer) for a given DTO. + *

+ * Detection strategy: + * 1. If UsageAtomEntryDto → usage domain + * 2. If CustomerAtomEntryDto → customer domain + * 3. If AtomFeedDto, inspect first entry's content + * 4. Otherwise, check DTO package name + * + * @param dto the DTO to inspect + * @return "usage" or "customer" + */ + private String detectDomain(Object dto) { + // 1. Check AtomEntry subtypes + if (dto instanceof UsageAtomEntryDto) { + return "usage"; + } + if (dto instanceof CustomerAtomEntryDto) { + return "customer"; + } + + // 2. Check AtomFeedDto entries + if (dto instanceof AtomFeedDto feed) { + if (feed.getEntries() != null && !feed.getEntries().isEmpty()) { + AtomEntryDto firstEntry = feed.getEntries().get(0); + return detectDomain(firstEntry); + } + } + + // 3. Check AtomEntryDto content + if (dto instanceof AtomEntryDto entry) { + Object content = entry.getContent(); + if (content != null) { + return detectDomain(content); + } + } + + // 4. Check package name + String packageName = dto.getClass().getPackage().getName(); + if (packageName.contains(".dto.customer")) { + return "customer"; + } + if (packageName.contains(".dto.usage")) { + return "usage"; + } + + // Default to usage domain + return "usage"; + } +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java index 5bc8697c..9b10225b 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java @@ -19,28 +19,21 @@ package org.greenbuttonalliance.espi.common.service.impl; -import com.fasterxml.jackson.annotation.JsonInclude; +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.greenbuttonalliance.espi.common.domain.usage.UsagePointEntity; import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; import org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto; import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; import org.greenbuttonalliance.espi.common.mapper.usage.UsagePointMapper; import org.greenbuttonalliance.espi.common.repositories.usage.UsagePointRepository; import org.greenbuttonalliance.espi.common.service.DtoExportService; import org.springframework.stereotype.Service; -import tools.jackson.databind.AnnotationIntrospector; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.cfg.DatatypeFeature; -import tools.jackson.databind.cfg.DateTimeFeature; -import tools.jackson.databind.introspect.JacksonAnnotationIntrospector; -import tools.jackson.databind.util.StdDateFormat; -import tools.jackson.dataformat.xml.XmlAnnotationIntrospector; -import tools.jackson.dataformat.xml.XmlMapper; -import tools.jackson.dataformat.xml.XmlWriteFeature; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule; import java.io.IOException; import java.io.OutputStream; @@ -126,50 +119,181 @@ public void exportUsagePointsFeed(List usagePoints, OutputStre @Override public void exportDto(Object dto, OutputStream stream) { + try { + // Determine required namespaces by inspecting the DTO content + Set requiredNamespaces = determineRequiredNamespaces(dto); - // Create JAXB context for DTO classes - final XmlMapper xmlMapper = createXmlMapper(); - - xmlMapper.writeValue(stream, dto); - - log.info("Successfully exported DTO of type: " + dto.getClass().getSimpleName()); + Marshaller marshaller = createMarshaller(dto.getClass(), requiredNamespaces); + marshaller.marshal(dto, stream); + log.info("Successfully exported DTO of type: " + dto.getClass().getSimpleName()); + } catch (JAXBException e) { + log.error("Failed to marshal DTO: " + e.getMessage(), e); + throw new RuntimeException("Failed to export DTO", e); + } } @Override public void exportAtomFeed(AtomFeedDto atomFeedDto, OutputStream stream) { - try { + // Write XML header manually stream.write(XML_HEADER.getBytes(StandardCharsets.UTF_8)); + + // Determine required namespaces by inspecting the feed content + Set requiredNamespaces = determineRequiredNamespaces(atomFeedDto); + + // Marshal the feed + Marshaller marshaller = createMarshaller(AtomFeedDto.class, requiredNamespaces); + marshaller.marshal(atomFeedDto, stream); + + log.info("Successfully exported DTO of type: " + atomFeedDto.getClass().getSimpleName()); } catch (IOException e) { - throw new RuntimeException(e); + log.error("Failed to write XML header: " + e.getMessage(), e); + throw new RuntimeException("Failed to export Atom feed", e); + } catch (JAXBException e) { + log.error("Failed to marshal Atom feed: " + e.getMessage(), e); + throw new RuntimeException("Failed to export Atom feed", e); } + } - // Create JAXB context for DTO classes - final XmlMapper xmlMapper = createXmlMapper(); + /** + * Determines required namespaces by inspecting DTO content. + * Examines AtomEntryDto/AtomFeedDto content to identify whether espi or cust namespace is needed. + * + * @param dto the DTO to inspect + * @return set of required namespace URIs (always includes Atom namespace) + */ + private Set determineRequiredNamespaces(Object dto) { + Set namespaces = new HashSet<>(); - xmlMapper.writeValue(stream, atomFeedDto); + // Always include Atom namespace + namespaces.add("http://www.w3.org/2005/Atom"); - log.info("Successfully exported DTO of type: " + atomFeedDto.getClass().getSimpleName()); + if (dto instanceof AtomEntryDto entry) { + // Inspect the content to determine espi vs cust namespace + Object content = entry.getContent(); + if (content != null) { + addNamespaceForContent(content, namespaces); + } + } else if (dto instanceof AtomFeedDto feed) { + // Check all entries in the feed + if (feed.getEntries() != null) { + for (AtomEntryDto entry : feed.getEntries()) { + Object content = entry.getContent(); + if (content != null) { + addNamespaceForContent(content, namespaces); + // Per NAESB ESPI standard, all entries use same namespace + // so we can break after finding the first one + break; + } + } + } + } + + return namespaces; } - private XmlMapper createXmlMapper() { - AnnotationIntrospector intr = XmlAnnotationIntrospector.Pair.instance - (new JakartaXmlBindAnnotationIntrospector(), - new JacksonAnnotationIntrospector()); - - // Create JAXB context for DTO classes - //2012-10-24T00:00:00Z - return XmlMapper.xmlBuilder() - // .configure(XmlWriteFeature.WRITE_XML_DECLARATION, true) - .annotationIntrospector(intr) - .addModule(new JakartaXmlBindAnnotationModule().setNonNillableInclusion(JsonInclude.Include.NON_EMPTY)) - .enable(SerializationFeature.INDENT_OUTPUT) - .enable(DateTimeFeature.WRITE_DATES_WITH_ZONE_ID) - //.enable(DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS) - //.enable(SerializationFeature.WRITE_DATES_AS_TIMESTAMP) - .disable(XmlWriteFeature.WRITE_NULLS_AS_XSI_NIL) - .defaultDateFormat(new StdDateFormat()) - .build(); + /** + * Adds the appropriate namespace (espi or cust) based on content type. + * + * @param content the content object to examine + * @param namespaces the set to add the namespace to + */ + private void addNamespaceForContent(Object content, Set namespaces) { + String packageName = content.getClass().getPackage().getName(); + + if (packageName.contains(".dto.usage")) { + // Usage domain resources use espi namespace + namespaces.add("http://naesb.org/espi"); + } else if (packageName.contains(".dto.customer")) { + // Customer domain resources use cust namespace + namespaces.add("http://naesb.org/espi/customer"); + } + } + + /** + * Creates a JAXB Marshaller configured for ESPI XML output. + * Initializes JAXBContext with all ESPI resource DTO types to ensure + * proper namespace declarations are generated when using @XmlElements. + * + * @param dtoClass the DTO class to marshal + * @param requiredNamespaces set of namespace URIs that should be declared + * @return configured Marshaller instance + * @throws JAXBException if marshaller creation fails + */ + private Marshaller createMarshaller(Class dtoClass, Set requiredNamespaces) throws JAXBException { + // Initialize context with ALL ESPI DTO classes to ensure JAXB pre-declares all namespaces + JAXBContext jaxbContext = JAXBContext.newInstance( + // Atom protocol classes + org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto.class, + org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto.class, + org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, + + // Usage domain classes (http://naesb.org/espi) + org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.MeterReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalBlockDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingTypeDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ElectricPowerQualitySummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.UsageSummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TimeConfigurationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ApplicationInformationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AuthorizationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.SubscriptionDto.class, + org.greenbuttonalliance.espi.common.dto.usage.BatchListDto.class, + org.greenbuttonalliance.espi.common.dto.usage.LineItemDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ServiceDeliveryPointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingQualityDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.DateTimeIntervalDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TariffRiderRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TariffRiderRefsDto.class, + org.greenbuttonalliance.espi.common.dto.usage.PnodeRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.PnodeRefsDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AggregatedNodeRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AggregatedNodeRefsDto.class, + + // Customer domain classes (http://naesb.org/espi/customer) + org.greenbuttonalliance.espi.common.dto.customer.CustomerDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAccountDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAgreementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.EndDeviceDto.class, + org.greenbuttonalliance.espi.common.dto.customer.MeterDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ProgramDateIdMappingsDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ServiceLocationDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementRefDto.class, + + // Dynamic class parameter + dtoClass + ); + Marshaller marshaller = jaxbContext.createMarshaller(); + + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + + // Set namespace prefix mapper with required namespaces + // This ensures only the needed namespaces are declared on the root element + org.greenbuttonalliance.espi.common.utils.EspiNamespacePrefixMapper prefixMapper = + new org.greenbuttonalliance.espi.common.utils.EspiNamespacePrefixMapper(requiredNamespaces); + + // Use the modern Jakarta/Glassfish property key + // This is specifically required for getContextualNamespaceDecls() to work + try { + marshaller.setProperty("org.glassfish.jaxb.namespacePrefixMapper", prefixMapper); + } catch (jakarta.xml.bind.PropertyException e) { + // Fallback for older environments or different providers + try { + marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", prefixMapper); + } catch (jakarta.xml.bind.PropertyException ex) { + log.warn("Could not set namespace prefix mapper: " + ex.getMessage()); + } + } + + // Set JAXB_FRAGMENT to false to enable proper root-level namespace declarations + // getContextualNamespaceDecls() requires this for proper namespace handling + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false); + + return marshaller; } @Override @@ -198,13 +322,17 @@ public AtomEntryDto createAtomEntry(String title, Object resource) { String resourceType = resource.getClass().getSimpleName(); UUID uuid5 = espiIdGeneratorService.generateSubscriptionId(resourceType, title); - return new AtomEntryDto( - "urn:uuid:" + uuid5.toString(), // id - Version 5 UUID - title, // title - now, // published - now, // updated - null, // links - resource // content (payload moved directly to AtomEntryDto) - ); + String entryId = "urn:uuid:" + uuid5.toString(); + + // Determine which AtomEntry subclass to use based on resource package + // Per NAESB ESPI standard, usage and customer domains are mutually exclusive + String packageName = resource.getClass().getPackage().getName(); + if (packageName.contains(".dto.customer")) { + // Customer domain resource -> CustomerAtomEntryDto (declares xmlns:cust only) + return new CustomerAtomEntryDto(entryId, title, now, now, null, resource); + } else { + // Usage domain resource -> UsageAtomEntryDto (declares xmlns:espi only) + return new UsageAtomEntryDto(entryId, title, now, now, null, resource); + } } } \ No newline at end of file diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportService.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportService.java new file mode 100644 index 00000000..e84d267f --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportService.java @@ -0,0 +1,121 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service.impl; + +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import org.greenbuttonalliance.espi.common.service.BaseExportService; +import org.springframework.stereotype.Service; + +import java.util.Set; + +/** + * Export service for ESPI Usage Domain resources. + *

+ * This service handles XML marshalling for usage domain resources defined in usage.xsd, + * including UsagePoint, MeterReading, IntervalBlock, ReadingType, etc. + *

+ * Namespace configuration: + * - Atom namespace (http://www.w3.org/2005/Atom) - default namespace + * - ESPI namespace (http://naesb.org/espi) - with "espi:" prefix + *

+ * This service does NOT register customer domain classes (CustomerDto, CustomerAccountDto, etc.) + * to prevent xmlns:cust namespace pollution. Per NAESB ESPI standard, usage and customer + * domains are mutually exclusive. + *

+ * Expected XML output: + * 

+ * <entry xmlns="http://www.w3.org/2005/Atom" xmlns:espi="http://naesb.org/espi">
+ *   <id>urn:uuid:...</id>
+ *   <title>Usage Point</title>
+ *   <espi:UsagePoint>
+ *     ...
+ *   </espi:UsagePoint>
+ * </entry>
+ *
+ */ +@Service("usageExportService") +public class UsageExportService extends BaseExportService { + + private static final String ATOM_NAMESPACE = "http://www.w3.org/2005/Atom"; + private static final String ESPI_NAMESPACE = "http://naesb.org/espi"; + + /** + * Creates JAXBContext with ONLY Atom + Usage domain classes. + *

+ * Registers exactly 2 namespaces: + * 1. Atom namespace (for entry, feed, link elements) + * 2. ESPI namespace (for usage domain resources) + *

+ * Does NOT register: + * - CustomerAtomEntryDto (would bring in cust namespace) + * - Customer domain DTOs (CustomerDto, CustomerAccountDto, etc.) + * + * @return JAXBContext configured for usage domain + * @throws JAXBException if context creation fails + */ + @Override + protected JAXBContext createJAXBContext() throws JAXBException { + return JAXBContext.newInstance( + // Atom protocol classes - ORDER MATTERS! + // AtomFeedDto and LinkDto FIRST to establish Atom namespace priority + org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto.class, + org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, + org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto.class, // Usage-specific entry + + // Usage domain classes (http://naesb.org/espi) - from usage.xsd + org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.MeterReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalBlockDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingTypeDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ElectricPowerQualitySummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.UsageSummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TimeConfigurationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ApplicationInformationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AuthorizationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.SubscriptionDto.class, + org.greenbuttonalliance.espi.common.dto.usage.BatchListDto.class, + org.greenbuttonalliance.espi.common.dto.usage.LineItemDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ServiceDeliveryPointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingQualityDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.DateTimeIntervalDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TariffRiderRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TariffRiderRefsDto.class, + org.greenbuttonalliance.espi.common.dto.usage.PnodeRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.PnodeRefsDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AggregatedNodeRefDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AggregatedNodeRefsDto.class + + // ❌ NO CustomerAtomEntryDto + // ❌ NO Customer domain DTOs (would bring in xmlns:cust) + ); + } + + /** + * Returns the 2 namespaces for usage domain. + * + * @return set containing Atom and ESPI namespaces + */ + @Override + protected Set getDomainNamespaces() { + return Set.of(ATOM_NAMESPACE, ESPI_NAMESPACE); + } +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/EspiNamespacePrefixMapper.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/EspiNamespacePrefixMapper.java new file mode 100644 index 00000000..07ffd2b4 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/EspiNamespacePrefixMapper.java @@ -0,0 +1,120 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.utils; + +import lombok.extern.slf4j.Slf4j; +import org.glassfish.jaxb.runtime.marshaller.NamespacePrefixMapper; + +import java.util.ArrayList; +import java.util.List; +import java.util.Set; + +/** + * JAXB Namespace Prefix Mapper for ESPI/Green Button XML output. + * + * Controls namespace prefixes used during XML marshalling to ensure + * consistent Green Button compliant XML output: + * - Atom elements use no prefix (default namespace) + * - ESPI usage elements use "espi:" prefix + * - ESPI customer elements use "cust:" prefix + * + * Usage: + * 

+ * marshaller.setProperty("org.glassfish.jaxb.namespacePrefixMapper",
+ *                        new EspiNamespacePrefixMapper());
+ *
+ */ +@Slf4j +public class EspiNamespacePrefixMapper extends NamespacePrefixMapper { + + private static final String ATOM_NAMESPACE = "http://www.w3.org/2005/Atom"; + private static final String ESPI_NAMESPACE = "http://naesb.org/espi"; + private static final String CUSTOMER_NAMESPACE = "http://naesb.org/espi/customer"; + + private final Set requiredNamespaces; + + /** + * Default constructor - declares Atom + both ESPI namespaces. + * Note: Per NAESB ESPI standard, espi and cust are mutually exclusive in actual use, + * but this constructor declares both for backward compatibility. + */ + public EspiNamespacePrefixMapper() { + this(Set.of(ATOM_NAMESPACE, ESPI_NAMESPACE, CUSTOMER_NAMESPACE)); + } + + /** + * Constructor with specific required namespaces. + * Only the specified namespaces will be declared on the root element. + * + * @param requiredNamespaces set of namespace URIs to declare + */ + public EspiNamespacePrefixMapper(Set requiredNamespaces) { + this.requiredNamespaces = requiredNamespaces != null ? requiredNamespaces : Set.of(); + } + + /** + * Returns the preferred prefix for the given namespace URI. + * + * Namespace prefix mapping: + * 1. Atom - empty prefix (default namespace) when used with 2 namespaces + * 2. ESPI - "espi" prefix + * 3. Customer - "cust" prefix + * + * With 2 namespaces (Atom + domain), Atom becomes default namespace. + * With 3+ namespaces, all get prefixes (JAXB 3.x limitation). + * + * @param namespaceUri the namespace URI + * @param suggestion the suggested prefix (ignored) + * @param requirePrefix whether a prefix is required (JAXB hint, often ignored for default namespace) + * @return the prefix to use, or null to use auto-generated prefix + */ + @Override + public String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) { + if (namespaceUri == null) { + return null; + } + + String prefix = null; + + // 1. Atom namespace - use "atom" prefix for predictable CMD Certification testing + // JAXB 3.x behavior with default namespace (empty prefix) is inconsistent between + // usage and customer domains, so we use explicit prefix for both. + if (ATOM_NAMESPACE.equals(namespaceUri)) { + prefix = "atom"; // Explicit prefix for consistent, predictable output + } + // 2. ESPI usage namespace gets "espi" prefix + else if (ESPI_NAMESPACE.equals(namespaceUri)) { + prefix = "espi"; + } + // 3. ESPI customer namespace gets "cust" prefix + else if (CUSTOMER_NAMESPACE.equals(namespaceUri)) { + prefix = "cust"; + } + + log.debug("getPreferredPrefix(uri={}, suggestion={}, requirePrefix={}) -> prefix={} (nsCount={})", + namespaceUri, suggestion, requirePrefix, prefix, requiredNamespaces.size()); + + return prefix; + } + + // Note: Removed getContextualNamespaceDecls() override + // Let JAXB automatically declare namespaces it finds during marshalling. + // We only control the prefix names via getPreferredPrefix(). +} diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/OffsetDateTimeAdapter.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/OffsetDateTimeAdapter.java new file mode 100644 index 00000000..4985d477 --- /dev/null +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/utils/OffsetDateTimeAdapter.java @@ -0,0 +1,67 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.utils; + +import jakarta.xml.bind.annotation.adapters.XmlAdapter; + +import java.time.OffsetDateTime; +import java.time.format.DateTimeFormatter; + +/** + * JAXB XML adapter for marshalling and unmarshalling OffsetDateTime instances. + *

+ * OffsetDateTime does not have a default no-arg constructor, which JAXB requires. + * This adapter converts between OffsetDateTime and ISO-8601 formatted strings + * for XML marshalling/unmarshalling. + *

+ * Usage: Apply to fields/properties using {@code @XmlJavaTypeAdapter(OffsetDateTimeAdapter.class)} + */ +public class OffsetDateTimeAdapter extends XmlAdapter { + + /** + * Unmarshal from XML string to OffsetDateTime. + * Handles null/empty strings gracefully. + * + * @param value ISO-8601 formatted string from XML + * @return OffsetDateTime instance, or null if input is null/empty + */ + @Override + public OffsetDateTime unmarshal(String value) { + if (value == null || value.trim().isEmpty()) { + return null; + } + return OffsetDateTime.parse(value, DateTimeFormatter.ISO_OFFSET_DATE_TIME); + } + + /** + * Marshal from OffsetDateTime to XML string. + * Handles null values gracefully. + * + * @param value OffsetDateTime instance + * @return ISO-8601 formatted string, or null if input is null + */ + @Override + public String marshal(OffsetDateTime value) { + if (value == null) { + return null; + } + return value.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME); + } +} diff --git a/openespi-common/src/main/resources/db/migration/V3__Create_additiional_Base_Tables.sql b/openespi-common/src/main/resources/db/migration/V3__Create_additiional_Base_Tables.sql index a3b96706..cf261ff3 100644 --- a/openespi-common/src/main/resources/db/migration/V3__Create_additiional_Base_Tables.sql +++ b/openespi-common/src/main/resources/db/migration/V3__Create_additiional_Base_Tables.sql @@ -147,13 +147,11 @@ CREATE TABLE customers priority_rank INTEGER, priority_type VARCHAR(256), - -- Customer specific fields + -- Customer specific fields (field order matches customer.xsd:72-112) kind VARCHAR(50), special_need VARCHAR(255), vip BOOLEAN DEFAULT FALSE, puc_number VARCHAR(100), - status VARCHAR(50), - priority VARCHAR(50), locale VARCHAR(10), customer_name VARCHAR(255), @@ -167,7 +165,7 @@ CREATE TABLE customers -- Indexes for customers table CREATE INDEX idx_customer_kind ON customers (kind); CREATE INDEX idx_customer_puc_number ON customers (puc_number); -CREATE INDEX idx_customer_status ON customers (status); +CREATE INDEX idx_customer_status ON customers (status_value); CREATE INDEX idx_customer_created ON customers (created); CREATE INDEX idx_customer_updated ON customers (updated); diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/CustomerXmlDebugTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/CustomerXmlDebugTest.java new file mode 100644 index 00000000..ce8878c7 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/CustomerXmlDebugTest.java @@ -0,0 +1,268 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common; + +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; +import org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.customer.CustomerDto; +import org.greenbuttonalliance.espi.common.utils.EspiNamespacePrefixMapper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Set; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Debug test for Customer Domain XML generation (Customer namespace only). + *

+ * Tests CustomerAtomEntryDto with customer.xsd resources to validate: + * - Only xmlns:cust="http://naesb.org/espi/customer" is declared + * - xmlns:espi (usage namespace) is NOT declared + * - Atom namespace is default (no prefix) + *

+ * Per NAESB ESPI standard, usage and customer domains are mutually exclusive. + */ +@DisplayName("Customer Domain XML Debug Test - JAXB") +class CustomerXmlDebugTest { + + private JAXBContext jaxbContext; + + @BeforeEach + void setUp() throws JAXBException { + // Initialize Jakarta JAXB Context with CUSTOMER DOMAIN ONLY + // This ensures ONLY cust namespace is declared, NOT espi namespace + // Note: Excluding AtomFeedDto to prevent JAXB from discovering UsageAtomEntryDto + jaxbContext = JAXBContext.newInstance( + // Atom protocol classes + org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto.class, // ONLY customer, NOT usage + org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, + + // Customer domain classes (http://naesb.org/espi/customer) + org.greenbuttonalliance.espi.common.dto.customer.CustomerDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAccountDto.class, + org.greenbuttonalliance.espi.common.dto.customer.CustomerAgreementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.EndDeviceDto.class, + org.greenbuttonalliance.espi.common.dto.customer.MeterDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ProgramDateIdMappingsDto.class, + org.greenbuttonalliance.espi.common.dto.customer.ServiceLocationDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementDto.class, + org.greenbuttonalliance.espi.common.dto.customer.StatementRefDto.class + ); + } + + /** + * Creates a marshaller configured for customer domain resources. + */ + private Marshaller createMarshallerForCustomerDomain() throws JAXBException { + // Required namespaces: Atom + cust ONLY (no espi) + Set requiredNamespaces = new HashSet<>(); + requiredNamespaces.add("http://www.w3.org/2005/Atom"); + requiredNamespaces.add("http://naesb.org/espi/customer"); + + Marshaller marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false); + + // Set namespace prefix mapper + EspiNamespacePrefixMapper prefixMapper = new EspiNamespacePrefixMapper(requiredNamespaces); + try { + marshaller.setProperty("org.glassfish.jaxb.namespacePrefixMapper", prefixMapper); + } catch (Exception e) { + marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", prefixMapper); + } + + return marshaller; + } + + @Test + @DisplayName("Should declare ONLY customer namespace (NOT usage namespace)") + void shouldDeclareCustomerNamespaceOnly() throws Exception { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440001", // uuid + null, // organisation + null, // kind + "Wheelchair access required", // specialNeed - add actual value to force namespace usage + true, // vip + null, // pucNumber + null, // status + null, // priority + null, // locale + "John Doe" // customerName + ); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto("urn:uuid:550e8400-e29b-51d4-a716-446655440002", "Customer Test", customer); + + // Act + Marshaller marshaller = createMarshallerForCustomerDomain(); + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Debug output + System.out.println("\n========== Customer Domain XML Output =========="); + System.out.println(xml); + System.out.println("===============================================\n"); + + // Assert - Customer namespace PRESENT + assertThat(xml) + .as("XML should declare customer namespace") + .contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + + // Assert - Usage namespace ABSENT + assertThat(xml) + .as("XML should NOT declare usage namespace") + .doesNotContain("xmlns:espi=\"http://naesb.org/espi\"") + .doesNotContain("xmlns:espi"); // Ensure no espi prefix at all + + // Assert - Atom namespace with atom prefix + assertThat(xml) + .as("XML should declare Atom namespace with atom prefix") + .contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + + // Assert - Customer content with cust prefix + assertThat(xml) + .as("Customer should use cust prefix") + .contains(""); + assertThat(xml).contains(""); + } + + @Test + @DisplayName("Should use Atom as default namespace (no prefix on entry/id/title)") + void shouldUseAtomAsDefaultNamespace() throws Exception { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440005", // uuid + null, // organisation + null, // kind + null, // specialNeed + null, // vip + "PUC-12345", // pucNumber + null, // status + null, // priority + null, // locale + "Test Customer" // customerName + ); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto("urn:uuid:550e8400-e29b-51d4-a716-446655440006", "Atom Test", customer); + + // Act + Marshaller marshaller = createMarshallerForCustomerDomain(); + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Assert - Atom elements use atom prefix + assertThat(xml) + .as("entry element should use atom prefix") + .contains("urn:uuid:550e8400-e29b-51d4-a716-446655440006"); + assertThat(xml).contains("Atom Test"); + assertThat(xml).doesNotContain("ns5:id"); + assertThat(xml).doesNotContain("ns5:title"); + assertThat(xml).doesNotContain("ns3:id"); + assertThat(xml).doesNotContain("ns3:title"); + } + + @Test + @DisplayName("Debug: See complete Customer Domain XML structure") + void debugCompleteCustomerDomainXml() throws Exception { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440007", // uuid + null, // organisation + null, // kind + "Hearing impaired", // specialNeed + true, // vip + "PUC-999", // pucNumber + null, // status + null, // priority + "en-US", // locale + "Debug Customer" // customerName + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440008", + "Residential Customer - Customer Domain", + customer + ); + + // Act + Marshaller marshaller = createMarshallerForCustomerDomain(); + + // Add listener for debugging + marshaller.setListener(new Marshaller.Listener() { + @Override + public void beforeMarshal(Object source) { + System.out.println("[JAXB] beforeMarshal: " + source.getClass().getSimpleName()); + } + }); + + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Debug output + System.out.println("\n========== Complete Customer Domain XML =========="); + System.out.println(xml); + System.out.println("=================================================\n"); + + // Assert comprehensive structure + assertThat(xml).contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + assertThat(xml).doesNotContain("xmlns:espi"); + assertThat(xml).contains(""); + assertThat(xml).contains("urn:uuid:550e8400-e29b-51d4-a716-446655440008"); + assertThat(xml).contains("Residential Customer - Customer Domain"); + } +} diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/Jackson3XmlMarshallingTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/JaxbXmlMarshallingTest.java similarity index 67% rename from openespi-common/src/test/java/org/greenbuttonalliance/espi/common/Jackson3XmlMarshallingTest.java rename to openespi-common/src/test/java/org/greenbuttonalliance/espi/common/JaxbXmlMarshallingTest.java index 6ee7eab8..e4b5f7da 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/Jackson3XmlMarshallingTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/JaxbXmlMarshallingTest.java @@ -19,52 +19,43 @@ package org.greenbuttonalliance.espi.common; -import com.fasterxml.jackson.annotation.JsonInclude; +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; +import jakarta.xml.bind.Unmarshaller; import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; -import tools.jackson.databind.AnnotationIntrospector; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.cfg.DateTimeFeature; -import tools.jackson.databind.introspect.JacksonAnnotationIntrospector; -import tools.jackson.databind.util.StdDateFormat; -import tools.jackson.dataformat.xml.XmlAnnotationIntrospector; -import tools.jackson.dataformat.xml.XmlMapper; -import tools.jackson.dataformat.xml.XmlWriteFeature; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule; + +import java.io.StringReader; +import java.io.StringWriter; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; /** - * Jackson 3 XML marshalling tests to verify JAXB annotation processing with ESPI data. - * Tests marshal/unmarshal round-trip with realistic data structures using Jackson 3 XmlMapper. + * JAXB XML marshalling tests to verify JAXB annotation processing with ESPI data. + * Tests marshal/unmarshal round-trip with realistic data structures using Jakarta JAXB Marshaller. */ -@DisplayName("Jackson 3 XML Marshalling Tests") -class Jackson3XmlMarshallingTest { +@DisplayName("JAXB XML Marshalling Tests") +class JaxbXmlMarshallingTest { - private XmlMapper xmlMapper; + private Marshaller marshaller; + private Unmarshaller unmarshaller; @BeforeEach - void setUp() { - // Initialize Jackson 3 XmlMapper with JAXB annotation support - AnnotationIntrospector intr = XmlAnnotationIntrospector.Pair.instance( - new JakartaXmlBindAnnotationIntrospector(), - new JacksonAnnotationIntrospector() - ); - - xmlMapper = XmlMapper.xmlBuilder() - .annotationIntrospector(intr) - .addModule(new JakartaXmlBindAnnotationModule() - .setNonNillableInclusion(JsonInclude.Include.NON_EMPTY)) - .enable(SerializationFeature.INDENT_OUTPUT) - .enable(DateTimeFeature.WRITE_DATES_WITH_ZONE_ID) - .disable(XmlWriteFeature.WRITE_NULLS_AS_XSI_NIL) - .defaultDateFormat(new StdDateFormat()) - .build(); + void setUp() throws JAXBException { + // Initialize Jakarta JAXB Marshaller for UsageAtomEntryDto + JAXBContext jaxbContext = JAXBContext.newInstance(UsageAtomEntryDto.class); + marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); // Don't write XML declaration + + unmarshaller = jaxbContext.createUnmarshaller(); } @Test @@ -84,17 +75,19 @@ void shouldMarshalUsagePointWithRealisticData() throws Exception { ); // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:test-usage-point", "Residential Electric Service", usagePoint); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:test-usage-point", "Residential Electric Service", usagePoint); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); - // Verify XML structure + // Verify XML structure with namespace prefixes assertThat(xml).contains("entry"); // Now wrapping in Atom entry assertThat(xml).contains("UsagePoint"); assertThat(xml).contains("http://naesb.org/espi"); assertThat(xml).contains("Residential Electric Service"); // In Atom title - assertThat(xml).containsPattern("]*>1"); // May have xmlns attribute + assertThat(xml).containsPattern("<(espi:)?status[^>]*>1"); // May have espi: prefix } @Test @@ -114,19 +107,21 @@ void shouldPerformRoundTripMarshallingForUsagePoint() throws Exception { ); // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto originalEntry = new AtomEntryDto("urn:uuid:commercial-gas-point", "Commercial Gas Service", originalUsagePoint); + UsageAtomEntryDto originalEntry = new UsageAtomEntryDto("urn:uuid:commercial-gas-point", "Commercial Gas Service", originalUsagePoint); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(originalEntry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(originalEntry, writer); + String xml = writer.toString(); - // Unmarshal back from XML using Jackson 3 - AtomEntryDto roundTripEntry = xmlMapper.readValue(xml, AtomEntryDto.class); + // Unmarshal back from XML using JAXB + AtomEntryDto roundTripEntry = (AtomEntryDto) unmarshaller.unmarshal(new StringReader(xml)); // Verify data integrity survived round trip - assertThat(roundTripEntry.title()).isEqualTo(originalEntry.title()); // Description is in Atom title - UsagePointDto roundTripUsagePoint = (UsagePointDto) roundTripEntry.content(); - assertThat(roundTripUsagePoint.status()).isEqualTo(originalUsagePoint.status()); - assertThat(roundTripUsagePoint.roleFlags()).isEqualTo(originalUsagePoint.roleFlags()); + assertThat(roundTripEntry.getTitle()).isEqualTo(originalEntry.getTitle()); // Description is in Atom title + UsagePointDto roundTripUsagePoint = (UsagePointDto) roundTripEntry.getContent(); + assertThat(roundTripUsagePoint.getStatus()).isEqualTo(originalUsagePoint.getStatus()); + assertThat(roundTripUsagePoint.getRoleFlags()).isEqualTo(originalUsagePoint.getRoleFlags()); } @Test @@ -146,22 +141,24 @@ void shouldHandleEmptyUsagePointWithoutErrors() throws Exception { ); // Wrap in Atom entry (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto(null, null, empty); + UsageAtomEntryDto entry = new UsageAtomEntryDto(null, null, empty); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); // Should still contain basic structure assertThat(xml).contains("entry"); assertThat(xml).contains("UsagePoint"); assertThat(xml).contains("http://naesb.org/espi"); - // Unmarshal back using Jackson 3 - AtomEntryDto roundTripEntry = xmlMapper.readValue(xml, AtomEntryDto.class); + // Unmarshal back using JAXB + AtomEntryDto roundTripEntry = (AtomEntryDto) unmarshaller.unmarshal(new StringReader(xml)); // Should not throw exceptions assertThat(roundTripEntry).isNotNull(); - assertThat(roundTripEntry.content()).isNotNull(); + assertThat(roundTripEntry.getContent()).isNotNull(); } @Test @@ -181,19 +178,21 @@ void shouldHandleNullValuesGracefully() throws Exception { ); // Wrap in Atom entry with null description/title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:test-nulls", null, withNulls); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:test-nulls", null, withNulls); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); - // Unmarshal back using Jackson 3 - AtomEntryDto roundTripEntry = xmlMapper.readValue(xml, AtomEntryDto.class); + // Unmarshal back using JAXB + AtomEntryDto roundTripEntry = (AtomEntryDto) unmarshaller.unmarshal(new StringReader(xml)); // Verify nulls are preserved - assertThat(roundTripEntry.title()).isNull(); // Null description is in Atom title - UsagePointDto roundTrip = (UsagePointDto) roundTripEntry.content(); - assertThat(roundTrip.roleFlags()).isNull(); - assertThat(roundTrip.status()).isEqualTo(withNulls.status()); + assertThat(roundTripEntry.getTitle()).isNull(); // Null description is in Atom title + UsagePointDto roundTrip = (UsagePointDto) roundTripEntry.getContent(); + assertThat(roundTrip.getRoleFlags()).isNull(); + assertThat(roundTrip.getStatus()).isEqualTo(withNulls.getStatus()); } @Test @@ -213,10 +212,12 @@ void shouldIncludeProperXmlNamespaces() throws Exception { ); // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:test-namespaces", "Test Service", usagePoint); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:test-namespaces", "Test Service", usagePoint); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); // Verify namespace declarations assertThat(xml).contains("xmlns"); @@ -245,10 +246,12 @@ void shouldMarshalSpecialCharactersCorrectly() throws Exception { ); // Wrap in Atom entry with special characters in title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:test-special-chars", "Service & Co. \"Smart\" Meter", usagePoint); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:test-special-chars", "Service & Co. \"Smart\" Meter", usagePoint); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); // Verify XML escaping assertThat(xml) @@ -256,12 +259,13 @@ void shouldMarshalSpecialCharactersCorrectly() throws Exception { s -> assertThat(s).contains("&"), s -> assertThat(s).contains("Service & Co.") ); - assertThat(xml).contains("<Electric>"); // < is escaped, > in quoted text may not be + // XML entities may be escaped differently in element content vs attributes + assertThat(xml).containsPattern("(<Electric>|)"); // May or may not escape in title content - // Unmarshal back and verify data integrity using Jackson 3 - AtomEntryDto roundTripEntry = xmlMapper.readValue(xml, AtomEntryDto.class); + // Unmarshal back and verify data integrity using JAXB + AtomEntryDto roundTripEntry = (AtomEntryDto) unmarshaller.unmarshal(new StringReader(xml)); - assertThat(roundTripEntry.title()).isEqualTo(entry.title()); // Description is in Atom title + assertThat(roundTripEntry.getTitle()).isEqualTo(entry.getTitle()); // Description is in Atom title } @Test @@ -281,10 +285,12 @@ void shouldNotThrowExceptionsDuringMarshalling() { ); // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:test-no-exceptions", "Test Service", usagePoint); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:test-no-exceptions", "Test Service", usagePoint); - // Verify marshalling does not throw using Jackson 3 - assertThatCode(() -> xmlMapper.writeValueAsString(entry)) - .doesNotThrowAnyException(); + // Verify marshalling does not throw using JAXB + assertThatCode(() -> { + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + }).doesNotThrowAnyException(); } } diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/MigrationVerificationTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/MigrationVerificationTest.java index ac62e503..3ff80313 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/MigrationVerificationTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/MigrationVerificationTest.java @@ -19,32 +19,24 @@ package org.greenbuttonalliance.espi.common; -import com.fasterxml.jackson.annotation.JsonInclude; import org.greenbuttonalliance.espi.common.domain.common.IdentifiedObject; import org.greenbuttonalliance.espi.common.domain.usage.UsagePointEntity; import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; import org.greenbuttonalliance.espi.common.domain.customer.entity.MeterEntity; +import org.greenbuttonalliance.espi.common.domain.customer.entity.Organisation; import org.greenbuttonalliance.espi.common.domain.customer.entity.ServiceLocationEntity; -import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; +import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; import org.greenbuttonalliance.espi.common.dto.SummaryMeasurementDto; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.DisplayName; -import tools.jackson.databind.AnnotationIntrospector; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.cfg.DateTimeFeature; -import tools.jackson.databind.introspect.JacksonAnnotationIntrospector; -import tools.jackson.databind.util.StdDateFormat; -import tools.jackson.dataformat.xml.XmlAnnotationIntrospector; -import tools.jackson.dataformat.xml.XmlMapper; -import tools.jackson.dataformat.xml.XmlWriteFeature; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule; import jakarta.validation.Validation; import jakarta.validation.Validator; import jakarta.validation.ValidatorFactory; +import java.time.OffsetDateTime; import java.util.UUID; import static org.junit.jupiter.api.Assertions.*; @@ -71,23 +63,14 @@ void jakartaValidationShouldWork() { } @Test - @DisplayName("Jackson 3 XML with JAXB annotations should work for DTOs") - void jackson3XmlWithJaxbAnnotationsShouldWork() throws Exception { - // Production code uses Jackson 3 XmlMapper with JAXB annotation support - AnnotationIntrospector intr = XmlAnnotationIntrospector.Pair.instance( - new JakartaXmlBindAnnotationIntrospector(), - new JacksonAnnotationIntrospector() - ); - - XmlMapper xmlMapper = XmlMapper.xmlBuilder() - .annotationIntrospector(intr) - .addModule(new JakartaXmlBindAnnotationModule() - .setNonNillableInclusion(JsonInclude.Include.NON_EMPTY)) - .enable(SerializationFeature.INDENT_OUTPUT) - .enable(DateTimeFeature.WRITE_DATES_WITH_ZONE_ID) - .disable(XmlWriteFeature.WRITE_NULLS_AS_XSI_NIL) - .defaultDateFormat(new StdDateFormat()) - .build(); + @DisplayName("JAXB XML with JAXB annotations should work for DTOs") + void jaxbXmlWithJaxbAnnotationsShouldWork() throws Exception { + // Production code uses Jakarta JAXB Marshaller with JAXB annotation support + jakarta.xml.bind.JAXBContext jaxbContext = jakarta.xml.bind.JAXBContext.newInstance(UsageAtomEntryDto.class); + jakarta.xml.bind.Marshaller marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(jakarta.xml.bind.Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(jakarta.xml.bind.Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(jakarta.xml.bind.Marshaller.JAXB_FRAGMENT, true); // Create a simple DTO with all nulls UsagePointDto dto = new UsagePointDto( @@ -105,7 +88,7 @@ void jackson3XmlWithJaxbAnnotationsShouldWork() throws Exception { // Wrap in Atom entry using full constructor (payload moved directly to AtomEntryDto, no AtomContentDto wrapper) java.time.LocalDateTime localDateTime = java.time.LocalDateTime.now().truncatedTo(java.time.temporal.ChronoUnit.SECONDS); java.time.OffsetDateTime now = localDateTime.atOffset(java.time.ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - AtomEntryDto entry = new AtomEntryDto( + UsageAtomEntryDto entry = new UsageAtomEntryDto( "urn:uuid:test-entry", "Test Usage Point", now, @@ -114,8 +97,12 @@ void jackson3XmlWithJaxbAnnotationsShouldWork() throws Exception { dto // content - passed directly (AtomEntryDto now includes AtomContentDto functionality) ); - // Marshal using Jackson 3 - String xml = assertDoesNotThrow(() -> xmlMapper.writeValueAsString(entry)); + // Marshal using JAXB + java.io.StringWriter writer = new java.io.StringWriter(); + String xml = assertDoesNotThrow(() -> { + marshaller.marshal(entry, writer); + return writer.toString(); + }); // Debug: print XML System.out.println("Generated XML:"); @@ -209,11 +196,11 @@ void summaryMeasurementDtoShouldWork() { "/espi/1_1/resource/ReadingType/07" // readingTypeRef ); - assertEquals("3", dto.powerOfTenMultiplier()); - assertEquals(1331784000L, dto.timeStamp()); - assertEquals("W", dto.uom()); - assertEquals(5000L, dto.value()); - assertEquals("/espi/1_1/resource/ReadingType/07", dto.readingTypeRef()); + assertEquals("3", dto.getPowerOfTenMultiplier()); + assertEquals(1331784000L, dto.getTimeStamp()); + assertEquals("W", dto.getUom()); + assertEquals(5000L, dto.getValue()); + assertEquals("/espi/1_1/resource/ReadingType/07", dto.getReadingTypeRef()); } @Test @@ -225,7 +212,115 @@ void basicCompilationVerification() { // 3. UUID primary key architecture compiles // 4. Modern entity structure compiles // 5. DTO structure with JAXB annotations compiles - + assertTrue(true, "Compilation successful - Spring Boot 3.5 migration core features working"); } + + @Test + @DisplayName("Customer entity with all embedded objects should work") + void customerWithAllEmbeddedObjectsShouldWork() { + // Test Customer entity with Organisation embedded object + CustomerEntity customer = new CustomerEntity(); + customer.setCustomerName("Test Customer"); + customer.setKind(CustomerKind.RESIDENTIAL); + customer.setSpecialNeed("Life support"); + customer.setVip(true); + customer.setPucNumber("PUC-12345"); + customer.setLocale("en-US"); + + // Test Organisation embedded object + Organisation org = new Organisation(); + org.setOrganisationName("Test Organisation"); + + // Test StreetAddress nested embedded object + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("123 Test Street"); + streetAddress.setTownDetail("Test City"); + streetAddress.setStateOrProvince("CA"); + streetAddress.setPostalCode("90000"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + // Test ElectronicAddress nested embedded object + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("test@example.com"); + electronicAddress.setWeb("https://example.com"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); + + // Test Status embedded object + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("active"); + status.setDateTime(OffsetDateTime.now()); + status.setReason("Migration verification test"); + customer.setStatus(status); + + // Test Priority embedded object + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(1); + priority.setRank(10); + priority.setType("high-priority"); + customer.setPriority(priority); + + // Verify all fields work + assertNotNull(customer.getId()); + assertEquals("Test Customer", customer.getCustomerName()); + assertEquals(CustomerKind.RESIDENTIAL, customer.getKind()); + assertEquals("Life support", customer.getSpecialNeed()); + assertTrue(customer.getVip()); + assertEquals("PUC-12345", customer.getPucNumber()); + assertEquals("en-US", customer.getLocale()); + + assertNotNull(customer.getOrganisation()); + assertEquals("Test Organisation", customer.getOrganisation().getOrganisationName()); + assertNotNull(customer.getOrganisation().getStreetAddress()); + assertEquals("123 Test Street", customer.getOrganisation().getStreetAddress().getStreetDetail()); + assertNotNull(customer.getOrganisation().getElectronicAddress()); + assertEquals("test@example.com", customer.getOrganisation().getElectronicAddress().getEmail1()); + + assertNotNull(customer.getStatus()); + assertEquals("active", customer.getStatus().getValue()); + assertNotNull(customer.getStatus().getDateTime()); + + assertNotNull(customer.getPriority()); + assertEquals(1, customer.getPriority().getValue()); + assertEquals(10, customer.getPriority().getRank()); + } + + @Test + @DisplayName("Customer embedded objects should be null-safe") + void customerEmbeddedObjectsShouldBeNullSafe() { + // Test that Customer can be created with null embedded objects + CustomerEntity customer = new CustomerEntity(); + customer.setCustomerName("Minimal Customer"); + customer.setOrganisation(null); + customer.setStatus(null); + customer.setPriority(null); + + assertNotNull(customer.getId()); + assertEquals("Minimal Customer", customer.getCustomerName()); + assertNull(customer.getOrganisation()); + assertNull(customer.getStatus()); + assertNull(customer.getPriority()); + } + + @Test + @DisplayName("Customer Organisation nested objects should be null-safe") + void customerOrganisationNestedObjectsShouldBeNullSafe() { + // Test that Organisation can be created with null nested objects + CustomerEntity customer = new CustomerEntity(); + Organisation org = new Organisation(); + org.setOrganisationName("Minimal Organisation"); + org.setStreetAddress(null); + org.setPostalAddress(null); + org.setElectronicAddress(null); + customer.setOrganisation(org); + + assertNotNull(customer.getOrganisation()); + assertEquals("Minimal Organisation", customer.getOrganisation().getOrganisationName()); + assertNull(customer.getOrganisation().getStreetAddress()); + assertNull(customer.getOrganisation().getPostalAddress()); + assertNull(customer.getOrganisation().getElectronicAddress()); + } } \ No newline at end of file diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/UsageXmlDebugTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/UsageXmlDebugTest.java new file mode 100644 index 00000000..bc3f1d53 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/UsageXmlDebugTest.java @@ -0,0 +1,269 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common; + +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; +import org.greenbuttonalliance.espi.common.utils.EspiNamespacePrefixMapper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.StringWriter; +import java.util.HashSet; +import java.util.Set; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Debug test for Usage Domain XML generation (ESPI namespace only). + *

+ * Tests UsageAtomEntryDto with usage.xsd resources to validate: + * - Only xmlns:espi="http://naesb.org/espi" is declared + * - xmlns:cust (customer namespace) is NOT declared + * - Atom namespace is default (no prefix) + *

+ * Per NAESB ESPI standard, usage and customer domains are mutually exclusive. + */ +@DisplayName("Usage Domain XML Debug Test - JAXB") +class UsageXmlDebugTest { + + private JAXBContext jaxbContext; + + @BeforeEach + void setUp() throws JAXBException { + // Initialize Jakarta JAXB Context with USAGE DOMAIN ONLY + // This ensures ONLY espi namespace is declared, NOT cust namespace + // Note: Excluding AtomFeedDto to prevent JAXB from discovering CustomerAtomEntryDto + jaxbContext = JAXBContext.newInstance( + // Atom protocol classes + org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto.class, // ONLY usage, NOT customer + org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, + + // Usage domain classes (http://naesb.org/espi) + org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.MeterReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalBlockDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingTypeDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ElectricPowerQualitySummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.UsageSummaryDto.class, + org.greenbuttonalliance.espi.common.dto.usage.TimeConfigurationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ApplicationInformationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.AuthorizationDto.class, + org.greenbuttonalliance.espi.common.dto.usage.SubscriptionDto.class, + org.greenbuttonalliance.espi.common.dto.usage.LineItemDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ServiceDeliveryPointDto.class, + org.greenbuttonalliance.espi.common.dto.usage.ReadingQualityDto.class, + org.greenbuttonalliance.espi.common.dto.usage.IntervalReadingDto.class, + org.greenbuttonalliance.espi.common.dto.usage.DateTimeIntervalDto.class + ); + } + + /** + * Creates a marshaller configured for usage domain resources. + */ + private Marshaller createMarshallerForUsageDomain() throws JAXBException { + // Required namespaces: Atom + espi ONLY (no cust) + Set requiredNamespaces = new HashSet<>(); + requiredNamespaces.add("http://www.w3.org/2005/Atom"); + requiredNamespaces.add("http://naesb.org/espi"); + + Marshaller marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, false); + + // Set namespace prefix mapper + EspiNamespacePrefixMapper prefixMapper = new EspiNamespacePrefixMapper(requiredNamespaces); + try { + marshaller.setProperty("org.glassfish.jaxb.namespacePrefixMapper", prefixMapper); + } catch (Exception e) { + marshaller.setProperty("com.sun.xml.bind.namespacePrefixMapper", prefixMapper); + } + + return marshaller; + } + + @Test + @DisplayName("Should declare ONLY espi namespace (NOT customer namespace)") + void shouldDeclareEspiNamespaceOnly() throws Exception { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440010", + new byte[]{0x01}, + null, (short) 1, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:550e8400-e29b-51d4-a716-446655440011", "Usage Test", usagePoint); + + // Act + Marshaller marshaller = createMarshallerForUsageDomain(); + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Debug output + System.out.println("\n========== Usage Domain XML Output =========="); + System.out.println(xml); + System.out.println("=============================================\n"); + + // Assert - ESPI namespace PRESENT + assertThat(xml) + .as("XML should declare espi namespace") + .contains("xmlns:espi=\"http://naesb.org/espi\""); + + // Assert - Customer namespace ABSENT + assertThat(xml) + .as("XML should NOT declare customer namespace") + .doesNotContain("xmlns:cust") + .doesNotContain("http://naesb.org/espi/customer"); + + // Assert - Atom namespace declared with atom prefix + assertThat(xml) + .as("XML should declare Atom namespace with atom prefix") + .contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + + // Assert - Usage content with espi prefix + assertThat(xml) + .as("UsagePoint should use espi prefix") + .contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + } + + @Test + @DisplayName("Should use Atom as default namespace (no prefix on entry/id/title)") + void shouldUseAtomAsDefaultNamespace() throws Exception { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440014", + new byte[]{0x03}, + null, (short) 1, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + UsageAtomEntryDto entry = new UsageAtomEntryDto("urn:uuid:550e8400-e29b-51d4-a716-446655440015", "Atom Test", usagePoint); + + // Act + Marshaller marshaller = createMarshallerForUsageDomain(); + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Assert - Atom elements use atom prefix + assertThat(xml) + .as("entry element should use atom prefix") + .contains("urn:uuid:550e8400-e29b-51d4-a716-446655440015"); + assertThat(xml).contains("Atom Test"); + assertThat(xml).doesNotContain("ns5:id"); + assertThat(xml).doesNotContain("ns5:title"); + assertThat(xml).doesNotContain("ns3:id"); + assertThat(xml).doesNotContain("ns3:title"); + } + + @Test + @DisplayName("Debug: See complete Usage Domain XML structure") + void debugCompleteUsageDomainXml() throws Exception { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:debug-usage", + new byte[]{0x01, 0x02}, // roleFlags + null, // serviceCategory + (short) 1, // status + null, null, null, null, null, // serviceDeliveryPoint through estimatedLoad + null, null, null, null, // grounded through minimalUsageExpected + null, null, null, null, null, // nominalServiceVoltage through ratedPower + null, null, null, null, // readCycle through servicePriority + null, null, null, null, null // pnodeRefs through electricPowerQualitySummaries + ); + + UsageAtomEntryDto entry = new UsageAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440000", + "Residential Electric Service - Usage Domain", + usagePoint + ); + + // Act + Marshaller marshaller = createMarshallerForUsageDomain(); + + // Add listener for debugging + marshaller.setListener(new Marshaller.Listener() { + @Override + public void beforeMarshal(Object source) { + System.out.println("[JAXB] beforeMarshal: " + source.getClass().getSimpleName()); + } + }); + + StringWriter writer = new StringWriter(); + marshaller.marshal(entry, writer); + String xml = writer.toString(); + + // Debug output + System.out.println("\n========== Complete Usage Domain XML =========="); + System.out.println(xml); + System.out.println("===============================================\n"); + + // Assert comprehensive structure + assertThat(xml).contains("xmlns:espi=\"http://naesb.org/espi\""); + assertThat(xml).doesNotContain("xmlns:cust"); + assertThat(xml).contains(""); + assertThat(xml).contains("urn:uuid:550e8400-e29b-51d4-a716-446655440000"); + assertThat(xml).contains("Residential Electric Service - Usage Domain"); + } +} diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/XmlDebugTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/XmlDebugTest.java deleted file mode 100644 index ad750ac3..00000000 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/XmlDebugTest.java +++ /dev/null @@ -1,203 +0,0 @@ -/* - * - * Copyright (c) 2025 Green Button Alliance, Inc. - * - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - */ - -package org.greenbuttonalliance.espi.common; - -import com.fasterxml.jackson.annotation.JsonInclude; -import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; -import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Test; -import tools.jackson.databind.AnnotationIntrospector; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.cfg.DateTimeFeature; -import tools.jackson.databind.introspect.JacksonAnnotationIntrospector; -import tools.jackson.databind.util.StdDateFormat; -import tools.jackson.dataformat.xml.XmlAnnotationIntrospector; -import tools.jackson.dataformat.xml.XmlMapper; -import tools.jackson.dataformat.xml.XmlWriteFeature; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule; - -import static org.assertj.core.api.Assertions.assertThat; - -/** - * Debug test to see what XML is actually generated by Jackson 3 XmlMapper. - * Useful for validating XML structure and namespace handling. - */ -@DisplayName("XML Debug Test") -class XmlDebugTest { - - private XmlMapper xmlMapper; - - @BeforeEach - void setUp() { - // Initialize Jackson 3 XmlMapper with JAXB annotation support - AnnotationIntrospector intr = XmlAnnotationIntrospector.Pair.instance( - new JakartaXmlBindAnnotationIntrospector(), - new JacksonAnnotationIntrospector() - ); - - xmlMapper = XmlMapper.xmlBuilder() - .annotationIntrospector(intr) - .addModule(new JakartaXmlBindAnnotationModule() - .setNonNillableInclusion(JsonInclude.Include.NON_EMPTY)) - .enable(SerializationFeature.INDENT_OUTPUT) - .enable(DateTimeFeature.WRITE_DATES_WITH_ZONE_ID) - .disable(XmlWriteFeature.WRITE_NULLS_AS_XSI_NIL) - .defaultDateFormat(new StdDateFormat()) - .build(); - } - - @Test - @DisplayName("Debug: See what XML is actually generated by Jackson 3") - void debugXmlOutput() throws Exception { - // Create a simple UsagePointDto - UsagePointDto usagePoint = new UsagePointDto( - "urn:uuid:debug-test", - new byte[]{0x01}, // Simple role flag - null, // serviceCategory - (short) 1, // Active status - null, null, null, null, null, // serviceDeliveryPoint, amiBillingReady, checkBilling, connectionState, estimatedLoad - null, null, null, null, // grounded, isSdp, isVirtual, minimalUsageExpected - null, null, null, null, null, // nominalServiceVoltage, outageRegion, phaseCode, ratedCurrent, ratedPower - null, null, null, null, // readCycle, readRoute, serviceDeliveryRemark, servicePriority - null, null, null, null, null // pnodeRefs, aggregatedNodeRefs, meterReadings, usageSummaries, electricPowerQualitySummaries - ); - - // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:debug-test", "Debug Service", usagePoint); - - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); - - // Print the actual XML for debugging - System.out.println("Generated XML (Jackson 3):"); - System.out.println("=========================="); - System.out.println(xml); - System.out.println("=========================="); - - // Comprehensive assertions - assertThat(xml).isNotNull(); - assertThat(xml.trim()).isNotEmpty(); - - // Validate root element - assertThat(xml).contains("entry"); // Now wrapping in Atom entry - assertThat(xml).contains("UsagePoint"); - - // Validate ESPI namespace - assertThat(xml).contains("http://naesb.org/espi"); - - // Validate content - assertThat(xml).contains("Debug Service"); // In Atom title - assertThat(xml).containsPattern("]*>1"); - assertThat(xml).contains("01"); // roleFlags as hex - - // Validate XML structure - now wrapped in Atom entry - assertThat(xml).contains("Debug Service"); - assertThat(xml).contains(""); - - // Validate no utility methods are serialized (should have @XmlTransient) - assertThat(xml).doesNotContain("meterReadingCount"); - assertThat(xml).doesNotContain("usageSummaryCount"); - assertThat(xml).doesNotContain("generateSelfHref"); - assertThat(xml).doesNotContain("generateUpHref"); - } - - @Test - @DisplayName("Debug: Complex UsagePoint with all fields") - void debugComplexUsagePoint() throws Exception { - // Create UsagePoint with more fields populated - UsagePointDto usagePoint = new UsagePointDto( - "urn:uuid:complex-test", - new byte[]{0x01, 0x02, 0x03, 0x04}, - null, // serviceCategory - (short) 2, - null, null, null, null, null, - null, null, null, null, - null, null, null, null, null, - null, null, null, null, - null, null, null, null, null - ); - - // Wrap in Atom entry with description as title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:complex-test", "Complex Service with Special & Characters ", usagePoint); - - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); - - // Print for debugging - System.out.println("\nComplex XML (Jackson 3):"); - System.out.println("========================"); - System.out.println(xml); - System.out.println("========================\n"); - - // Validate XML escaping - assertThat(xml).contains("&"); // & is escaped - assertThat(xml).contains("<"); // < is escaped - - // Validate hex encoding of roleFlags - assertThat(xml).contains("01020304"); - - // Validate structure - description in Atom title - assertThat(xml).contains("Complex Service with Special & Characters <test>"); - assertThat(xml).contains(""); - } - - @Test - @DisplayName("Debug: Minimal UsagePoint (mostly nulls)") - void debugMinimalUsagePoint() throws Exception { - // Create minimal UsagePoint - UsagePointDto usagePoint = new UsagePointDto( - "urn:uuid:minimal-test", // uuid - null, // roleFlags - null, // serviceCategory - null, // status - null, null, null, null, null, // serviceDeliveryPoint, amiBillingReady, checkBilling, connectionState, estimatedLoad - null, null, null, null, // grounded, isSdp, isVirtual, minimalUsageExpected - null, null, null, null, null, // nominalServiceVoltage, outageRegion, phaseCode, ratedCurrent, ratedPower - null, null, null, null, // readCycle, readRoute, serviceDeliveryRemark, servicePriority - null, null, null, null, null // pnodeRefs, aggregatedNodeRefs, meterReadings, usageSummaries, electricPowerQualitySummaries - ); - - // Wrap in Atom entry with null title (IdentifiedObject fields handled by Atom layer) - AtomEntryDto entry = new AtomEntryDto("urn:uuid:minimal-test", null, usagePoint); - - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(entry); - - // Print for debugging - System.out.println("\nMinimal XML (Jackson 3):"); - System.out.println("========================"); - System.out.println(xml); - System.out.println("========================\n"); - - // Validate minimal structure - assertThat(xml).contains("entry"); // Now wrapping in Atom entry - assertThat(xml).contains("UsagePoint"); - assertThat(xml).contains("http://naesb.org/espi"); - - // Validate that null fields are not included (NON_EMPTY policy) - assertThat(xml).doesNotContain(" + * Validates that CustomerDto: + * - Matches customer.xsd field sequence exactly + * - Properly marshals all embedded types (Organisation, Status, Priority) + * - Uses correct namespace (http://naesb.org/espi/customer) + * - Produces valid XML with cust: prefix + */ +@DisplayName("CustomerDto XML Marshalling Tests") +class CustomerDtoMarshallingTest { + + private CustomerExportService customerExportService; + + @BeforeEach + void setUp() { + customerExportService = new CustomerExportService(); + customerExportService.init(); + } + + @Test + @DisplayName("Should marshal Customer with all fields populated") + void shouldMarshalCustomerWithAllFields() { + // Arrange - Create comprehensive CustomerDto with all fields + CustomerDto.StatusDto status = new CustomerDto.StatusDto( + "active", + OffsetDateTime.now(), + "New account created" + ); + + CustomerDto.PriorityDto priority = new CustomerDto.PriorityDto( + 1, // value + 10, // rank + "high-priority" // type + ); + + CustomerDto.PhoneNumberDto phone1 = new CustomerDto.PhoneNumberDto( + "415", // areaCode + "555", // cityCode + "1234", // localNumber + "100" // extension + ); + + CustomerDto.PhoneNumberDto phone2 = new CustomerDto.PhoneNumberDto( + "415", + "555", + "5678", + null + ); + + CustomerDto.ElectronicAddressDto electronicAddress = new CustomerDto.ElectronicAddressDto( + "customer@example.com", // email1 + "billing@example.com", // email2 + "https://customer.example.com", // web + null // radio + ); + + CustomerDto.StreetAddressDto streetAddress = new CustomerDto.StreetAddressDto( + "123 Main Street, Apt 4B", // streetDetail + "San Francisco", // townDetail + "CA", // stateOrProvince + "94102", // postalCode + "USA" // country + ); + + CustomerDto.StreetAddressDto postalAddress = new CustomerDto.StreetAddressDto( + "PO Box 789", + "San Francisco", + "CA", + "94103", + "USA" + ); + + CustomerDto.OrganisationDto organisation = new CustomerDto.OrganisationDto( + streetAddress, + postalAddress, + phone1, + phone2, + electronicAddress, + "ACME Energy Services" // organisationName + ); + + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440000", // uuid + organisation, + CustomerKind.RESIDENTIAL, + "Wheelchair access required", // specialNeed + true, // vip + "PUC-12345", // pucNumber + status, + priority, + "en-US", // locale + "John Q. Public" // customerName + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440001", + "Residential Customer - Full Data", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Debug output + System.out.println("\n========== Customer Full XML Output =========="); + System.out.println(xml); + System.out.println("==============================================\n"); + + // Assert - Namespace declarations + assertThat(xml) + .as("Should declare customer namespace with cust prefix") + .contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + + assertThat(xml) + .as("Should declare Atom namespace with atom prefix") + .contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + + assertThat(xml) + .as("Should NOT declare usage namespace") + .doesNotContain("xmlns:espi=\"http://naesb.org/espi\""); + + // Assert - Field order matches customer.xsd (organisation, kind, specialNeed, vip, pucNumber, status, priority, locale, customerName) + assertThat(xml).contains(""); + + // Organisation should come first + int organisationIndex = xml.indexOf(""); + assertThat(organisationIndex) + .as("Organisation element should be present") + .isGreaterThan(0); + + // Kind should come after Organisation + int kindIndex = xml.indexOf(""); + assertThat(kindIndex) + .as("kind should come after Organisation") + .isGreaterThan(organisationIndex); + + // specialNeed after kind + int specialNeedIndex = xml.indexOf(""); + assertThat(specialNeedIndex) + .as("specialNeed should come after kind") + .isGreaterThan(kindIndex); + + // vip after specialNeed + int vipIndex = xml.indexOf(""); + assertThat(vipIndex) + .as("vip should come after specialNeed") + .isGreaterThan(specialNeedIndex); + + // pucNumber after vip + int pucNumberIndex = xml.indexOf(""); + assertThat(pucNumberIndex) + .as("pucNumber should come after vip") + .isGreaterThan(vipIndex); + + // status after pucNumber + int statusIndex = xml.indexOf(""); + assertThat(statusIndex) + .as("status should come after pucNumber") + .isGreaterThan(pucNumberIndex); + + // priority after status + int priorityIndex = xml.indexOf(""); + assertThat(priorityIndex) + .as("priority should come after status") + .isGreaterThan(statusIndex); + + // locale after priority + int localeIndex = xml.indexOf(""); + assertThat(localeIndex) + .as("locale should come after priority") + .isGreaterThan(priorityIndex); + + // customerName after locale + int customerNameIndex = xml.indexOf(""); + assertThat(customerNameIndex) + .as("customerName should come after locale") + .isGreaterThan(localeIndex); + + // Assert - Field values + assertThat(xml).contains("ACME Energy Services"); + assertThat(xml).contains("RESIDENTIAL"); + assertThat(xml).contains("Wheelchair access required"); + assertThat(xml).contains("true"); + assertThat(xml).contains("PUC-12345"); + assertThat(xml).contains("en-US"); + assertThat(xml).contains("John Q. Public"); + + // Assert - Embedded types + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + } + + @Test + @DisplayName("Should marshal Customer with minimal fields") + void shouldMarshalCustomerWithMinimalFields() { + // Arrange - Create minimal CustomerDto (only customerName required) + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440010", + null, // organisation + null, // kind + null, // specialNeed + null, // vip + null, // pucNumber + null, // status + null, // priority + null, // locale + "Jane Smith" // customerName + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440011", + "Minimal Customer", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Assert + assertThat(xml).contains(""); + assertThat(xml).contains("Jane Smith"); + assertThat(xml).contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + } + + @Test + @DisplayName("Should use cust prefix for all Customer elements") + void shouldUseCustPrefixForAllElements() { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:test-prefix", + null, + CustomerKind.COMMERCIAL, + "Test special need", + false, + "PUC-999", + null, + null, + "en-GB", + "Test Customer Inc" + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:test-prefix-entry", + "Prefix Test", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Assert - All customer elements should have cust: prefix + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + assertThat(xml).contains(""); + + // Assert - NO generic ns3/ns5 prefixes + assertThat(xml).doesNotContain("ns3:"); + assertThat(xml).doesNotContain("ns5:"); + } +} \ No newline at end of file diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java new file mode 100644 index 00000000..5b20a8ba --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java @@ -0,0 +1,325 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.dto.customer; + +import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; +import org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto; +import org.greenbuttonalliance.espi.common.service.impl.DtoExportServiceImpl; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.time.LocalDateTime; +import java.time.OffsetDateTime; +import java.time.ZoneOffset; +import java.time.temporal.ChronoUnit; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * XML marshalling/unmarshalling tests for CustomerDto. + * Verifies Jakarta JAXB Marshaller processes JAXB annotations correctly for ESPI 4.0 customer.xsd compliance. + * Follows the same pattern as DtoExportServiceImplTest for usage domain resources. + */ +@DisplayName("CustomerDto XML Marshalling Tests") +class CustomerDtoTest { + + private DtoExportServiceImpl dtoExportService; + + @BeforeEach + void setUp() { + // Initialize DtoExportService with null repository/mapper (not needed for DTO-only tests) + org.greenbuttonalliance.espi.common.service.EspiIdGeneratorService espiIdGeneratorService = + new org.greenbuttonalliance.espi.common.service.EspiIdGeneratorService(); + dtoExportService = new DtoExportServiceImpl(null, null, espiIdGeneratorService); + } + + @Test + @DisplayName("Should export Customer with complete realistic data") + void shouldExportCustomerWithRealisticData() throws IOException { + // Arrange + LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); + OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); + + CustomerDto customer = createFullCustomerDto(); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440000", + "ACME Energy Services Customer", + now, now, null, customer + ); + + AtomFeedDto feed = new AtomFeedDto( + "urn:uuid:feed-id", "Customer Feed", now, now, null, + List.of(entry) + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + dtoExportService.exportAtomFeed(feed, stream); + String xml = stream.toString(StandardCharsets.UTF_8); + + // Debug output + System.out.println("========== Customer XML Output =========="); + System.out.println(xml); + System.out.println("========================================="); + + // Assert - Basic structure + assertThat(xml).startsWith(""); + assertThat(xml).contains(""); + + // Assert - Customer namespace (cust: prefix for customer.xsd) + assertThat(xml).contains("http://naesb.org/espi/customer"); + assertThat(xml).contains("cust:"); + assertThat(xml).contains(""); + + // Assert - Organisation fields present + assertThat(xml).contains(""); + int specialNeedPos = xml.indexOf(""); + int vipPos = xml.indexOf(""); + int pucNumberPos = xml.indexOf(""); + int statusPos = xml.indexOf(""); + int priorityPos = xml.indexOf(""); + int localePos = xml.indexOf(""); + int customerNamePos = xml.indexOf(""); + + assertThat(organisationPos).isGreaterThan(0).isLessThan(kindPos); + assertThat(kindPos).isLessThan(specialNeedPos); + assertThat(specialNeedPos).isLessThan(vipPos); + assertThat(vipPos).isLessThan(pucNumberPos); + assertThat(pucNumberPos).isLessThan(statusPos); + assertThat(statusPos).isLessThan(priorityPos); + assertThat(priorityPos).isLessThan(localePos); + assertThat(localePos).isLessThan(customerNamePos); + } + + @Test + @DisplayName("Should verify Organisation field order per customer.xsd") + void shouldVerifyOrganisationFieldOrder() throws IOException { + // Arrange + LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); + OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); + + CustomerDto customer = createFullCustomerDto(); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440004", + "Test Customer", + now, now, null, customer + ); + + AtomFeedDto feed = new AtomFeedDto( + "urn:uuid:feed-id", "Test Feed", now, now, null, + List.of(entry) + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + dtoExportService.exportAtomFeed(feed, stream); + String xml = stream.toString(StandardCharsets.UTF_8); + + // Assert - Verify Organisation field order per customer.xsd:1096-1125 + // Order: streetAddress, postalAddress, phone1, phone2, electronicAddress, organisationName + int streetPos = xml.indexOf(""); + int postalPos = xml.indexOf(""); + int phone1Pos = xml.indexOf(""); + int phone2Pos = xml.indexOf(""); + int electronicPos = xml.indexOf(""); + int orgNamePos = xml.indexOf(""); + + assertThat(streetPos).isGreaterThan(0).isLessThan(postalPos); + assertThat(postalPos).isLessThan(phone1Pos); + assertThat(phone1Pos).isLessThan(phone2Pos); + assertThat(phone2Pos).isLessThan(electronicPos); + assertThat(electronicPos).isLessThan(orgNamePos); + } + + @Test + @DisplayName("Should export Customer with minimal data") + void shouldExportCustomerWithMinimalData() throws IOException { + // Arrange + LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); + OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); + + CustomerDto.OrganisationDto organisation = new CustomerDto.OrganisationDto( + null, null, null, null, null, "Minimal Org" + ); + + CustomerDto customer = new CustomerDto( + "550e8400-e29b-51d4-a716-446655440002", + organisation, + CustomerKind.ENTERPRISE, + null, null, null, null, null, null, null + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440002", + "Minimal Customer", + now, now, null, customer + ); + + AtomFeedDto feed = new AtomFeedDto( + "urn:uuid:feed-id", "Test Feed", now, now, null, + List.of(entry) + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + dtoExportService.exportAtomFeed(feed, stream); + String xml = stream.toString(StandardCharsets.UTF_8); + + // Assert + assertThat(xml).contains(" "related".equals(link.rel())) + .filter(link -> "related".equals(link.getRel())) .findFirst() .orElse(null); assertThat(relatedLink).isNotNull(); - assertThat(relatedLink.href()).isEqualTo(CERTIFICATION_URL); - assertThat(relatedLink.type()).isEqualTo("text/html"); + assertThat(relatedLink.getHref()).isEqualTo(CERTIFICATION_URL); + assertThat(relatedLink.getType()).isEqualTo("text/html"); } @Test @@ -130,13 +130,13 @@ void shouldNotAddCertificationLinkWhenNullOrEmpty() { void shouldAddEntriesUsingFluentApi() { OffsetDateTime now = OffsetDateTime.now(ZoneOffset.UTC); - AtomEntryDto usagePointEntry = new AtomEntryDto( + UsageAtomEntryDto usagePointEntry = new UsageAtomEntryDto( "urn:uuid:test-usage-point", "Test Usage Point", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null) ); - AtomEntryDto meterReadingEntry = new AtomEntryDto( + UsageAtomEntryDto meterReadingEntry = new UsageAtomEntryDto( "urn:uuid:test-meter-reading", "Test Meter Reading", new MeterReadingDto() @@ -160,17 +160,13 @@ void shouldAddEntriesUsingFluentApi() { void shouldAddMultipleEntriesAtOnce() { OffsetDateTime now = OffsetDateTime.now(ZoneOffset.UTC); - List entries = List.of( - new AtomEntryDto("urn:uuid:entry1", "Entry 1", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null)), - new AtomEntryDto("urn:uuid:entry2", "Entry 2", new MeterReadingDto()) - ); - SubscriptionDto dto = new SubscriptionDto( TEST_SUBSCRIPTION_ID, SubscriptionDto.SchemaType.ENERGY, now, now - ).withEntries(entries); + ).withEntry(new UsageAtomEntryDto("urn:uuid:entry1", "Entry 1", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null))) + .withEntry(new UsageAtomEntryDto("urn:uuid:entry2", "Entry 2", new MeterReadingDto())); assertThat(dto.getEntries()).hasSize(2); } @@ -189,11 +185,11 @@ void shouldConvertToAtomFeedDtoWithEnergyTitle() { AtomFeedDto feed = dto.toAtomFeed(); - assertThat(feed.id()).isEqualTo("urn:uuid:" + TEST_SUBSCRIPTION_ID); - assertThat(feed.title()).isEqualTo("Green Button Energy Feed"); - assertThat(feed.published()).isEqualTo(now); - assertThat(feed.updated()).isEqualTo(now); - assertThat(feed.links()).hasSize(1); + assertThat(feed.getId()).isEqualTo("urn:uuid:" + TEST_SUBSCRIPTION_ID); + assertThat(feed.getTitle()).isEqualTo("Green Button Energy Feed"); + assertThat(feed.getPublished()).isEqualTo(now); + assertThat(feed.getUpdated()).isEqualTo(now); + assertThat(feed.getLinks()).hasSize(1); } @Test @@ -210,7 +206,7 @@ void shouldConvertToAtomFeedDtoWithCustomerTitle() { AtomFeedDto feed = dto.toAtomFeed(); - assertThat(feed.title()).isEqualTo("Green Button Customer Feed"); + assertThat(feed.getTitle()).isEqualTo("Green Button Customer Feed"); } @Test @@ -218,8 +214,8 @@ void shouldConvertToAtomFeedDtoWithCustomerTitle() { void shouldIncludeAllEntriesInAtomFeedDto() { OffsetDateTime now = OffsetDateTime.now(ZoneOffset.UTC); - AtomEntryDto entry1 = new AtomEntryDto("urn:uuid:entry1", "Entry 1", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null)); - AtomEntryDto entry2 = new AtomEntryDto("urn:uuid:entry2", "Entry 2", new MeterReadingDto()); + UsageAtomEntryDto entry1 = new UsageAtomEntryDto("urn:uuid:entry1", "Entry 1", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null)); + UsageAtomEntryDto entry2 = new UsageAtomEntryDto("urn:uuid:entry2", "Entry 2", new MeterReadingDto()); SubscriptionDto dto = new SubscriptionDto( TEST_SUBSCRIPTION_ID, @@ -233,8 +229,8 @@ void shouldIncludeAllEntriesInAtomFeedDto() { AtomFeedDto feed = dto.toAtomFeed(); - assertThat(feed.entries()).hasSize(2); - assertThat(feed.links()).hasSize(2); // self + related + assertThat(feed.getEntries()).hasSize(2); + assertThat(feed.getLinks()).hasSize(2); // self + related } @Test diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDtoTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDtoTest.java index 9dbd8e59..d1dca9a2 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDtoTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/usage/TimeConfigurationDtoTest.java @@ -19,50 +19,40 @@ package org.greenbuttonalliance.espi.common.dto.usage; -import com.fasterxml.jackson.annotation.JsonInclude; +import jakarta.xml.bind.JAXBContext; +import jakarta.xml.bind.JAXBException; +import jakarta.xml.bind.Marshaller; +import jakarta.xml.bind.Unmarshaller; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; -import tools.jackson.databind.AnnotationIntrospector; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.cfg.DateTimeFeature; -import tools.jackson.databind.introspect.JacksonAnnotationIntrospector; -import tools.jackson.databind.util.StdDateFormat; -import tools.jackson.dataformat.xml.XmlAnnotationIntrospector; -import tools.jackson.dataformat.xml.XmlMapper; -import tools.jackson.dataformat.xml.XmlWriteFeature; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector; -import tools.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationModule; + +import java.io.StringReader; +import java.io.StringWriter; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.jupiter.api.Assertions.*; /** * XML marshalling/unmarshalling tests for TimeConfigurationDto. - * Verifies Jackson 3 XmlMapper processes JAXB annotations correctly for ESPI 4.0 schema compliance. + * Verifies JAXB processes annotations correctly for ESPI 4.0 schema compliance. */ @DisplayName("TimeConfigurationDto XML Marshalling Tests") class TimeConfigurationDtoTest { - private XmlMapper xmlMapper; + private Marshaller marshaller; + private Unmarshaller unmarshaller; @BeforeEach - void setUp() { - // Initialize Jackson 3 XmlMapper with JAXB annotation support - AnnotationIntrospector intr = XmlAnnotationIntrospector.Pair.instance( - new JakartaXmlBindAnnotationIntrospector(), - new JacksonAnnotationIntrospector() - ); - - xmlMapper = XmlMapper.xmlBuilder() - .annotationIntrospector(intr) - .addModule(new JakartaXmlBindAnnotationModule() - .setNonNillableInclusion(JsonInclude.Include.NON_EMPTY)) - .enable(SerializationFeature.INDENT_OUTPUT) - .enable(DateTimeFeature.WRITE_DATES_WITH_ZONE_ID) - .disable(XmlWriteFeature.WRITE_NULLS_AS_XSI_NIL) - .defaultDateFormat(new StdDateFormat()) - .build(); + void setUp() throws JAXBException { + // Initialize Jakarta JAXB Marshaller for TimeConfigurationDto + JAXBContext jaxbContext = JAXBContext.newInstance(TimeConfigurationDto.class); + marshaller = jaxbContext.createMarshaller(); + marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8"); + marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true); + + unmarshaller = jaxbContext.createUnmarshaller(); } @Test @@ -78,8 +68,10 @@ void shouldMarshalTimeConfigurationWithRealisticData() throws Exception { -28800L // tzOffset (UTC-8 in seconds) ); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(timeConfig); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(timeConfig, writer); + String xml = writer.toString(); // Verify XML structure assertThat(xml).contains("TimeConfiguration"); @@ -104,18 +96,20 @@ void shouldPerformRoundTripMarshallingForTimeConfiguration() throws Exception { -18000L // tzOffset (UTC-5) ); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(original); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(original, writer); + String xml = writer.toString(); - // Unmarshal back from XML using Jackson 3 - TimeConfigurationDto roundTrip = xmlMapper.readValue(xml, TimeConfigurationDto.class); + // Unmarshal back from XML using JAXB + TimeConfigurationDto roundTrip = (TimeConfigurationDto) unmarshaller.unmarshal(new StringReader(xml)); // Verify data integrity survived round trip // Note: uuid is @XmlTransient (handled by Atom wrapper), so it won't survive round trip - assertThat(roundTrip.tzOffset()).isEqualTo(original.tzOffset()); - assertThat(roundTrip.dstOffset()).isEqualTo(original.dstOffset()); - assertThat(roundTrip.dstStartRule()).isEqualTo(original.dstStartRule()); - assertThat(roundTrip.dstEndRule()).isEqualTo(original.dstEndRule()); + assertThat(roundTrip.getTzOffset()).isEqualTo(original.getTzOffset()); + assertThat(roundTrip.getDstOffset()).isEqualTo(original.getDstOffset()); + assertThat(roundTrip.getDstStartRule()).isEqualTo(original.getDstStartRule()); + assertThat(roundTrip.getDstEndRule()).isEqualTo(original.getDstEndRule()); } @Test @@ -131,8 +125,10 @@ void shouldHandleTimeConfigurationWithOnlyTimezoneOffset() throws Exception { 7200L // tzOffset (UTC+2) ); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(simple); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(simple, writer); + String xml = writer.toString(); // Verify XML structure assertThat(xml).contains("TimeConfiguration"); @@ -142,14 +138,14 @@ void shouldHandleTimeConfigurationWithOnlyTimezoneOffset() throws Exception { assertThat(xml).doesNotContain("dstStartRule"); assertThat(xml).doesNotContain("dstEndRule"); - // Unmarshal back using Jackson 3 - TimeConfigurationDto roundTrip = xmlMapper.readValue(xml, TimeConfigurationDto.class); + // Unmarshal back using JAXB + TimeConfigurationDto roundTrip = (TimeConfigurationDto) unmarshaller.unmarshal(new StringReader(xml)); // Verify data integrity - assertThat(roundTrip.tzOffset()).isEqualTo(simple.tzOffset()); - assertThat(roundTrip.dstOffset()).isNull(); - assertThat(roundTrip.dstStartRule()).isNull(); - assertThat(roundTrip.dstEndRule()).isNull(); + assertThat(roundTrip.getTzOffset()).isEqualTo(simple.getTzOffset()); + assertThat(roundTrip.getDstOffset()).isNull(); + assertThat(roundTrip.getDstStartRule()).isNull(); + assertThat(roundTrip.getDstEndRule()).isNull(); } @Test @@ -158,15 +154,17 @@ void shouldHandleEmptyTimeConfigurationWithoutErrors() throws Exception { // Create empty TimeConfiguration TimeConfigurationDto empty = new TimeConfigurationDto(); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(empty); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(empty, writer); + String xml = writer.toString(); // Should still contain basic structure assertThat(xml).contains("TimeConfiguration"); assertThat(xml).contains("http://naesb.org/espi"); - // Unmarshal back using Jackson 3 - TimeConfigurationDto roundTrip = xmlMapper.readValue(xml, TimeConfigurationDto.class); + // Unmarshal back using JAXB + TimeConfigurationDto roundTrip = (TimeConfigurationDto) unmarshaller.unmarshal(new StringReader(xml)); // Should not throw exceptions assertThat(roundTrip).isNotNull(); @@ -185,8 +183,10 @@ void shouldIncludeProperXmlNamespacesAndElementOrder() throws Exception { -28800L // tzOffset ); - // Marshal to XML using Jackson 3 - String xml = xmlMapper.writeValueAsString(timeConfig); + // Marshal to XML using JAXB + StringWriter writer = new StringWriter(); + marshaller.marshal(timeConfig, writer); + String xml = writer.toString(); // Verify namespace declarations assertThat(xml).contains("xmlns"); @@ -216,9 +216,9 @@ void shouldHandleByteArrayCloningForDstRules() { originalEndRule, 3600L, originalStartRule, -18000L ); - // Get byte arrays via accessors (should be cloned) - byte[] retrievedStartRule = timeConfig.dstStartRule(); - byte[] retrievedEndRule = timeConfig.dstEndRule(); + // Get byte arrays via getters (should be cloned) + byte[] retrievedStartRule = timeConfig.getDstStartRule(); + byte[] retrievedEndRule = timeConfig.getDstEndRule(); // Verify arrays are equal but not same instance assertArrayEquals(originalStartRule, retrievedStartRule, "Start rule content should match"); @@ -228,7 +228,7 @@ void shouldHandleByteArrayCloningForDstRules() { // Modifying retrieved arrays should not affect original retrievedStartRule[0] = (byte) 0xFF; - assertNotEquals(retrievedStartRule[0], timeConfig.dstStartRule()[0], + assertNotEquals(retrievedStartRule[0], timeConfig.getDstStartRule()[0], "Modifying cloned array should not affect original"); } diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/mapper/usage/SubscriptionMapperTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/mapper/usage/SubscriptionMapperTest.java index 9001098a..0ba56670 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/mapper/usage/SubscriptionMapperTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/mapper/usage/SubscriptionMapperTest.java @@ -21,6 +21,7 @@ import org.greenbuttonalliance.espi.common.domain.usage.SubscriptionEntity; import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; import org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto; import org.greenbuttonalliance.espi.common.dto.usage.MeterReadingDto; import org.greenbuttonalliance.espi.common.dto.usage.SubscriptionDto; @@ -76,7 +77,7 @@ void shouldCreateSubscriptionDtoFromEntity() { assertThat(dto.getSubscriptionId()).isEqualTo(TEST_SUBSCRIPTION_ID.toString()); assertThat(dto.getSchemaType()).isEqualTo(SubscriptionDto.SchemaType.ENERGY); assertThat(dto.getLinks()).hasSize(1); // Only self link - assertThat(dto.getLinks().get(0).rel()).isEqualTo("self"); + assertThat(dto.getLinks().get(0).getRel()).isEqualTo("self"); } @Test @@ -92,7 +93,7 @@ void shouldIncludeCertificationLinkWhenCertified() { assertThat(dto.getLinks()).hasSize(2); // self + related assertThat(dto.getLinks().stream() - .filter(link -> "related".equals(link.rel())) + .filter(link -> "related".equals(link.getRel())) .findFirst()) .isPresent(); } @@ -107,7 +108,7 @@ void shouldNotIncludeCertificationLinkWhenNotCertified() { assertThat(dto.getLinks()).hasSize(1); // Only self link assertThat(dto.getLinks().stream() - .filter(link -> "related".equals(link.rel())) + .filter(link -> "related".equals(link.getRel())) .findFirst()) .isEmpty(); } @@ -117,17 +118,18 @@ void shouldNotIncludeCertificationLinkWhenNotCertified() { void shouldCreateAtomFeedDtoDirectlyWithEntries() { SubscriptionEntity entity = new SubscriptionEntity(TEST_SUBSCRIPTION_ID); - List entries = List.of( - new AtomEntryDto("urn:uuid:entry1", "Usage Point", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null)), - new AtomEntryDto("urn:uuid:entry2", "Meter Reading", new MeterReadingDto()) + // Using Arrays.asList for polymorphic list creation + List entries = java.util.Arrays.asList( + new UsageAtomEntryDto("urn:uuid:entry1", "Usage Point", new UsagePointDto(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null)), + new UsageAtomEntryDto("urn:uuid:entry2", "Meter Reading", new MeterReadingDto()) ); AtomFeedDto feed = subscriptionMapper.toAtomFeed(entity, SubscriptionDto.SchemaType.ENERGY, entries); assertThat(feed).isNotNull(); - assertThat(feed.id()).isEqualTo("urn:uuid:" + TEST_SUBSCRIPTION_ID); - assertThat(feed.title()).isEqualTo("Green Button Energy Feed"); - assertThat(feed.entries()).hasSize(2); + assertThat(feed.getId()).isEqualTo("urn:uuid:" + TEST_SUBSCRIPTION_ID); + assertThat(feed.getTitle()).isEqualTo("Green Button Energy Feed"); + assertThat(feed.getEntries()).hasSize(2); } @Test @@ -175,6 +177,6 @@ void shouldUseCustomerTitleForCustomerSchemaType() { AtomFeedDto feed = subscriptionMapper.toAtomFeed(entity, SubscriptionDto.SchemaType.CUSTOMER, List.of()); - assertThat(feed.title()).isEqualTo("Green Button Customer Feed"); + assertThat(feed.getTitle()).isEqualTo("Green Button Customer Feed"); } } diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepositoryTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepositoryTest.java index a44e4703..e79611b3 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepositoryTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/customer/CustomerRepositoryTest.java @@ -20,6 +20,7 @@ import jakarta.validation.ConstraintViolation; import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; +import org.greenbuttonalliance.espi.common.domain.customer.entity.Organisation; import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; import org.greenbuttonalliance.espi.common.test.BaseRepositoryTest; import org.greenbuttonalliance.espi.common.test.TestDataBuilders; @@ -38,9 +39,11 @@ /** * Comprehensive test suite for CustomerRepository. - * - * Tests all CRUD operations, 8 custom query methods, relationships, - * and validation constraints for Customer entities. + * + * Tests all CRUD operations, relationships, and validation constraints for Customer entities. + * Per ESPI 4.0 API specification, only default JpaRepository methods are supported (findById, findAll, save, delete). + * Removed tests for: findByCustomerName, findByKind, findByPucNumber, findVipCustomers, + * findCustomersWithSpecialNeeds, findByLocale, findByPriorityRange, findByOrganisationName */ @DisplayName("Customer Repository Tests") class CustomerRepositoryTest extends BaseRepositoryTest { @@ -142,288 +145,209 @@ void shouldCountCustomers() { } @Nested - @DisplayName("Custom Query Methods") - class CustomQueryMethodsTest { + @DisplayName("JPA Relationships") + class RelationshipsTest { @Test - @DisplayName("Should find customer by customer name (case insensitive)") - void shouldFindCustomerByCustomerNameCaseInsensitive() { + @DisplayName("Should handle customer accounts relationship") + void shouldHandleCustomerAccountsRelationship() { // Arrange CustomerEntity customer = TestDataBuilders.createValidCustomer(); - customer.setCustomerName("ACME Energy Solutions"); - customerRepository.save(customer); - flushAndClear(); + customer.setCustomerName("Customer with Accounts"); // Act - Optional result1 = customerRepository.findByCustomerName("ACME Energy Solutions"); - Optional result2 = customerRepository.findByCustomerName("acme energy solutions"); - Optional result3 = customerRepository.findByCustomerName("Acme Energy Solutions"); - - // Assert - assertThat(result1).isPresent(); - assertThat(result1.get().getCustomerName()).isEqualTo("ACME Energy Solutions"); - - assertThat(result2).isPresent(); - assertThat(result2.get().getCustomerName()).isEqualTo("ACME Energy Solutions"); - - assertThat(result3).isPresent(); - assertThat(result3.get().getCustomerName()).isEqualTo("ACME Energy Solutions"); - } - - @Test - @DisplayName("Should find customers by kind") - void shouldFindCustomersByKind() { - // Arrange - CustomerEntity residential1 = TestDataBuilders.createValidCustomer(); - residential1.setCustomerName("Residential Customer 1"); - residential1.setKind(CustomerKind.RESIDENTIAL); - - CustomerEntity residential2 = TestDataBuilders.createValidCustomer(); - residential2.setCustomerName("Residential Customer 2"); - residential2.setKind(CustomerKind.RESIDENTIAL); - - CustomerEntity commercial = TestDataBuilders.createValidCustomer(); - commercial.setCustomerName("Commercial Customer"); - commercial.setKind(CustomerKind.COMMERCIAL); - - customerRepository.saveAll(List.of(residential1, residential2, commercial)); + CustomerEntity savedCustomer = customerRepository.save(customer); flushAndClear(); - // Act - List residentialCustomers = customerRepository.findByKind(CustomerKind.RESIDENTIAL); - List commercialCustomers = customerRepository.findByKind(CustomerKind.COMMERCIAL); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); // Assert - assertThat(residentialCustomers).hasSize(2); - assertThat(residentialCustomers).extracting(CustomerEntity::getCustomerName) - .contains("Residential Customer 1", "Residential Customer 2"); - - assertThat(commercialCustomers).hasSize(1); - assertThat(commercialCustomers).extracting(CustomerEntity::getCustomerName) - .contains("Commercial Customer"); + assertThat(retrieved).isPresent(); + assertThat(retrieved.get().getCustomerAccounts()).isNotNull(); + // Note: In a real implementation, you'd test actual CustomerAccount relationships } @Test - @DisplayName("Should find customer by PUC number") - void shouldFindCustomerByPucNumber() { + @DisplayName("Should handle null relationships gracefully") + void shouldHandleNullRelationshipsGracefully() { // Arrange CustomerEntity customer = TestDataBuilders.createValidCustomer(); - customer.setCustomerName("Customer with PUC"); - customer.setPucNumber("PUC123456789"); - customerRepository.save(customer); - flushAndClear(); - - // Act - Optional result = customerRepository.findByPucNumber("PUC123456789"); + customer.setCustomerName("Customer without Relationships"); + customer.setCustomerAccounts(null); - // Assert - assertThat(result).isPresent(); - assertThat(result.get().getCustomerName()).isEqualTo("Customer with PUC"); - assertThat(result.get().getPucNumber()).isEqualTo("PUC123456789"); + // Act & Assert + assertThatCode(() -> { + CustomerEntity saved = customerRepository.save(customer); + System.out.println("[DEBUG_LOG] After save - customerAccounts: " + saved.getCustomerAccounts()); + flushAndClear(); + Optional retrieved = customerRepository.findById(saved.getId()); + System.out.println("[DEBUG_LOG] After retrieve - customerAccounts: " + retrieved.get().getCustomerAccounts()); + assertThat(retrieved).isPresent(); + assertThat(retrieved.get().getCustomerAccounts()).isNotNull(); + assertThat(retrieved.get().getCustomerAccounts()).isEmpty(); + }).doesNotThrowAnyException(); } + } - @Test - @DisplayName("Should find VIP customers") - void shouldFindVipCustomers() { - // Arrange - CustomerEntity vipCustomer1 = TestDataBuilders.createValidCustomer(); - vipCustomer1.setCustomerName("VIP Customer 1"); - vipCustomer1.setVip(true); - - CustomerEntity vipCustomer2 = TestDataBuilders.createValidCustomer(); - vipCustomer2.setCustomerName("VIP Customer 2"); - vipCustomer2.setVip(true); - - CustomerEntity regularCustomer = TestDataBuilders.createValidCustomer(); - regularCustomer.setCustomerName("Regular Customer"); - regularCustomer.setVip(false); - - customerRepository.saveAll(List.of(vipCustomer1, vipCustomer2, regularCustomer)); - flushAndClear(); - - // Act - List vipCustomers = customerRepository.findVipCustomers(); - - // Assert - assertThat(vipCustomers).hasSize(2); - assertThat(vipCustomers).extracting(CustomerEntity::getCustomerName) - .contains("VIP Customer 1", "VIP Customer 2"); - assertThat(vipCustomers).allMatch(CustomerEntity::getVip); - } + @Nested + @DisplayName("Embedded Objects Persistence") + class EmbeddedObjectsTest { @Test - @DisplayName("Should find customers with special needs") - void shouldFindCustomersWithSpecialNeeds() { + @DisplayName("Should persist and retrieve Organisation embedded object") + void shouldPersistAndRetrieveOrganisation() { // Arrange - CustomerEntity specialNeedsCustomer1 = TestDataBuilders.createValidCustomer(); - specialNeedsCustomer1.setCustomerName("Special Needs Customer 1"); - specialNeedsCustomer1.setSpecialNeed("Life Support Equipment"); - - CustomerEntity specialNeedsCustomer2 = TestDataBuilders.createValidCustomer(); - specialNeedsCustomer2.setCustomerName("Special Needs Customer 2"); - specialNeedsCustomer2.setSpecialNeed("Medical Equipment"); - - CustomerEntity regularCustomer = TestDataBuilders.createValidCustomer(); - regularCustomer.setCustomerName("Regular Customer"); - regularCustomer.setSpecialNeed("NONE"); - - CustomerEntity nullSpecialNeedCustomer = TestDataBuilders.createValidCustomer(); - nullSpecialNeedCustomer.setCustomerName("Null Special Need Customer"); - nullSpecialNeedCustomer.setSpecialNeed(null); - - customerRepository.saveAll(List.of(specialNeedsCustomer1, specialNeedsCustomer2, regularCustomer, nullSpecialNeedCustomer)); - flushAndClear(); + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Customer with Organisation"); + + // Set Organisation embedded object + Organisation org = new Organisation(); + org.setOrganisationName("ACME Energy Services"); + + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("123 Main Street"); + streetAddress.setTownDetail("San Francisco"); + streetAddress.setStateOrProvince("CA"); + streetAddress.setPostalCode("94102"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + Organisation.StreetAddress postalAddress = new Organisation.StreetAddress(); + postalAddress.setStreetDetail("PO Box 789"); + postalAddress.setTownDetail("San Francisco"); + postalAddress.setStateOrProvince("CA"); + postalAddress.setPostalCode("94103"); + postalAddress.setCountry("USA"); + org.setPostalAddress(postalAddress); + + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("contact@acme.com"); + electronicAddress.setEmail2("support@acme.com"); + electronicAddress.setWeb("https://www.acme.com"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); // Act - List specialNeedsCustomers = customerRepository.findCustomersWithSpecialNeeds(); + CustomerEntity saved = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(saved.getId()); // Assert - assertThat(specialNeedsCustomers).hasSize(2); - assertThat(specialNeedsCustomers).extracting(CustomerEntity::getCustomerName) - .contains("Special Needs Customer 1", "Special Needs Customer 2"); - assertThat(specialNeedsCustomers).extracting(CustomerEntity::getSpecialNeed) - .contains("Life Support Equipment", "Medical Equipment"); + assertThat(retrieved).isPresent(); + Organisation retrievedOrg = retrieved.get().getOrganisation(); + assertThat(retrievedOrg).isNotNull(); + assertThat(retrievedOrg.getOrganisationName()).isEqualTo("ACME Energy Services"); + assertThat(retrievedOrg.getStreetAddress()).isNotNull(); + assertThat(retrievedOrg.getStreetAddress().getStreetDetail()).isEqualTo("123 Main Street"); + assertThat(retrievedOrg.getStreetAddress().getTownDetail()).isEqualTo("San Francisco"); + assertThat(retrievedOrg.getPostalAddress()).isNotNull(); + assertThat(retrievedOrg.getPostalAddress().getStreetDetail()).isEqualTo("PO Box 789"); + assertThat(retrievedOrg.getElectronicAddress()).isNotNull(); + assertThat(retrievedOrg.getElectronicAddress().getEmail1()).isEqualTo("contact@acme.com"); } @Test - @DisplayName("Should find customers by locale") - void shouldFindCustomersByLocale() { + @DisplayName("Should persist and retrieve Status embedded object") + void shouldPersistAndRetrieveStatus() { // Arrange - CustomerEntity usCustomer1 = TestDataBuilders.createValidCustomer(); - usCustomer1.setCustomerName("US Customer 1"); - usCustomer1.setLocale("en_US"); - - CustomerEntity usCustomer2 = TestDataBuilders.createValidCustomer(); - usCustomer2.setCustomerName("US Customer 2"); - usCustomer2.setLocale("en_US"); - - CustomerEntity frenchCustomer = TestDataBuilders.createValidCustomer(); - frenchCustomer.setCustomerName("French Customer"); - frenchCustomer.setLocale("fr_FR"); + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Customer with Status"); - customerRepository.saveAll(List.of(usCustomer1, usCustomer2, frenchCustomer)); - flushAndClear(); + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("active"); + status.setDateTime(java.time.OffsetDateTime.now()); + status.setReason("Account activated"); + customer.setStatus(status); // Act - List usCustomers = customerRepository.findByLocale("en_US"); - List frenchCustomers = customerRepository.findByLocale("fr_FR"); + CustomerEntity saved = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(saved.getId()); // Assert - assertThat(usCustomers).hasSize(2); - assertThat(usCustomers).extracting(CustomerEntity::getCustomerName) - .contains("US Customer 1", "US Customer 2"); - - assertThat(frenchCustomers).hasSize(1); - assertThat(frenchCustomers).extracting(CustomerEntity::getCustomerName) - .contains("French Customer"); + assertThat(retrieved).isPresent(); + CustomerEntity.Status retrievedStatus = retrieved.get().getStatus(); + assertThat(retrievedStatus).isNotNull(); + assertThat(retrievedStatus.getValue()).isEqualTo("active"); + assertThat(retrievedStatus.getDateTime()).isNotNull(); + assertThat(retrievedStatus.getReason()).isEqualTo("Account activated"); } @Test - @DisplayName("Should find customers by priority range") - void shouldFindCustomersByPriorityRange() { + @DisplayName("Should persist and retrieve Priority embedded object") + void shouldPersistAndRetrievePriority() { // Arrange - CustomerEntity highPriorityCustomer = TestDataBuilders.createValidCustomer(); - highPriorityCustomer.setCustomerName("High Priority Customer"); - // Note: Priority is an embedded object, so we'll test this conceptually - // In a real implementation, you'd need to create Priority objects - - CustomerEntity mediumPriorityCustomer = TestDataBuilders.createValidCustomer(); - mediumPriorityCustomer.setCustomerName("Medium Priority Customer"); - - CustomerEntity lowPriorityCustomer = TestDataBuilders.createValidCustomer(); - lowPriorityCustomer.setCustomerName("Low Priority Customer"); + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Customer with Priority"); - customerRepository.saveAll(List.of(highPriorityCustomer, mediumPriorityCustomer, lowPriorityCustomer)); - flushAndClear(); + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(1); + priority.setRank(10); + priority.setType("high-priority"); + customer.setPriority(priority); // Act - List results = customerRepository.findByPriorityRange(1, 10); + CustomerEntity saved = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(saved.getId()); // Assert - // Since we don't have actual Priority objects set up, this will return empty - // In a real implementation, you'd set up Priority embedded objects - assertThat(results).isNotNull(); + assertThat(retrieved).isPresent(); + CustomerEntity.Priority retrievedPriority = retrieved.get().getPriority(); + assertThat(retrievedPriority).isNotNull(); + assertThat(retrievedPriority.getValue()).isEqualTo(1); + assertThat(retrievedPriority.getRank()).isEqualTo(10); + assertThat(retrievedPriority.getType()).isEqualTo("high-priority"); } @Test - @DisplayName("Should find customers by organisation name") - void shouldFindCustomersByOrganisationName() { + @DisplayName("Should persist and retrieve all embedded objects together") + void shouldPersistAndRetrieveAllEmbeddedObjects() { // Arrange - CustomerEntity customer1 = TestDataBuilders.createValidCustomer(); - customer1.setCustomerName("Customer 1"); - // Note: Organisation is an embedded object, so we'll test this conceptually - // In a real implementation, you'd need to create Organisation objects - - CustomerEntity customer2 = TestDataBuilders.createValidCustomer(); - customer2.setCustomerName("Customer 2"); - - customerRepository.saveAll(List.of(customer1, customer2)); - flushAndClear(); - - // Act - List results = customerRepository.findByOrganisationName("ACME Corp"); - - // Assert - // Since we don't have actual Organisation objects set up, this will return empty - // In a real implementation, you'd set up Organisation embedded objects - assertThat(results).isNotNull(); - } + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Customer with All Embedded Objects"); + customer.setKind(CustomerKind.COMMERCIAL); + customer.setSpecialNeed("Wheelchair access"); + customer.setVip(true); + customer.setPucNumber("PUC-12345"); + customer.setLocale("en-US"); - @Test - @DisplayName("Should handle empty results gracefully") - void shouldHandleEmptyResultsGracefully() { - // Act & Assert - assertThat(customerRepository.findByCustomerName("NonExistentCustomer")).isEmpty(); - assertThat(customerRepository.findByKind(CustomerKind.ENTERPRISE)).isEmpty(); - assertThat(customerRepository.findByPucNumber("NonExistentPUC")).isEmpty(); - assertThat(customerRepository.findVipCustomers()).isEmpty(); - assertThat(customerRepository.findCustomersWithSpecialNeeds()).isEmpty(); - assertThat(customerRepository.findByLocale("NonExistentLocale")).isEmpty(); - } - } + // Organisation + Organisation org = new Organisation(); + org.setOrganisationName("Complete Corp"); + customer.setOrganisation(org); - @Nested - @DisplayName("JPA Relationships") - class RelationshipsTest { + // Status + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("active"); + customer.setStatus(status); - @Test - @DisplayName("Should handle customer accounts relationship") - void shouldHandleCustomerAccountsRelationship() { - // Arrange - CustomerEntity customer = TestDataBuilders.createValidCustomer(); - customer.setCustomerName("Customer with Accounts"); + // Priority + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(5); + customer.setPriority(priority); // Act - CustomerEntity savedCustomer = customerRepository.save(customer); + CustomerEntity saved = customerRepository.save(customer); flushAndClear(); - - Optional retrieved = customerRepository.findById(savedCustomer.getId()); + Optional retrieved = customerRepository.findById(saved.getId()); // Assert assertThat(retrieved).isPresent(); - assertThat(retrieved.get().getCustomerAccounts()).isNotNull(); - // Note: In a real implementation, you'd test actual CustomerAccount relationships - } - - @Test - @DisplayName("Should handle null relationships gracefully") - void shouldHandleNullRelationshipsGracefully() { - // Arrange - CustomerEntity customer = TestDataBuilders.createValidCustomer(); - customer.setCustomerName("Customer without Relationships"); - customer.setCustomerAccounts(null); - - // Act & Assert - assertThatCode(() -> { - CustomerEntity saved = customerRepository.save(customer); - System.out.println("[DEBUG_LOG] After save - customerAccounts: " + saved.getCustomerAccounts()); - flushAndClear(); - Optional retrieved = customerRepository.findById(saved.getId()); - System.out.println("[DEBUG_LOG] After retrieve - customerAccounts: " + retrieved.get().getCustomerAccounts()); - assertThat(retrieved).isPresent(); - assertThat(retrieved.get().getCustomerAccounts()).isNotNull(); - assertThat(retrieved.get().getCustomerAccounts()).isEmpty(); - }).doesNotThrowAnyException(); + CustomerEntity result = retrieved.get(); + assertThat(result.getCustomerName()).isEqualTo("Customer with All Embedded Objects"); + assertThat(result.getKind()).isEqualTo(CustomerKind.COMMERCIAL); + assertThat(result.getSpecialNeed()).isEqualTo("Wheelchair access"); + assertThat(result.getVip()).isTrue(); + assertThat(result.getPucNumber()).isEqualTo("PUC-12345"); + assertThat(result.getLocale()).isEqualTo("en-US"); + assertThat(result.getOrganisation()).isNotNull(); + assertThat(result.getOrganisation().getOrganisationName()).isEqualTo("Complete Corp"); + assertThat(result.getStatus()).isNotNull(); + assertThat(result.getStatus().getValue()).isEqualTo("active"); + assertThat(result.getPriority()).isNotNull(); + assertThat(result.getPriority().getValue()).isEqualTo(5); } } diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerMySQLIntegrationTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerMySQLIntegrationTest.java new file mode 100644 index 00000000..ce9026b5 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerMySQLIntegrationTest.java @@ -0,0 +1,347 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.repositories.integration; + +import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; +import org.greenbuttonalliance.espi.common.domain.customer.entity.Organisation; +import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; +import org.greenbuttonalliance.espi.common.repositories.customer.CustomerRepository; +import org.greenbuttonalliance.espi.common.test.BaseTestContainersTest; +import org.greenbuttonalliance.espi.common.test.TestDataBuilders; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.DynamicPropertyRegistry; +import org.springframework.test.context.DynamicPropertySource; +import org.testcontainers.junit.jupiter.Container; + +import java.time.OffsetDateTime; +import java.util.List; +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Customer entity integration tests using MySQL TestContainer. + * + * Tests full CRUD operations and relationship persistence with a real MySQL database. + */ +@DisplayName("Customer Integration Tests - MySQL") +@ActiveProfiles({"test", "test-mysql"}) +class CustomerMySQLIntegrationTest extends BaseTestContainersTest { + + @Container + private static final org.testcontainers.containers.MySQLContainer mysql = mysqlContainer; + + static { + mysql.start(); + } + + @DynamicPropertySource + static void configureMySQLProperties(DynamicPropertyRegistry registry) { + registry.add("spring.datasource.url", mysql::getJdbcUrl); + registry.add("spring.datasource.username", mysql::getUsername); + registry.add("spring.datasource.password", mysql::getPassword); + registry.add("spring.datasource.driver-class-name", () -> "com.mysql.cj.jdbc.Driver"); + } + + @Autowired + private CustomerRepository customerRepository; + + @Nested + @DisplayName("CRUD Operations") + class CrudOperationsTest { + + @Test + @DisplayName("Should save and retrieve customer with all fields") + void shouldSaveAndRetrieveCustomerWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("MySQL Integration Test Customer"); + customer.setKind(CustomerKind.COMMERCIAL); + customer.setSpecialNeed("Wheelchair access"); + customer.setVip(true); + customer.setPucNumber("PUC-MYSQL-12345"); + customer.setLocale("en-US"); + + // Organisation + Organisation org = new Organisation(); + org.setOrganisationName("MySQL Test Corporation"); + + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("123 MySQL Street"); + streetAddress.setTownDetail("Database City"); + streetAddress.setStateOrProvince("CA"); + streetAddress.setPostalCode("94000"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("mysql@test.com"); + electronicAddress.setWeb("https://mysql.test.com"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); + + // Status + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("active"); + status.setDateTime(OffsetDateTime.now()); + status.setReason("MySQL integration test"); + customer.setStatus(status); + + // Priority + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(1); + priority.setRank(10); + priority.setType("high-priority"); + customer.setPriority(priority); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity result = retrieved.get(); + + assertThat(result.getCustomerName()).isEqualTo("MySQL Integration Test Customer"); + assertThat(result.getKind()).isEqualTo(CustomerKind.COMMERCIAL); + assertThat(result.getSpecialNeed()).isEqualTo("Wheelchair access"); + assertThat(result.getVip()).isTrue(); + assertThat(result.getPucNumber()).isEqualTo("PUC-MYSQL-12345"); + assertThat(result.getLocale()).isEqualTo("en-US"); + + assertThat(result.getOrganisation()).isNotNull(); + assertThat(result.getOrganisation().getOrganisationName()).isEqualTo("MySQL Test Corporation"); + assertThat(result.getOrganisation().getStreetAddress()).isNotNull(); + assertThat(result.getOrganisation().getStreetAddress().getStreetDetail()).isEqualTo("123 MySQL Street"); + + assertThat(result.getStatus()).isNotNull(); + assertThat(result.getStatus().getValue()).isEqualTo("active"); + + assertThat(result.getPriority()).isNotNull(); + assertThat(result.getPriority().getValue()).isEqualTo(1); + } + + @Test + @DisplayName("Should update customer fields") + void shouldUpdateCustomerFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Original Name"); + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + + // Act + savedCustomer.setCustomerName("Updated Name"); + savedCustomer.setVip(true); + CustomerEntity updatedCustomer = customerRepository.save(savedCustomer); + flushAndClear(); + + Optional retrieved = customerRepository.findById(updatedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + assertThat(retrieved.get().getCustomerName()).isEqualTo("Updated Name"); + assertThat(retrieved.get().getVip()).isTrue(); + } + + @Test + @DisplayName("Should delete customer") + void shouldDeleteCustomer() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Customer to Delete"); + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + + // Act + customerRepository.deleteById(savedCustomer.getId()); + flushAndClear(); + + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isEmpty(); + } + } + + @Nested + @DisplayName("Bulk Operations") + class BulkOperationsTest { + + @Test + @DisplayName("Should handle bulk save operations") + void shouldHandleBulkSaveOperations() { + // Arrange + List customers = TestDataBuilders.createValidEntities(5, + TestDataBuilders::createValidCustomer); + + for (int i = 0; i < customers.size(); i++) { + customers.get(i).setCustomerName("MySQL Bulk Customer " + i); + } + + // Act + List savedCustomers = customerRepository.saveAll(customers); + flushAndClear(); + + // Assert + assertThat(savedCustomers).hasSize(5); + assertThat(savedCustomers).allMatch(customer -> customer.getId() != null); + + long count = customerRepository.count(); + assertThat(count).isGreaterThanOrEqualTo(5); + } + + @Test + @DisplayName("Should handle bulk delete operations") + void shouldHandleBulkDeleteOperations() { + // Arrange + List customers = TestDataBuilders.createValidEntities(3, + TestDataBuilders::createValidCustomer); + + List savedCustomers = customerRepository.saveAll(customers); + long initialCount = customerRepository.count(); + flushAndClear(); + + // Act + customerRepository.deleteAll(savedCustomers); + flushAndClear(); + + // Assert + long finalCount = customerRepository.count(); + assertThat(finalCount).isEqualTo(initialCount - 3); + } + } + + @Nested + @DisplayName("Embedded Objects Persistence") + class EmbeddedObjectsTest { + + @Test + @DisplayName("Should persist and retrieve Organisation with all nested types") + void shouldPersistOrganisationWithAllTypes() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("MySQL Organisation Test"); + + Organisation org = new Organisation(); + org.setOrganisationName("Complete MySQL Corporation"); + + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("456 MySQL Avenue"); + streetAddress.setTownDetail("Database Town"); + streetAddress.setStateOrProvince("NY"); + streetAddress.setPostalCode("10001"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + Organisation.StreetAddress postalAddress = new Organisation.StreetAddress(); + postalAddress.setStreetDetail("PO Box 999"); + postalAddress.setTownDetail("Database Town"); + postalAddress.setStateOrProvince("NY"); + postalAddress.setPostalCode("10002"); + postalAddress.setCountry("USA"); + org.setPostalAddress(postalAddress); + + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("contact@mysql.test"); + electronicAddress.setEmail2("support@mysql.test"); + electronicAddress.setWeb("https://mysql.test"); + electronicAddress.setRadio("RADIO-123"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + Organisation retrievedOrg = retrieved.get().getOrganisation(); + assertThat(retrievedOrg).isNotNull(); + assertThat(retrievedOrg.getOrganisationName()).isEqualTo("Complete MySQL Corporation"); + assertThat(retrievedOrg.getStreetAddress().getStreetDetail()).isEqualTo("456 MySQL Avenue"); + assertThat(retrievedOrg.getPostalAddress().getStreetDetail()).isEqualTo("PO Box 999"); + assertThat(retrievedOrg.getElectronicAddress().getEmail1()).isEqualTo("contact@mysql.test"); + assertThat(retrievedOrg.getElectronicAddress().getRadio()).isEqualTo("RADIO-123"); + } + + @Test + @DisplayName("Should persist Status with all fields") + void shouldPersistStatusWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("MySQL Status Test"); + + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("suspended"); + OffsetDateTime testDateTime = OffsetDateTime.now(); + status.setDateTime(testDateTime); + status.setReason("MySQL test suspension"); + customer.setStatus(status); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity.Status retrievedStatus = retrieved.get().getStatus(); + assertThat(retrievedStatus).isNotNull(); + assertThat(retrievedStatus.getValue()).isEqualTo("suspended"); + assertThat(retrievedStatus.getDateTime()).isNotNull(); + assertThat(retrievedStatus.getReason()).isEqualTo("MySQL test suspension"); + } + + @Test + @DisplayName("Should persist Priority with all fields") + void shouldPersistPriorityWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("MySQL Priority Test"); + + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(5); + priority.setRank(50); + priority.setType("medium-priority"); + customer.setPriority(priority); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity.Priority retrievedPriority = retrieved.get().getPriority(); + assertThat(retrievedPriority).isNotNull(); + assertThat(retrievedPriority.getValue()).isEqualTo(5); + assertThat(retrievedPriority.getRank()).isEqualTo(50); + assertThat(retrievedPriority.getType()).isEqualTo("medium-priority"); + } + } +} \ No newline at end of file diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerPostgreSQLIntegrationTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerPostgreSQLIntegrationTest.java new file mode 100644 index 00000000..d3c23d30 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/repositories/integration/CustomerPostgreSQLIntegrationTest.java @@ -0,0 +1,347 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.repositories.integration; + +import org.greenbuttonalliance.espi.common.domain.customer.entity.CustomerEntity; +import org.greenbuttonalliance.espi.common.domain.customer.entity.Organisation; +import org.greenbuttonalliance.espi.common.domain.customer.enums.CustomerKind; +import org.greenbuttonalliance.espi.common.repositories.customer.CustomerRepository; +import org.greenbuttonalliance.espi.common.test.BaseTestContainersTest; +import org.greenbuttonalliance.espi.common.test.TestDataBuilders; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.DynamicPropertyRegistry; +import org.springframework.test.context.DynamicPropertySource; +import org.testcontainers.junit.jupiter.Container; + +import java.time.OffsetDateTime; +import java.util.List; +import java.util.Optional; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Customer entity integration tests using PostgreSQL TestContainer. + * + * Tests full CRUD operations and relationship persistence with a real PostgreSQL database. + */ +@DisplayName("Customer Integration Tests - PostgreSQL") +@ActiveProfiles({"test", "test-postgresql"}) +class CustomerPostgreSQLIntegrationTest extends BaseTestContainersTest { + + @Container + private static final org.testcontainers.containers.PostgreSQLContainer postgres = postgresqlContainer; + + static { + postgres.start(); + } + + @DynamicPropertySource + static void configurePostgreSQLProperties(DynamicPropertyRegistry registry) { + registry.add("spring.datasource.url", postgres::getJdbcUrl); + registry.add("spring.datasource.username", postgres::getUsername); + registry.add("spring.datasource.password", postgres::getPassword); + registry.add("spring.datasource.driver-class-name", () -> "org.postgresql.Driver"); + } + + @Autowired + private CustomerRepository customerRepository; + + @Nested + @DisplayName("CRUD Operations") + class CrudOperationsTest { + + @Test + @DisplayName("Should save and retrieve customer with all fields") + void shouldSaveAndRetrieveCustomerWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("PostgreSQL Integration Test Customer"); + customer.setKind(CustomerKind.RESIDENTIAL); + customer.setSpecialNeed("Life support equipment"); + customer.setVip(false); + customer.setPucNumber("PUC-PG-98765"); + customer.setLocale("en-GB"); + + // Organisation + Organisation org = new Organisation(); + org.setOrganisationName("PostgreSQL Test Services"); + + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("789 PostgreSQL Boulevard"); + streetAddress.setTownDetail("Postgres City"); + streetAddress.setStateOrProvince("WA"); + streetAddress.setPostalCode("98000"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("postgres@test.com"); + electronicAddress.setWeb("https://postgres.test.com"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); + + // Status + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("pending"); + status.setDateTime(OffsetDateTime.now()); + status.setReason("PostgreSQL integration test"); + customer.setStatus(status); + + // Priority + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(3); + priority.setRank(30); + priority.setType("normal-priority"); + customer.setPriority(priority); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity result = retrieved.get(); + + assertThat(result.getCustomerName()).isEqualTo("PostgreSQL Integration Test Customer"); + assertThat(result.getKind()).isEqualTo(CustomerKind.RESIDENTIAL); + assertThat(result.getSpecialNeed()).isEqualTo("Life support equipment"); + assertThat(result.getVip()).isFalse(); + assertThat(result.getPucNumber()).isEqualTo("PUC-PG-98765"); + assertThat(result.getLocale()).isEqualTo("en-GB"); + + assertThat(result.getOrganisation()).isNotNull(); + assertThat(result.getOrganisation().getOrganisationName()).isEqualTo("PostgreSQL Test Services"); + assertThat(result.getOrganisation().getStreetAddress()).isNotNull(); + assertThat(result.getOrganisation().getStreetAddress().getStreetDetail()).isEqualTo("789 PostgreSQL Boulevard"); + + assertThat(result.getStatus()).isNotNull(); + assertThat(result.getStatus().getValue()).isEqualTo("pending"); + + assertThat(result.getPriority()).isNotNull(); + assertThat(result.getPriority().getValue()).isEqualTo(3); + } + + @Test + @DisplayName("Should update customer fields") + void shouldUpdateCustomerFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("Original PostgreSQL Name"); + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + + // Act + savedCustomer.setCustomerName("Updated PostgreSQL Name"); + savedCustomer.setKind(CustomerKind.COMMERCIAL); + CustomerEntity updatedCustomer = customerRepository.save(savedCustomer); + flushAndClear(); + + Optional retrieved = customerRepository.findById(updatedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + assertThat(retrieved.get().getCustomerName()).isEqualTo("Updated PostgreSQL Name"); + assertThat(retrieved.get().getKind()).isEqualTo(CustomerKind.COMMERCIAL); + } + + @Test + @DisplayName("Should delete customer") + void shouldDeleteCustomer() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("PostgreSQL Customer to Delete"); + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + + // Act + customerRepository.deleteById(savedCustomer.getId()); + flushAndClear(); + + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isEmpty(); + } + } + + @Nested + @DisplayName("Bulk Operations") + class BulkOperationsTest { + + @Test + @DisplayName("Should handle bulk save operations") + void shouldHandleBulkSaveOperations() { + // Arrange + List customers = TestDataBuilders.createValidEntities(5, + TestDataBuilders::createValidCustomer); + + for (int i = 0; i < customers.size(); i++) { + customers.get(i).setCustomerName("PostgreSQL Bulk Customer " + i); + } + + // Act + List savedCustomers = customerRepository.saveAll(customers); + flushAndClear(); + + // Assert + assertThat(savedCustomers).hasSize(5); + assertThat(savedCustomers).allMatch(customer -> customer.getId() != null); + + long count = customerRepository.count(); + assertThat(count).isGreaterThanOrEqualTo(5); + } + + @Test + @DisplayName("Should handle bulk delete operations") + void shouldHandleBulkDeleteOperations() { + // Arrange + List customers = TestDataBuilders.createValidEntities(3, + TestDataBuilders::createValidCustomer); + + List savedCustomers = customerRepository.saveAll(customers); + long initialCount = customerRepository.count(); + flushAndClear(); + + // Act + customerRepository.deleteAll(savedCustomers); + flushAndClear(); + + // Assert + long finalCount = customerRepository.count(); + assertThat(finalCount).isEqualTo(initialCount - 3); + } + } + + @Nested + @DisplayName("Embedded Objects Persistence") + class EmbeddedObjectsTest { + + @Test + @DisplayName("Should persist and retrieve Organisation with all nested types") + void shouldPersistOrganisationWithAllTypes() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("PostgreSQL Organisation Test"); + + Organisation org = new Organisation(); + org.setOrganisationName("Complete PostgreSQL Corporation"); + + Organisation.StreetAddress streetAddress = new Organisation.StreetAddress(); + streetAddress.setStreetDetail("321 PostgreSQL Drive"); + streetAddress.setTownDetail("Postgres Town"); + streetAddress.setStateOrProvince("OR"); + streetAddress.setPostalCode("97000"); + streetAddress.setCountry("USA"); + org.setStreetAddress(streetAddress); + + Organisation.StreetAddress postalAddress = new Organisation.StreetAddress(); + postalAddress.setStreetDetail("PO Box 777"); + postalAddress.setTownDetail("Postgres Town"); + postalAddress.setStateOrProvince("OR"); + postalAddress.setPostalCode("97001"); + postalAddress.setCountry("USA"); + org.setPostalAddress(postalAddress); + + Organisation.ElectronicAddress electronicAddress = new Organisation.ElectronicAddress(); + electronicAddress.setEmail1("contact@postgres.test"); + electronicAddress.setEmail2("support@postgres.test"); + electronicAddress.setWeb("https://postgres.test"); + electronicAddress.setRadio("PG-RADIO-456"); + org.setElectronicAddress(electronicAddress); + + customer.setOrganisation(org); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + Organisation retrievedOrg = retrieved.get().getOrganisation(); + assertThat(retrievedOrg).isNotNull(); + assertThat(retrievedOrg.getOrganisationName()).isEqualTo("Complete PostgreSQL Corporation"); + assertThat(retrievedOrg.getStreetAddress().getStreetDetail()).isEqualTo("321 PostgreSQL Drive"); + assertThat(retrievedOrg.getPostalAddress().getStreetDetail()).isEqualTo("PO Box 777"); + assertThat(retrievedOrg.getElectronicAddress().getEmail1()).isEqualTo("contact@postgres.test"); + assertThat(retrievedOrg.getElectronicAddress().getRadio()).isEqualTo("PG-RADIO-456"); + } + + @Test + @DisplayName("Should persist Status with all fields") + void shouldPersistStatusWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("PostgreSQL Status Test"); + + CustomerEntity.Status status = new CustomerEntity.Status(); + status.setValue("active"); + OffsetDateTime testDateTime = OffsetDateTime.now(); + status.setDateTime(testDateTime); + status.setReason("PostgreSQL test activation"); + customer.setStatus(status); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity.Status retrievedStatus = retrieved.get().getStatus(); + assertThat(retrievedStatus).isNotNull(); + assertThat(retrievedStatus.getValue()).isEqualTo("active"); + assertThat(retrievedStatus.getDateTime()).isNotNull(); + assertThat(retrievedStatus.getReason()).isEqualTo("PostgreSQL test activation"); + } + + @Test + @DisplayName("Should persist Priority with all fields") + void shouldPersistPriorityWithAllFields() { + // Arrange + CustomerEntity customer = TestDataBuilders.createValidCustomer(); + customer.setCustomerName("PostgreSQL Priority Test"); + + CustomerEntity.Priority priority = new CustomerEntity.Priority(); + priority.setValue(2); + priority.setRank(20); + priority.setType("high-priority"); + customer.setPriority(priority); + + // Act + CustomerEntity savedCustomer = customerRepository.save(customer); + flushAndClear(); + Optional retrieved = customerRepository.findById(savedCustomer.getId()); + + // Assert + assertThat(retrieved).isPresent(); + CustomerEntity.Priority retrievedPriority = retrieved.get().getPriority(); + assertThat(retrievedPriority).isNotNull(); + assertThat(retrievedPriority.getValue()).isEqualTo(2); + assertThat(retrievedPriority.getRank()).isEqualTo(20); + assertThat(retrievedPriority.getType()).isEqualTo("high-priority"); + } + } +} diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportServiceTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportServiceTest.java new file mode 100644 index 00000000..fb9a2ae9 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/CustomerExportServiceTest.java @@ -0,0 +1,233 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service.impl; + +import org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.customer.CustomerDto; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayOutputStream; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for CustomerExportService namespace handling. + *

+ * Verifies that customer domain exports: + * - Declare ONLY Atom and Customer namespaces (NO usage namespace) + * - Use Atom as default namespace (no prefix on entry, id, title) + * - Use cust: prefix for customer domain elements + */ +@DisplayName("CustomerExportService Namespace Tests") +class CustomerExportServiceTest { + + private CustomerExportService customerExportService; + + @BeforeEach + void setUp() { + customerExportService = new CustomerExportService(); + // Manually initialize since we're not using Spring context + customerExportService.init(); + } + + @Test + @DisplayName("Should declare ONLY customer namespace (NOT usage namespace)") + void shouldDeclareCustomerNamespaceOnly() { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440001", // uuid + null, // organisation + null, // kind + "Wheelchair access required", // specialNeed + true, // vip + null, // pucNumber + null, // status + null, // priority + null, // locale + "John Doe" // customerName + ); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440002", + "Customer Test", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Debug output + System.out.println("\n========== Customer Domain XML Output =========="); + System.out.println(xml); + System.out.println("===============================================\n"); + + // Assert - Customer namespace PRESENT + assertThat(xml) + .as("XML should declare customer namespace") + .contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + + // Assert - Usage namespace ABSENT + assertThat(xml) + .as("XML should NOT declare usage namespace") + .doesNotContain("xmlns:espi=\"http://naesb.org/espi\"") + .doesNotContain("xmlns:espi"); // Ensure no espi prefix at all + + // Assert - Atom namespace is declared with atom prefix + assertThat(xml) + .as("XML should declare Atom namespace with atom prefix") + .contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + + // Assert - Customer content with cust prefix + assertThat(xml) + .as("Customer should use cust prefix") + .contains("urn:uuid:550e8400-e29b-51d4-a716-446655440004"); + + assertThat(xml) + .as("title element should have atom prefix") + .contains("Atom Prefix Test"); + + // Assert - NO ns3/ns5 generic prefixes on Atom elements + assertThat(xml) + .as("Should NOT have ns3 or ns5 generic prefixes") + .doesNotContain("ns3:id") + .doesNotContain("ns3:title") + .doesNotContain("ns5:id") + .doesNotContain("ns5:title") + .doesNotContain("ns3:entry") + .doesNotContain("ns5:entry"); + } + + @Test + @DisplayName("Should use cust prefix for Customer elements") + void shouldUseCustPrefixForCustomer() { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440005", // uuid + null, // organisation + null, // kind + null, // specialNeed + null, // vip + "PUC-12345", // pucNumber + null, // status + null, // priority + null, // locale + "Test Customer" // customerName + ); + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440006", + "CUST Prefix Test", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Assert + assertThat(xml).contains(""); + assertThat(xml).contains(""); + } + + @Test + @DisplayName("Should produce valid ESPI XML structure") + void shouldProduceValidEspiXmlStructure() { + // Arrange + CustomerDto customer = new CustomerDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440007", // uuid + null, // organisation + null, // kind + "Hearing impaired", // specialNeed + true, // vip + "PUC-999", // pucNumber + null, // status + null, // priority + "en-US", // locale + "Debug Customer" // customerName + ); + + CustomerAtomEntryDto entry = new CustomerAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440008", + "Residential Customer - Customer Domain", + customer + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + customerExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Debug output + System.out.println("\n========== Complete Customer Domain XML =========="); + System.out.println(xml); + System.out.println("==================================================\n"); + + // Assert comprehensive structure + assertThat(xml).contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + assertThat(xml).contains("xmlns:cust=\"http://naesb.org/espi/customer\""); + assertThat(xml).doesNotContain("xmlns:espi"); // No usage namespace pollution + assertThat(xml).doesNotContain("ns3:"); // No generic prefixes + assertThat(xml).doesNotContain("ns5:"); // No generic prefixes + assertThat(xml).contains(""); // Customer elements use cust prefix + assertThat(xml).contains("urn:uuid:550e8400-e29b-51d4-a716-446655440008"); + assertThat(xml).contains("Residential Customer - Customer Domain"); + } +} diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImplTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImplTest.java deleted file mode 100644 index 1abcb479..00000000 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImplTest.java +++ /dev/null @@ -1,478 +0,0 @@ -package org.greenbuttonalliance.espi.common.service.impl; - -import org.greenbuttonalliance.espi.common.domain.common.LinkType; -import org.greenbuttonalliance.espi.common.domain.common.ServiceCategory; -import org.greenbuttonalliance.espi.common.domain.usage.UsagePointEntity; -import org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto; -import org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto; -import org.greenbuttonalliance.espi.common.dto.atom.LinkDto; -import org.greenbuttonalliance.espi.common.dto.BillingChargeSourceDto; -import org.greenbuttonalliance.espi.common.dto.SummaryMeasurementDto; -import org.greenbuttonalliance.espi.common.dto.usage.*; -import org.greenbuttonalliance.espi.common.mapper.usage.*; -import org.greenbuttonalliance.espi.common.repositories.usage.UsagePointRepository; -import org.jspecify.annotations.NonNull; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Test; -import org.springframework.test.util.ReflectionTestUtils; - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.OutputStream; -import java.nio.charset.StandardCharsets; -import java.time.LocalDateTime; -import java.time.OffsetDateTime; -import java.time.ZoneOffset; -import java.time.temporal.ChronoUnit; -import java.util.ArrayList; -import java.util.List; -import java.util.UUID; - -import static org.assertj.core.api.Assertions.assertThat; - - -class DtoExportServiceImplTest { - - private UsagePointRepository usagePointRepository; - - private UsagePointMapper usagePointMapper = new UsagePointMapperImpl(); - - private MeterReadingMapper meterReadingMapper = new MeterReadingMapperImpl(); - private DtoExportServiceImpl dtoExportService; - - @BeforeEach - void setUp() { - // UsagePointMapper only needs serviceDeliveryPointMapper (no date fields after IdentifiedObject removal) - ReflectionTestUtils.setField(usagePointMapper, "serviceDeliveryPointMapper", new ServiceDeliveryPointMapperImpl()); - - // Create EspiIdGeneratorService for UUID5 generation - org.greenbuttonalliance.espi.common.service.EspiIdGeneratorService espiIdGeneratorService = - new org.greenbuttonalliance.espi.common.service.EspiIdGeneratorService(); - - dtoExportService = new DtoExportServiceImpl(usagePointRepository, usagePointMapper, espiIdGeneratorService); - } - - @Test - @DisplayName("Should export Atom feed with valid XML structure and metadata") - void shouldExportAtomFeedWithValidXmlStructure() throws IOException { - // Arrange - LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); - OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - - AtomEntryDto usagePointEntryDto = getUsagePointEntry(now); - AtomEntryDto meterReadingEntryDto = getMeeterReadingEntryDto(now); - AtomEntryDto readingEntry = getReadingEntryDto(now); - AtomEntryDto intervalBlockEntry = getIntervlBlockEntryDto(now); - AtomEntryDto timeConfigEntry = getTimeConfigurationEntry(now); - AtomEntryDto usageSummaryEntry = getUsageSummaryEntry(now); - AtomEntryDto epqsEntry = getElectricPowerQualitySummaryEntry(now); - - AtomFeedDto atomFeedDto = new AtomFeedDto("urn:uuid:15B0A4ED-CCF4-5521-A0A1-9FF650EC8A6B", - "Green Button Subscription Feed", - now, now, null, - List.of(usagePointEntryDto, meterReadingEntryDto, readingEntry, intervalBlockEntry, - timeConfigEntry, usageSummaryEntry, epqsEntry)); - - // Act - ByteArrayOutputStream stream = new ByteArrayOutputStream(); - dtoExportService.exportAtomFeed(atomFeedDto, stream); - String xml = stream.toString(StandardCharsets.UTF_8); - - // Print for debugging (can be removed later) - System.out.println(xml); - - // Assert - XML Declaration - assertThat(xml).startsWith(""); - - // Assert - Root element - assertThat(xml).contains(""); - - // Assert - Feed metadata (using Version-5 UUID) - assertThat(xml).contains("urn:uuid:15B0A4ED-CCF4-5521-A0A1-9FF650EC8A6B"); - assertThat(xml).contains("Green Button Subscription Feed"); - assertThat(xml).contains(""); - assertThat(xml).contains(""); - - // Assert - Entry structure (may have namespace attributes) - assertThat(xml).contains(""); - - // Assert - ESPI namespace in content (URL and prefix usage) - assertThat(xml).contains("http://naesb.org/espi"); // Namespace URL present - assertThat(xml).contains("espi:"); // ESPI namespace prefix used - assertThat(xml).contains(""); - assertThat(xml).contains(""); - - // Assert - All 7 entries present - assertThat(xml).contains("Front Electric Meter"); // UsagePoint title - assertThat(xml).contains("Meter Reading"); // MeterReading title - assertThat(xml).contains("Type of Meter Reading Data"); // ReadingType title - assertThat(xml).contains("Interval Block"); // IntervalBlock title - assertThat(xml).contains("EST Time Configuration"); // TimeConfiguration title - assertThat(xml).contains("Monthly Usage Summary"); // UsageSummary title - assertThat(xml).contains("Power Quality Summary"); // ElectricPowerQualitySummary title - - // Assert - UsageSummary fields with populated data - assertThat(xml).contains("urn:uuid:[0-9a-fA-F-]{36}"); // UUID format - assertThat(xml).contains(""); // Should have title element - assertThat(xml).contains("<published>"); // ISO 8601 timestamp - assertThat(xml).contains("<updated>"); // ISO 8601 timestamp - - // Assert - Timestamps are ISO 8601 format - assertThat(xml).containsPattern("<published>\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}"); - assertThat(xml).containsPattern("<updated>\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}"); - } - - @Test - @DisplayName("Should export ESPI UsagePoint content correctly") - void shouldExportEspiUsagePointContent() throws IOException { - // Arrange - LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); - OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - - AtomEntryDto usagePointEntry = getUsagePointEntry(now); - AtomFeedDto atomFeedDto = new AtomFeedDto( - "urn:uuid:test-feed", "Test Feed", now, now, null, - List.of(usagePointEntry) - ); - - // Act - ByteArrayOutputStream stream = new ByteArrayOutputStream(); - dtoExportService.exportAtomFeed(atomFeedDto, stream); - String xml = stream.toString(StandardCharsets.UTF_8); - - // Assert - ESPI namespace (URL and prefix usage) - assertThat(xml).contains("http://naesb.org/espi"); // Namespace URL present - assertThat(xml).contains("espi:"); // ESPI namespace prefix used - - // Assert - UsagePoint element with namespace prefix - assertThat(xml).contains("<espi:UsagePoint"); // Opening tag (may have attributes) - assertThat(xml).contains("</espi:UsagePoint>"); - - // Assert - ServiceCategory field - assertThat(xml).contains("ServiceCategory"); - assertThat(xml).contains("ELECTRICITY"); - } - - @Test - @DisplayName("Should use Version-5 UUIDs in test data") - void shouldUseVersion5UuidsInTestData() throws IOException { - // Arrange - LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); - OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - - AtomEntryDto usagePointEntry = getUsagePointEntry(now); - AtomEntryDto readingEntry = getReadingEntryDto(now); - AtomEntryDto intervalBlockEntry = getIntervlBlockEntryDto(now); - - AtomFeedDto atomFeedDto = new AtomFeedDto( - "urn:uuid:15B0A4ED-CCF4-5521-A0A1-9FF650EC8A6B", // Version-5 - "Test Feed", now, now, null, - List.of(usagePointEntry, readingEntry, intervalBlockEntry) - ); - - // Act - ByteArrayOutputStream stream = new ByteArrayOutputStream(); - dtoExportService.exportAtomFeed(atomFeedDto, stream); - String xml = stream.toString(StandardCharsets.UTF_8); - - // Assert - Feed ID uses Version-5 UUID (note '5' in version field) - assertThat(xml).contains("<id>urn:uuid:15B0A4ED-CCF4-5521-A0A1-9FF650EC8A6B</id>"); - - // Assert - Entry IDs use Version-5 UUIDs - assertThat(xml).contains("urn:uuid:48C2A019-5598-5E16-B0F9-49E4FF27F5FB"); // UsagePoint - assertThat(xml).contains("urn:uuid:3430B025-65D5-593A-BEC2-053603C91CD7"); // ReadingType - assertThat(xml).contains("urn:uuid:FE9A61BB-6913-52D4-88BE-9634A218EF53"); // IntervalBlock - - // Assert - Version field should be '5' (3rd group, 1st char) - // Format: xxxxxxxx-xxxx-5xxx-xxxx-xxxxxxxxxxxx - assertThat(xml).containsPattern("urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-5[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"); - } - - @Test - @DisplayName("Should export ESPI ReadingType content correctly") - void shouldExportEspiReadingTypeContent() throws IOException { - // Arrange - LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); - OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - - AtomEntryDto readingEntry = getReadingEntryDto(now); - AtomFeedDto atomFeedDto = new AtomFeedDto( - "urn:uuid:test-feed", "Test Feed", now, now, null, - List.of(readingEntry) - ); - - // Act - ByteArrayOutputStream stream = new ByteArrayOutputStream(); - dtoExportService.exportAtomFeed(atomFeedDto, stream); - String xml = stream.toString(StandardCharsets.UTF_8); - - // Assert - ReadingType element (may have attributes) - assertThat(xml).contains("<espi:ReadingType"); - assertThat(xml).contains("</espi:ReadingType>"); - - // Assert - ReadingType fields - assertThat(xml).contains("<accumulationBehaviour"); - assertThat(xml).contains("<commodity"); - assertThat(xml).contains("<dataQualifier"); - assertThat(xml).contains("<flowDirection"); - assertThat(xml).contains("<intervalLength"); - } - - @Test - @DisplayName("Should export ESPI IntervalBlock content correctly") - void shouldExportEspiIntervalBlockContent() throws IOException { - // Arrange - LocalDateTime localDateTime = LocalDateTime.now().truncatedTo(ChronoUnit.SECONDS); - OffsetDateTime now = localDateTime.atOffset(ZoneOffset.UTC).toZonedDateTime().toOffsetDateTime(); - - AtomEntryDto intervalBlockEntry = getIntervlBlockEntryDto(now); - AtomFeedDto atomFeedDto = new AtomFeedDto( - "urn:uuid:test-feed", "Test Feed", now, now, null, - List.of(intervalBlockEntry) - ); - - // Act - ByteArrayOutputStream stream = new ByteArrayOutputStream(); - dtoExportService.exportAtomFeed(atomFeedDto, stream); - String xml = stream.toString(StandardCharsets.UTF_8); - - // Assert - IntervalBlock element (with ESPI namespace prefix) - assertThat(xml).contains("IntervalBlock"); // IntervalBlock element present - assertThat(xml).contains("espi:IntervalBlock>"); // With namespace prefix - - // Assert - IntervalBlock interval - assertThat(xml).contains("<interval"); - assertThat(xml).contains("<start>"); - assertThat(xml).contains("<duration>"); - - // Assert - IntervalReading elements - assertThat(xml).contains("<IntervalReading"); - assertThat(xml).contains("<cost>"); - assertThat(xml).contains("<value>"); - assertThat(xml).contains("<timePeriod>"); - - // Assert - Multiple readings present (4 readings in test data) - int readingCount = xml.split("<IntervalReading").length - 1; - assertThat(readingCount).isEqualTo(4); - } - - private static @NonNull AtomEntryDto getIntervlBlockEntryDto(OffsetDateTime now) { - List<IntervalReadingDto> intervalReadings = new ArrayList<>(); - // New constructor: cost, readingQualities, timePeriod, value, consumptionTier, tou, cpp - intervalReadings.add(new IntervalReadingDto(974L, new ArrayList<>(List.of(new ReadingQualityDto("8"))), new DateTimeIntervalDto(1330578000L, 900L), 282L, null, null, null)); - - intervalReadings.add(new IntervalReadingDto(965L, new ArrayList<>(List.of(new ReadingQualityDto("7"))), new DateTimeIntervalDto(1330578900L, 900L), 323L, null, null, null)); - - // Using convenience constructor: value, cost, timePeriod - intervalReadings.add(new IntervalReadingDto(294L, 884L, new DateTimeIntervalDto(1330579800L, 900L))); - intervalReadings.add(new IntervalReadingDto(331L, 995L, new DateTimeIntervalDto(1330580700L, 900L))); - - IntervalBlockDto intervalBlockDto = new IntervalBlockDto("urn:uuid:FE9A61BB-6913-52D4-88BE-9634A218EF53", - new DateTimeIntervalDto(1330578000L, 86400L), intervalReadings); - - List<LinkDto> intervalBlockLinks = new ArrayList<>(); - intervalBlockLinks.add(new LinkDto("self", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading/01/IntervalBlock/173")); - intervalBlockLinks.add(new LinkDto("up", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading/01/IntervalBlock")); - - return new AtomEntryDto("urn:uuid:FE9A61BB-6913-52D4-88BE-9634A218EF53", "Interval Block", now, now, - intervalBlockLinks, intervalBlockDto); - } - - private static @NonNull AtomEntryDto getReadingEntryDto(OffsetDateTime now) { - ReadingTypeDto readingTypeDto = new ReadingTypeDto(1L, "urn:uuid:3430B025-65D5-593A-BEC2-053603C91CD7", - null, "4", "1", null, "840", "12", "NET", "TOTAL", 900L, "NET", "KILO", "DAILY", "V", "1", "CONTINUOUS", "1", null, - null, null); - - List<LinkDto> readingTypeLinkList = new ArrayList<>(); - readingTypeLinkList.add(new LinkDto("self", "/espi/1_1/resource/ReadingType/07")); - readingTypeLinkList.add(new LinkDto("up", "/espi/1_1/resource/ReadingType")); - - return new AtomEntryDto("urn:uuid:3430B025-65D5-593A-BEC2-053603C91CD7", "Type of Meter Reading Data", now, now, - readingTypeLinkList, readingTypeDto); - } - - private static @NonNull AtomEntryDto getMeeterReadingEntryDto(OffsetDateTime now) { - MeterReadingDto meterReadingDto = new MeterReadingDto(); - - List<LinkDto> meterReadingLinkList = new ArrayList<>(); - meterReadingLinkList.add(new LinkDto("self", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading/01")); - meterReadingLinkList.add(new LinkDto("up", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading")); - - return new AtomEntryDto("urn:uuid:01", "Meter Reading", now, now, meterReadingLinkList, meterReadingDto); - } - - AtomEntryDto getUsagePointEntry(OffsetDateTime now) { - - UsagePointEntity usagePointEntity = new UsagePointEntity(); - usagePointEntity.setId(UUID.fromString("48C2A019-5598-5E16-B0F9-49E4FF27F5FB")); - usagePointEntity.setSelfLink(new LinkType("self", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F")); - usagePointEntity.setUpLink(new LinkType("up", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint")); - List<LinkType> relatedLinks = new ArrayList<>(); - relatedLinks.add(new LinkType("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading" )); - relatedLinks.add(new LinkType("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerUsageSummary" )); - relatedLinks.add(new LinkType("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerQualitySummary" )); - relatedLinks.add(new LinkType("related","/espi/1_1/resource/LocalTimeParameters/01" )); - usagePointEntity.setRelatedLinks(relatedLinks); - - usagePointEntity.setServiceCategory(ServiceCategory.ELECTRICITY); - - List<LinkDto> usagePointList = new ArrayList<>(); - - usagePointList.add(new LinkDto("self","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F" )); - usagePointList.add(new LinkDto("up","\"/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint" )); - usagePointList.add(new LinkDto("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F" )); - usagePointList.add(new LinkDto("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/MeterReading" )); - usagePointList.add(new LinkDto("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerUsageSummary" )); - usagePointList.add(new LinkDto("related","/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerQualitySummary" )); - usagePointList.add(new LinkDto("related","/espi/1_1/resource/LocalTimeParameters/01" )); - - UsagePointDto usagePointDto = usagePointMapper.toDto(usagePointEntity); - - return new AtomEntryDto("urn:uuid:48C2A019-5598-5E16-B0F9-49E4FF27F5FB", "Front Electric Meter", - now, - now, - usagePointList, - usagePointDto); - } - - private static @NonNull AtomEntryDto getTimeConfigurationEntry(OffsetDateTime now) { - // TimeConfigurationDto full constructor: id, uuid, dstEndRule, dstOffset, dstStartRule, tzOffset - TimeConfigurationDto timeConfigDto = new TimeConfigurationDto( - null, // id (ignored - handled by Atom layer) - null, // uuid (handled by Atom layer) - null, // dstEndRule (byte[]) - 3600L, // dstOffset (1 hour DST in seconds) - null, // dstStartRule (byte[]) - -18000L // tzOffset (-5 hours in seconds = EST) - ); - - List<LinkDto> links = new ArrayList<>(); - links.add(new LinkDto("self", "/espi/1_1/resource/LocalTimeParameters/01")); - links.add(new LinkDto("up", "/espi/1_1/resource/LocalTimeParameters")); - - return new AtomEntryDto("urn:uuid:2A0B8C3D-4E5F-5678-90AB-CDEF12345678", "EST Time Configuration", - now, now, links, timeConfigDto); - } - - private static @NonNull AtomEntryDto getUsageSummaryEntry(OffsetDateTime now) { - // Canonical constructor: id, uuid, + 24 XSD fields with comprehensive test data - UsageSummaryDto usageSummaryDto = new UsageSummaryDto( - null, // id - null, // uuid - new DateTimeIntervalDto(1330578000L, 2592000L), // billingPeriod (30 days) - 150000L, // billLastPeriod ($1500.00 in cents) - 175000L, // billToDate ($1750.00 in cents) - 25000L, // costAdditionalLastPeriod ($250.00 additional charges) - List.of(new LineItemDto(15000L, 0L, 1332392400L, "Demand Charge", null, 2, null, null), - new LineItemDto(10000L, 0L, 1332392400L, "Service Fee", null, 3, null, null)), - "USD", // currency - new SummaryMeasurementDto("3", 1330578000L, "72", 450000L, null), // overallConsumptionLastPeriod (450 kWh) - new SummaryMeasurementDto("3", 1333256400L, "72", 425000L, null), // currentBillingPeriodOverAllConsumption (425 kWh) - new SummaryMeasurementDto("3", 1330491600L, "72", 390000L, null), // currentDayLastYearNetConsumption (390 kWh) - new SummaryMeasurementDto("3", 1333256400L, "72", 15000L, null), // currentDayNetConsumption (15 kWh) - new SummaryMeasurementDto("3", 1333256400L, "72", 16000L, null), // currentDayOverallConsumption (16 kWh) - new SummaryMeasurementDto("38", 1332392400L, "72", 5000L, null), // peakDemand (5 kW) - new SummaryMeasurementDto("3", 1330405200L, "72", 385000L, null), // previousDayLastYearOverallConsumption (385 kWh) - new SummaryMeasurementDto("3", 1333170000L, "72", 14500L, null), // previousDayNetConsumption (14.5 kWh) - new SummaryMeasurementDto("3", 1333170000L, "72", 15500L, null), // previousDayOverallConsumption (15.5 kWh) - "14", // qualityOfReading (VALID) - new SummaryMeasurementDto("38", 1331182800L, "72", 4800L, null), // ratchetDemand (4.8 kW) - new DateTimeIntervalDto(1328000000L, 31536000L), // ratchetDemandPeriod (1 year) - 1333256400L, // statusTimeStamp - 1, // commodity (ELECTRICITY_SECONDARY_METERED) - "TOU-Residential", // tariffProfile - "15", // readCycle (15th of month) - new TariffRiderRefsDto(List.of( - new TariffRiderRefDto("Green-Energy-Rider", "ENROLLED", 1328000000L), - new TariffRiderRefDto("Demand-Response-Credit", "ENROLLED", 1328000000L))), - new BillingChargeSourceDto("MEASURED") // billingChargeSource - ); - - List<LinkDto> links = new ArrayList<>(); - links.add(new LinkDto("self", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/UsageSummary/01")); - links.add(new LinkDto("up", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/UsageSummary")); - - return new AtomEntryDto("urn:uuid:3B1C9D4E-5F6A-5789-01BC-DEF234567890", "Monthly Usage Summary", - now, now, links, usageSummaryDto); - } - - private static @NonNull AtomEntryDto getElectricPowerQualitySummaryEntry(OffsetDateTime now) { - // Canonical constructor: id, uuid, + 14 XSD fields, usagePointId = 17 parameters with comprehensive test data - ElectricPowerQualitySummaryDto epqsDto = new ElectricPowerQualitySummaryDto( - null, // id - null, // uuid - 850L, // flickerPlt (0.85 long-term flicker severity) - 720L, // flickerPst (0.72 short-term flicker severity) - 320L, // harmonicVoltage (3.20% THD) - 2L, // longInterruptions (2 long interruptions) - 120000L, // mainsVoltage (120.000 V in millivolts) - (short) 4, // measurementProtocol (IEC 61000-4-30) - 60000L, // powerFrequency (60.000 Hz in millihertz) - 5L, // rapidVoltageChanges (5 rapid voltage changes) - 3L, // shortInterruptions (3 short interruptions) - new DateTimeIntervalDto(1330578000L, 86400L), // summaryInterval (1 day) - 8L, // supplyVoltageDips (8 voltage dips) - 150L, // supplyVoltageImbalance (1.50% imbalance) - 250L, // supplyVoltageVariations (2.50% voltage variation) - 1L, // tempOvervoltage (1 temporary overvoltage event) - null // usagePointId - ); - - List<LinkDto> links = new ArrayList<>(); - links.add(new LinkDto("self", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerQualitySummary/01")); - links.add(new LinkDto("up", "/espi/1_1/resource/RetailCustomer/9B6C7066/UsagePoint/5446AF3F/ElectricPowerQualitySummary")); - - return new AtomEntryDto("urn:uuid:4C2D0E5F-6A7B-5890-12CD-EF3456789012", "Power Quality Summary", - now, now, links, epqsDto); - } -} \ No newline at end of file diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportServiceTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportServiceTest.java new file mode 100644 index 00000000..79a98797 --- /dev/null +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/service/impl/UsageExportServiceTest.java @@ -0,0 +1,228 @@ +/* + * + * Copyright (c) 2025 Green Button Alliance, Inc. + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.greenbuttonalliance.espi.common.service.impl; + +import org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto; +import org.greenbuttonalliance.espi.common.dto.usage.UsagePointDto; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayOutputStream; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for UsageExportService namespace handling. + * <p> + * Verifies that usage domain exports: + * - Declare ONLY Atom and ESPI namespaces (NO customer namespace) + * - Use Atom as default namespace (no prefix on entry, id, title) + * - Use espi: prefix for usage domain elements + */ +@DisplayName("UsageExportService Namespace Tests") +class UsageExportServiceTest { + + private UsageExportService usageExportService; + + @BeforeEach + void setUp() { + usageExportService = new UsageExportService(); + // Manually initialize since we're not using Spring context + usageExportService.init(); + } + + @Test + @DisplayName("Should declare ONLY espi namespace (NOT customer namespace)") + void shouldDeclareEspiNamespaceOnly() { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440010", + new byte[]{0x01}, + null, (short) 1, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + UsageAtomEntryDto entry = new UsageAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440011", + "Usage Test", + usagePoint + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + usageExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Debug output + System.out.println("\n========== Usage Domain XML Output =========="); + System.out.println(xml); + System.out.println("=============================================\n"); + + // Assert - ESPI namespace PRESENT + assertThat(xml) + .as("XML should declare espi namespace") + .contains("xmlns:espi=\"http://naesb.org/espi\""); + + // Assert - Customer namespace ABSENT + assertThat(xml) + .as("XML should NOT declare customer namespace") + .doesNotContain("xmlns:cust") + .doesNotContain("http://naesb.org/espi/customer"); + + // Assert - Atom namespace is declared with atom prefix + assertThat(xml) + .as("XML should declare Atom namespace with atom prefix") + .contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + + // Assert - Usage content with espi prefix + assertThat(xml) + .as("UsagePoint should use espi prefix") + .contains("<espi:UsagePoint"); + } + + @Test + @DisplayName("Should use atom prefix for Atom elements") + void shouldUseAtomPrefixForAtomElements() { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440012", + new byte[]{0x02}, + null, (short) 1, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + UsageAtomEntryDto entry = new UsageAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440013", + "Atom Prefix Test", + usagePoint + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + usageExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Assert - Atom elements WITH atom: prefix + assertThat(xml) + .as("entry element should have atom prefix") + .contains("<atom:entry"); + + assertThat(xml) + .as("id element should have atom prefix") + .contains("<atom:id>urn:uuid:550e8400-e29b-51d4-a716-446655440013</atom:id>"); + + assertThat(xml) + .as("title element should have atom prefix") + .contains("<atom:title>Atom Prefix Test</atom:title>"); + + // Assert - NO ns3/ns5 generic prefixes on Atom elements + assertThat(xml) + .as("Should NOT have ns3 or ns5 generic prefixes") + .doesNotContain("ns3:id") + .doesNotContain("ns3:title") + .doesNotContain("ns5:id") + .doesNotContain("ns5:title") + .doesNotContain("ns3:entry") + .doesNotContain("ns5:entry"); + } + + @Test + @DisplayName("Should use espi prefix for UsagePoint elements") + void shouldUseEspiPrefixForUsagePoint() { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440014", + new byte[]{0x03}, + null, (short) 1, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + UsageAtomEntryDto entry = new UsageAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440015", + "ESPI Prefix Test", + usagePoint + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + usageExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Assert + assertThat(xml).contains("<espi:UsagePoint>"); + assertThat(xml).contains("<espi:roleFlags>"); + assertThat(xml).contains("<espi:status>"); + assertThat(xml).contains("</espi:UsagePoint>"); + } + + @Test + @DisplayName("Should produce valid ESPI XML structure") + void shouldProduceValidEspiXmlStructure() { + // Arrange + UsagePointDto usagePoint = new UsagePointDto( + "urn:uuid:debug-usage", + new byte[]{0x01, 0x02}, // roleFlags + null, // serviceCategory + (short) 1, // status + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null, + null, null, null, null, + null, null, null, null, null + ); + + UsageAtomEntryDto entry = new UsageAtomEntryDto( + "urn:uuid:550e8400-e29b-51d4-a716-446655440000", + "Residential Electric Service - Usage Domain", + usagePoint + ); + + // Act + ByteArrayOutputStream stream = new ByteArrayOutputStream(); + usageExportService.exportDto(entry, stream); + String xml = stream.toString(); + + // Debug output + System.out.println("\n========== Complete Usage Domain XML =========="); + System.out.println(xml); + System.out.println("===============================================\n"); + + // Assert comprehensive structure + assertThat(xml).contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); + assertThat(xml).contains("xmlns:espi=\"http://naesb.org/espi\""); + assertThat(xml).doesNotContain("xmlns:cust"); // No customer namespace pollution + assertThat(xml).doesNotContain("ns3:"); // No generic prefixes + assertThat(xml).doesNotContain("ns5:"); // No generic prefixes + assertThat(xml).contains("<atom:entry"); // Atom elements use atom prefix + assertThat(xml).contains("<espi:UsagePoint>"); // Usage elements use espi prefix + assertThat(xml).contains("urn:uuid:550e8400-e29b-51d4-a716-446655440000"); + assertThat(xml).contains("Residential Electric Service - Usage Domain"); + } +} \ No newline at end of file diff --git a/openespi-datacustodian/src/main/java/org/greenbuttonalliance/espi/datacustodian/config/WebConfiguration.java b/openespi-datacustodian/src/main/java/org/greenbuttonalliance/espi/datacustodian/config/WebConfiguration.java index 47a86bfd..224a8438 100644 --- a/openespi-datacustodian/src/main/java/org/greenbuttonalliance/espi/datacustodian/config/WebConfiguration.java +++ b/openespi-datacustodian/src/main/java/org/greenbuttonalliance/espi/datacustodian/config/WebConfiguration.java @@ -100,19 +100,20 @@ public void configureContentNegotiation(ContentNegotiationConfigurer configurer) @Bean public Jaxb2Marshaller jaxb2Marshaller() { Jaxb2Marshaller marshaller = new Jaxb2Marshaller(); - + // Set context path for ESPI domain objects marshaller.setPackagesToScan( "org.greenbuttonalliance.espi.common.domain", - "org.greenbuttonalliance.espi.common.models.atom" + "org.greenbuttonalliance.espi.common.dto" ); - - // Configure marshaller properties + + // Configure marshaller properties including the NamespacePrefixMapper marshaller.setMarshallerProperties(java.util.Map.of( - Marshaller.JAXB_FORMATTED_OUTPUT, xmlPrettyPrint, - Marshaller.JAXB_ENCODING, "UTF-8" + Marshaller.JAXB_FORMATTED_OUTPUT, true, + Marshaller.JAXB_ENCODING, "UTF-8", + "org.glassfish.jaxb.namespacePrefixMapper", new org.greenbuttonalliance.espi.common.utils.EspiNamespacePrefixMapper() )); - + return marshaller; } From 18d4b6ddb3931e92e1844d33f28150b0ac2cf841 Mon Sep 17 00:00:00 2001 From: "Donald F. Coffin" <dcoffin@greenbuttonalliance.org> Date: Thu, 22 Jan 2026 15:53:49 -0500 Subject: [PATCH 2/2] fix: Resolve CI/CD failures in PR #90 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix compilation and test failures caused by record-to-class conversion. Changes: - Fix UsagePointRESTRepositoryImpl: feedDto.entries() → feedDto.getEntries() - Fix DtoExportServiceImpl: Add UsageAtomEntryDto and CustomerAtomEntryDto to JAXBContext - Fix CustomerDtoTest: Update assertion for prefixed namespace format Issue: Record accessor methods (entries()) were converted to JavaBean getters (getEntries()) when DTOs were converted from records to classes for JAXB compatibility. JAXBContext was missing domain-specific entry classes that contain @XmlElements annotations, preventing proper marshalling of Customer content. Test Results: All 609 openespi-common tests passing, all 47 openespi-thirdparty tests passing Fixes CI/CD checks for PR #90 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> --- .../espi/common/service/impl/DtoExportServiceImpl.java | 2 ++ .../espi/common/dto/customer/CustomerDtoTest.java | 3 ++- .../repository/impl/UsagePointRESTRepositoryImpl.java | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java index 9b10225b..c62af189 100644 --- a/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java +++ b/openespi-common/src/main/java/org/greenbuttonalliance/espi/common/service/impl/DtoExportServiceImpl.java @@ -226,6 +226,8 @@ private Marshaller createMarshaller(Class<?> dtoClass, Set<String> requiredNames // Atom protocol classes org.greenbuttonalliance.espi.common.dto.atom.AtomFeedDto.class, org.greenbuttonalliance.espi.common.dto.atom.AtomEntryDto.class, + org.greenbuttonalliance.espi.common.dto.atom.UsageAtomEntryDto.class, + org.greenbuttonalliance.espi.common.dto.atom.CustomerAtomEntryDto.class, org.greenbuttonalliance.espi.common.dto.atom.LinkDto.class, // Usage domain classes (http://naesb.org/espi) diff --git a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java index 5b20a8ba..2a41d7c0 100644 --- a/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java +++ b/openespi-common/src/test/java/org/greenbuttonalliance/espi/common/dto/customer/CustomerDtoTest.java @@ -87,7 +87,8 @@ void shouldExportCustomerWithRealisticData() throws IOException { // Assert - Basic structure assertThat(xml).startsWith("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"); - assertThat(xml).contains("<feed xmlns=\"http://www.w3.org/2005/Atom\">"); + assertThat(xml).contains("<atom:feed"); + assertThat(xml).contains("xmlns:atom=\"http://www.w3.org/2005/Atom\""); // Assert - Customer namespace (cust: prefix for customer.xsd) assertThat(xml).contains("http://naesb.org/espi/customer"); diff --git a/openespi-thirdparty/src/main/java/org/greenbuttonalliance/espi/thirdparty/repository/impl/UsagePointRESTRepositoryImpl.java b/openespi-thirdparty/src/main/java/org/greenbuttonalliance/espi/thirdparty/repository/impl/UsagePointRESTRepositoryImpl.java index 0c1043ff..93ad7479 100755 --- a/openespi-thirdparty/src/main/java/org/greenbuttonalliance/espi/thirdparty/repository/impl/UsagePointRESTRepositoryImpl.java +++ b/openespi-thirdparty/src/main/java/org/greenbuttonalliance/espi/thirdparty/repository/impl/UsagePointRESTRepositoryImpl.java @@ -118,7 +118,7 @@ public List<UsagePointEntity> findAllByRetailCustomerId(Long retailCustomerId) AtomFeedDto feedDto = (AtomFeedDto) unmarshaller.unmarshal(new StringReader(xmlResponse)); // Use openespi-common mappers for transformation - List<UsagePointEntity> usagePoints = feedDto.entries().stream() + List<UsagePointEntity> usagePoints = feedDto.getEntries().stream() .map(entry -> { UsagePointDto dto = (UsagePointDto) entry.getResource(); return usagePointMapper.toEntity(dto);