[java-shib-shared] 01/02: JSSH-27 - Implement an ensureId method to help with nullability annotation

[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=f454e9befb7279ebda654c4787ebb1143c5b72a1

commit f454e9befb7279ebda654c4787ebb1143c5b72a1
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Tue Apr 25 15:23:25 2023 +0100

    JSSH-27 - Implement an ensureId method to help with nullability annotation
    
    https://shibboleth.atlassian.net/browse/JSSH-27
    
    Make the ensureId method public
    
    Do some cleanup areound places where its fine for getId() to return null but current
    behavior would be ugly.
---
 .../java/net/shibboleth/shared/security/impl/IPRangeAccessControl.java  | 2 +-
 .../java/net/shibboleth/shared/service/AbstractReloadableService.java   | 2 +-
 .../shared/service/security/impl/ReloadingAccessControlService.java     | 2 ++
 .../shared/service/security/impl/ServiceableAccessControlService.java   | 2 ++
 .../shared/component/AbstractIdentifiedInitializableComponent.java      | 2 +-
 5 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/shib-security/src/main/java/net/shibboleth/shared/security/impl/IPRangeAccessControl.java b/shib-security/src/main/java/net/shibboleth/shared/security/impl/IPRangeAccessControl.java
index 2510df37..81a146a9 100644
--- a/shib-security/src/main/java/net/shibboleth/shared/security/impl/IPRangeAccessControl.java
+++ b/shib-security/src/main/java/net/shibboleth/shared/security/impl/IPRangeAccessControl.java
@@ -107,7 +107,7 @@ public class IPRangeAccessControl extends AbstractIdentifiableInitializableCompo
      * @return  prefix
      */
     @Nonnull private String getLogPrefix() {
-        return "Policy " + getId() + ":";
+        return "Policy " + ensureId() + ":";
     }
 
 }
diff --git a/shib-service/src/main/java/net/shibboleth/shared/service/AbstractReloadableService.java b/shib-service/src/main/java/net/shibboleth/shared/service/AbstractReloadableService.java
index c4a6e601..6b6c0688 100644
--- a/shib-service/src/main/java/net/shibboleth/shared/service/AbstractReloadableService.java
+++ b/shib-service/src/main/java/net/shibboleth/shared/service/AbstractReloadableService.java
@@ -272,6 +272,7 @@ public abstract class AbstractReloadableService<T> extends AbstractIdentifiableI
             if (getId() != null) {
                 final StringBuilder builder = new StringBuilder("Service '").append(getId()).append("':");
                 prefix = builder.toString();
+                assert prefix != null;
                 if (null == logPrefix) {
                     logPrefix = prefix;
                 }
@@ -280,7 +281,6 @@ public abstract class AbstractReloadableService<T> extends AbstractIdentifiableI
             }
         }
         
-        assert prefix != null;
         return prefix;
     }
 
diff --git a/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ReloadingAccessControlService.java b/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ReloadingAccessControlService.java
index 507c8b79..246ad26d 100644
--- a/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ReloadingAccessControlService.java
+++ b/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ReloadingAccessControlService.java
@@ -51,6 +51,8 @@ public class ReloadingAccessControlService extends AbstractServiceableComponent<
         final String id = service.getId();
         if (id != null) {
             setId(id);
+        } else if (getId() == null){
+            setId("UnNamedReloadingAccessControlService");
         }
         super.doInitialize();
     }
diff --git a/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ServiceableAccessControlService.java b/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ServiceableAccessControlService.java
index 534bdec4..2c7c1553 100644
--- a/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ServiceableAccessControlService.java
+++ b/shib-service/src/main/java/net/shibboleth/shared/service/security/impl/ServiceableAccessControlService.java
@@ -51,6 +51,8 @@ public class ServiceableAccessControlService extends AbstractServiceableComponen
         final String id = service.getId();
         if (id != null) {
             setId(id);
+        } else if (getId() == null){
+            setId("UnNamedServiceableAccessControlService");
         }
         super.doInitialize();
     }
diff --git a/shib-support/src/main/java/net/shibboleth/shared/component/AbstractIdentifiedInitializableComponent.java b/shib-support/src/main/java/net/shibboleth/shared/component/AbstractIdentifiedInitializableComponent.java
index 43b5dc9e..8ae0c5cf 100644
--- a/shib-support/src/main/java/net/shibboleth/shared/component/AbstractIdentifiedInitializableComponent.java
+++ b/shib-support/src/main/java/net/shibboleth/shared/component/AbstractIdentifiedInitializableComponent.java
@@ -52,7 +52,7 @@ public abstract class AbstractIdentifiedInitializableComponent extends AbstractI
      *
      * @since 9.0.0
      */
-    protected final @Nonnull String ensureId() {
+    public final @Nonnull String ensureId() {
         final var id = getId();
         if (id == null) {
             throw new IllegalStateException();

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