[java-oidc-common] branch main updated: Fix javadoc warnings.
Scott Cantor
cantor.2 at osu.edu
Wed Oct 18 19:42:41 UTC 2023
This is an automated email from the git hooks/post-receive script.
scantor 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=22e8a2d7cff1c66e01ed64bd31d17930bbca3eaf
The following commit(s) were added to refs/heads/main by this push:
new 22e8a2d Fix javadoc warnings.
22e8a2d is described below
commit 22e8a2d7cff1c66e01ed64bd31d17930bbca3eaf
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Wed Oct 18 15:42:38 2023 -0400
Fix javadoc warnings.
---
.../impl/BasicJOSEObjectCredentialResolver.java | 15 ++++++++++
.../oidc/security/impl/JWSTokenSigner.java | 8 ++++--
.../impl/ClientInformationNodeProcessor.java | 7 ++++-
.../HTTPProviderConfigurationFetchingStrategy.java | 19 +++++++------
.../ext/impl/provider/InlineJwksProvider.java | 33 +++++++++++++++++++++-
5 files changed, 69 insertions(+), 13 deletions(-)
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJOSEObjectCredentialResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJOSEObjectCredentialResolver.java
index 3b4ff0d..c58058f 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJOSEObjectCredentialResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/BasicJOSEObjectCredentialResolver.java
@@ -143,6 +143,13 @@ public class BasicJOSEObjectCredentialResolver extends AbstractCriteriaFiltering
return credentials;
}
+ /**
+ * Process JWE header into a list of credentials.
+ *
+ * @param jweHeader header object
+ *
+ * @return list of credentials.
+ */
@Nonnull @NonnullElements protected List<Credential> processJWEHeader(@Nonnull final JWEHeader jweHeader) {
final List<Credential> credentials = new ArrayList<>();
@@ -161,6 +168,14 @@ public class BasicJOSEObjectCredentialResolver extends AbstractCriteriaFiltering
return credentials;
}
+ /**
+ * Build JWK credential.
+ *
+ * @param jwk JWK to wrap
+ * @param headerKid KID header
+ *
+ * @return the credential
+ */
@Nullable protected BasicJWKCredential buildJWKCredential(
@Nonnull final JWK jwk, @Nullable final String headerKid) {
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSTokenSigner.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSTokenSigner.java
index 75d2215..a296c72 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSTokenSigner.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSTokenSigner.java
@@ -22,7 +22,6 @@ import javax.annotation.Nullable;
import org.opensaml.security.credential.Credential;
import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import com.nimbusds.jose.Algorithm;
import com.nimbusds.jose.JOSEException;
@@ -42,6 +41,7 @@ import net.shibboleth.oidc.security.credential.JWKCredential;
import net.shibboleth.oidc.security.jose.SignatureException;
import net.shibboleth.oidc.security.jose.SignatureSigningParameters;
import net.shibboleth.shared.logic.Constraint;
+import net.shibboleth.shared.primitive.LoggerFactory;
/**
* Supports signing a JSON Web Token (JWT) claims set using the JSON Web Signature standard using the algorithm and
@@ -55,7 +55,7 @@ import net.shibboleth.shared.logic.Constraint;
public class JWSTokenSigner {
/** Class logger. */
- private final Logger log = LoggerFactory.getLogger(JWSTokenSigner.class);
+ @Nonnull private final Logger log = LoggerFactory.getLogger(JWSTokenSigner.class);
/** The signature signing parameters. */
@Nonnull private final SignatureSigningParameters params;
@@ -75,7 +75,9 @@ public class JWSTokenSigner {
* @param jwtClaims the claims to sign
* @param typeHeader the optional JOSE object type to add to the JWS JOSE header
*
- * @return a signed JWT or {@code null} if an error occurs.
+ * @return a signed JWT or {@code null} if an error occurs
+ *
+ * @throws SignatureException if an error occurs
*/
@Nonnull public SignedJWT sign(@Nonnull final JWTClaimsSet jwtClaims,
@Nullable final String typeHeader) throws SignatureException{
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ClientInformationNodeProcessor.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ClientInformationNodeProcessor.java
index b6c312c..528eaaa 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ClientInformationNodeProcessor.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/ClientInformationNodeProcessor.java
@@ -632,10 +632,15 @@ public class ClientInformationNodeProcessor implements MetadataNodeProcessor {
return null;
}
+ /**
+ * Abstract base class that fills in some operations.
+ */
protected abstract class SkeletonEchoingRoleDescriptorResolver implements RoleDescriptorResolver {
/** {@inheritDoc} */
- @Override public Iterable<RoleDescriptor> resolve(final CriteriaSet criteria) throws ResolverException {
+ @Override
+ @Nonnull public Iterable<RoleDescriptor> resolve(@Nullable final CriteriaSet criteria)
+ throws ResolverException {
return Arrays.asList(resolveSingle(criteria));
}
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/HTTPProviderConfigurationFetchingStrategy.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/HTTPProviderConfigurationFetchingStrategy.java
index b400ca6..bd9ff3e 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/HTTPProviderConfigurationFetchingStrategy.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/impl/HTTPProviderConfigurationFetchingStrategy.java
@@ -30,7 +30,6 @@ import org.apache.hc.core5.http.HttpStatus;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import com.google.common.net.MediaType;
@@ -41,6 +40,7 @@ import net.shibboleth.oidc.metadata.criterion.IssuerIDCriterion;
import net.shibboleth.shared.annotation.constraint.NotEmpty;
import net.shibboleth.shared.logic.Constraint;
import net.shibboleth.shared.net.MediaTypeSupport;
+import net.shibboleth.shared.primitive.LoggerFactory;
import net.shibboleth.shared.resolver.CriteriaSet;
import net.shibboleth.shared.resolver.ResolverException;
@@ -68,6 +68,12 @@ public class HTTPProviderConfigurationFetchingStrategy
/** Strategy for composing an issuer with the well-known configuration path.*/
@Nonnull private BiFunction<Issuer, String, String> wellKnownLocationCompositionStrategy;
+ /**
+ * Constructor.
+ *
+ * @param client the HTTP client
+ * @param handler response handler
+ */
protected HTTPProviderConfigurationFetchingStrategy(@Nonnull final HttpClient client,
@Nonnull final HttpClientResponseHandler<OIDCProviderMetadata> handler) {
super(client, handler);
@@ -78,7 +84,7 @@ public class HTTPProviderConfigurationFetchingStrategy
/**
* Set the well-known URL path component.
*
- * <p>Defaults to {@value DEFAULT_OPENID_PROVIDER_WELL_KNOWN_PATH}.</p>
+ * <p>Defaults to {@value #DEFAULT_OPENID_PROVIDER_WELL_KNOWN_PATH}.</p>
*
* @param path the path.
*/
@@ -120,12 +126,9 @@ public class HTTPProviderConfigurationFetchingStrategy
@Immutable
@ThreadSafe
private static final class DefaultWellKnownPathCompositionStrategy implements BiFunction<Issuer, String, String> {
-
- /** Class logger. */
- @Nonnull private final Logger log = LoggerFactory.getLogger(DefaultWellKnownPathCompositionStrategy.class);
@Override
- @Nullable public String apply(@Nonnull final Issuer issuer, @Nonnull @NotEmpty final String wellKnownPath) {
+ @Nullable public String apply(@Nullable final Issuer issuer, @Nullable @NotEmpty final String wellKnownPath) {
// remove trailing slash if any (see openid-connect-discovery 4.1)
final String normalizedIssuer = StringUtils.removeEnd(issuer.getValue(), "/");
final StringBuilder builder = new StringBuilder();
@@ -218,10 +221,10 @@ public class HTTPProviderConfigurationFetchingStrategy
*/
protected void validateHttpResponse(@Nonnull final ClassicHttpResponse response) throws ResolverException {
- String contentTypeValue = response.getEntity().getContentType();
+ final String contentTypeValue = response.getEntity().getContentType();
log.debug("Saw raw Content-Type from response header '{}'", contentTypeValue);
- if (!MediaTypeSupport.validateContentType(contentTypeValue,Set.of(CONTENT_TYPE), true, false)) {
+ if (!MediaTypeSupport.validateContentType(contentTypeValue, Set.of(CONTENT_TYPE), true, false)) {
throw new ResolverException("HTTP response specified an unsupported Content-Type MIME type: "
+ contentTypeValue);
}
diff --git a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/keyinfo/ext/impl/provider/InlineJwksProvider.java b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/keyinfo/ext/impl/provider/InlineJwksProvider.java
index c471648..50c782d 100644
--- a/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/keyinfo/ext/impl/provider/InlineJwksProvider.java
+++ b/oidc-common-metadata-impl/src/main/java/net/shibboleth/oidc/metadata/keyinfo/ext/impl/provider/InlineJwksProvider.java
@@ -85,6 +85,14 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return credentials;
}
+ /**
+ * Build a JWKCredential.
+ *
+ * @param jwk input JWK
+ * @param kiContext KeyInfo context
+ *
+ * @return the built credential
+ */
@Nonnull protected BasicJWKCredential buildCredential(@Nonnull final JWK jwk,
@Nonnull final KeyInfoResolutionContext kiContext) {
final BasicJWKCredential credential = new BasicJWKCredential();
@@ -115,6 +123,13 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return credential;
}
+ /**
+ * Parse JWKs out of a string.
+ *
+ * @param input input string
+ *
+ * @return parsed JWKs
+ */
@Nullable protected List<JWK> parseJWKs(@Nullable final String input) {
final JWKSet jwkSet = parseJWKSet(input);
if (jwkSet != null) {
@@ -128,6 +143,13 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return null;
}
+ /**
+ * Parse JWKSet from a string.
+ *
+ * @param input input string
+ *
+ * @return parsed JWKSet
+ */
@Nullable protected JWKSet parseJWKSet(@Nullable final String input) {
try {
return JWKSet.parse(input);
@@ -141,6 +163,13 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return null;
}
+ /**
+ * Parse JWK from a string.
+ *
+ * @param input input string
+ *
+ * @return parsed JWK
+ */
@Nullable protected JWK parseJWK(@Nullable final String input) {
try {
return JWK.parse(input);
@@ -154,6 +183,7 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return null;
}
+ /** {@inheritDoc} */
@Override
public boolean handles(@Nonnull final XMLObject keyInfoChild) {
return getJwksData(keyInfoChild) != null;
@@ -173,4 +203,5 @@ public class InlineJwksProvider extends AbstractKeyInfoProvider {
return null;
}
}
-}
+
+}
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list