[java-opensaml] branch master updated: Javadoc warning fixes.
Scott Cantor
cantor.2 at osu.edu
Sun Oct 15 17:41:13 EDT 2017
This is an automated email from the git hooks/post-receive script.
scantor pushed a commit to branch master
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=4d6287594b19991a67c65a400bf1db8d83776214
The following commit(s) were added to refs/heads/master by this push:
new 4d62875 Javadoc warning fixes.
4d62875 is described below
commit 4d6287594b19991a67c65a400bf1db8d83776214
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Sun Oct 15 17:41:09 2017 -0400
Javadoc warning fixes.
---
.../artifact/impl/StorageServiceSAMLArtifactMap.java | 2 +-
.../SAMLProtocolMessageXMLSignatureSecurityHandler.java | 4 ++--
.../resolver/impl/AbstractDynamicMetadataResolver.java | 2 +-
.../impl/AbstractSubjectConfirmationValidator.java | 15 ++++++++++-----
.../impl/HolderOfKeySubjectConfirmationValidator.java | 2 +-
.../saml/saml2/profile/impl/AddStatusToResponse.java | 2 +-
.../impl/SecurityEnhancedHttpClientSupport.java | 6 +++---
.../java/org/opensaml/storage/impl/JPAStorageService.java | 7 ++++---
.../storage/impl/client/ClientStorageService.java | 3 ++-
.../storage/impl/client/LogLocalStorageSaveResults.java | 2 +-
.../client/SaveCookieBackedClientStorageServices.java | 2 +-
.../storage/impl/memcached/MemcachedStorageService.java | 3 +--
.../storage/impl/memcached/StringTranscoderTest.java | 2 +-
.../xmlsec/impl/BasicEncryptionParametersResolver.java | 2 +-
14 files changed, 30 insertions(+), 24 deletions(-)
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 c44298b..95bb732 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
@@ -127,7 +127,7 @@ public class StorageServiceSAMLArtifactMap extends AbstractInitializableComponen
* Set the map entry factory.
*
* <p>
- * In addition to implementing the {@link SAMLArtifactMapEntryFactory} interface, the injected
+ * In addition to implementing the {@link SAMLArtifactMap.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/common/binding/security/impl/SAMLProtocolMessageXMLSignatureSecurityHandler.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/SAMLProtocolMessageXMLSignatureSecurityHandler.java
index 668d359..b19213d 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/SAMLProtocolMessageXMLSignatureSecurityHandler.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/security/impl/SAMLProtocolMessageXMLSignatureSecurityHandler.java
@@ -34,8 +34,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * SAML security message handler which validates the signature (if present) on the {@link SAMLObject} which represents
- * the SAML protocol message being processed.
+ * SAML security message handler which validates the signature (if present) on the
+ * {@link org.opensaml.saml.common.SAMLObject} which represents the SAML protocol message being processed.
*
* <p>
* If the message is not an instance of {@link SignableSAMLObject}, then no processing is performed. If signature
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
index 8dd6297..4e47a43 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicMetadataResolver.java
@@ -629,7 +629,7 @@ public abstract class AbstractDynamicMetadataResolver extends AbstractMetadataRe
* processed metadata in the backing store.
*
* <p>
- * Equivalent to {@link #processNewMetadata(XMLObject, String, false)}.
+ * Equivalent to {@link #processNewMetadata(XMLObject, String, boolean)} called with false.
* </p>
*
* @param root the root of the new metadata document being processed
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidator.java
index d0db689..cf04f2a 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AbstractSubjectConfirmationValidator.java
@@ -110,9 +110,11 @@ public abstract class AbstractSubjectConfirmationValidator implements SubjectCon
}
/**
- * Validates the <code>NotBefore</code> condition of the {@link SubjectConfirmationData}, if any is present.
+ * Validates the <code>NotBefore</code> condition of the
+ * {@link org.opensaml.saml.saml2.core.SubjectConfirmationData}, if any is present.
*
- * @param confirmation confirmation method, with {@link SubjectConfirmationData}, being validated
+ * @param confirmation confirmation method, with {@link org.opensaml.saml.saml2.core.SubjectConfirmationData},
+ * being validated
* @param assertion assertion bearing the confirmation method
* @param context current validation context
*
@@ -140,9 +142,11 @@ public abstract class AbstractSubjectConfirmationValidator implements SubjectCon
}
/**
- * Validates the <code>NotOnOrAfter</code> condition of the {@link SubjectConfirmationData}, if any is present.
+ * Validates the <code>NotOnOrAfter</code> condition of the
+ * {@link org.opensaml.saml.saml2.core.SubjectConfirmationData}, if any is present.
*
- * @param confirmation confirmation method, with {@link SubjectConfirmationData}, being validated
+ * @param confirmation confirmation method, with {@link org.opensaml.saml.saml2.core.SubjectConfirmationData},
+ * being validated
* @param assertion assertion bearing the confirmation method
* @param context current validation context
*
@@ -226,7 +230,8 @@ public abstract class AbstractSubjectConfirmationValidator implements SubjectCon
}
/**
- * Validates the <code>Address</code> condition of the {@link SubjectConfirmationData}, if any is present.
+ * Validates the <code>Address</code> condition of the {@link org.opensaml.saml.saml2.core.SubjectConfirmationData},
+ * if any is present.
*
* @param confirmation confirmation method being validated
* @param assertion assertion bearing the confirmation method
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidator.java
index c6a37b0..e06bcfe 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/HolderOfKeySubjectConfirmationValidator.java
@@ -61,7 +61,7 @@ import org.slf4j.LoggerFactory;
* {@link KeyValue} or {@link DEREncodedKeyValue} within one of the {@link KeyInfo} entries in the confirmation data
* </li>
* <li>
- * the presenter's public cert matches an {@link org.opensaml.xml.signature.X509Certificate} within one of the
+ * the presenter's public cert matches an {@link org.opensaml.xmlsec.signature.X509Certificate} within one of the
* {@link KeyInfo} entries in the confirmation data
* </li>
* </ul>
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AddStatusToResponse.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AddStatusToResponse.java
index caaec03..9f35908 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AddStatusToResponse.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/profile/impl/AddStatusToResponse.java
@@ -58,7 +58,7 @@ import com.google.common.base.Predicates;
import com.google.common.collect.Collections2;
/**
- * Action that sets {@link Status} content in a {@link Response} obtained from
+ * Action that sets {@link Status} content in a {@link StatusResponseType} obtained from
* a lookup strategy, typically from the outbound message context.
*
* <p>If the message already contains status information, this action will overwrite it.</p>
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
index 8304699..558a9ec 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedHttpClientSupport.java
@@ -49,7 +49,7 @@ public final class SecurityEnhancedHttpClientSupport {
* server TLS based on a mandatory {@link TrustEngine} supplied at runtime.
*
* <p>
- * Equivalent to {@link #buildTLSSocketFactory(true, false)}.
+ * Equivalent to {@link #buildTLSSocketFactory(boolean, boolean)} called with true, false.
* </p>
*
* @return a new instance of security-enhanced TLS socket factory
@@ -65,7 +65,7 @@ public final class SecurityEnhancedHttpClientSupport {
* and additionally configured for optional client TLS support via context client TLS credential.
*
* <p>
- * Equivalent to {@link #buildTLSSocketFactory(true, true)}.
+ * Equivalent to {@link #buildTLSSocketFactory(boolean, boolean)} called with true, true.
* </p>
*
* @return a new instance of security-enhanced TLS socket factory
@@ -84,7 +84,7 @@ public final class SecurityEnhancedHttpClientSupport {
* </p>
*
* <p>
- * Equivalent to {@link #buildTLSSocketFactory(false, true)}.
+ * Equivalent to {@link #buildTLSSocketFactory(boolean, boolean)} called with false, true.
* </p>
*
* @return a new instance of security-enhanced TLS socket factory
diff --git a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/JPAStorageService.java b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/JPAStorageService.java
index 7adcb5e..2899d2c 100644
--- a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/JPAStorageService.java
+++ b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/JPAStorageService.java
@@ -60,8 +60,8 @@ public class JPAStorageService extends AbstractStorageService implements Storage
/** Entity manager factory. */
@Nonnull private final EntityManagerFactory entityManagerFactory;
- /** Number of times to retry a transaction if it rolls back. Default value is {@value} . */
- @NonNegative private int transactionRetry = 3;
+ /** Number of times to retry a transaction if it rolls back. */
+ @NonNegative private int transactionRetry;
/**
* Creates a new JPA storage service.
@@ -74,6 +74,7 @@ public class JPAStorageService extends AbstractStorageService implements Storage
setContextSize(JPAStorageRecord.CONTEXT_SIZE);
setKeySize(JPAStorageRecord.KEY_SIZE);
setValueSize(Integer.MAX_VALUE);
+ setTransactionRetry(3);
}
/**
@@ -86,7 +87,7 @@ public class JPAStorageService extends AbstractStorageService implements Storage
}
/**
- * Sets the number of times a transaction will be retried.
+ * Sets the number of times a transaction will be retried (default is 3).
*
* @param retry number of transaction retries
*/
diff --git a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/ClientStorageService.java b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/ClientStorageService.java
index 935348b..126b231 100644
--- a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/ClientStorageService.java
+++ b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/ClientStorageService.java
@@ -67,7 +67,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Implementation of {@link StorageService} that stores data in-memory in a shared session attribute.
+ * Implementation of {@link org.opensaml.storage.StorageService} that stores data in-memory in a
+ * shared session attribute.
*
* <p>The data for this service is managed in a {@link ClientStorageServiceStore} object, which must
* be created by some operation within the container for this implementation to function. Actual
diff --git a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/LogLocalStorageSaveResults.java b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/LogLocalStorageSaveResults.java
index 118cb8c..52be73c 100644
--- a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/LogLocalStorageSaveResults.java
+++ b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/LogLocalStorageSaveResults.java
@@ -32,7 +32,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
/**
* An action that logs the results of Local Storage-based {@link ClientStorageService} save operations.
*
- * @event {@link EventIds#PROCEED_EVENT_ID}
+ * @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
*
* @param <InboundMessageType>
* @param <OutboundMessageType>
diff --git a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/SaveCookieBackedClientStorageServices.java b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/SaveCookieBackedClientStorageServices.java
index 5681b16..5c31a13 100644
--- a/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/SaveCookieBackedClientStorageServices.java
+++ b/opensaml-storage-impl/src/main/java/org/opensaml/storage/impl/client/SaveCookieBackedClientStorageServices.java
@@ -43,7 +43,7 @@ import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
/**
- * An action that performs any number of {@link ClientStorageOperation} instances sourced from
+ * An action that performs any number of {@link ClientStorageServiceOperation} instances sourced from
* cookies by issuing the necessary Set-Cookie headers.
*
* <p>The {@link ClientStorageSaveContext} is also removed.</p>
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 c52ecf2..6cc9472 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,8 +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 edu.vt.middleware.idp.storage.MemcachedStorageCapabilities#valueSize} should be set equal to the
- * chosen slab size.
+ * the {@link MemcachedStorageCapabilities#valueSize} should be set equal to the chosen slab size.
*
* @param capabilities Memcached storage capabilities.
*/
diff --git a/opensaml-storage-impl/src/test/java/org/opensaml/storage/impl/memcached/StringTranscoderTest.java b/opensaml-storage-impl/src/test/java/org/opensaml/storage/impl/memcached/StringTranscoderTest.java
index 1770834..b5108f8 100644
--- a/opensaml-storage-impl/src/test/java/org/opensaml/storage/impl/memcached/StringTranscoderTest.java
+++ b/opensaml-storage-impl/src/test/java/org/opensaml/storage/impl/memcached/StringTranscoderTest.java
@@ -23,7 +23,7 @@ import org.testng.annotations.Test;
import static org.testng.Assert.assertEquals;
/**
- * Unit test for {@link edu.vt.middleware.idp.storage.StringTranscoder}.
+ * Unit test for {@link StringTranscoder}.
*/
public class StringTranscoderTest {
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
index 1fed081..b618e35 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicEncryptionParametersResolver.java
@@ -220,7 +220,7 @@ public class BasicEncryptionParametersResolver extends AbstractSecurityParameter
/**
* Validate that the {@link EncryptionParameters} instance has all the required properties populated.
*
- * <p>Equivalent to: {@link #validate(EncryptionParameters, false)} </p>
+ * <p>Equivalent to: {@link #validate(EncryptionParameters, boolean)} called with false</p>
*
* @param params the parameters instance to evaluate
*
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list