[java-oidc-common] branch main updated: Javadoc and annotation fixes
Phil Smart
philip.smart at jisc.ac.uk
Fri Apr 28 10:54:45 UTC 2023
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=55cd9679aa822e2737c309418b8c1a56d5c56333
The following commit(s) were added to refs/heads/main by this push:
new 55cd967 Javadoc and annotation fixes
55cd967 is described below
commit 55cd9679aa822e2737c309418b8c1a56d5c56333
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Apr 28 11:54:43 2023 +0100
Javadoc and annotation fixes
---
.../main/java/net/shibboleth/oidc/metadata/BackingStore.java | 4 ----
.../java/net/shibboleth/oidc/metadata/DynamicBackingStore.java | 2 +-
.../oidc/metadata/RefreshableProviderMetadataResolver.java | 5 ++---
.../net/shibboleth/oidc/metadata/cache/LoadingStrategy.java | 6 +++---
.../java/net/shibboleth/oidc/metadata/cache/MetadataCache.java | 2 +-
.../net/shibboleth/oidc/metadata/filter/MetadataFilter.java | 5 -----
.../oidc/metadata/cache/impl/AbstractMetadataCache.java | 10 ++++------
.../metadata/cache/impl/BatchMetadataCacheBuilderSpec.java | 2 +-
.../DefaultOIDCProviderMetadataExpirationTimeStrategy.java | 6 ++++--
.../shibboleth/oidc/metadata/impl/AbstractBackingStore.java | 5 ++---
.../oidc/metadata/impl/AbstractOIDCEntityResolver.java | 6 +++---
.../metadata/impl/AbstractReloadingOIDCEntityResolver.java | 7 +++++--
.../metadata/impl/FilesystemClientInformationResolver.java | 3 ++-
.../oidc/metadata/impl/FilesystemProviderMetadataResolver.java | 1 +
.../impl/ReloadingRelyingPartyClientInformationProvider.java | 1 -
15 files changed, 29 insertions(+), 36 deletions(-)
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/BackingStore.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/BackingStore.java
index 1b6253d..4fbbd71 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/BackingStore.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/BackingStore.java
@@ -44,8 +44,4 @@ public interface BackingStore<I, T> {
*/
@Nonnull List<T> getOrderedValues();
-
-
-
-
}
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
index 4bee3ea..350d25c 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/DynamicBackingStore.java
@@ -27,7 +27,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElemen
import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
-/** A dynamic version of a BackingStore.
+/** A dynamic version of a {@link BackingStore}.
*
* @param <I> the identifier type
* @param <T> the type of object stored, referenced by the key.
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/RefreshableProviderMetadataResolver.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/RefreshableProviderMetadataResolver.java
index f7e4d24..417dbcc 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/RefreshableProviderMetadataResolver.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/RefreshableProviderMetadataResolver.java
@@ -49,11 +49,10 @@ public interface RefreshableProviderMetadataResolver extends ProviderMetadataRes
/**
* Get the time that the currently available metadata was last updated. Note, this may be different than
- * the time retrieved by {@link #getLastRefresh()} is the metadata was known not to have changed during
+ * the time retrieved by {@link #getLastRefresh()} if the metadata was known not to have changed during
* the last refresh cycle.
*
- * @return time when the currently metadata was last updated, null if it has never successfully been read
- * in
+ * @return time when the currently metadata was last updated, {@code null} if it has never successfully been read
*/
@Nullable Instant getLastUpdate();
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 bfa07b0..ec79cdc 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
@@ -32,9 +32,9 @@ public interface LoadingStrategy {
/**
* Load cache data from a source. If the source data has not
- * changed from the last time it was loaded (as specified in the cache loading context) a
- * {@literal null} should be returned. If source data can not be loaded for a known
- * and accepted reason, a {@literal null} should be returned. For any other error in
+ * changed from the last time it was loaded (as specified in the {@link CacheLoadingContext}) a
+ * {@code null} should be returned. If source data can not be loaded for a known
+ * and accepted reason, a {@code null} should be returned. For any other error in
* loading cache data, the {@link CacheLoadingException} should be thrown.
*
* @param context the cache loading context
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 ada4725..dc097ed 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
@@ -29,7 +29,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* 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>
+ * as well as storage/eviction strategies.</p>
*
* <p>Implementations are intended to be access concurrently, and therefore are required to be thread-safe.</p>
*
diff --git a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/filter/MetadataFilter.java b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/filter/MetadataFilter.java
index 825e068..a226f29 100644
--- a/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/filter/MetadataFilter.java
+++ b/oidc-common-metadata-api/src/main/java/net/shibboleth/oidc/metadata/filter/MetadataFilter.java
@@ -25,11 +25,6 @@ import javax.annotation.Nullable;
* A metadata filter is used to process a metadata document after it has been acquired from a metadata source.
*
* <p>
- * Some example SAML filters might remove everything but identity providers roles, decreasing the
- * data a service provider needs to work with, or a filter could be used to perform integrity checking
- * on the retrieved metadata by verifying a digital signature.
- * </p>
- * <p>
* Some example OIDC filters might throw a filter exception or return null if the metadata no longer
* supports, for example, the ES-algorithms.
* </p>
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/AbstractMetadataCache.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/AbstractMetadataCache.java
index 8a987d2..34d6310 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/AbstractMetadataCache.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/AbstractMetadataCache.java
@@ -175,7 +175,7 @@ public abstract class AbstractMetadataCache<IdentifierType, MetadataType>
// create a schedular for thread tasks.
if (createOwnSchedular) {
// Use thread builder to allow setting threads as deamon and a name.
- // Set as deamon background threads. Do not prevent JVM exit.
+ // Set as deamon background threads -do not prevent JVM exit.
executorService = Executors.newSingleThreadScheduledExecutor(
new ThreadFactoryBuilder().setDaemon(true).setNameFormat(TimerSupport.getTimerName(this)+"-%d")
.build());
@@ -367,8 +367,8 @@ public abstract class AbstractMetadataCache<IdentifierType, MetadataType>
}
/**
- * Lookup the specified entityID from the index. The returned list will be a copy of what is stored in the backing
- * index, and is safe to be manipulated by callers.
+ * Lookup the specified identifier from the index. The returned list will be a copy of what is stored in the backing
+ * index and is safe to be manipulated by callers.
*
* @param identifier the identifier to lookup
*
@@ -472,7 +472,7 @@ public abstract class AbstractMetadataCache<IdentifierType, MetadataType>
}
/**
- * Determine if the metadata has expired based on the expiration time set in the managment metadata.
+ * Determine if the metadata has expired based on the expiration time set in the management metadata.
*
* @param mgmtData management data
*
@@ -506,8 +506,6 @@ public abstract class AbstractMetadataCache<IdentifierType, MetadataType>
* Remove/discard all metadata for the backing store.
*
* <p>Ensure thread-safety is observed in the calling method.</p>
- *
- * TODO check lock.
*/
protected void invalidateAll() {
backingStore.getIndexedValues().clear();
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilderSpec.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilderSpec.java
index c60a1d7..5c1ace2 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilderSpec.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/BatchMetadataCacheBuilderSpec.java
@@ -34,7 +34,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
import net.shibboleth.utilities.java.support.logic.Constraint;
/**
- * A specification for building a batch based read-ahead metadata cache.
+ * A specification for building a batch read-ahead metadata cache.
*
* @param <IdentifierType> The metadata identifier type.
* @param <MetadataType> the metadata type.
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultOIDCProviderMetadataExpirationTimeStrategy.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultOIDCProviderMetadataExpirationTimeStrategy.java
index 4182a84..a2d5349 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultOIDCProviderMetadataExpirationTimeStrategy.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/cache/impl/DefaultOIDCProviderMetadataExpirationTimeStrategy.java
@@ -26,8 +26,10 @@ import com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata;
import net.shibboleth.oidc.metadata.cache.ExpirationTimeContext;
-/** Strategy for computing an expiry time for {@link OIDCProviderMetadata}.
- * Defaults to now plus the max cache duration.*/
+/**
+ * Strategy for computing an expiry time for {@link OIDCProviderMetadata}.
+ * Defaults to now plus the max cache duration.
+ */
public class DefaultOIDCProviderMetadataExpirationTimeStrategy
implements Function<ExpirationTimeContext<OIDCProviderMetadata>, Instant> {
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractBackingStore.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractBackingStore.java
index 222edc1..e6f323b 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractBackingStore.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractBackingStore.java
@@ -37,12 +37,11 @@ import net.shibboleth.oidc.metadata.BackingStore;
public abstract class AbstractBackingStore<I, T> implements BackingStore<I, T> {
/** Index of entity IDs to their descriptors. */
- private Map<I, List<T>> indexedValues;
+ @Nonnull private final Map<I, List<T>> indexedValues;
/** Ordered list of entity descriptors. */
- private List<T> orderedValues;
+ @Nonnull private final List<T> orderedValues;
-
/**
* Constructor.
*/
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCEntityResolver.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCEntityResolver.java
index a3ef4af..de3c6ed 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCEntityResolver.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractOIDCEntityResolver.java
@@ -67,7 +67,7 @@ public abstract class AbstractOIDCEntityResolver<Key extends Identifier, Value>
/**
* Constructor.
*/
- public AbstractOIDCEntityResolver() {
+ protected AbstractOIDCEntityResolver() {
failFastInitialization = true;
}
@@ -262,10 +262,10 @@ public abstract class AbstractOIDCEntityResolver<Key extends Identifier, Value>
protected class JsonBackingStore {
/** Index of identifiers to their entity information. */
- private Map<Key, List<Value>> indexedEntities;
+ private final Map<Key, List<Value>> indexedEntities;
/** Ordered list of entity information. */
- private List<Value> orderedEntitiess;
+ private final List<Value> orderedEntitiess;
/** Constructor. */
protected JsonBackingStore() {
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractReloadingOIDCEntityResolver.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractReloadingOIDCEntityResolver.java
index 1bf5ac0..a5b69c4 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractReloadingOIDCEntityResolver.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/AbstractReloadingOIDCEntityResolver.java
@@ -41,6 +41,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
/**
+ * Base class for metadata providers that cache and periodically refresh their entities.
* Based on {@link org.opensaml.saml.metadata.resolver.impl.AbstractReloadingMetadataResolver}.
*
* @param <Key> The identifier type in the backing store
@@ -99,6 +100,7 @@ public abstract class AbstractReloadingOIDCEntityResolver<Key extends Identifier
}
}
+ @Override
protected void initOIDCResolver() throws ComponentInitializationException {
super.initOIDCResolver();
try {
@@ -243,11 +245,12 @@ public abstract class AbstractReloadingOIDCEntityResolver<Key extends Identifier
/**
* Fetches metadata from a source.
*
- * @return the fetched metadata, or null if the metadata is known not to have changed since the last retrieval
+ * @return the fetched metadata, or {@code null} if the metadata is known not to have changed since the last
+ * retrieval
*
* @throws ResolverException thrown if there is a problem fetching the metadata
*/
- protected abstract byte[] fetchMetadata() throws ResolverException;
+ @Nullable protected abstract byte[] fetchMetadata() throws ResolverException;
/** Background task that refreshes metadata. */
private class RefreshMetadataTask extends TimerTask {
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemClientInformationResolver.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemClientInformationResolver.java
index c03b4ca..3b899de 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemClientInformationResolver.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemClientInformationResolver.java
@@ -47,6 +47,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
/**
+ * An OIDC metadata provider that pulls client metadata from a file on the local filesystem.
* Based on {@link org.opensaml.saml.metadata.resolver.impl.FilesystemMetadataResolver}.
*/
public class FilesystemClientInformationResolver extends AbstractFileOIDCEntityResolver<ClientID, OIDCClientInformation>
@@ -142,7 +143,7 @@ public class FilesystemClientInformationResolver extends AbstractFileOIDCEntityR
}
try {
final JSONArray parsedArray = JSONArrayUtils.parse(rawString);
- final List<OIDCClientInformation> result = new ArrayList<OIDCClientInformation>();
+ final List<OIDCClientInformation> result = new ArrayList<>();
for (final Object object : parsedArray) {
final OIDCClientInformation client = OIDCClientInformation.parse((JSONObject) object);
result.add(client);
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemProviderMetadataResolver.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemProviderMetadataResolver.java
index c34f75a..0736de2 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemProviderMetadataResolver.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/FilesystemProviderMetadataResolver.java
@@ -47,6 +47,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
/**
+ * An OIDC metadata provider that pulls provider metadata from a file on the local filesystem.
* Based on {@link org.opensaml.saml.metadata.resolver.impl.FilesystemMetadataResolver}.
*/
public class FilesystemProviderMetadataResolver extends AbstractFileOIDCEntityResolver<Issuer, OIDCProviderMetadata>
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ReloadingRelyingPartyClientInformationProvider.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ReloadingRelyingPartyClientInformationProvider.java
index 7134c03..552e92f 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ReloadingRelyingPartyClientInformationProvider.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ReloadingRelyingPartyClientInformationProvider.java
@@ -38,7 +38,6 @@ import net.shibboleth.utilities.java.support.service.ServiceableComponent;
/**
* This class uses the service interface to implement {@link ClientInformationResolver}.
- * Based on net.shibboleth.idp.saml.metadata.impl.ReloadingRelyingPartyMetadataProvider.
*/
public class ReloadingRelyingPartyClientInformationProvider extends AbstractIdentifiableInitializableComponent
implements ClientInformationResolver {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list