[java-shib-shared] branch main updated: Add more information to the Javadoc comment to help future maintainers

[Rod Widdowson]

This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch main
in repository java-shib-shared.

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-shared.git;a=commit;h=091732111f5b7e8cf16d7112a35d6292c1893d62

The following commit(s) were added to refs/heads/main by this push:
     new 09173211 Add more information to the Javadoc comment to help future maintainers
09173211 is described below

commit 091732111f5b7e8cf16d7112a35d6292c1893d62
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Tue Nov 29 10:30:39 2022 +0000

    Add more information to the Javadoc comment to help future maintainers
---
 .../shared/spring/service/AbstractServiceableComponent.java      | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/shib-service/src/main/java/net/shibboleth/shared/spring/service/AbstractServiceableComponent.java b/shib-service/src/main/java/net/shibboleth/shared/spring/service/AbstractServiceableComponent.java
index 01586e93..f5303f8c 100644
--- a/shib-service/src/main/java/net/shibboleth/shared/spring/service/AbstractServiceableComponent.java
+++ b/shib-service/src/main/java/net/shibboleth/shared/spring/service/AbstractServiceableComponent.java
@@ -94,7 +94,14 @@ public abstract class AbstractServiceableComponent<T> extends AbstractIdentifiab
         unpinComponent();
     }
 
-    /**  Grab the service lock ex (which means noone else is active) and then call spring to tear everything down. */
+    /** Grab the service lock ex (which means no-one else is active) and then call Spring to tear
+     * everything down.
+     *
+     * The fact that we have the service lock ex means that this method does not need to be
+     * add a 'synchronize' because we are doing it explicitly.  Further we are careful with the
+     * operation order so there are no races in this code and and no user of the underlying
+     * component can be active as we are tearing down.
+     */
     public void unloadComponent() {
         if (null == applicationContext) {
             log.debug("Component '{}': Component already unloaded", getId());

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.