[java-support] branch main updated: JSPT-108 ServiceableComponent should implement AutoClose

[Rod Widdowson]

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

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

View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=15e837afab3112a74330f67f1af1c72d2e562689

The following commit(s) were added to refs/heads/main by this push:
     new 15e837a  JSPT-108 ServiceableComponent should implement AutoClose
15e837a is described below

commit 15e837afab3112a74330f67f1af1c72d2e562689
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Fri Jul 22 16:31:16 2022 +0100

    JSPT-108 ServiceableComponent should implement AutoClose
    
    https://shibboleth.atlassian.net/browse/JSPT-108
    
    Flesh out the Javadoc
---
 .../shibboleth/utilities/java/support/service/ReloadableService.java | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java b/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java
index ffe7327..59dcd1c 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java
@@ -64,8 +64,9 @@ public interface ReloadableService<T> extends InitializableComponent {
     /**
      * Get the serviceable component that this service supports. If the component hasn't been successfully
      * loaded yet or if this service does not support a ServiceableComponent, null is returned. On a non-null
-     * value, the returned component will be pinned and <em>MUST</em> be unpinned by a call to
-     * {@link ServiceableComponent#unpinComponent()}.
+     * value, the returned component will be pinned and <em>MUST</em> be unpinned.  This can be done
+     * by exploting the fact that a ServiceableComponent implements {@link AutoCloseable} or explicitly via
+     * a call to {@link ServiceableComponent#unpinComponent()} 
      * 
      * @return the component, if appropriate.
      */

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