[java-opensaml] branch main updated: Fix many fatal Javadocs errors from recent checkins.
Brent Putman
putmanb at georgetown.edu
Tue Mar 2 06:55:10 UTC 2021
This is an automated email from the git hooks/post-receive script.
putmanb 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=0626fbfc6cbbaa4b9b8e90767add6263904d94f3
The following commit(s) were added to refs/heads/main by this push:
new 0626fbfc6 Fix many fatal Javadocs errors from recent checkins.
0626fbfc6 is described below
commit 0626fbfc6cbbaa4b9b8e90767add6263904d94f3
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Tue Mar 2 01:54:52 2021 -0500
Fix many fatal Javadocs errors from recent checkins.
(Brent needs to remember to run full a mvn -Prelease before a big
checkin...).
---
.../xmlsec/agreement/KeyAgreementParameters.java | 2 +-
.../xmlsec/agreement/KeyAgreementProcessor.java | 2 +-
.../opensaml/xmlsec/algorithm/AlgorithmSupport.java | 4 ++--
.../org/opensaml/xmlsec/derivation/KeyDerivation.java | 2 +-
.../xmlsec/derivation/KeyDerivationSupport.java | 4 ++--
.../org/opensaml/xmlsec/encryption/PBKDF2Params.java | 6 +++---
.../main/java/org/opensaml/xmlsec/encryption/Salt.java | 2 +-
.../xmlsec/keyinfo/KeyInfoGeneratorFactory.java | 2 ++
.../agreement/impl/AbstractKeyAgreementProcessor.java | 8 ++++----
.../opensaml/xmlsec/agreement/impl/DigestMethod.java | 2 +-
.../org/opensaml/xmlsec/agreement/impl/KANonce.java | 2 +-
.../agreement/impl/KeyAgreementParameterParser.java | 2 +-
.../agreement/impl/KeyAgreementParametersParser.java | 2 +-
.../org/opensaml/xmlsec/derivation/impl/ConcatKDF.java | 10 ++++------
.../org/opensaml/xmlsec/derivation/impl/PBKDF2.java | 18 +++++++++---------
.../xmlsec/encryption/impl/ConcatKDFParamsImpl.java | 3 +--
.../keyinfo/impl/BasicKeyInfoGeneratorFactory.java | 6 ++----
.../impl/KeyAgreementKeyInfoGeneratorFactory.java | 6 +++---
18 files changed, 40 insertions(+), 43 deletions(-)
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementParameters.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementParameters.java
index 05fe2807e..4c4e46699 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementParameters.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementParameters.java
@@ -68,7 +68,7 @@ public class KeyAgreementParameters extends ClassIndexedSet<KeyAgreementParamete
/**
* A convenience method for initializing all parameters which are initializable.
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if any parameters fail initialization
*/
public void initializeAll() throws KeyAgreementException {
for (final KeyAgreementParameter param : this) {
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementProcessor.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementProcessor.java
index d90b7a47e..1c4afbf9d 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementProcessor.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/agreement/KeyAgreementProcessor.java
@@ -44,7 +44,7 @@ public interface KeyAgreementProcessor {
*
* @return the agreement credential
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if the key agreement operation is not completed successfully
*/
@Nonnull public KeyAgreementCredential execute(@Nonnull final Credential publicCredential,
@Nonnull final String keyAlgorithm, @Nonnull final KeyAgreementParameters parameters)
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/algorithm/AlgorithmSupport.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/algorithm/AlgorithmSupport.java
index 6e1dad94d..6fe8d474a 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/algorithm/AlgorithmSupport.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/algorithm/AlgorithmSupport.java
@@ -401,7 +401,7 @@ public final class AlgorithmSupport {
* @return a randomly-generated KeyPair
* @throws NoSuchProviderException provider not found
* @throws NoSuchAlgorithmException algorithm not found
- * @throws InvalidAlgorithmParameterException
+ * @throws InvalidAlgorithmParameterException algorithm parameter spec is unsupported
*/
@Nonnull public static KeyPair generateKeyPair(@Nonnull final String algoURI,
@Nonnull final AlgorithmParameterSpec paramSpec)
@@ -454,7 +454,7 @@ public final class AlgorithmSupport {
* @return a basic credential containing a randomly generated asymmetric key pair
* @throws NoSuchAlgorithmException algorithm not found
* @throws NoSuchProviderException provider not found
- * @throws InvalidAlgorithmParameterException
+ * @throws InvalidAlgorithmParameterException algorithm parameter spec is unsupported
*/
@Nonnull public static Credential generateKeyPairAndCredential(@Nonnull final String algorithmURI,
@Nonnull final AlgorithmParameterSpec paramSpec,
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivation.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivation.java
index a5063dd1f..b868eb5f7 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivation.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivation.java
@@ -53,7 +53,7 @@ public interface KeyDerivation extends KeyAgreementParameter {
*
* @return the derived key
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if the key derivation operation is not completed successfully
*/
@Nonnull public SecretKey derive(@Nonnull final byte[] secret, @Nonnull final String keyAlgorithm,
@Nullable final Integer keyLength) throws KeyDerivationException;
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivationSupport.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivationSupport.java
index e19165156..44c7e273a 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivationSupport.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/derivation/KeyDerivationSupport.java
@@ -39,7 +39,7 @@ public final class KeyDerivationSupport {
*
* @return the JCA key algorithm
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if key algorithm could not be determined
*/
@Nonnull public static String getJCAKeyAlgorithm(@Nonnull final String algorithmURI)
throws KeyDerivationException {
@@ -66,7 +66,7 @@ public final class KeyDerivationSupport {
*
* @return the effective key length
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if algorithm and specified key lengths are not consistent
*/
@Nonnull public static Integer getEffectiveKeyLength(@Nonnull final String algorithmURI,
@Nullable final Integer specifiedKeyLength) throws KeyDerivationException {
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/PBKDF2Params.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/PBKDF2Params.java
index 0034bf6dd..71ab41134 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/PBKDF2Params.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/PBKDF2Params.java
@@ -66,7 +66,7 @@ public interface PBKDF2Params extends XMLObject {
/**
* Set the IterationCount child element.
*
- * @param count
+ * @param count the new iteration count
*/
public void setIterationCount(@Nullable final IterationCount count);
@@ -80,7 +80,7 @@ public interface PBKDF2Params extends XMLObject {
/**
* Set the KeyLength child element.
*
- * @param length
+ * @param length the new key length
*/
public void setKeyLength(@Nullable final KeyLength length);
@@ -94,7 +94,7 @@ public interface PBKDF2Params extends XMLObject {
/**
* Set the PRF child element.
*
- * @param prf
+ * @param prf the new PRF element
*/
public void setPRF(@Nullable final PRF prf);
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/Salt.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/Salt.java
index abbea0214..955032eed 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/Salt.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/Salt.java
@@ -45,7 +45,7 @@ public interface Salt extends XMLObject {
/**
* Set the Specified child element.
*
- * @param specified
+ * @param specified the element
*/
public void setSpecified(@Nullable final Specified specified);
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/keyinfo/KeyInfoGeneratorFactory.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/keyinfo/KeyInfoGeneratorFactory.java
index fcb31d361..11d581f68 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/keyinfo/KeyInfoGeneratorFactory.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/keyinfo/KeyInfoGeneratorFactory.java
@@ -21,6 +21,8 @@ import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opensaml.security.credential.Credential;
+import org.opensaml.xmlsec.encryption.OriginatorKeyInfo;
+import org.opensaml.xmlsec.encryption.RecipientKeyInfo;
import org.opensaml.xmlsec.signature.KeyInfo;
/**
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/AbstractKeyAgreementProcessor.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/AbstractKeyAgreementProcessor.java
index a1fe063d7..e78b7133e 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/AbstractKeyAgreementProcessor.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/AbstractKeyAgreementProcessor.java
@@ -61,7 +61,7 @@ public abstract class AbstractKeyAgreementProcessor implements KeyAgreementProce
*
* @return the obtained private credential
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if private credential can not be obtained
*/
@Nonnull protected Credential obtainPrivateCredential(@Nonnull final Credential publicCredential,
@Nonnull final KeyAgreementParameters parameters) throws KeyAgreementException {
@@ -84,7 +84,7 @@ public abstract class AbstractKeyAgreementProcessor implements KeyAgreementProce
*
* @return the secret produced by the key agreement operation
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if secret generation fails
*/
@Nonnull protected abstract byte[] generateAgreementSecret(@Nonnull final Credential publicCredential,
@Nonnull final Credential privateCredential, @Nonnull final KeyAgreementParameters parameters)
@@ -99,7 +99,7 @@ public abstract class AbstractKeyAgreementProcessor implements KeyAgreementProce
*
* @return the derived secret key
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if key derivation operation does not complete successfully
*/
@Nonnull protected abstract SecretKey deriveSecretKey(@Nonnull final byte[] secret,
@Nonnull final String keyAlgorithm, @Nonnull final KeyAgreementParameters parameters)
@@ -115,7 +115,7 @@ public abstract class AbstractKeyAgreementProcessor implements KeyAgreementProce
*
* @return the new key agreement credential
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if credential can not be successfully constructed
*/
@Nonnull protected KeyAgreementCredential buildKeyAgreementCredential(@Nonnull final SecretKey derivedKey,
@Nonnull final Credential publicCredential, @Nonnull final Credential privateCredential,
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/DigestMethod.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/DigestMethod.java
index 2f4697c44..a4335ffeb 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/DigestMethod.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/DigestMethod.java
@@ -96,7 +96,7 @@ public class DigestMethod extends AbstractInitializableComponent
*
* @return new parameter instance
*
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException if component initialization fails
*/
@Nonnull public static DigestMethod fromXMLObject(
@Nonnull final org.opensaml.xmlsec.signature.DigestMethod xmlObject)
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KANonce.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KANonce.java
index 73850aa01..9b317cc72 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KANonce.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KANonce.java
@@ -96,7 +96,7 @@ public class KANonce extends AbstractInitializableComponent
*
* @return new parameter instance
*
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException if component initialization fails
*/
@Nonnull public static KANonce fromXMLObject(@Nonnull final org.opensaml.xmlsec.encryption.KANonce xmlObject)
throws ComponentInitializationException {
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParameterParser.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParameterParser.java
index 8528e170b..a2689c3bb 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParameterParser.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParameterParser.java
@@ -44,7 +44,7 @@ public interface KeyAgreementParameterParser {
*
* @return the new key agreement parameter instance
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if parameter parsing of the supplied object fails
*/
KeyAgreementParameter parse(@Nonnull final XMLObject xmlObject) throws KeyAgreementException;
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParametersParser.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParametersParser.java
index 01352340d..0a91dc474 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParametersParser.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/agreement/impl/KeyAgreementParametersParser.java
@@ -50,7 +50,7 @@ public class KeyAgreementParametersParser {
*
* @return the new instance of key agreement parameters
*
- * @throws KeyAgreementException
+ * @throws KeyAgreementException if parameters parsing does not complete successfully
*/
@Nonnull public KeyAgreementParameters parse(@Nonnull final AgreementMethod agreementMethod)
throws KeyAgreementException {
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 4f746b8be..3e076dd8b 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
@@ -303,7 +303,7 @@ public class ConcatKDF extends AbstractInitializableComponent
*
* @return the derived key bytes
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if key derivation does not complete successfully
*/
protected byte[] derive(@Nonnull final byte[] secret, @Nonnull final byte[] otherInfo,
@Nonnull final Integer keyLength) throws KeyDerivationException {
@@ -329,7 +329,7 @@ public class ConcatKDF extends AbstractInitializableComponent
*
* @return a new corresponding instance of BC Digest
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if the specified digest algorithm is unsupported
*/
@Nonnull protected Digest getDigestInstance(@Nonnull final String digestURI) throws KeyDerivationException {
switch(digestURI) {
@@ -368,7 +368,7 @@ public class ConcatKDF extends AbstractInitializableComponent
*
* @return the decoded value, which may be an empty array
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if parameter value could not be decoded successfully
*/
@Nonnull protected byte[] decodeParam(@Nullable final String value, @Nonnull final String name)
throws KeyDerivationException {
@@ -400,8 +400,6 @@ public class ConcatKDF extends AbstractInitializableComponent
* @param value the value to process
*
* @return the padded value, which may be null
- *
- * @throws KeyDerivationException
*/
@Nullable protected static String padParam(@Nullable final String value) {
@@ -487,7 +485,7 @@ public class ConcatKDF extends AbstractInitializableComponent
*
* @return new parameter instance
*
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException if component initialization fails
*/
@Nonnull public static ConcatKDF fromXMLObject(@Nonnull final KeyDerivationMethod xmlObject)
throws ComponentInitializationException {
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/PBKDF2.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/PBKDF2.java
index 7311267c7..bc5f9b7d1 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/PBKDF2.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/derivation/impl/PBKDF2.java
@@ -135,7 +135,7 @@ public class PBKDF2 extends AbstractInitializableComponent
/**
* Set the generated salt length, in bytes.
*
- * @param length
+ * @param length the generated salt length
*/
public void setGeneratedSaltLength(@Nullable final Integer length) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -182,7 +182,7 @@ public class PBKDF2 extends AbstractInitializableComponent
/**
* Set the iteration count.
*
- * @param count
+ * @param count the iteration count
*/
public void setIterationCount(@Nullable final Integer count) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -209,7 +209,7 @@ public class PBKDF2 extends AbstractInitializableComponent
* Note: KeyLength in expressed XML will be in <b>bytes</b>
* </p>
*
- * @param length
+ * @param length the key length
*/
public void setKeyLength(@Nullable final Integer length) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -228,7 +228,7 @@ public class PBKDF2 extends AbstractInitializableComponent
/**
* Set the pseudo-random function algorithm URI.
*
- * @param uri
+ * @param uri the PRF URI
*/
public void setPRF(@Nullable final String uri) {
ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -307,7 +307,7 @@ public class PBKDF2 extends AbstractInitializableComponent
*
* @return the salt bytes
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if the salt value can not be successfully resolved
*/
protected byte[] getEffectiveSalt() throws KeyDerivationException {
byte[] saltBytes = null;
@@ -336,11 +336,11 @@ public class PBKDF2 extends AbstractInitializableComponent
* Get the effective key length, in bits.
*
* @param keyAlgorithm the algorithm for which the derived key will be used
- * @param specifiedKeyLength
+ * @param specifiedKeyLength the explicitly specified key length
*
* @return the effective key length, in bits
*
- * @throws KeyDerivationException
+ * @throws KeyDerivationException if the key length can not be successfully resolved
*/
protected Integer getEffectiveKeyLength(@Nonnull final String keyAlgorithm,
@Nullable final Integer specifiedKeyLength) throws KeyDerivationException {
@@ -425,7 +425,7 @@ public class PBKDF2 extends AbstractInitializableComponent
*
* @return new parameter instance
*
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException if component initialization fails
*/
@Nonnull public static PBKDF2 fromXMLObject(@Nonnull final KeyDerivationMethod xmlObject)
throws ComponentInitializationException {
@@ -464,7 +464,7 @@ public class PBKDF2 extends AbstractInitializableComponent
*
* @param xmlParams the instance to validate
*
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException if the specified params fails validation of required values
*/
// Checkstyle: CyclomaticComplexity OFF
private static void validateXMLObjectParameters(@Nonnull final PBKDF2Params xmlParams)
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/encryption/impl/ConcatKDFParamsImpl.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/encryption/impl/ConcatKDFParamsImpl.java
index 7af7a7338..c86b3b765 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/encryption/impl/ConcatKDFParamsImpl.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/encryption/impl/ConcatKDFParamsImpl.java
@@ -110,8 +110,7 @@ public class ConcatKDFParamsImpl extends AbstractXMLObject implements ConcatKDFP
partyUInfo = prepareForAssignment(partyUInfo, newPartyUInfo);
}
- /** {@inheritDoc}
- * @throws DecoderException */
+ /** {@inheritDoc} */
@Nullable public byte[] getPartyUInfoBytes() {
try {
return partyUInfo == null ? null : Hex.decodeHex(partyUInfo);
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicKeyInfoGeneratorFactory.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicKeyInfoGeneratorFactory.java
index 9327c9aa9..d9b932a77 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicKeyInfoGeneratorFactory.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicKeyInfoGeneratorFactory.java
@@ -238,14 +238,12 @@ public class BasicKeyInfoGeneratorFactory implements KeyInfoGeneratorFactory {
* Build a new KeyInfo instance.
*
* <p>
- * The exact element type is determined by {@link BasicOptions#keyInfoElementType}, defaulting to
- * {@link KeyInfo#DEFAULT_ELEMENT_NAME} if the option is null. It is a runtime error if the specified type
- * is not a sub-type of {@link KeyInfo}.
+ * The exact element type is determined by {@link #keyInfoType} which was supplied at factory construction.
* </p>
*
* @return a new KeyInfo instance
*
- * @throws SecurityException
+ * @throws SecurityException if class type can not be mapped to an element {@link QName}
*/
protected KeyInfo buildKeyInfo() throws SecurityException {
final QName elementName = classToElementName(keyInfoType);
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/KeyAgreementKeyInfoGeneratorFactory.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/KeyAgreementKeyInfoGeneratorFactory.java
index b02f26804..ad5ae4a1e 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/KeyAgreementKeyInfoGeneratorFactory.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/KeyAgreementKeyInfoGeneratorFactory.java
@@ -224,7 +224,7 @@ public class KeyAgreementKeyInfoGeneratorFactory extends BasicKeyInfoGeneratorFa
* @param agreementMethod the AgreementMethod that is being built
* @param credential the Credential that is being processed
*
- * @throws SecurityException
+ * @throws SecurityException if there is a fatal error processing any agreement parameters
*/
private void processAgreementParameters(@Nonnull final KeyInfo keyInfo,
@Nonnull final AgreementMethod agreementMethod, @Nonnull final KeyAgreementCredential credential)
@@ -253,7 +253,7 @@ public class KeyAgreementKeyInfoGeneratorFactory extends BasicKeyInfoGeneratorFa
* @param agreementMethod the AgreementMethod that is being built
* @param credential the Credential that is being processed
*
- * @throws SecurityException
+ * @throws SecurityException if there is a fatal error processing the originator KeyInfo
*/
private void processOriginatorKeyInfo(@Nonnull final KeyInfo keyInfo,
@Nonnull final AgreementMethod agreementMethod, @Nonnull final KeyAgreementCredential credential)
@@ -293,7 +293,7 @@ public class KeyAgreementKeyInfoGeneratorFactory extends BasicKeyInfoGeneratorFa
* @param agreementMethod the AgreementMethod that is being built
* @param credential the Credential that is being processed
*
- * @throws SecurityException
+ * @throws SecurityException if there is a fatal error processing the recipient KeyInfo
*/
private void processRecipientKeyInfo(@Nonnull final KeyInfo keyInfo,
@Nonnull final AgreementMethod agreementMethod, @Nonnull final KeyAgreementCredential credential)
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list