[java-opensaml] branch master updated: Javadoc fixes
Ian Young
ian at iay.org.uk
Thu Nov 9 10:43:34 EST 2017
This is an automated email from the git hooks/post-receive script.
iay 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=000e2c245b982d0185481b912597d5fba23bd930
The following commit(s) were added to refs/heads/master by this push:
new 000e2c2 Javadoc fixes
000e2c2 is described below
commit 000e2c245b982d0185481b912597d5fba23bd930
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Thu Nov 9 15:43:24 2017 +0000
Javadoc fixes
---
.../opensaml/core/xml/ElementExtensibleXMLObject.java | 2 +-
.../org/opensaml/core/xml/XMLObjectBaseTestCase.java | 2 +-
.../java/org/opensaml/saml/common/SAMLObjectSupport.java | 2 +-
.../navigate/AttributeConsumerServiceLookupFunction.java | 3 ++-
.../common/profile/logic/EntityAttributesPredicate.java | 2 +-
.../java/org/opensaml/saml/config/SAMLConfiguration.java | 6 ++----
.../opensaml/saml/config/SAMLConfigurationSupport.java | 4 +---
.../org/opensaml/saml/ext/saml2mdrpi/Publication.java | 2 +-
.../opensaml/saml/ext/saml2mdrpi/PublicationInfo.java | 2 +-
.../opensaml/saml/ext/saml2mdrpi/PublicationPath.java | 2 +-
.../opensaml/saml/ext/saml2mdrpi/RegistrationInfo.java | 2 +-
.../opensaml/saml/ext/saml2mdrpi/RegistrationPolicy.java | 2 +-
.../org/opensaml/saml/ext/saml2mdrpi/UsagePolicy.java | 2 +-
.../resolver/index/SimpleStringMetadataIndexKey.java | 2 +-
.../assertion/SAML2AssertionValidationParameters.java | 9 ++++++---
.../saml2/assertion/SubjectConfirmationValidator.java | 6 ++++--
.../impl/AbstractSubjectConfirmationValidator.java | 3 ++-
.../saml2/binding/decoding/impl/HTTPArtifactDecoder.java | 2 +-
.../impl/AbstractDynamicHTTPMetadataResolverTest.java | 1 -
.../security/httpclient/HttpClientSecurityConstants.java | 9 ++++++---
.../security/x509/tls/CertificateNameOptions.java | 6 +++---
.../impl/SecurityEnhancedTLSSocketFactory.java | 16 ++++++++++------
.../httpclient/impl/TrustEngineTLSSocketFactory.java | 9 ++++++---
.../impl/BasicClientTLSValidationParametersResolver.java | 3 ++-
.../opensaml/soap/messaging/SOAPMessagingSupport.java | 4 ++--
.../java/org/opensaml/storage/StorageCapabilities.java | 2 +-
.../main/java/org/opensaml/storage/StorageRecord.java | 2 +-
.../xmlsec/signature/impl/KeyInfoUnmarshaller.java | 2 +-
28 files changed, 61 insertions(+), 48 deletions(-)
diff --git a/opensaml-core/src/main/java/org/opensaml/core/xml/ElementExtensibleXMLObject.java b/opensaml-core/src/main/java/org/opensaml/core/xml/ElementExtensibleXMLObject.java
index 0b3af41..2867425 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/xml/ElementExtensibleXMLObject.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/xml/ElementExtensibleXMLObject.java
@@ -41,7 +41,7 @@ public interface ElementExtensibleXMLObject extends XMLObject {
* @param typeOrName the QName of the statements to return
* @return list of XMLObjects added to this XMLObject as part of the "any" content model
*
- * TODO: think this should be typed List<? extends XMLObject>
+ * TODO: think this should be typed List<? extends XMLObject>
*/
@Nonnull public List<XMLObject> getUnknownXMLObjects(@Nonnull final QName typeOrName);
}
\ No newline at end of file
diff --git a/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java b/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
index 047678a..2cfcdbc 100644
--- a/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
+++ b/opensaml-core/src/test/java/org/opensaml/core/xml/XMLObjectBaseTestCase.java
@@ -187,7 +187,7 @@ public abstract class XMLObjectBaseTestCase extends OpenSAMLInitBaseTestCase {
/**
* Unmarshalls an element file into its XMLObject.
*
- * @param if true, checked exceptions will be thrown, if false then they cause assertion of test failure
+ * @param propagateErrors if true, checked exceptions will be thrown, if false then they cause assertion of test failure
* @return the XMLObject from the file
*
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/SAMLObjectSupport.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/SAMLObjectSupport.java
index a369dce..ec26dcf 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/SAMLObjectSupport.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/SAMLObjectSupport.java
@@ -45,7 +45,7 @@ public final class SAMLObjectSupport {
* {@link SignatureConstants#TRANSFORM_C14N_EXCL_OMIT_COMMENTS}
* or {@link SignatureConstants#TRANSFORM_C14N_EXCL_WITH_COMMENTS},
* it declares on the object all non-visible namespaces
- * as determined by {@link org.opensaml.core.xml.XMLObject.NamespaceManager#getNonVisibleNamespaces()}.
+ * as determined by {@link org.opensaml.core.xml.NamespaceManager#getNonVisibleNamespaces()}.
* </p>
*
* @param signableObject the signable SAML object to evaluate
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/navigate/AttributeConsumerServiceLookupFunction.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/navigate/AttributeConsumerServiceLookupFunction.java
index c3ba38a..e06e8d0 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/navigate/AttributeConsumerServiceLookupFunction.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/navigate/AttributeConsumerServiceLookupFunction.java
@@ -24,7 +24,8 @@ import org.opensaml.saml.common.messaging.context.AttributeConsumingServiceConte
import org.opensaml.saml.saml2.metadata.AttributeConsumingService;
/**
- * {@link Function} to return the {@link AttributeConsumingService} from the {@link AttributeConsumingServiceContext}.
+ * {@link com.google.common.base.Function} to return the {@link AttributeConsumingService}
+ * from the {@link AttributeConsumingServiceContext}.
*/
public class AttributeConsumerServiceLookupFunction implements
ContextDataLookupFunction<AttributeConsumingServiceContext, AttributeConsumingService> {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/EntityAttributesPredicate.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/EntityAttributesPredicate.java
index 76c8f17..a6758b4 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/EntityAttributesPredicate.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/EntityAttributesPredicate.java
@@ -57,7 +57,7 @@ import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
/**
- * Predicate to determine whether an {@link EntityDescriptor} or its parent groups contain an {@EntityAttribute}
+ * Predicate to determine whether an {@link EntityDescriptor} or its parent groups contain an {@link EntityAttributes}
* extension {@link Attribute} that matches the predicate's criteria.
*/
public class EntityAttributesPredicate implements Predicate<EntityDescriptor> {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfiguration.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfiguration.java
index c5141ea..f6b7e45 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfiguration.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfiguration.java
@@ -96,9 +96,7 @@ public class SAMLConfiguration {
/**
* Sets the date format used to string'ify SAML's date/time objects.
*
- * See the
- * {@link <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>}
- * documentation for format syntax.
+ * See the {@link java.text.SimpleDateFormat} documentation for format syntax.
*
* @param format date format used to string'ify date objects
*/
@@ -167,7 +165,7 @@ public class SAMLConfiguration {
* <p>
* The supplied list will be copied. Values will be normalized: 1) strings will be trimmed,
* 2) nulls will be removed, and 3) all values will be lowercased.
- * </>
+ * </p>
*
* <p>Note, the appearance of schemes such as 'javascript' may open the system up to attacks
* (e.g. cross-site scripting attacks).
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfigurationSupport.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfigurationSupport.java
index f703f94..2f2ce2e 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfigurationSupport.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/config/SAMLConfigurationSupport.java
@@ -46,9 +46,7 @@ public final class SAMLConfigurationSupport {
/**
* Sets the date format used to string'ify SAML's date/time objects.
*
- * See the
- * {@link <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>}
- * documentation for format syntax.
+ * See the {@link java.text.SimpleDateFormat} documentation for format syntax.
*
* @param format date format used to string'ify date objects
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/Publication.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/Publication.java
index c81f8f9..d65656b 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/Publication.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/Publication.java
@@ -24,7 +24,7 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:Publication></code> element. <br/>
+ * * Representation of the <code><mdrpi:Publication></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationInfo.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationInfo.java
index bd4b28f..d375458 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationInfo.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationInfo.java
@@ -26,7 +26,7 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:PublicationInfo></code> element. <br/>
+ * * Representation of the <code><mdrpi:PublicationInfo></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationPath.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationPath.java
index 280210b..500a34e 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationPath.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/PublicationPath.java
@@ -25,7 +25,7 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:PublicationPath></code> element. <br/>
+ * * Representation of the <code><mdrpi:PublicationPath></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationInfo.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationInfo.java
index 01fd922..5773807 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationInfo.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationInfo.java
@@ -26,7 +26,7 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:RegistrationInfo></code> element. <br/>
+ * * Representation of the <code><mdrpi:RegistrationInfo></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationPolicy.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationPolicy.java
index 2c7a3d0..8928eb5 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationPolicy.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/RegistrationPolicy.java
@@ -23,7 +23,7 @@ import org.opensaml.saml.common.xml.SAMLConstants;
import org.opensaml.saml.saml2.metadata.LocalizedURI;
/**
- * Representation of the <code><mdrpi:RegistrationPolicy></code> element. <br/>
+ * Representation of the <code><mdrpi:RegistrationPolicy></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/UsagePolicy.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/UsagePolicy.java
index 428ae6e..2f0753c 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/UsagePolicy.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdrpi/UsagePolicy.java
@@ -23,7 +23,7 @@ import org.opensaml.saml.common.xml.SAMLConstants;
import org.opensaml.saml.saml2.metadata.LocalizedURI;
/**
- * Representation of the <code><mdrpi:UsagePolicy></code> element. <br/>
+ * Representation of the <code><mdrpi:UsagePolicy></code> element. <br/>
* See <a
* href="http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/">http://docs.oasis-open.org/security
* /saml/Post2.0/saml-metadata-rpi/v1.0/</a>
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/index/SimpleStringMetadataIndexKey.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/index/SimpleStringMetadataIndexKey.java
index d6524c7..0b75e5d 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/index/SimpleStringMetadataIndexKey.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/index/SimpleStringMetadataIndexKey.java
@@ -25,7 +25,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
- * A simple implementation of {@link of MetadataIndexKey} based on a single input string.
+ * A simple implementation of {@link MetadataIndexKey} based on a single input string.
*/
public class SimpleStringMetadataIndexKey implements MetadataIndexKey {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
index db5c2b6..2cfe7bd 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SAML2AssertionValidationParameters.java
@@ -57,13 +57,15 @@ public final class SAML2AssertionValidationParameters {
public static final String SIGNATURE_VALIDATION_CRITERIA_SET = STD_PREFIX + ".SignatureValidationCriteriaSet";
/**
- * Carries a {@link java.util.Set<java.lang.String>} whose values are the acceptable
+ * Carries a {@link java.util.Set}<code><</code>{@link java.lang.String}<code>></code>
+ * whose values are the acceptable
* {@link org.opensaml.saml.saml2.core.SubjectConfirmationData} recipients.
*/
public static final String SC_VALID_RECIPIENTS = STD_PREFIX + SC_INFIX + ".ValidRecipients";
/**
- * Carries a {@link java.util.Set<java.net.InetAddress>} whose values are the acceptable
+ * Carries a {@link java.util.Set}<code><</code>{@link java.net.InetAddress}<code>></code>
+ * whose values are the acceptable
* {@link org.opensaml.saml.saml2.core.SubjectConfirmationData} addresses.
*/
public static final String SC_VALID_ADDRESSES = STD_PREFIX + SC_INFIX + ".ValidAddresses";
@@ -85,7 +87,8 @@ public final class SAML2AssertionValidationParameters {
public static final String SC_HOK_CONFIRMED_KEYINFO = STD_PREFIX + SC_INFIX + ".HoK.ConfirmedKeyInfo";
/**
- * Carries a {@link java.util.Set<java.lang.String>} whose values are the acceptable
+ * Carries a {@link java.util.Set}<code><</code>{@link java.lang.String}<code>></code>
+ * whose values are the acceptable
* {@link org.opensaml.saml.saml2.core.AudienceRestriction} {@link org.opensaml.saml.saml2.core.Audience}
* values for evaluating the Assertion.
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SubjectConfirmationValidator.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SubjectConfirmationValidator.java
index a6919c6..679b338 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SubjectConfirmationValidator.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/assertion/SubjectConfirmationValidator.java
@@ -27,7 +27,8 @@ import org.opensaml.saml.saml2.core.Assertion;
import org.opensaml.saml.saml2.core.SubjectConfirmation;
/**
- * Validator that confirms the {@link Subject} of the issuer by evaluating the {@link SubjectConfirmation}s within that
+ * Validator that confirms the {@link org.opensaml.saml.saml2.core.Subject}
+ * of the issuer by evaluating the {@link SubjectConfirmation}s within that
* subject.
*/
@ThreadSafe
@@ -41,7 +42,8 @@ public interface SubjectConfirmationValidator {
public String getServicedMethod();
/**
- * Confirms the {@link Subject} by means of the given {@link SubjectConfirmation}.
+ * Confirms the {@link org.opensaml.saml.saml2.core.Subject}
+ * by means of the given {@link SubjectConfirmation}.
*
* @param confirmation the subject confirmation information
* @param assertion the assertion bearing the subject
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 cf04f2a..d8a047c 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
@@ -174,7 +174,8 @@ public abstract class AbstractSubjectConfirmationValidator implements SubjectCon
}
/**
- * Validates the <code>Recipient</code> condition of the {@link SubjectConfirmationData}, if any is present.
+ * Validates the <code>Recipient</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/binding/decoding/impl/HTTPArtifactDecoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPArtifactDecoder.java
index 6e83d4d..ccaf2d9 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPArtifactDecoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPArtifactDecoder.java
@@ -357,7 +357,7 @@ public class HTTPArtifactDecoder extends BaseHttpServletRequestXMLMessageDecoder
/**
* @param artifact
* @param peerRoleDescriptor
- * @param artifactResolveEndpointURL
+ * @param ars
* @return
*/
private SAMLObject dereferenceArtifact(final SAML2Artifact artifact, final RoleDescriptor peerRoleDescriptor,
diff --git a/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolverTest.java b/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolverTest.java
index 6f298be..7fa79a5 100644
--- a/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolverTest.java
+++ b/opensaml-saml-impl/src/test/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolverTest.java
@@ -143,7 +143,6 @@ public class AbstractDynamicHTTPMetadataResolverTest extends XMLObjectBaseTestCa
/**
* Constructor.
*
- * @param backgroundTaskTimer
* @param client
*/
public MockDynamicHTTPMetadataResolver(HttpClient client) {
diff --git a/opensaml-security-api/src/main/java/org/opensaml/security/httpclient/HttpClientSecurityConstants.java b/opensaml-security-api/src/main/java/org/opensaml/security/httpclient/HttpClientSecurityConstants.java
index 0668eb4..d391641 100644
--- a/opensaml-security-api/src/main/java/org/opensaml/security/httpclient/HttpClientSecurityConstants.java
+++ b/opensaml-security-api/src/main/java/org/opensaml/security/httpclient/HttpClientSecurityConstants.java
@@ -26,7 +26,10 @@ import net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory;
public final class HttpClientSecurityConstants {
/** Context key for a trust engine instance supplied by an HttpClient caller.
- * Value must be an instance of {@link TrustEngine<? super X509Credential>}. */
+ * Value must be an instance of
+ * {@link org.opensaml.security.trust.TrustEngine}<code><? super </code>
+ * {@link org.opensaml.security.x509.X509Credential}<code>></code>.
+ */
public static final String CONTEXT_KEY_TRUST_ENGINE = "opensaml.TrustEngine";
/** Context key for a criteria set instance supplied by an HttpClient caller.
@@ -42,11 +45,11 @@ public final class HttpClientSecurityConstants {
public static final String CONTEXT_KEY_CLIENT_TLS_CREDENTIAL = "opensaml.ClientTLSCredential";
/** HttpContext key for a a list of TLS protocols to enable on the socket.
- * Must be an instance of {@link List<String>}. */
+ * Must be an instance of {@link java.util.List}<code><</code>{@link String}<code>></code>. */
public static final String CONTEXT_KEY_TLS_PROTOCOLS = TLSSocketFactory.CONTEXT_KEY_TLS_PROTOCOLS;
/** HttpContext key for a a list of TLS cipher suites to enable on the socket.
- * Must be an instance of {@link List<String>}. */
+ * Must be an instance of {@link java.util.List}<code><</code>{@link String}<code>></code>. */
public static final String CONTEXT_KEY_TLS_CIPHER_SUITES = TLSSocketFactory.CONTEXT_KEY_TLS_CIPHER_SUITES;
/** HttpContext key for an instance of {@link org.apache.http.conn.ssl.X509HostnameVerifier}. */
diff --git a/opensaml-security-api/src/main/java/org/opensaml/security/x509/tls/CertificateNameOptions.java b/opensaml-security-api/src/main/java/org/opensaml/security/x509/tls/CertificateNameOptions.java
index b2f7b4c..1910d76 100644
--- a/opensaml-security-api/src/main/java/org/opensaml/security/x509/tls/CertificateNameOptions.java
+++ b/opensaml-security-api/src/main/java/org/opensaml/security/x509/tls/CertificateNameOptions.java
@@ -56,7 +56,7 @@ public class CertificateNameOptions implements Cloneable {
*/
private X500DNHandler x500DNHandler;
- /** The format specifier for serializaing X.500 subject names to strings. */
+ /** The format specifier for serializing X.500 subject names to strings. */
private String x500SubjectDNFormat;
/** Constructor. */
@@ -104,7 +104,7 @@ public class CertificateNameOptions implements Cloneable {
/**
* Get the set of types of subject alternative names evaluate as derived issuer entity ID names,
- * using integer constants defined in {@link org.opensaml.security.X509Support}.
+ * using integer constants defined in {@link org.opensaml.security.x509.X509Support}.
*
* @return Returns the subjectAltNames.
*/
@@ -114,7 +114,7 @@ public class CertificateNameOptions implements Cloneable {
/**
* Set the set of types of subject alternative names evaluate as derived issuer entity ID names,
- * using integer constants defined in {@link org.opensaml.security.X509Support}.
+ * using integer constants defined in {@link org.opensaml.security.x509.X509Support}.
*
* @param names the set of types of subject alternative names
*/
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
index 40e3726..47752ec 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/SecurityEnhancedTLSSocketFactory.java
@@ -58,7 +58,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* <p>
* This implementation wraps an existing TLS socket factory instance, decorating it with additional support for:
* <ul>
- * <li>Verifying the server TLS certificate and chain via a {@link TrustEngine<Credential>}
+ * <li>Verifying the server TLS certificate and chain via a
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
* and {@link CriteriaSet} supplied by the HttpClient caller via the {@link HttpContext}.</li>
*
* <li>Loading and clearing a thread-local instance of {@link X509Credential} used for client TLS.</li>
@@ -69,7 +70,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* The context keys used by this component are as follows, defined in {@link HttpClientSecurityConstants}:
* <ul>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_TRUST_ENGINE}: The trust engine instance used.
- * Supplied by the HttpClient caller. Must be an instance of {@link TrustEngine<Credential>}.</li>
+ * Supplied by the HttpClient caller. Must be an instance of
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>.</li>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_CRITERIA_SET}: The criteria set instance used.
* Supplied by the HttpClient caller. Must be an instance of {@link CriteriaSet}. </li>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_SERVER_TLS_CREDENTIAL_TRUSTED}: The result of the
@@ -107,8 +109,8 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* </p>
*
* <p>
- * Client TLS support requires use of a compatible {@link java.net.ssl.KeyManager} implementation configured in the
- * {@link java.net.ssl.SSLContext} of the wrapped {@link LayeredConnectionSocketFactory}, such as
+ * Client TLS support requires use of a compatible {@link javax.net.ssl.KeyManager} implementation configured in the
+ * {@link javax.net.ssl.SSLContext} of the wrapped {@link LayeredConnectionSocketFactory}, such as
* {@link org.opensaml.security.x509.tls.impl.ThreadLocalX509CredentialKeyManager}.
* </p>
*
@@ -234,7 +236,8 @@ public class SecurityEnhancedTLSSocketFactory implements LayeredConnectionSocket
/**
* Perform trust evaluation by extracting the server TLS {@link X509Credential} from the
- * {@link SSLSession} and evaluating it via a {@link TrustEngine<Credential>}
+ * {@link SSLSession} and evaluating it via a
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
* and {@link CriteriaSet} supplied by the caller via the {@link HttpContext}.
*
* @param socket the socket instance being processed
@@ -257,7 +260,8 @@ public class SecurityEnhancedTLSSocketFactory implements LayeredConnectionSocket
// Checkstyle: ReturnCount OFF
/**
* Perform trust evaluation by extracting the server TLS {@link X509Credential} from the
- * {@link SSLSession} and evaluating it via a {@link TrustEngine<Credential>}
+ * {@link SSLSession} and evaluating it via a
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
* and {@link CriteriaSet} supplied by the caller via the {@link HttpContext}.
*
* @param socket the socket instance being processed
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/TrustEngineTLSSocketFactory.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/TrustEngineTLSSocketFactory.java
index d4d5ecb..04dda01 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/TrustEngineTLSSocketFactory.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/TrustEngineTLSSocketFactory.java
@@ -51,14 +51,16 @@ import org.slf4j.LoggerFactory;
/**
* An implementation of HttpClient's {@link LayeredConnectionSocketFactory}, which supports
- * verifying the server TLS certificate and chain via a {@link TrustEngine<Credential>}
+ * verifying the server TLS certificate and chain via a
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
* and {@link CriteriaSet} supplied by the HttpClient caller via the {@link HttpContext}.
*
* <p>
* The context keys used by this component are as follows, defined in {@link HttpClientSecurityConstants}:
* <ul>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_TRUST_ENGINE}: The trust engine instance used.
- * Supplied by the HttpClient caller. Must be an instance of {@link TrustEngine<Credential>}.</li>
+ * Supplied by the HttpClient caller. Must be an instance of
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>.</li>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_CRITERIA_SET}: The criteria set instance used.
* Supplied by the HttpClient caller. Must be an instance of {@link CriteriaSet}. </li>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_SERVER_TLS_CREDENTIAL_TRUSTED}: The result of the
@@ -144,7 +146,8 @@ public class TrustEngineTLSSocketFactory implements LayeredConnectionSocketFacto
// Checkstyle: ReturnCount OFF
/**
* Perform trust evaluation by extracting the server TLS {@link X509Credential} from the
- * {@link SSLSession} and evaluating it via a {@link TrustEngine<Credential>}
+ * {@link SSLSession} and evaluating it via a
+ * {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
* and {@link CriteriaSet} supplied by the caller via the {@link HttpContext}.
*
* @param socket the socket instance being processed
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/BasicClientTLSValidationParametersResolver.java b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/BasicClientTLSValidationParametersResolver.java
index 34bd206..d001a54 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/BasicClientTLSValidationParametersResolver.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/tls/impl/BasicClientTLSValidationParametersResolver.java
@@ -74,7 +74,8 @@ public class BasicClientTLSValidationParametersResolver implements ClientTLSVali
}
/**
- * Resolve and return the effective {@link TrustEngine<? super X509Credential>}.
+ * Resolve and return the effective
+ * {@link TrustEngine}<code><? super </code>{@link X509Credential}<code>></code>.
*
* @param criteria the input criteria being evaluated
*
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/SOAPMessagingSupport.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/SOAPMessagingSupport.java
index fe3546f..60146fe 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/SOAPMessagingSupport.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/messaging/SOAPMessagingSupport.java
@@ -52,7 +52,7 @@ public final class SOAPMessagingSupport {
private SOAPMessagingSupport() {}
/**
- * Get the current {@link InboundSOAPContext} for the given {@link @link MessageContext}.
+ * Get the current {@link InboundSOAPContext} for the given {@link MessageContext}.
*
* @param messageContext the current message context
*
@@ -64,7 +64,7 @@ public final class SOAPMessagingSupport {
}
/**
- * Get the current {@link SOAP11Context} for the given {@link @link MessageContext}.
+ * Get the current {@link SOAP11Context} for the given {@link MessageContext}.
*
* @param messageContext the current message context
* @param autoCreate whether to auto-create the context if it does not exist
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageCapabilities.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageCapabilities.java
index 593bd35..c0b2b34 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageCapabilities.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageCapabilities.java
@@ -20,7 +20,7 @@ package org.opensaml.storage;
/**
* Exposes capabilities of a {@link StorageService} implementation.
*
- * <p>Deprecated in favor of {@link StorageServiceEx}.
+ * <p>Deprecated in favor of {@link StorageCapabilitiesEx}.</p>
*/
public interface StorageCapabilities {
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageRecord.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageRecord.java
index 1e90477..a12e9bb 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageRecord.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/StorageRecord.java
@@ -99,7 +99,7 @@ public class StorageRecord<Type> {
/**
* Set the record version.
*
- * @param ver the new record version, must be > 0
+ * @param ver the new record version, must be > 0
*/
protected void setVersion(final long ver) {
version = Constraint.isGreaterThan(0, ver, "Version must be greater than zero");
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/signature/impl/KeyInfoUnmarshaller.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/signature/impl/KeyInfoUnmarshaller.java
index 9026d7d..b1d9778 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/signature/impl/KeyInfoUnmarshaller.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/signature/impl/KeyInfoUnmarshaller.java
@@ -23,7 +23,7 @@ import org.opensaml.xmlsec.signature.KeyInfo;
import org.w3c.dom.Attr;
/**
- * A thread-safe Unmarshaller for {@link org.opensaml.xmlsec.signature.KeyInfoType} objects.
+ * A thread-safe Unmarshaller for {@link org.opensaml.xmlsec.signature.KeyInfo} objects.
*/
public class KeyInfoUnmarshaller extends AbstractXMLSignatureUnmarshaller {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list