[java-shib-metadata] branch main updated: JSPT-98 Integrate lifecycle checking methods in base classes

Rod Widdowson rdw at steadingsoftware.com
Wed Jul 13 08:52:13 UTC 2022


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

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

View the commit online:
http://git.shibboleth.net/view/?p=java-shib-metadata.git;a=commit;h=70dc92c055fbc6497e852ed140c54ffa81cf2cb7

The following commit(s) were added to refs/heads/main by this push:
     new 70dc92c05 JSPT-98 Integrate lifecycle checking methods in base classes
70dc92c05 is described below

commit 70dc92c055fbc6497e852ed140c54ffa81cf2cb7
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Wed Jul 13 09:44:00 2022 +0100

    JSPT-98 Integrate lifecycle checking methods in base classes
    
    https://shibboleth.atlassian.net/browse/JSPT-98
    
    Stop using ComponentSupport and use the appropriate methods instead.
---
 .../metadata/impl/MetadataProviderContainer.java   |  7 +++---
 .../metadata/impl/ReloadableMetadataResolver.java  | 12 ++++------
 .../MetadataPKIXValidationInformationResolver.java | 27 ++++++++++------------
 3 files changed, 19 insertions(+), 27 deletions(-)

diff --git a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/MetadataProviderContainer.java b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/MetadataProviderContainer.java
index f91f90e6a..c9ef3c61f 100644
--- a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/MetadataProviderContainer.java
+++ b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/MetadataProviderContainer.java
@@ -28,7 +28,6 @@ import org.slf4j.LoggerFactory;
 import net.shibboleth.ext.spring.service.AbstractServiceableComponent;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
 
@@ -57,7 +56,7 @@ public class MetadataProviderContainer extends AbstractServiceableComponent<Meta
      * @param key what to set
      */
     public void setSortKey(final int key) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         sortKey = key;
     }
     
@@ -67,7 +66,7 @@ public class MetadataProviderContainer extends AbstractServiceableComponent<Meta
      * @param theResolver The {@link MetadataResolver} to embed.
      */
     @Nonnull public void setEmbeddedResolver(@Nonnull final MetadataResolver theResolver) {
-        ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
+        throwSetterPreconditionExceptions();
         resolver = Constraint.isNotNull(theResolver, "MetadataResolver cannot be null");
     }
 
