[java-idp-plugin-webauthn] branch main updated: Javadoc cleanup
Phil Smart
philip.smart at jisc.ac.uk
Thu Jul 31 11:26:42 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=c085d0326d856ca6cabeaa366fb53d8b9c9abecd
The following commit(s) were added to refs/heads/main by this push:
new c085d03 Javadoc cleanup
c085d03 is described below
commit c085d0326d856ca6cabeaa366fb53d8b9c9abecd
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Jul 31 12:26:40 2025 +0100
Javadoc cleanup
---
.../webauthn/audit/impl/AbstractWebAuthnAuditingAction.java | 4 ++--
.../idp/plugin/authn/webauthn/storage/impl/CacheService.java | 4 ++--
.../plugin/authn/webauthn/storage/impl/CacheServiceImpl.java | 2 +-
.../storage/impl/CredentialRegistrationSerializer.java | 2 +-
.../storage/impl/IdPStorageServiceCredentialRepository.java | 10 +++++-----
.../impl/StorageServiceCredentialRepositoryFactory.java | 3 +--
.../main/resources/META-INF/net.shibboleth.idp/postconfig.xml | 3 +--
.../idp/plugin/authn/webauthn/conf/authn/webauthn.properties | 2 +-
8 files changed, 14 insertions(+), 16 deletions(-)
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 b21109f..42edead 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
@@ -56,10 +56,10 @@ public abstract class AbstractWebAuthnAuditingAction<T> extends AbstractWebAuthn
/** The Spring RequestContext to operate on. */
@Nullable private RequestContext requestContext;
- /** A hook to be executed during a success audit even.*/
+ /** A hook to be executed during a success audit event.*/
@Nonnull private BiConsumer<ProfileRequestContext, String> onSuccessAuditHook;
- /** A hook to be executed during a failure audit even.*/
+ /** A hook to be executed during a failure audit event.*/
@Nonnull private BiConsumer<ProfileRequestContext, String> onFailureAuditHook;
/**
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 5a82af2..f6a58c6 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
@@ -22,7 +22,7 @@ import com.yubico.webauthn.data.ByteArray;
import net.shibboleth.idp.plugin.authn.webauthn.storage.CredentialRecord;
/**
- * A cache facade that handles the consistent conversation between {@link CredentialRecord}s and cache entries.
+ * A cache facade that handles the consistent conversion between {@link CredentialRecord}s and cache entries.
*
* @since 1.3.0
*/
@@ -33,7 +33,7 @@ public interface CacheService {
* cached value.
*
* @param key the key to use
- * @return the username associated with userHandle in the cache, or {@code null} if no mapping is found.
+ * @return the username associated with key in the cache, or {@code null} if no mapping is found.
*/
@Nullable String getIfPresent(@Nonnull final ByteArray key);
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 1243443..251251f 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
@@ -29,7 +29,7 @@ import net.shibboleth.shared.logic.Constraint;
import net.shibboleth.shared.primitive.LoggerFactory;
/**
- * An implementation of a {@link CacheService} that handles the consistent conversation between
+ * An implementation of a {@link CacheService} that handles the consistent conversion between
* {@link CredentialRecord}s and username cache entries using the supplied strategies.
*
* @since 1.3.0
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CredentialRegistrationSerializer.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CredentialRegistrationSerializer.java
index 0c8726e..a209df1 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CredentialRegistrationSerializer.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/CredentialRegistrationSerializer.java
@@ -39,7 +39,7 @@ import net.shibboleth.shared.component.AbstractInitializableComponent;
/**
- * Serialize the WebauthnPublicKeyCredentialRecord to a string using base64URL encoding.
+ * Serialize the set of CredentialRecords to a JSON string.
*/
public class CredentialRegistrationSerializer extends AbstractInitializableComponent
implements StorageSerializer<Set<CredentialRecord>> {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRepository.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRepository.java
index 5b83cdb..d162aea 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRepository.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRepository.java
@@ -71,9 +71,9 @@ import net.shibboleth.shared.primitive.LoggerFactory;
* <p>Any exception is wrapped in an unchecked {@link CredentialRepositoryException}. If the caller does not deem
* this terminal, they should catch and handle that error appropriately.</p>
*
- * <p>Username mappings are stored in two different caches. The first stores userHandle to username mappings, the second
- * stores credentialId to username mappings. The cache is updated immediately after a lookup or add operation.
- * Cache entries are removed only when they are found to be invalid on lookup.</p>
+ * <p>Secondary username indexes are stored in two different caches. The first stores userHandle to username mappings,
+ * the second stores credentialId to username mappings. The cache is updated immediately after a lookup or add
+ * operation. Cache entries are removed only when they are found to be invalid on lookup.</p>
*
* <p>This repository is thread-safe after it is initialised.</p>
*/
@@ -94,7 +94,7 @@ public class IdPStorageServiceCredentialRepository extends AbstractIdentifiableI
@NonnullAfterInit private EnumeratableStorageService storageService;
/**
- * A shared lock to synchronize access to read and write operations. Needs to be a reentrant type, so a read
+ * A shared lock to synchronize access to read and write operations. Needs to be a reentrant type so a read
* can occur within a write lock (by the same thread).
*/
@NonnullAfterInit private ReentrantReadWriteLock lock;
@@ -172,7 +172,7 @@ public class IdPStorageServiceCredentialRepository extends AbstractIdentifiableI
/**
* Set a loader that loads credential records to be cached on initialisation of this storage service.
*
- * @param loader The initialCacheLoader to set.
+ * @param loader The initial cache loader to set.
*/
public void setStorageRecordCacheLoader(
@Nonnull final Function<String, List<StorageRecord<Set<CredentialRecord>>>> loader) {
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 87acfe0..83fa82a 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
@@ -394,8 +394,7 @@ public class StorageServiceCredentialRepositoryFactory extends AbstractInitializ
} else if (defaultAcceleratorType == AcceleratorType.READALL &&
getJdbcAccelerator() instanceof final WebAuthnJDBCReadAllAccelerator accelerator) {
repo.setCredentialByCredentialIdLookupStrategy(new QueryByAllStrategy(accelerator));
- }
-
+ }
if (getStorageRecordCacheLoader() != null) {
repo.setStorageRecordCacheLoader(getStorageRecordCacheLoader());
diff --git a/webauthn-impl/src/main/resources/META-INF/net.shibboleth.idp/postconfig.xml b/webauthn-impl/src/main/resources/META-INF/net.shibboleth.idp/postconfig.xml
index ec72373..cd615a2 100644
--- a/webauthn-impl/src/main/resources/META-INF/net.shibboleth.idp/postconfig.xml
+++ b/webauthn-impl/src/main/resources/META-INF/net.shibboleth.idp/postconfig.xml
@@ -104,8 +104,7 @@
p:serializer="#{getObject('shibboleth.authn.WebAuthn.CredentialRepositoryStorageSerializer') ?: getObject('shibboleth.authn.WebAuthn.DefaultCredentialRepositoryStorageSerializer')}"
p:expireAfterAccess="%{idp.authn.webauthn.StorageService.cache.expireAfterAccess:PT60M}"
p:enableCache="%{idp.authn.webauthn.StorageService.cache.enable:true}">
- </bean>
-
+ </bean>
<bean id="shibboleth.authn.WebAuthn.DefaultCredentialRepositoryStorageSerializer"
class="net.shibboleth.idp.plugin.authn.webauthn.storage.impl.CredentialRegistrationSerializer" />
diff --git a/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/conf/authn/webauthn.properties b/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/conf/authn/webauthn.properties
index 4c87ac6..c2787ca 100644
--- a/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/conf/authn/webauthn.properties
+++ b/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/conf/authn/webauthn.properties
@@ -34,7 +34,7 @@ idp.authn.webauthn.supportedPrincipals = \
#idp.authn.webauthn.StorageService.cache.enable = true
# Set the expires after last access time on the cache
#idp.authn.webauthn.StorageService.cache.expireAfterAccess = PT60M
-# The JDBC credential repository accelerator to use, only to be enabled if you are using a JDBC storage service with a compatible RDMS datasource
+# The JDBC credential repository accelerator to use, only to be enabled if you are using a JDBC storage service with a compatible RDMS
#idp.authn.webauthn.StorageService.jdbcAccelerator = WebAuthnJDBCAccelerator
#idp.authn.webauthn.StorageService.jdbcAccelerator.defaultType = QUERY
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list