[java-opensaml] branch main updated: Javadoc and warning fixes.
Scott Cantor
cantor.2 at osu.edu
Mon Mar 8 23:31:41 UTC 2021
This is an automated email from the git hooks/post-receive script.
scantor pushed a commit to branch main
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=880d80885bf27b4740c853d30aa61f05192e766d
The following commit(s) were added to refs/heads/main by this push:
new 880d80885 Javadoc and warning fixes.
880d80885 is described below
commit 880d80885bf27b4740c853d30aa61f05192e766d
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Mon Mar 8 18:31:38 2021 -0500
Javadoc and warning fixes.
---
.../main/java/org/opensaml/core/xml/config/XMLConfigurator.java | 1 -
.../opensaml/messaging/context/navigate/ChildContextLookup.java | 4 +++-
.../profile/action/AbstractHandlerDelegatingProfileAction.java | 2 +-
.../java/org/opensaml/profile/action/impl/EncodeMessage.java | 4 ++--
.../org/opensaml/saml/common/binding/SAMLBindingSupport.java | 3 +--
.../opensaml/saml/saml2/assertion/SAML20AssertionValidator.java | 2 ++
.../binding/artifact/impl/StorageServiceSAMLArtifactMap.java | 3 ++-
.../saml/metadata/resolver/filter/impl/PredicateFilter.java | 9 ++++++++-
.../opensaml/saml/saml2/profile/impl/AbstractEncryptAction.java | 2 ++
.../security/impl/SAMLMetadataEncryptionParametersResolver.java | 1 -
.../src/main/java/org/opensaml/security/crypto/ec/ECSupport.java | 1 -
.../main/java/org/opensaml/soap/client/http/HttpSOAPClient.java | 4 ++--
.../opensaml/storage/impl/memcached/MemcachedStorageService.java | 2 +-
.../main/java/org/opensaml/xmlsec/derivation/impl/ConcatKDF.java | 1 -
.../keyinfo/impl/provider/AgreementMethodKeyInfoProvider.java | 2 --
15 files changed, 24 insertions(+), 17 deletions(-)
diff --git a/opensaml-core/src/main/java/org/opensaml/core/xml/config/XMLConfigurator.java b/opensaml-core/src/main/java/org/opensaml/core/xml/config/XMLConfigurator.java
index 2152cacda..55683ff34 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/xml/config/XMLConfigurator.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/xml/config/XMLConfigurator.java
@@ -19,7 +19,6 @@ package org.opensaml.core.xml.config;
import java.io.File;
import java.io.FileInputStream;
-import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Constructor;
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/navigate/ChildContextLookup.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/navigate/ChildContextLookup.java
index 6c5498870..9f55efd6d 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/navigate/ChildContextLookup.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/navigate/ChildContextLookup.java
@@ -44,7 +44,9 @@ public class ChildContextLookup<ParentContext extends BaseContext, ChildContext
private boolean autocreate;
/**
- * Constructor. Sets {@link #autocreate} to <code>false</code>.
+ * Constructor.
+ *
+ * <p>Equivalent to calling the two-parameter constructor with false.</p>
*
* @param type child context type to look up
*/
diff --git a/opensaml-profile-api/src/main/java/org/opensaml/profile/action/AbstractHandlerDelegatingProfileAction.java b/opensaml-profile-api/src/main/java/org/opensaml/profile/action/AbstractHandlerDelegatingProfileAction.java
index 8b36cab1c..8b6116aaa 100644
--- a/opensaml-profile-api/src/main/java/org/opensaml/profile/action/AbstractHandlerDelegatingProfileAction.java
+++ b/opensaml-profile-api/src/main/java/org/opensaml/profile/action/AbstractHandlerDelegatingProfileAction.java
@@ -63,7 +63,7 @@ public abstract class AbstractHandlerDelegatingProfileAction<DelegateType extend
*
* @param delegateClass the delegate class. Must have a no-argument constructor. For those that do not,
* instead pass in a pre-constructed instance via
- * {@link AbstractHandlerDelegatingProfileAction(MessageHandler, ContextDataLookupFunction)}.
+ * {@link #AbstractHandlerDelegatingProfileAction(MessageHandler, ContextDataLookupFunction)}.
* @param lookup the lookup function for the message context on which to operate,
* typically for either the inbound or outbound context
*/
diff --git a/opensaml-profile-impl/src/main/java/org/opensaml/profile/action/impl/EncodeMessage.java b/opensaml-profile-impl/src/main/java/org/opensaml/profile/action/impl/EncodeMessage.java
index e0e60fafa..504e3277b 100644
--- a/opensaml-profile-impl/src/main/java/org/opensaml/profile/action/impl/EncodeMessage.java
+++ b/opensaml-profile-impl/src/main/java/org/opensaml/profile/action/impl/EncodeMessage.java
@@ -41,8 +41,8 @@ import org.slf4j.LoggerFactory;
/**
* Action that encodes an outbound response from the outbound {@link MessageContext}.
*
- * <p>The {@link #encoderFactory} is used to obtain a new {@link MessageEncoder} to
- * use, and the encoder is destroyed upon completion.</p>
+ * <p>The input to {@link #setMessageEncoderFactory(Function)} is used to obtain a new
+ * {@link MessageEncoder} to use, and the encoder is destroyed upon completion.</p>
*
*
* @event {@link EventIds#PROCEED_EVENT_ID}
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
index 7c54bf67c..c6ee12b8c 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
@@ -36,7 +36,6 @@ import org.opensaml.saml.common.messaging.context.SAMLBindingContext;
import org.opensaml.saml.common.messaging.context.SAMLEndpointContext;
import org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext;
import org.opensaml.saml.saml2.metadata.Endpoint;
-import org.opensaml.xmlsec.signature.Signature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -359,7 +358,7 @@ public final class SAMLBindingSupport {
Constraint.isTrue(artifactEndpointIndex.length == 2, "Artifact endpoint index length was not 2, was: "
+ artifactEndpointIndex.length);
final short value = ByteBuffer.wrap(artifactEndpointIndex).order(ByteOrder.BIG_ENDIAN).getShort();
- return (int) Constraint.isGreaterThanOrEqual(0, value,
+ return Constraint.isGreaterThanOrEqual(0, value,
"Input value was too large, resulting in a negative 16-bit short");
}
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java
index b8815781c..3a9ce1223 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML20AssertionValidator.java
@@ -146,6 +146,7 @@ public class SAML20AssertionValidator {
/** SAML signature profile validator.*/
@Nullable private SignaturePrevalidator signaturePrevalidator;
+// Checkstyle: ParameterNumber OFF
/**
* Constructor.
*
@@ -198,6 +199,7 @@ public class SAML20AssertionValidator {
trustEngine = newTrustEngine;
signaturePrevalidator = newSignaturePrevalidator;
}
+// Checkstyle: ParameterNumber ON
/**
* Constructor.
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/artifact/impl/StorageServiceSAMLArtifactMap.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/artifact/impl/StorageServiceSAMLArtifactMap.java
index 1a281826d..d83c2c7df 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/artifact/impl/StorageServiceSAMLArtifactMap.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/artifact/impl/StorageServiceSAMLArtifactMap.java
@@ -33,6 +33,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.binding.artifact.SAMLArtifactMap;
+import org.opensaml.saml.common.binding.artifact.SAMLArtifactMap.SAMLArtifactMapEntryFactory;
import org.opensaml.storage.StorageRecord;
import org.opensaml.storage.StorageSerializer;
import org.opensaml.storage.StorageService;
@@ -134,7 +135,7 @@ public class StorageServiceSAMLArtifactMap extends AbstractInitializableComponen
* Set the map entry factory.
*
* <p>
- * In addition to implementing the {@link SAMLArtifactMap.SAMLArtifactMapEntryFactory} interface, the injected
+ * In addition to implementing the {@link SAMLArtifactMapEntryFactory} interface, the injected
* object must support the {@link StorageSerializer} interface to enable entries to be stored via the injected
* {@link StorageService} instance.
* </p>
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/PredicateFilter.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/PredicateFilter.java
index ea3f7db06..20b571f1e 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/PredicateFilter.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/PredicateFilter.java
@@ -47,7 +47,14 @@ import org.slf4j.LoggerFactory;
public class PredicateFilter implements MetadataFilter {
/** Whether matching means to include or exclude an entity. */
- public enum Direction { INCLUDE, EXCLUDE, };
+ public enum Direction {
+
+ /** Matches are to be included. */
+ INCLUDE,
+
+ /** Matches are to be excluded. */
+ EXCLUDE,
+ };
/** Class logger. */
@Nonnull private final Logger log = LoggerFactory.getLogger(PredicateFilter.class);
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AbstractEncryptAction.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AbstractEncryptAction.java
index 6cd6cf22f..69dc6ab8b 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AbstractEncryptAction.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AbstractEncryptAction.java
@@ -169,6 +169,7 @@ public abstract class AbstractEncryptAction extends AbstractConditionalProfileAc
return encrypter;
}
+// Checkstyle: CyclomaticComplexity OFF
/** {@inheritDoc} */
@Override
protected boolean doPreExecute(@Nonnull final ProfileRequestContext profileRequestContext) {
@@ -226,6 +227,7 @@ public abstract class AbstractEncryptAction extends AbstractConditionalProfileAc
return true;
}
+// Checkstyle: CyclomaticComplexity ON
/**
* Return the right set of parameters for the operation to be performed, or none if no encryption should occur.
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataEncryptionParametersResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataEncryptionParametersResolver.java
index 5f71be2e1..bbff0273b 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataEncryptionParametersResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataEncryptionParametersResolver.java
@@ -37,7 +37,6 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
-import org.bouncycastle.jcajce.spec.UserKeyingMaterialSpec;
import org.opensaml.core.xml.XMLObject;
import org.opensaml.saml.saml2.metadata.EncryptionMethod;
import org.opensaml.saml.security.SAMLMetadataKeyAgreementEncryptionConfiguration;
diff --git a/opensaml-security-api/src/main/java/org/opensaml/security/crypto/ec/ECSupport.java b/opensaml-security-api/src/main/java/org/opensaml/security/crypto/ec/ECSupport.java
index 9897c4dd3..e2a4e1835 100644
--- a/opensaml-security-api/src/main/java/org/opensaml/security/crypto/ec/ECSupport.java
+++ b/opensaml-security-api/src/main/java/org/opensaml/security/crypto/ec/ECSupport.java
@@ -26,7 +26,6 @@ import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.interfaces.ECPrivateKey;
import java.security.interfaces.ECPublicKey;
-import java.security.spec.AlgorithmParameterSpec;
import java.security.spec.ECParameterSpec;
import java.security.spec.ECPoint;
import java.security.spec.EllipticCurve;
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
index 06eccd456..95e06fb65 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/client/http/HttpSOAPClient.java
@@ -223,8 +223,8 @@ public class HttpSOAPClient extends AbstractInitializableComponent implements SO
} else if (code == HttpStatus.SC_INTERNAL_SERVER_ERROR) {
processFaultResponse(response, context);
} else {
- throw new SOAPClientException("Received " + code + " HTTP response status code from HTTP request to "
- + endpoint);
+ throw new SOAPClientException("Received " + code +
+ " HTTP response status code from HTTP request to " + endpoint);
}
} finally {
try {
diff --git a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/memcached/MemcachedStorageService.java b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/memcached/MemcachedStorageService.java
index 5f1e8ebcb..88849d808 100644
--- a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/memcached/MemcachedStorageService.java
+++ b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/memcached/MemcachedStorageService.java
@@ -175,7 +175,7 @@ public class MemcachedStorageService extends AbstractIdentifiableInitializableCo
/**
* Sets the storage capabilities. This method should be used when the default 1M slab size is changed;
- * the {@link MemcachedStorageCapabilities#valueSize} should be set equal to the chosen slab size.
+ * the {@link MemcachedStorageCapabilities#getValueSize()} should be set equal to the chosen slab size.
*
* @param capabilities Memcached storage capabilities.
*/
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/ConcatKDF.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/ConcatKDF.java
index 3e076dd8b..bbecdcf68 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/ConcatKDF.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/ConcatKDF.java
@@ -47,7 +47,6 @@ import org.opensaml.xmlsec.derivation.KeyDerivation;
import org.opensaml.xmlsec.derivation.KeyDerivationException;
import org.opensaml.xmlsec.derivation.KeyDerivationSupport;
import org.opensaml.xmlsec.encryption.ConcatKDFParams;
-import org.opensaml.xmlsec.encryption.EncryptedType;
import org.opensaml.xmlsec.encryption.KeyDerivationMethod;
import org.opensaml.xmlsec.encryption.support.EncryptionConstants;
import org.opensaml.xmlsec.signature.DigestMethod;
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/provider/AgreementMethodKeyInfoProvider.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/provider/AgreementMethodKeyInfoProvider.java
index 99ca9d92d..b2a2dd6f7 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/provider/AgreementMethodKeyInfoProvider.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/provider/AgreementMethodKeyInfoProvider.java
@@ -36,8 +36,6 @@ import org.opensaml.xmlsec.agreement.impl.KeyAgreementParametersParser;
import org.opensaml.xmlsec.agreement.impl.PrivateCredential;
import org.opensaml.xmlsec.encryption.AgreementMethod;
import org.opensaml.xmlsec.encryption.EncryptedType;
-import org.opensaml.xmlsec.encryption.EncryptionMethod;
-import org.opensaml.xmlsec.encryption.KeySize;
import org.opensaml.xmlsec.encryption.OriginatorKeyInfo;
import org.opensaml.xmlsec.encryption.RecipientKeyInfo;
import org.opensaml.xmlsec.keyinfo.KeyInfoCredentialResolutionMode;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list