This is an automated email from the ASF dual-hosted git repository. amichair pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/aries-rsa.git
commit 63201370de1a378261dce58d6e7b59fe471411a3 Author: Amichai Rothman <[email protected]> AuthorDate: Mon May 11 21:01:00 2026 +0300 Add detailed note about TCK compliance and the EventListenerBridge to readme --- rsa/Readme.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/rsa/Readme.md b/rsa/Readme.md index 473780dc..b084f591 100644 --- a/rsa/Readme.md +++ b/rsa/Readme.md @@ -1,8 +1,35 @@ # Remote Service Admin -Is called by the Topology Manager to expose local services as remote endpoints and create local proxy services as -clients for remote endpoints. +This service is called by the Topology Manager to do the "heavy lifting" of expose local services +as remote endpoints and creating local proxy services as clients for remote endpoints. -Aries RSA has a custom [SPI DistributionProvider](https://github.com/apache/aries-rsa/blob/master/spi/src/main/java/org/apache/aries/rsa/spi/DistributionProvider.java) that allows to easily create new transports and serializations. -The RemoteServiceAdmin bundle tracks such provider services and relays the actual creation of endpoints and proxies to -suitable providers. +Aries RSA has a custom [SPI DistributionProvider](https://github.com/apache/aries-rsa/blob/master/spi/src/main/java/org/apache/aries/rsa/spi/DistributionProvider.java) +that facilitates creating new transports and serializations. +The RemoteServiceAdmin bundle tracks such provider services and delegates +the actual creation of endpoints and proxies to suitable providers. + +### A Note About TCK Compliance + +Aries RSA runs the TCK compliance tests as part of the build process +to ensure that it is fully compliant with the RSA specification. One of +the details being tested is backwards compatibility with the +`EndpointListener` interface for legacy endpoint event producers +and consumers. This interface has been deprecated since release 1.1 of +the spec in 2015, and superceded by the newer `EndpointEventListener` +interface. + +In order to be compliant with this requirement and pass the TCK tests, +this module implements an `EventListenerBridge` component to bridge the +two event types. However, since this is very unlikely to be needed in +practice (only if an OSGi container runs two different local RSA +implementations, both the modern Aries RSA implementation and another +RSA implementation that is over a decade old), and since it may have +some complexity and performance implications, this bridge is disabled +by default. + +To enable the bridge for full TCK compatibility, set the system +property `org.apache.aries.rsa.bridge` to `"true"`. + +Needless to say, both the legacy interface and the bridge supporting +it should be considered deprecated and may be removed in a future +release. Anyone still using them is urged to upgrade to the new interface.
