[java-opensaml] 03/03: OSJ-237: Support refreshing API on dynamic metadata plugins
Brent Putman
putmanb at georgetown.edu
Fri Sep 14 22:54:23 EDT 2018
This is an automated email from the git hooks/post-receive script.
putmanb pushed a commit to branch master
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=6f6a271a0dc09a982fa1aaec8e1c7dcae9ce99fa
commit 6f6a271a0dc09a982fa1aaec8e1c7dcae9ce99fa
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Fri Sep 14 22:31:34 2018 -0400
OSJ-237: Support refreshing API on dynamic metadata plugins
---
.../resolver/ChainingMetadataResolver.java | 20 ++++++++-
.../resolver/ClearableMetadataResolver.java | 51 ++++++++++++++++++++++
.../impl/AbstractDynamicMetadataResolver.java | 40 ++++++++++++++++-
.../resolver/impl/CompositeMetadataResolver.java | 21 ++++++++-
.../impl/AbstractDynamicMetadataResolverTest.java | 51 ++++++++++++++++++++++
5 files changed, 180 insertions(+), 3 deletions(-)
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ChainingMetadataResolver.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ChainingMetadataResolver.java
index b8a256f..66c4f6b 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ChainingMetadataResolver.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ChainingMetadataResolver.java
@@ -51,7 +51,7 @@ import com.google.common.collect.ImmutableList;
* the registered resolvers in resolver list order.
*/
public class ChainingMetadataResolver extends AbstractIdentifiableInitializableComponent implements MetadataResolver,
- RefreshableMetadataResolver {
+ RefreshableMetadataResolver, ClearableMetadataResolver {
/** Class logger. */
@Nonnull private final Logger log = LoggerFactory.getLogger(ChainingMetadataResolver.class);
@@ -150,6 +150,24 @@ public class ChainingMetadataResolver extends AbstractIdentifiableInitializableC
return Collections.emptyList();
}
+
+ /** {@inheritDoc} */
+ public void clear() throws ResolverException {
+ for (final MetadataResolver resolver : resolvers) {
+ if (resolver instanceof ClearableMetadataResolver) {
+ ((ClearableMetadataResolver) resolver).clear();
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ public void clear(String entityID) throws ResolverException {
+ for (final MetadataResolver resolver : resolvers) {
+ if (resolver instanceof ClearableMetadataResolver) {
+ ((ClearableMetadataResolver) resolver).clear(entityID);
+ }
+ }
+ }
/** {@inheritDoc} */
@Override public void refresh() throws ResolverException {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ClearableMetadataResolver.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ClearableMetadataResolver.java
new file mode 100644
index 0000000..415a32f
--- /dev/null
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/ClearableMetadataResolver.java
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the University Corporation for Advanced Internet Development,
+ * Inc. (UCAID) under one or more contributor license agreements. See the
+ * NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The UCAID licenses this file to You under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.opensaml.saml.metadata.resolver;
+
+import javax.annotation.Nonnull;
+
+import net.shibboleth.utilities.java.support.resolver.ResolverException;
+
+/**
+ * Specialization of {@link MetadataResolver} that supports on-demand clearing of the resolver's
+ * internal cache of data.
+ *
+ * <p>
+ * This would typically be implemented by "dynamic" resolvers of metadata such as {@link DynamicMetadataResolver},
+ * rather than "batch" resolvers such as {@link BatchMetadataResolver}.
+ * </p>
+ */
+public interface ClearableMetadataResolver extends MetadataResolver {
+
+ /**
+ * Attempt to clear all data from the internal cache of the resolver.
+ *
+ * @throws ResolverException if the clear operation was unsuccessful
+ */
+ void clear() throws ResolverException;
+
+ /**
+ * Attempt to clear data from the internal cache of the resolver for the specified entityID.
+ *
+ * @param entityID the target entityID
+ *
+ * @throws ResolverException if the clear operation was unsuccessful
+ */
+ void clear(@Nonnull final String entityID) throws ResolverException;
+
+}
\ No newline at end of file
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
index 23fc174..daae4fb 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
@@ -43,7 +43,9 @@ import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.core.xml.persist.XMLObjectLoadSaveManager;
import org.opensaml.core.xml.util.XMLObjectSupport;
import org.opensaml.core.xml.util.XMLObjectSupport.CloneOutputOption;
+import org.opensaml.saml.metadata.resolver.ClearableMetadataResolver;
import org.opensaml.saml.metadata.resolver.DynamicMetadataResolver;
+import org.opensaml.saml.metadata.resolver.MetadataResolver;
import org.opensaml.saml.metadata.resolver.filter.FilterException;
import org.opensaml.saml.saml2.common.SAML2Support;
import org.opensaml.saml.saml2.metadata.EntityDescriptor;
@@ -80,7 +82,7 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* Abstract subclass for metadata resolvers that resolve metadata dynamically, as needed and on demand.
*/
public abstract class AbstractDynamicMetadataResolver extends AbstractMetadataResolver
- implements DynamicMetadataResolver {
+ implements DynamicMetadataResolver, ClearableMetadataResolver {
/** Metric name for the timer for {@link #fetchFromOriginSource(CriteriaSet)}. */
public static final String METRIC_TIMER_FETCH_FROM_ORIGIN_SOURCE = "timer.fetchFromOriginSource";
@@ -526,6 +528,42 @@ public abstract class AbstractDynamicMetadataResolver extends AbstractMetadataRe
ComponentSupport.ifDestroyedThrowDestroyedComponentException(this);
metricsBaseName = StringSupport.trimOrNull(baseName);
}
+
+ /** {@inheritDoc} */
+ public void clear() throws ResolverException {
+ final DynamicEntityBackingStore backingStore = getBackingStore();
+ final Map<String, List<EntityDescriptor>> indexedDescriptors = backingStore.getIndexedDescriptors();
+
+ for (final String entityID : indexedDescriptors.keySet()) {
+ final EntityManagementData mgmtData = backingStore.getManagementData(entityID);
+ final Lock writeLock = mgmtData.getReadWriteLock().writeLock();
+ try {
+ writeLock.lock();
+
+ removeByEntityID(entityID, backingStore);
+ backingStore.removeManagementData(entityID);
+
+ } finally {
+ writeLock.unlock();
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ public void clear(@Nonnull final String entityID) throws ResolverException {
+ final DynamicEntityBackingStore backingStore = getBackingStore();
+ final EntityManagementData mgmtData = backingStore.getManagementData(entityID);
+ final Lock writeLock = mgmtData.getReadWriteLock().writeLock();
+ try {
+ writeLock.lock();
+
+ removeByEntityID(entityID, backingStore);
+ backingStore.removeManagementData(entityID);
+
+ } finally {
+ writeLock.unlock();
+ }
+ }
/** {@inheritDoc} */
@Override
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/CompositeMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/CompositeMetadataResolver.java
index 41201ff..2ce3425 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/CompositeMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/CompositeMetadataResolver.java
@@ -35,6 +35,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
import org.joda.time.DateTime;
+import org.opensaml.saml.metadata.resolver.ClearableMetadataResolver;
import org.opensaml.saml.metadata.resolver.MetadataResolver;
import org.opensaml.saml.metadata.resolver.RefreshableMetadataResolver;
import org.opensaml.saml.metadata.resolver.filter.MetadataFilter;
@@ -52,7 +53,7 @@ import com.google.common.collect.Iterables;
* {@link MetadataResolver}s.
*/
public class CompositeMetadataResolver extends AbstractIdentifiedInitializableComponent implements MetadataResolver,
- RefreshableMetadataResolver {
+ RefreshableMetadataResolver, ClearableMetadataResolver {
/** Class logger. */
@Nonnull private final Logger log = LoggerFactory.getLogger(CompositeMetadataResolver.class);
@@ -151,6 +152,24 @@ public class CompositeMetadataResolver extends AbstractIdentifiedInitializableCo
resolvers = Collections.emptyList();
}
+
+ /** {@inheritDoc} */
+ public void clear() throws ResolverException {
+ for (final MetadataResolver resolver : resolvers) {
+ if (resolver instanceof ClearableMetadataResolver) {
+ ((ClearableMetadataResolver) resolver).clear();
+ }
+ }
+ }
+
+ /** {@inheritDoc} */
+ public void clear(String entityID) throws ResolverException {
+ for (final MetadataResolver resolver : resolvers) {
+ if (resolver instanceof ClearableMetadataResolver) {
+ ((ClearableMetadataResolver) resolver).clear(entityID);
+ }
+ }
+ }
/** {@inheritDoc} */
@Override public void refresh() throws ResolverException {
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolverTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolverTest.java
index 70b86f8..a290657 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolverTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolverTest.java
@@ -195,6 +195,57 @@ public class AbstractDynamicMetadataResolverTest extends XMLObjectBaseTestCase {
}
@Test
+ public void testClear() throws ComponentInitializationException, ResolverException {
+ sourceMap.put(id1, ed1);
+ sourceMap.put(id2, ed2);
+ sourceMap.put(id3, ed3);
+
+ resolver.initialize();
+
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id1))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id2))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id3))));
+
+ DynamicEntityBackingStore backingStore = resolver.getBackingStore();
+
+ resolver.clear();
+
+ Assert.assertFalse(backingStore.getIndexedDescriptors().containsKey(id1));
+ Assert.assertFalse(backingStore.getIndexedDescriptors().containsKey(id2));
+ Assert.assertFalse(backingStore.getIndexedDescriptors().containsKey(id3));
+
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id1))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id2))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id3))));
+ }
+
+ @Test
+ public void testClearByEntityID() throws ComponentInitializationException, ResolverException {
+ sourceMap.put(id1, ed1);
+ sourceMap.put(id2, ed2);
+ sourceMap.put(id3, ed3);
+
+ resolver.initialize();
+
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id1))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id2))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id3))));
+
+ DynamicEntityBackingStore backingStore = resolver.getBackingStore();
+
+ resolver.clear(id1);
+ resolver.clear(id2);
+
+ Assert.assertFalse(backingStore.getIndexedDescriptors().containsKey(id1));
+ Assert.assertFalse(backingStore.getIndexedDescriptors().containsKey(id2));
+ Assert.assertTrue(backingStore.getIndexedDescriptors().containsKey(id3));
+
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id1))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id2))));
+ Assert.assertNotNull(resolver.resolveSingle(new CriteriaSet(new EntityIdCriterion(id3))));
+ }
+
+ @Test
public void testDOMDropFromFetch() throws ComponentInitializationException, ResolverException {
sourceMap.put(id1, ed1);
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list