frankframework / frankframework/frank-doc

The MessageStoreSender.java class defines unwanted XML elements MessageStoreSenderErrorStorage and MessageStoreSenderMessageLog

Open
#155 1 comment 0 reactions 0 assignees View on GitHub
doclet
Dominant language
Java
Stars
5
Forks
5
Avg merge
1h 20m
Merged PRs (30d)
1

Description

Java class MessageStoreSender.java should define XML elements MessageStoreErrorSender and MessageStoreSender, but in addition the elements MessageStoreSenderErrorStorage and MessageStoreSenderMessageLog are defined. These extra elements should not be used by Frank developers and hence they should not appear in the Frank!Doc.

These elements appear because Java class MessageStoreSender inherits class JdbcTransactionalStorage for technical reasons. The existence of error stores and message logs is expressed by element roles (ITransactionalStorage, "errorStorage") and (ITransactionalStorage, "messageLog"). There is a FrankElement for Java class MessageStoreSender. The XML tags are calculated from all the ElementRoles to which MessageStoreSender belongs. Because of the inheritence, these ElementRole-s include (ITransactionalStorage, "errorStorage") and (ITransactionalStorage, "messageLog"). This is why the unwanted XML elements appear.

One way to solve this is to introduce a new annotation in the Frank!Doc that says that an inheritance relation is only technical. Then the logic that defines ElementType-s should exclude members based on this annotation. As a consequence the ElementRole-s that include these ElementType-s do not include the unwanted members and hence the unwanted XML elements are not defined.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.