@@ -100,7 +99,7 @@ public class MetadataProviderContainer extends AbstractServiceableComponent<Meta
     
     /** {@inheritDoc} */
     @Override public int compareTo(final MetadataProviderContainer other) {
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
+        throwComponentStateExceptions();
         final int result = sortKey.compareTo(other.sortKey);
         if (result != 0) {
             return result;
diff --git a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/ReloadableMetadataResolver.java b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/ReloadableMetadataResolver.java
index 54d6f3364..19025e8b5 100644
--- a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/ReloadableMetadataResolver.java
+++ b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/metadata/impl/ReloadableMetadataResolver.java
@@ -30,7 +30,6 @@ import org.slf4j.LoggerFactory;
 
 import net.shibboleth.utilities.java.support.annotation.ParameterName;
 import net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
 import net.shibboleth.utilities.java.support.resolver.ResolverException;
@@ -62,8 +61,7 @@ public class ReloadableMetadataResolver extends AbstractIdentifiableInitializabl
 
     /** {@inheritDoc} */
     @Override @Nonnull public Iterable<EntityDescriptor> resolve(final CriteriaSet criteria) throws ResolverException {
-
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
+        throwComponentStateExceptions();
         ServiceableComponent<MetadataResolver> component = null;
         try {
             component = service.getServiceableComponent();
@@ -86,9 +84,7 @@ public class ReloadableMetadataResolver extends AbstractIdentifiableInitializabl
 
     /** {@inheritDoc} */
     @Override @Nullable public EntityDescriptor resolveSingle(final CriteriaSet criteria) throws ResolverException {
-
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
-        ServiceableComponent<MetadataResolver> component = null;
+        throwComponentStateExceptions();        ServiceableComponent<MetadataResolver> component = null;
         try {
             component = service.getServiceableComponent();
             if (null == component) {
@@ -110,7 +106,7 @@ public class ReloadableMetadataResolver extends AbstractIdentifiableInitializabl
 
     /** {@inheritDoc} */
     @Override public boolean isRequireValidMetadata() {
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
+        throwComponentStateExceptions();
         ServiceableComponent<MetadataResolver> component = null;
         try {
             component = service.getServiceableComponent();
@@ -136,7 +132,7 @@ public class ReloadableMetadataResolver extends AbstractIdentifiableInitializabl
 
     /** {@inheritDoc} */
     @Override public MetadataFilter getMetadataFilter() {
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
+        throwComponentStateExceptions();
         ServiceableComponent<MetadataResolver> component = null;
         try {
             component = service.getServiceableComponent();
diff --git a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/security/impl/MetadataPKIXValidationInformationResolver.java b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/security/impl/MetadataPKIXValidationInformationResolver.java
index b9d2a77d7..6f5b614f8 100644
--- a/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/security/impl/MetadataPKIXValidationInformationResolver.java
+++ b/shib-metadata-impl/src/main/java/net/shibboleth/idp/saml/security/impl/MetadataPKIXValidationInformationResolver.java
@@ -28,17 +28,6 @@ import java.util.concurrent.locks.ReadWriteLock;
 import javax.annotation.Nonnull;
 import javax.xml.namespace.QName;
 
-import net.shibboleth.idp.saml.security.KeyAuthoritySupport;
-import net.shibboleth.idp.saml.xmlobject.KeyAuthority;
-import net.shibboleth.utilities.java.support.annotation.ParameterName;
-import net.shibboleth.utilities.java.support.collection.LockableClassToInstanceMultiMap;
-import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
-import net.shibboleth.utilities.java.support.component.ComponentSupport;
-import net.shibboleth.utilities.java.support.logic.Constraint;
-import net.shibboleth.utilities.java.support.primitive.StringSupport;
-import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
-import net.shibboleth.utilities.java.support.resolver.ResolverException;
-
 import org.opensaml.core.criterion.EntityIdCriterion;
 import org.opensaml.core.xml.XMLObject;
 import org.opensaml.saml.criterion.EntityRoleCriterion;
@@ -58,6 +47,16 @@ import org.opensaml.xmlsec.signature.KeyInfo;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import net.shibboleth.idp.saml.security.KeyAuthoritySupport;
+import net.shibboleth.idp.saml.xmlobject.KeyAuthority;
+import net.shibboleth.utilities.java.support.annotation.ParameterName;
+import net.shibboleth.utilities.java.support.collection.LockableClassToInstanceMultiMap;
+import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
+import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.StringSupport;
+import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
+import net.shibboleth.utilities.java.support.resolver.ResolverException;
+
 /**
  * An implementation of {@link PKIXValidationInformationResolver} which resolves {@link PKIXValidationInformation} based
  * on information stored in SAML 2 metadata. Validation information is retrieved from Shibboleth-specific metadata
@@ -111,8 +110,7 @@ public class MetadataPKIXValidationInformationResolver extends AbstractInitializ
     /** {@inheritDoc} */
     @Override public Iterable<PKIXValidationInformation> resolve(final CriteriaSet criteriaSet)
                             throws ResolverException {
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
-
+        throwComponentStateExceptions();
         checkCriteriaRequirements(criteriaSet);
 
         final String entityID = criteriaSet.get(EntityIdCriterion.class).getEntityId();
@@ -131,8 +129,7 @@ public class MetadataPKIXValidationInformationResolver extends AbstractInitializ
 
     /** {@inheritDoc} */
     @Override @Nonnull public Set<String> resolveTrustedNames(final CriteriaSet criteriaSet) throws ResolverException {
-        ComponentSupport.ifNotInitializedThrowUninitializedComponentException(this);
-
+        throwComponentStateExceptions();
         checkCriteriaRequirements(criteriaSet);
 
         final String entityID = criteriaSet.get(EntityIdCriterion.class).getEntityId();

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


More information about the commits mailing list