Mapping Properties to Java Class
About
It is possible to map the data given in the spring application yaml/json/properties file with the java class directly. This process, known as mapping, allows to directly link the data in the configuration files to corresponding fields in Java classes. With this. it is easy the update the data directly in the properties file without need to build the application again.
Mapping payment purposes which are available in different languages.
Define the properties in application.yaml file.
payment:
purpose:
purposeEn:
- 'Others'
- 'Holidays'
purposeAr:
'آحرون' -
'العطل' -
purposeFr:
- 'Autres'
- 'Vacances'Create PaymentPurposes.java class
package org.example.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
@ConfigurationProperties(prefix = "payment.purpose")
@Data
public class PaymentPurposes {
private List<String> purposeEn;
private List<String> purposeAr;
private List<String> purposeFr;
}Map the parent-child hierarchy property of transaction category.
Define the properties in application.yaml file.
transaction:
category-details:
categories:
- name: 'General'
code: 'G1'
subcategories:
- name: 'Miscellaneous'
code: 'M1'
- name: 'Shopping'
code: 'S1'
- name: 'Travel'
code: 'T1'
subcategories:
- name: 'Flight'
code: 'F1'
- name: 'Hotel'
code: 'H1'Create TransactionCategories.java class
package org.example.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
@ConfigurationProperties(prefix = "transaction.category-details")
@Data
public class TransactionCategories {
private List<Category> categories;
@Data
public static class Category {
private String name;
private String code;
private List<Subcategory> subcategories;
}
@Data
public static class Subcategory {
private String name;
private String code;
}
}Map the key value pairs of message templates
Define the properties in application.yaml file.
messaging:
templates:
welcome: "Welcome to our messaging app! We're glad to have you on board."
invitation: "You've been invited to join a group chat. Click the link to join."
notification: "You have a new message. Click here to view it."Create MessagingTemplates.java class
package org.example.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Map;
@Component
@ConfigurationProperties(prefix = "messaging")
@Data
public class MessagingTemplates {
private Map<String, String> templates;
}Add Integration Tests to test above 3 examples.
package org.example;
import lombok.extern.slf4j.Slf4j;
import org.example.config.MessagingTemplates;
import org.example.config.PaymentPurposes;
import org.example.config.TransactionCategories;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@Slf4j
@SpringBootTest
class SampleIT {
@Autowired
private PaymentPurposes paymentPurposes;
@Autowired
private TransactionCategories transactionCategories;
@Autowired
private MessagingTemplates messagingTemplates;
@Test
void testPaymentProperties() {
log.info("Properties: {}", paymentPurposes);
Assertions.assertEquals("Others", paymentPurposes.getPurposeEn().get(0));
Assertions.assertEquals("آحرون", paymentPurposes.getPurposeAr().get(0));
Assertions.assertEquals("Autres", paymentPurposes.getPurposeFr().get(0));
}
@Test
void testTransactionCategories() {
log.info("TransactionCategories: {}", transactionCategories);
Assertions.assertEquals(2, transactionCategories.getCategories().size());
}
@Test
void testMessagingTemplates() {
log.info("MessagingTemplates: {}", messagingTemplates);
Assertions.assertEquals(3, messagingTemplates.getTemplates().size());
}
}
Mapping card types and fees in a Map.
Define the properties in application.yaml file.
bank:
credit:
cards:
fees:
platinum:
fee: "5.0"
vat: "5.0"
lifestyle:
fee: "5.0"
vat: "5.0"Create CardProperties.java class
package org.example.config;
import java.util.Map;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationProperties(prefix = "bank.credit.cards")
@Getter
@Setter
public class CardProperties {
private Map<String, Map<String, String>> fees;
}Mapping Error Codes and Description
Define the properties in application.yaml file.
myapp:
faults:
- action: "RETRY"
errorCode: "PAYMENT_TIMEOUT"
type: "TRANSIENT"
system: "PaymentGateway"
nativeError: "PG-504"
englishDescription: "Payment gateway timeout. Please try again."
hindiDescription: "भुगतान गेटवे टाइमआउट। कृपया पुनः प्रयास करें।"
- action: "ESCALATE"
errorCode: "ACCOUNT_LOCKED"
type: "PERMANENT"
system: "AccountService"
nativeError: "AS-401"
englishDescription: "Your account has been locked."
hindiDescription: "आपका खाता लॉक कर दिया गया है।"Create ErrorConfig.java class
package com.company.project.config;
import java.util.ArrayList;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@Setter
@Getter
@Configuration
@ConfigurationProperties(prefix = "myapp")
public class ErrorConfig {
private List<ErrorOverride> faults = new ArrayList<>();
public record ErrorOverride(
String action,
String errorCode,
String type,
String system,
String nativeError,
String englishDescription,
String hindiDescription
) {}
}
Mapping Audit Categories
Define the properties in application.yaml file.
audit:
config:
event-categories:
- event-category: "User Control"
severity: "HIGH"
enabled: true
object-types:
- object-type: "User Group"
retention-days: 365
notifiable: true
event-actions:
- name: "Create"
log-level: "INFO"
- name: "Update"
log-level: "WARN"
- object-type: "Work Group"
retention-days: 180
notifiable: false
event-actions:
- name: "Create"
log-level: "INFO"
- name: "Update"
log-level: "INFO"
- object-type: "Legal Entity"
retention-days: 730
notifiable: true
event-actions:
- name: "Create"
log-level: "AUDIT"
- name: "Update"
log-level: "AUDIT"
- object-type: "User Permissions"
retention-days: 90
notifiable: true
event-actions:
- name: "Update Permissions"
log-level: "CRITICAL"
- event-category: "Account Statements"
severity: "MEDIUM"
enabled: true
object-types:
- object-type: "Account Statements"
retention-days: 180
notifiable: false
event-actions:
- name: "Read"
log-level: "INFO"Create AuditConfig.java class
package com.company.project.config;
import java.util.ArrayList;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@Setter
@Getter
@Configuration
@ConfigurationProperties(prefix = "audit.config")
public class AuditConfig {
private List<EventCategory> eventCategories = new ArrayList<>();
public record EventCategory(
String eventCategory,
String severity,
boolean enabled,
List<ObjectType> objectTypes
) {}
public record ObjectType(
String objectType,
int retentionDays,
boolean notifiable,
List<EventAction> eventActions
) {}
public record EventAction(
String name,
String logLevel
) {}
}Last updated