Spring Boot Auto-Configure for Terasoluna Framework 5.x Common Libraries & Extensions.

This is a personal experimental project unrelated to TERASOLUNA. TERASOLUNA is a registered trademark of NTT DATA Corporation.

Notes

• Supports upper Java 17
• Supports Spring Boot 3.0.6
• Supports Terasoluna Gfw 5.8.1

---

Artifacts

• terasoluna-gfw-spring-boot-autoconfigure
• terasoluna-gfw-spring-boot-test-autoconfigure

---

terasoluna-gfw-spring-boot-autoconfigure

Auto-Configure for Application using Terasoluna Framework 5.x Common Libraries.

Getting Start

<dependency>
    <groupId>io.github.yoshikawaa.gfw.spring.boot</groupId>
    <artifactId>terasoluna-gfw-spring-boot-autoconfigure</artifactId>
    <version>1.1.0</version>
</dependency>

Auto-Configure Features

• Common Features
  • Logging Exceptions
  • Clock Factory
• Web MVC Features
  • Transaction Token
  • CodeList
  • Exception Handling
  • Trace Logging for Controllers
• Web Features
  • Logging Session Events
  • Logging with Mapped Diagnostic Context (MDC)
• Thymeleaf Features
  • Thymeleaf Dialect (not Terasoluna Gfw support)

More infomation of features Terasoluna Gfw.

Logging Exceptions

Enable Logging Exceptions if provided terasoluna-gfw-common.

• ExceptionCodeResolver
• ExceptionLogger
• ResultMessagesLoggingInterceptor

ExceptionCodeResolverConfigurer bean provide to configure ExceptionCodeResolver.

@Bean
ExceptionCodeResolverConfigurer exceptionCodeResolverConfigurer() {
    return builder -> {
        builder
            .mapping("ResourceNotFoundException", "e.xx.fw.5001")
            .mapping("InvalidTransactionTokenException", "e.xx.fw.7001")
            .mapping("BusinessException", "e.xx.fw.8001")
            .mapping(".DataAccessException", "e.xx.fw.9002")
            .defaultExceptionCode("e.xx.fw.9001");
    };
}

ExceptionCodeResolver is also used by SystemExceptionResolver.

Clock Factory

since v1.1.0

Enable Clock Factory for JSR-310 Date and Time API if provided terasoluna-gfw-common.

• DefaultClockFactory

ClockFactory bean override DefaultClockFactory bean.

@Bean
ClockFactory clockFactory(DataSource dataSource, @Value("clock.sql") String sql) {
    return return new JdbcClockFactory(dataSource, sql);
}

Transaction Token

Enable Transaction Token if provided terasoluna-gfw-web.

• TransactionTokenInterceptor
• TransactionTokenRequestDataValueProcessor

Set property to change behavior.

name	type	default
gfw.mvc.transaction-token.size-per-token-name	Integer	10

If a bean named requestDataValueProcessor is registered by Spring Security, wrap it with CompositeRequestDataValueProcessor.

CodeList

Enable CodeList if provided terasoluna-gfw-web.

• CodeListInterceptor

Register CodeList bean.

@Bean("CL_SIMPLE")
public CodeList simple() {
    SimpleMapCodeList codeList = new SimpleMapCodeList();
    codeList.setMap(Collections.singletonMap("001", "Tom"));
    return codeList;
}

Set property to change behavior.

name	type	default
gfw.mvc.codelist.enabled	boolean	true
gfw.mvc.codelist.id-pattern	String	CL_.+

It is recommended to set gfw.mvc.codelist.enabled=false to improve performance if obtain CodeList bean directly using Spring EL.

Exception Handling

Enable Exception Handling if provided terasoluna-gfw-web.

• SystemExceptionResolver

SystemExceptionResolverConfigurer bean provide to configure SystemExceptionResolver.

@Bean
SystemExceptionResolverConfigurer systemExceptionResolverConfigurer() {
    return builder -> builder
        .mapping("ResourceNotFoundException", "error/resourceNotFoundError")
        .mapping("BusinessException", "error/businessError")
        .mapping("InvalidTransactionTokenException", "error/transactionTokenError")
        .mapping(".DataAccessException", "error/dataAccessError")
        .statusCode("error/resourceNotFoundError", 404)
        .statusCode("error/businessError", 409)
        .statusCode("error/transactionTokenError", 409)
        .statusCode("error/dataAccessError", 500)
        .defaultErrorView("error")
        .defaultStatusCode(500);
}

If you want to configure completely, you can define SystemExceptionResolver bean to override.

Logging exceptions is not supported.

• HandlerExceptionResolverLoggingInterceptor : Please consider to use spring.mvc.log-resolved-exception.
• ExceptionLoggingFilter : Please consider to use server.error.include-stacktrace or intercept ErrorController.

Trace Logging for Controllers

Enable Trace Logging if provided terasoluna-gfw-web.

• TraceLoggingInterceptor

Please set logging.level.org.terasoluna.gfw.web.logging.TraceLoggingInterceptor=trace to enable trace log.

Set property to change behavior.

name	type	default
gfw.mvc.trace-logging.warn-handling-nanos	Long	-

Logging Session Events

since v1.0.1

Enable Debug/Trace Logging about Session Events if provided terasoluna-gfw-web.

• HttpSessionEventLoggingListener

Please set logging.level.org.terasoluna.gfw.web.logging.HttpSessionEventLoggingListener=trace to enable trace log.

Logging with Mapped Diagnostic Context (MDC)

Enable MDC if provided terasoluna-gfw-web/terasoluna-gfw-security-web.

• MDCClearFilter
• XTrackMDCPutFilter
• UserIdMDCPutFilter (require terasoluna-gfw-security-web & spring-boot-security-starter)

Please set logging.pattern.level to contain MDC key X-Track or USER. For example logging.pattern.level=X-Track:%X{X-Track} UserId:%X{USER} %5p.

Thymeleaf Dialect

Enable Thymeleaf Dialect if provided thymeleaf-extras-terasoluna-gfw.

• TerasolunaGfwDialect

Please see thymeleaf-extras-terasoluna-gfw.

---

terasoluna-gfw-spring-boot-test-autoconfigure

Auto-Configure for Test using Terasoluna Framework 5.x Common Libraries.

Getting Start

<dependency>
    <groupId>io.github.yoshikawaa.gfw.spring.boot</groupId>
    <artifactId>terasoluna-gfw-spring-boot-test-autoconfigure</artifactId>
    <version>1.1.0</version>
</dependency>

Auto-Configure Features

• @AutoConfigureTerasolunaGfw

Terasoluna Gfw not support Testing functions. Please use Recommended Feature.

@AutoConfigureTerasolunaGfw

@WebMvcTest
@AutoConfigureTerasolunaGfw // <- anotate!
class SampleTest {
    @Test
    void test() {
        //
    }
}

Provide attributes to disable features.

name	mapped property
codeListEnabled	gfw.mvc.codelist.enabled

Recommended Features

Enable useful support for MockMvc if provided spring-test-terasoluna-gfw.

Please see spring-test-terasoluna-gfw.