| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
- mzs Schema Change: Introduce new type
mzs:ERVConfirmedDelivery (which is a mzs:MessageType extension) and
replace mzs:DeliveryNotification/msg:ERVConfirmedDelivery with
mzs:ERVConfirmedDelivery. Reason: Necessary to provide all
parameters to sender application (AppDeliveryID, DeliverySystem,
ZSDeliveryID, a.o.).
- Adapt Msg2MzsConverter accordingly.
|
|
- Problem: MOA ZS converts the mzs:Receiver/Person to
msg:Receiver/Person even if mzs:Receiver/Person is null.
- Solution: Distinguish Cases.
- Add ClearingProfilID in mzs2msg conversion.
|
|
- Problem: When activating the QueryPersonRequest, the TNVZ returns an
Identification element that needs to be integrated into the
msg:DeliveryRequest as a child of Receiver. The Identification child
is mutually exclusive to another sequence consisting of (Person,
AustrianAddressesOnly, Address). I forget to delete the sequence
when adding the Identifcation element and violate the the msg
schema.
- Solution: Delete sequence when adding Identification.
- Test the fix in test case.
Thanks to Johannes Hörtnagl for pointing out the problem.
|
|
|
|
|
|
- Problem: Apparently I used the wrong executor when supplying the
backend tasks via CompletableFuture.supplyAsync(). This method
relies on ForkJoinPool.commonPool(), and threads in this pool are
not configured correctly?
- Solution: Use spring-boots auto-configured TaskExecutor.
- More Information on this issue can be found here:
https://issues.apache.org/jira/browse/CXF-8100#
|
|
app2mzs Schema Changes:
- mzs:MessageType/ZSDeliveryID was mandatory. However, in certain
cases the ZSDeliveryID does not exist (Example: perform
QueryPersonRequest, request fails > no ZSDeliveryID). This element
is now optional.
- mzs:Error/Code was of type xs:integer, is now xs:string. Reason:
msg:Code is also of type string.
Incorporate app2mzs schema changes into code base.
|
|
|
|
- Error was assigned to TNVZ Client, but appeared in MSG Client.
|
|
|
|
|
|
Upgrade zusemsg 2.2.0 to 2.2.007:
- msg:RelayedViaERV
- Change from boolean to complex type (ervcode).
- Move from msg:DeliveryRequestStatusType/Success into
msg:DeliveryRequestStatusType, which affects Success, Error, and
PartialSuccess.
- Was removed from DeliveryNotificationType.
- Change msg:DeliveryNotification/Answer from list to singleton.
- Change msg:DeliveryRequestStatusType/PartialSuccess is to type AnswerType.
- msg:DeliveryRequestStatusType and msg:DeliveryNotificationType
receive the attribute ID (for signature referencing).
- Add new optional element msg:AustrianAdressesOnly (IndicatorType) to
DeliveryRequestType/Receiver/(choice sequence).
- Add new optional element ClearingProfilID to DeliveryRequestType/Sender.
- Add new element ERVConfirmedDelivery, which subsitutes msg:Answer
and extends msg:AbstractOperation
- Has element ErvCode (also new token256 type).
- Has element ERVDeliveryTimestamp.
- Add new optional element TargetIdentification of type
p:IdentificationType to msg:DeliveryNotification/User/ as optional
element.
- Add new enumeration "System" to msg:DeliveryNotification/User/Role.
- Rename type AustrianLanguageType from
"AustrianEthicMinorityLanguageType" to "AustrianLanguageType" and
add "DE" as value.
- msg:Tags were unbounded, now they are limited to 20.
- VersionNumberType: Patch version can have three digits.
Upgrade zusetnvz 2.2.0 to 2.2.006:
- Add StandardMimeTypeList to tnvz:QueryPersonResponse and
tnvz:QueryAdressabilityResponse.
- Add AllStandardMimeTypes (indicator) to tnvz:PersonResult/Success.
- Add optional msg:MetadataList to tnvz:PersonQueryType/Metadata
tnvz:AddressabilityQueryType/Metadata.
- Move tnvz:AustrianAdressesOnly to msg namespace.
Carry zusemsg changes into app2mzs interface:
- Switch namespace of AustrianAdressesOnly from tnvz to msg.
- Add new optional element ClearingProfilID to
mzs:DeliveryRequestType/Sender; Reason: Element was added to zusemsg
2.2.007.
- Add new choice in mzs:DeliveryNotification to forward new answer
type msg:ERVConfirmedDelivery to the app.
- Move msg:RelayedViaERV from SuccessType into MessageType (now it's
available to all types that derive from MessageType).
Accommodate zusemsg/tnvz changes in code base:
- TNVZHelper: Consider StandardMimeTypeList when assessing if
DeliveryRequest/mimetypes overlap with TNVZ's Accepted Mimetypes.
- Msg2MzsConverter:
- Put getRelayedViaERV() into all DeliveryStatusRequest replies.
- Honor that Notification/Answer is Singleton instead of List.
- Handle case were DeliveryNotification/Answer is of type
ERVConfirmedDeliveryType.
- Remove RelayedViaERV from DeliveryNotification as this element is
not available anymore.
- NotificationResponse: Honor that Notification/Answer is Singleton
instead of List.
Fix all testcases and sample soap messages to comply with schema changes.
|
|
- But: Leave MZS Interface at Soap 1.1
- Add ClientFactory.createSOAP11 to ensure that we can talk back to the app.
|
|
...since it's a client that communicates with the app.
|
|
- JAXB Hack: Handle InterruptionException properly (as in [1], "Dont
swallow Interrupts")
- Mzs2MsgConverter: Rename convert(Person) to
convertReceiverPerson(Person) to emphasize that this method can only
be used to convert Receiver Persons (Reminder: Receiver Persons are
PhysicalPersons / CorporateBodies. SenderPersons can also be
Authorities)
- Mzs2MsgConverter: Remove assertion because not needed anymore.
- Refactor: Move mzs:DeliveryRequest validation out ouf augmenter and
into service.
- Refactor: Create a single entry point for validating a
mzs:DeliveryRequest.
- Remove unused imports.
- Fix log messages.
[1] https://www.ibm.com/developerworks/java/library/j-jtp05236/index.html?ca=drs-#2.1
|
|
|
|
...by ensuring that the interceptor also stores messages with the element
"msg:DeliveryResponse" to the repository.
|
|
- Ensure that moazs creates concrete Persons (CorporateBody,
PhysicalPerson), resp. concrete Adresses (InternetAddress,
PostalAddress, TelephoneAdress) instead of AbstractPersons or
AbstractAdresses during conversion from mzs to msg. Reason:
Instances of abstract classes do not conform to the xml scheme.
|
|
- Problem: Jaxb + JAVA >= 9 Runtime + Tomcat = ClassNotFoundException:
ContextFactory.
Reason: Apparently, jaxb uses the "wrong" classloader (the system
classloader via the thread classloader) and this classloader does
not know about jaxb api's and implementations at runtime since
oracle decided to move jaxb* out of JRE.
Solution: create a new thread, override the thread's "thread"
classloader with the "class" classloader and do all jaxb
interactions in that thread. See:
https://sjhannah.com/blog/2018/11/21/jaxb-hell-on-jdk-9/
- Move "run jaxb interactions in own thread with class class loader"
code into own component (JaxbClassNotFoundFix,
runInTheadWithClassClassLoader) and wrap ClientFactory and
Marshaller code into the "runInTheadWithClassClassLoader".
- Ensure that app can be deployed in a Tomcat container (by following
this guide: https://www.baeldung.com/spring-boot-war-tomcat-deploy)
|
|
|
|
Schema Changes:
- Remove mzs:DeliveryRequest/TnvzMetaData because all metadata fields
can be collected from DeliveryRequest and redundancy is not needed.
Fixes and Refactoring in preprocess:
- MzsDeliveryRequestValidator: Instead of returning false, throw an
exception when a condition is not met, and explain which condition
is not met / why it is not met in the exception's message.
- Integrate interface change in ConfigProfileGenerator and
DeliveryRequestAugmenter.
- Rewrite and simplify DeliveryRequestAugmenter's augmentation.
- ConfigUtil Fixes: Ensure that we do not override the wrong
parameters while merging. This error appeared in tnvz / msg client,
connection / receive timeout, key / trust store, and lax hostname
verification / trust all.
Fix Bugs in Interceptor / SoapUtils:
- Problem: DOM access and information extraction was implemented
somewhat sloppy.
- SolutioN: Change DOM access interface to access DOM more
efficiently. Add boundary checks and handle edge cases while
extracting information from SOAP Messages.
- Test those changes properly.
Testing:
- Implement Delivery Request Flow in ITEndToEndTest.
- Start application on random port instead of fixed port when running
integration tests.
- Add assertions to tests in ITMzsServiceTest suite.
Others Bug Fixes:
- ServicesConfig: Ensure that mzs service and msg service run on
different endpoint addresses (/msg and /mzs).
- DeliveryRequestBackend: Throw exception when binary message is
missing. Don't wrap the exception.
- SaveResponseToFileSink: Wrap Response in JAXB Element (otherwise,
marshaller does not recognize it)
|
|
|
|
Reason: MoaZSException (and: its builder) were used to collect
intermediary results while stepping through the delivery request
backend. These results were needed to generate meaningful responses
towards the sender application in case of error. However, the builder
sprawled over too many interfaces (e.g. DeliveryRequestBackend and
TNVZHelper) and it became difficult to understand from where
intermediary results originated.
Solution: Put MoaZSException on diet:
- Remove all DeliveryAnswer fields from MoaZSException and refactor
code base to ensure that the removed fields get sourced by other
means.
- Remove Builder since amount of parameters is manageable.
Refactor DeliveryRequestBackend:
- Instead of passing down the builder and using MoaZSException as the
only source for intermediary results, we collect available results
at the outermost stack frame (DeliveryRequestBackend.accept) and
only retrieve results via exception if those results appear
somewhere down the stack frame (E.g. PredviceNoteSent). We collect
available results with the "fallbackAnswerBuilder" and switch to the
msg client response, once received.
Refactor MsgResponseBackend:
- Handle cases (response missing, binary response missing) properly.
- Integrate changes from MsgResponse.generateError()
Refactor TVNZHelper:
- Remove MoaZSExceptionBuilder from all interfaces.
Refactor MsgResponse.generateError:
- Change interface such that it's more intuitive.
- Implement NotificationResponse.generateError.
- Implement RequestStatusResponse.generateError.
Others:
- Replace all invocations against MoaZSException.Builder.
|
|
Mzs Schema Changes:
- Formerly: The mzs:DeliveryNotificationType is a choice between
Success And Error; Change: Wrap choice in a sequence. Reason: msg
2.0.0 adds fields that fit best in this sequence. Adding new fields
to Success or Error duplicates code, whereas adding it to the base
type (which is MessageType) also affects mzs:DeliveryRequestStatus.
- Add msg:SenderDetails, ReceiverDetails, user, AdditionalFormat,
NotificationsPerformed; Reason: It was added to zusemsg 2.0.0.
|
|
MZS Schema Change:
- Add configuration for ForwardResponseToServiceSink
(add parameters in mzs:DeliveryRequest/Config)
- Add sink configuration in application.yaml, convert from Spring
Environment to ConfigType, and merge ConfigTypes.
- Validate sink configuration completeness.
Contract added:
- Add contract mzs2app.wsdl: This contract specifies how
mzs:DeliveryRequestStatus' and mzs:DeliveryNotifications are
forwarded to the sender application.
- Implement "ForwardResponseToService" Sink.
- Add and implement MsgResponse.sendToMzsClient() : This is a somewhat
unfortunate solution because, intuitively, sending should be done by
it's caller, the "ForwardResponseToService"-sink. However, this
solution prevents differences between msg:DeliveryRequestStatus and
msg:DeliveryNotification (and code that needs to handle differences,
i.e. sending) from sprawling outside of the respective MsgResponse
derivatives. We move the entire "send" process into MsgResponse to
prevent a hard-to-maintain "if type == notification then do x else
to y" construct in ForwardResponseToServiceSink. Otherwise,
introducing the MsgResponse wrapper was pointless.
|
|
- MZS Schema Change: Add "MsgResponseSinks" element to
mzs:DeliveryRequest/Config that allows sender to configure how
MsgResponses should be archived.
- ConfigUtil: Interpret MsgResponseSink parameters from Spring
Environment and merge with ConfigType.
- MsgResponseBackend: Send responses to sinks according to
MsgResponseSinks in Config
- application.yaml: Add MsgResponseSinks parameter to configuration.
- Uncouple Sink implementations from java.util.function.Function,
because the sink interfaces are going to differ and there is no need
to unite them under one interface.
- Add and test LogResponseSink, which logs responses to it's logger.
- MsgResponse: Add JAXB getter for response. Reason: Can be passed to
marshaller.
|
|
- Fix typo in SafeResponseToFileSink.
- MoaZSException: Simplify constructor by replacing lots of arguments
with the builder instance.
- Fix minor codesmells (unused imports, superfluous braces).
|
|
StoreSOAPBodyBinaryInRepositoryInterceptor:
- Replace "generate body's id via concatenation" with "give the right
generator function the app delivery id and let the generator
function do the work". Reason: Prevent the logistics of deriving IDs
to spill into unrelated components.
MsgResponse refactor:
- Make MsgResponse an abstract class.
- Derive ResponseID's ONLY in MsgResponse::createResponseID.
Others:
- Ensure that all invocations to DeliveryRepository.getResponse and
BinaryRepository.get use "responseID" instead of ambiguous "id" or
incorrect "appDeliveryID".
- Move SingleThreadedDeliveryPipeline into process package.
|
|
- Add zuse2app.wsdl contract.
- Add MsgResponse as an type-agnostic view for DeliveryRequestStatus
and DeliveryNotification messages. Reason: Both DeliveryNotification
and DeliveryRequestStatus messages have similar fields and need to
be treated similarly (e.g.: receive from msg service, store to
repository, verify signature, store to file...). In order to prevent
duplicated code, the wrapper interface provides a type-agnostic view
onto these messages for depending components to operate on.
- Add MsgResponseHandler interface; decides how to process
MsgResponse. Also implement this handler with a multi-threaded
single-node implementation.
- Add MsgResponseSink interface; decides how to archive MsgResponse.
- Implement and test SafeResponseToFileSink.
Change Identifier for MsgResponses:
- Before, DeliveryRequestStatus and DeliveryNotifications had their
own repositories. Now, both types are stored in the same repository
(the MsgResponse repository) to streamline the handling of
MsgResponses. We need to change the identification of MsgReponses,
otherwise the identifiers (AppDeliveryID) clash.
- MsgResponses are not identified by:
<AppDeliveryId>+<typeSpecificSuffix>
- Rewrite StoreSOAPInterceptor to accommodate fact that, both
DeliveryRequestStatus and DeliveryNotification messages have
different IDs upon storage / retrieval.
Restructure packages and components as follows:
- client: All components that are involved when consuming a web service.
- process: "fabric" of MoaZS; contains business logic that
orchestrates back-end tasks of MoaZS's operational services, e.g.:
by processing a delivery request.
- service: Implementation of MoaZS's front-end services.
Refactoring:
- MoaZSException: Remove unused fields. Before: Store mzsrequest,
tnvzresult, msgrequest and msgresult as members. Now: Only keep the
fields that are needed later, e.g for generating a
msg:DeliveryRequestStatus element. Add copy constructor to Builder.
- Put storage of byte[] into a dedicated "BinaryRepository". Reason:
This was useful in a former design. Now it's not really needed
anymore.
- Put "create Endpoint" code into EndpointFactory. Reason: Eliminate
duplicated code when configuring a service.
Testing:
- Activate Stacktraces in surefire.
|
|
- Move components that depend on the service contracts into scheme
package.
- Move cxf related components into util package.
- Rename SameThread to SingleThreaded.
|
|
|
|
- TnvzHelper: Handle edge case where
Mzs/DeliveryRequest/Sender/CorporateBody is missing (Reason: This
field is in a <choice> with msg:SenderProfile, so if CorporateBody
is missing the request still passes the schema validation). Handle
case by rejecting missing CorporateBody and TnvzQuery activated.
- Add test cases for TnvzHelper.
|
|
- Merge TnvzClient and TnvzResultVerifier to TnvzHelper; TnvzHelper
now builds the QueryPersonRequest, sends it to the tnvz port and
evaluates the result.
- Publish some interfaces in Mzs2MsgConverter because they are needed
by TnvzHelper.
- Generalize MsgClientFactory to ClientFactory such that it can be
used to generate arbitrary SOAP clients (e.g. also for tnvz!).
Schema Changes to accomodate Tnvz's QueryPersonRequest:
- Add optional tnvz:AustrianAddressesOnly and optional TnvzMetaData to
mzs:mzs:DeliveryRequest.
Removed Unit Tests:
- Remove subset of SameThreadDeliveryPipeline testcases (mimetype
related) because its logic moved to TnvzHelper.
|
|
- EgovUtils were needed because of DomUtils. Replace it with eaaf
components' DomUtils.
- Add test case to ensure SoapUtils still works as intended. - Remove
unused import statement
|
|
- Move JaxbM initialization into Marshaller such that it can be used
in tests without Spring's Application Context.
- Remove SpringRunner from Mzs2MsgConverter Test, which makes the test
run faster.
|
|
|
|
- Ensure proper communication of errors between pipeline and mzs
service by converting MoaZSExceptions into DeliveryRequestStatus
messages.
- Revise MoaZSException: Add optional fields; those fields are a)
helpful to construct meaningful error messages and b) optional
because, depending on where an exception appears, either existent or
non-existent and thus optional. Add inner-class Builder.
- Integrate Signature Verification into pipeline and add Stub for
SignatureVerification.
- Move TNVZResponse's Mimetype check into dedicated class (Reason:
separate abstration layers).
- Update api changes in testcases.
|
|
- Add egovutils dependency (Reason: Need DomUtils to serialize /
unserialize Soap Message via DOMParser)
- Add Incerceptor to MsgClient / -Factory that stores the message
content byte-by-byte in the DeliveryRepository. The format is
required for successfully validating a DeliveryRequestStatus.
- Add SoapUtils, which interacts with byte[] Soap message.
- Add CXFMessageUtils, which interacts with CXF Messages from
interceptor chains.
- Refactor xsd namespaces: Move them out from the PrefixMapper and
into a dedicated class.
|
|
- MZS cant reply with a msg:DeliveryRequestStatusType to a
mzs:DeliveryRequest. Reason: unmarshalling a
msg:DeliveryRequestStatusType with JAXB (after receiving the msg
reply) breaks the signature in msg:DeliveryRequestStatusType. Why?
Because JAXB marshalling tinkers with the namespaces and, as for the
current state of knowledge, we cannot configure the JAXB marshaller
to reconstruct a XML Document byte-by-byte such that a signature
that went through this process can be verified successfully (see [1]).
- For this reason, we revert back to mzs:DeliveryResponse and add new
fields / remove obsolete fields / capture all changes between zusemsg
1.5.3 and zusemsg 2.0.0.
- The easier solution would be to wrap and transmit signed data +
signature in a binary (base64) container, such that apache cxf and
other web service frameworks won't unmarshall them. This doesnt work
because zusemsg 2.0.0 is final.
app2mzs.xsd Changes in Detail :
- Add DeliverySystem, ZSDeliveryID and GZ to MessageType (MessageType
is the base type of DeliveryResponse.Success, -PartialSuccess, and
-Error); Reason: It was added to zusemsg 2.0.0.
- Add SignedDeliveryRequestStatus to MessageType. Reason: If msg
returns signed reply, this element contains the reply as byte[] such
that the signature does not break.
- Add optional PreadvicenoteSend to ErrorType (because it was added in
zusemsg 2.0.0)
- Remove MZSDeliveryID from every instance because this ID does not
exist anymore (moa zs does not maintain requests in a database).
- Remove DocumentReference from ErrorType as it was removed from
zusemsg 2.0.0.
- Remove DeliveryConfirmation as node in DeliveryNotificiationType
because it does not exist anymore in zusemsg 2.0.0;
DeliveryConfirmation is also obsolete because all msg' replies are
signed and need to be transferred to the sender application as a
byte[], which is done by SignedDeliveryRequestStatus node in
MessageType.
- Remove DeliveryStatement as node in DeliveryNotificiationType
because it does not exist anymore in zusemsg 2.0.0.
Other Changes
- Adapt codebase: MzsService returns mzs:DeliveryResponse.
- Implement conversion from msg:DeliveryRequestStatus to
mzs:DeliveryResponse.
- Add store / retrieve interface to DeliveryRepository that stores
signed delivery request statuses as byte[].
Temporary Changes
- Disable integration tests which have external dependencies.
[1] https://download.oracle.com/javaee-archive/jaxb.java.net/users/2007/03/6674.html
Signed-off-by: Christof Rabensteiner <christof.rabensteiner@iaik.tugraz.at>
|
|
- Rename jaxbmarshaller field to prevent confusion with class name.
|
|
- Fix: Replace MessageFormat.format with String.format
- Refactor: Use Method Reference
- Add Todo Item
|
|
|
|
|
