[java-idp-plugin-webauthn] branch main updated: Add since tags, improve Javadoc
Phil Smart
philip.smart at jisc.ac.uk
Mon Jul 21 16:24:59 UTC 2025
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch main
in repository java-idp-plugin-webauthn.
View the commit online:
http://git.shibboleth.net/view/?p=java-idp-plugin-webauthn.git;a=commit;h=cd7f73ecfdc892198d1c1dab16351d690e4d71f0
The following commit(s) were added to refs/heads/main by this push:
new cd7f73e Add since tags, improve Javadoc
cd7f73e is described below
commit cd7f73ecfdc892198d1c1dab16351d690e4d71f0
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Mon Jul 21 17:24:57 2025 +0100
Add since tags, improve Javadoc
---
.../authn/webauthn/audit/impl/AbstractWebAuthnAuditingAction.java | 4 ++++
.../idp/plugin/authn/webauthn/storage/impl/CacheService.java | 2 ++
.../idp/plugin/authn/webauthn/storage/impl/CacheServiceImpl.java | 2 ++
.../plugin/authn/webauthn/storage/impl/DisabledCacheServiceImpl.java | 2 ++
.../idp/plugin/authn/webauthn/storage/impl/QueryByAllStrategy.java | 2 ++
.../authn/webauthn/storage/impl/QueryByCredentialIdStrategy.java | 2 ++
.../plugin/authn/webauthn/storage/impl/QueryByUserHandleStrategy.java | 2 ++
.../authn/webauthn/storage/impl/ReadAllCacheLoadingStrategy.java | 2 ++
.../storage/impl/StorageServiceCredentialRepositoryFactory.java | 2 ++
.../impl/StrategyBasedIdPStorageServiceCredentialRepository.java | 2 ++
.../plugin/authn/webauthn/storage/impl/WebAuthnJDBCAccelerator.java | 2 ++
.../authn/webauthn/storage/impl/WebAuthnJDBCAcceleratorImpl.java | 2 ++
.../authn/webauthn/storage/impl/WebAuthnJDBCQueryAccelerator.java | 2 ++
.../authn/webauthn/storage/impl/WebAuthnJDBCReadAllAccelerator.java | 4 +++-
.../plugin/authn/webauthn/storage/impl/WebAuthnJDBCStorageRecord.java | 2 ++
15 files changed, 33 insertions(+), 1 deletion(-)
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/audit/impl/AbstractWebAuthnAuditingAction.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/audit/impl/AbstractWebAuthnAuditingAction.java
index fbf20c4..b21109f 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/audit/impl/AbstractWebAuthnAuditingAction.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/audit/impl/AbstractWebAuthnAuditingAction.java
@@ -163,6 +163,8 @@ public abstract class AbstractWebAuthnAuditingAction<T> extends AbstractWebAuthn
*
* @param profileRequestContext the profile request context
* @param action a descriptive string of the action that was performed. Can be {@code null} if not used.
+ *
+ * @since 1.3.0
*/
protected void auditSuccess(@Nonnull final ProfileRequestContext profileRequestContext,
@Nullable final String action) {
@@ -176,6 +178,8 @@ public abstract class AbstractWebAuthnAuditingAction<T> extends AbstractWebAuthn
*
* @param profileRequestContext the profile request context
* @param action a descriptive string of the action that was performed. Can be {@code null} if not used.
+ *
+ * @since 1.3.0
*/
protected void auditFailure(@Nonnull final ProfileRequestContext profileRequestContext,
@Nullable final String action) {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheService.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheService.java
index c8a57bb..5a82af2 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheService.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheService.java
@@ -23,6 +23,8 @@ import net.shibboleth.idp.plugin.authn.webauthn.storage.CredentialRecord;
/**
* A cache facade that handles the consistent conversation between {@link CredentialRecord}s and cache entries.
+ *
+ * @since 1.3.0
*/
public interface CacheService {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheServiceImpl.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheServiceImpl.java
index b285eae..1243443 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheServiceImpl.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CacheServiceImpl.java
@@ -31,6 +31,8 @@ import net.shibboleth.shared.primitive.LoggerFactory;
/**
* An implementation of a {@link CacheService} that handles the consistent conversation between
* {@link CredentialRecord}s and username cache entries using the supplied strategies.
+ *
+ * @since 1.3.0
*/
public final class CacheServiceImpl implements CacheService {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/DisabledCacheServiceImpl.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/DisabledCacheServiceImpl.java
index 7a2bdf7..1c771c2 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/DisabledCacheServiceImpl.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/DisabledCacheServiceImpl.java
@@ -22,6 +22,8 @@ import net.shibboleth.idp.plugin.authn.webauthn.storage.CredentialRecord;
/**
* A no-op implementation of a {@link CacheService}. Constructed if the cache service is effectively disabled.
+ *
+ * @since 1.3.0
*/
public class DisabledCacheServiceImpl implements CacheService {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByAllStrategy.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByAllStrategy.java
index 3334084..80b61a6 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByAllStrategy.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByAllStrategy.java
@@ -31,6 +31,8 @@ import net.shibboleth.shared.logic.Constraint;
/**
* A query strategy that loads all known credentials from the datasource based on the storage context label.
+ *
+ * @since 1.3.0
*/
public class QueryByAllStrategy implements BiFunction<String, ByteArray, List<StorageRecord<Set<CredentialRecord>>>>{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByCredentialIdStrategy.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByCredentialIdStrategy.java
index 12e9e13..b70a96f 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByCredentialIdStrategy.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByCredentialIdStrategy.java
@@ -32,6 +32,8 @@ import net.shibboleth.shared.logic.Constraint;
/**
* A query strategy that uses the specialised query functionality of the {@link WebAuthnJDBCQueryAccelerator} to
* load credentials from the datasource with the given credentialId.
+ *
+ * @since 1.3.0
*/
public class QueryByCredentialIdStrategy
implements BiFunction<String, ByteArray, List<StorageRecord<Set<CredentialRecord>>>>{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByUserHandleStrategy.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByUserHandleStrategy.java
index 09091ce..33885dd 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByUserHandleStrategy.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/QueryByUserHandleStrategy.java
@@ -32,6 +32,8 @@ import net.shibboleth.shared.logic.Constraint;
/**
* A query strategy that uses the specialised query functionality of the {@link WebAuthnJDBCQueryAccelerator} to
* load credentials from the datasource with the given userHandle.
+ *
+ * @since 1.3.0
*/
public class QueryByUserHandleStrategy
implements BiFunction<String, ByteArray, List<StorageRecord<Set<CredentialRecord>>>>{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/ReadAllCacheLoadingStrategy.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/ReadAllCacheLoadingStrategy.java
index a9f182f..ab74c7b 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/ReadAllCacheLoadingStrategy.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/ReadAllCacheLoadingStrategy.java
@@ -31,6 +31,8 @@ import net.shibboleth.shared.primitive.LoggerFactory;
/**
* A cache loading strategy that loads all known credentials from the datasource.
+ *
+ * @since 1.3.0
*/
public class ReadAllCacheLoadingStrategy implements Function<String, List<StorageRecord<Set<CredentialRecord>>>>{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StorageServiceCredentialRepositoryFactory.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StorageServiceCredentialRepositoryFactory.java
index 233490c..87acfe0 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StorageServiceCredentialRepositoryFactory.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StorageServiceCredentialRepositoryFactory.java
@@ -51,6 +51,8 @@ import net.shibboleth.shared.primitive.LoggerFactory;
* If a {@link WebAuthnJDBCQueryAccelerator} has been injected, the
* {@link StrategyBasedIdPStorageServiceCredentialRepository} will be instantiated, else the
* {@link IdPStorageServiceCredentialRepository} is instantiated.
+ *
+ * @since 1.3.0
*/
@ThreadSafe
public class StorageServiceCredentialRepositoryFactory extends AbstractInitializableComponent
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StrategyBasedIdPStorageServiceCredentialRepository.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StrategyBasedIdPStorageServiceCredentialRepository.java
index 75bbe02..e73e81a 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StrategyBasedIdPStorageServiceCredentialRepository.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/StrategyBasedIdPStorageServiceCredentialRepository.java
@@ -42,6 +42,8 @@ import net.shibboleth.shared.primitive.LoggerFactory;
/**
* An extension of the {@link IdPStorageServiceCredentialRepository} that utalizes specialised
* lookup functions to improve the performance of userHandle and credentialId lookup operations.
+ *
+ * @since 1.3.0
*/
@ThreadSafeAfterInit
public class StrategyBasedIdPStorageServiceCredentialRepository extends IdPStorageServiceCredentialRepository {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAccelerator.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAccelerator.java
index 956b16b..54d7d3a 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAccelerator.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAccelerator.java
@@ -16,6 +16,8 @@ package net.shibboleth.idp.plugin.authn.webauthn.storage.impl;
/**
* A marker interface for a JDBC query accelerator that improves the performance of lookup operations.
+ *
+ * @since 1.3.0
*/
public interface WebAuthnJDBCAccelerator {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAcceleratorImpl.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAcceleratorImpl.java
index b31af29..ecf64e3 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAcceleratorImpl.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCAcceleratorImpl.java
@@ -53,6 +53,8 @@ import net.shibboleth.shared.primitive.StringSupport;
* Implementation of a {@link WebAuthnJDBCQueryAccelerator} and {@link WebAuthnJDBCReadAllAccelerator} that uses
* specialized queries to lookup credentials by userHandle and credentialId. The default queries are suitable for MySQL
* only.
+ *
+ * @since 1.3.0
*/
public final class WebAuthnJDBCAcceleratorImpl extends AbstractIdentifiableInitializableComponent
implements WebAuthnJDBCQueryAccelerator, WebAuthnJDBCReadAllAccelerator {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCQueryAccelerator.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCQueryAccelerator.java
index f03caf4..17fd06a 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCQueryAccelerator.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCQueryAccelerator.java
@@ -29,6 +29,8 @@ import net.shibboleth.shared.annotation.constraint.Unmodifiable;
/**
* An accelerator for JDBC queries to improve the performance of lookup operations that search for non-indexed fields,
* namely; userHandle and credentialId.
+ *
+ * @since 1.3.0
*/
public interface WebAuthnJDBCQueryAccelerator extends WebAuthnJDBCAccelerator {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCReadAllAccelerator.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCReadAllAccelerator.java
index ddec83e..ad7210a 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCReadAllAccelerator.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCReadAllAccelerator.java
@@ -25,7 +25,9 @@ import net.shibboleth.shared.annotation.constraint.NonnullElements;
import net.shibboleth.shared.annotation.constraint.NotEmpty;
/**
- * An accelerator for JDBC queries to improve the performance of lookup operations.
+ * An accelerator for JDBC queries to improve the performance of lookup operations.
+ *
+ * @since 1.3.0
*/
public interface WebAuthnJDBCReadAllAccelerator extends WebAuthnJDBCAccelerator{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCStorageRecord.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCStorageRecord.java
index 7cbad79..a9d1939 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCStorageRecord.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/WebAuthnJDBCStorageRecord.java
@@ -25,6 +25,8 @@ import net.shibboleth.shared.annotation.constraint.NotEmpty;
* This is notable in that it allows creation with a specified version (from
* the database).
* @param <T> type of record
+ *
+ * @since 1.3.0
*/
class WebAuthnJDBCStorageRecord<T> extends MutableStorageRecord<T> {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list