[java-oidc-common] branch main updated: Javadoc fixes

[Phil Smart]

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

philsmart pushed a commit to branch main
in repository java-oidc-common.

View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=38476922ad9f57dda5185d83c1344fec6f4785e5

The following commit(s) were added to refs/heads/main by this push:
     new 3847692  Javadoc fixes
3847692 is described below

commit 38476922ad9f57dda5185d83c1344fec6f4785e5
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Tue Feb 22 17:29:44 2022 +0000

    Javadoc fixes
---
 .../java/net/shibboleth/oidc/metadata/cache/LoadingStrategy.java   | 5 ++++-
 .../java/net/shibboleth/oidc/metadata/cache/MetadataCache.java     | 7 +++++--
 .../cache/impl/DefaultSourceMetadataExpirationTimeStrategy.java    | 2 +-
 3 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/LoadingStrategy.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/LoadingStrategy.java
index f087ead..b2037bd 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/LoadingStrategy.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/LoadingStrategy.java
@@ -2,6 +2,9 @@ package net.shibboleth.oidc.metadata.cache;
 
 import java.util.function.Function;
 
+import javax.annotation.Nonnull;
+
+/** A strategy that loads binary information from a configured source.*/
 public interface LoadingStrategy extends Function<CacheLoadingContext, byte[]> {
     
     /**
@@ -9,6 +12,6 @@ public interface LoadingStrategy extends Function<CacheLoadingContext, byte[]> {
      * 
      * @return the source identifier friendly name.
      */
-    String getSourceIdentifier();
+    @Nonnull String getSourceIdentifier();
 
 }
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/MetadataCache.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/MetadataCache.java
index 186f09e..582c7cc 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/MetadataCache.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/cache/MetadataCache.java
@@ -27,9 +27,12 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
 import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
 
 /**
- * A metadata cache. 
+ * A cache for loading, storing, and retrieving metadata against against the supplied {@link CriteriaSet}.
+ *  
+ * <p>Implementations can choose the specific cache semantics implemented e.g. read-through, refresh-ahead etc.
+ * and storage/eviction strategies.</p>
  * 
- * TODO: finish
+ * <p>Implementations are intended to be access concurrently, and therefore are required to be thread-safe.</p>
  *
  * @param <U> The metadata type.
  */
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultSourceMetadataExpirationTimeStrategy.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultSourceMetadataExpirationTimeStrategy.java
index e7f6972..cb9946e 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultSourceMetadataExpirationTimeStrategy.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultSourceMetadataExpirationTimeStrategy.java
@@ -26,7 +26,7 @@ import javax.annotation.Nonnull;
 import net.shibboleth.utilities.java.support.logic.Constraint;
 
 /** 
- * Simple strategy for computing an expiry time for source byte metadata: it adds configurable duration to Now.
+ * Simple strategy for computing an expiry time by adding an expiry duration to the current time.
  */
 public class DefaultSourceMetadataExpirationTimeStrategy 
                         implements Function<byte[], Instant> {

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