[java-opensaml] branch master updated: JPAR-131 - Fix doclint issues
Ian Young
ian at iay.org.uk
Thu Dec 19 11:20:25 EST 2019
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=59f1ad843c38b74d2bf4e9804e7dd1c61ec0ea00
The following commit(s) were added to refs/heads/master by this push:
new 59f1ad8 JPAR-131 - Fix doclint issues
59f1ad8 is described below
commit 59f1ad843c38b74d2bf4e9804e7dd1c61ec0ea00
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Thu Dec 19 16:20:15 2019 +0000
JPAR-131 - Fix doclint issues
https://issues.shibboleth.net/jira/browse/JPAR-131
---
.../org/opensaml/core/config/Configuration.java | 2 +-
.../opensaml/core/config/ConfigurationService.java | 2 +-
.../config/provider/MapBasedConfiguration.java | 2 +-
.../core/criterion/SatisfyAnyCriterion.java | 3 --
.../main/java/org/opensaml/core/xml/XMLObject.java | 8 ++---
.../opensaml/messaging/context/BaseContext.java | 4 +--
.../profile/action/impl/EncodeMessage.java | 2 +-
.../common/AbstractSAMLObjectUnmarshaller.java | 4 +--
.../context/SAMLSubjectNameIdentifierContext.java | 3 +-
.../opensaml/saml/ext/saml2mdrpi/Publication.java | 5 +--
.../saml/ext/saml2mdrpi/PublicationInfo.java | 5 +--
.../saml/ext/saml2mdrpi/PublicationPath.java | 5 +--
.../saml/ext/saml2mdrpi/RegistrationInfo.java | 5 +--
.../saml/ext/saml2mdrpi/RegistrationPolicy.java | 5 +--
.../opensaml/saml/ext/saml2mdrpi/UsagePolicy.java | 5 +--
.../opensaml/saml/ext/saml2mdui/DiscoHints.java | 15 ++++----
.../opensaml/saml/ext/saml2mdui/DomainHint.java | 2 +-
.../saml/ext/saml2mdui/GeolocationHint.java | 2 +-
.../org/opensaml/saml/ext/saml2mdui/IPHint.java | 2 +-
.../org/opensaml/saml/ext/saml2mdui/UIInfo.java | 40 ++++++++++++++--------
.../metadata/resolver/filter/MetadataFilter.java | 2 +-
.../support/AttributeConsumingServiceSelector.java | 6 ++--
.../metadata/support/SAML2MetadataSupport.java | 3 +-
.../org/opensaml/saml/saml1/core/StatusCode.java | 1 -
.../saml2/assertion/SAML20AssertionValidator.java | 11 +++---
.../opensaml/saml/saml2/encryption/Encrypter.java | 4 +++
.../saml/saml2/metadata/SPSSODescriptor.java | 4 +--
.../saml/saml2/metadata/SSODescriptor.java | 2 +-
.../impl/BasicDynamicTrustedNamesStrategy.java | 2 +-
.../filter/impl/ByReferenceMetadataFilter.java | 2 +-
.../impl/AbstractBatchMetadataResolver.java | 2 +-
.../impl/AbstractDynamicHTTPMetadataResolver.java | 13 +++++--
.../resolver/impl/HTTPMetadataResolver.java | 10 +++++-
.../resolver/impl/RegexRequestURLBuilder.java | 2 +-
.../saml/metadata/resolver/impl/package-info.java | 18 ++++++----
.../index/impl/SAMLArtifactMetadataIndex.java | 2 +-
.../impl/AbstractSubjectConfirmationValidator.java | 6 ++--
.../AudienceRestrictionConditionValidator.java | 6 ++--
.../impl/BearerSubjectConfirmationValidator.java | 9 +++--
.../DelegationRestrictionConditionValidator.java | 8 ++---
.../HolderOfKeySubjectConfirmationValidator.java | 10 +++---
.../impl/OneTimeUseConditionValidator.java | 6 ++--
.../impl/ProxyRestrictionConditionValidator.java | 8 ++---
...SenderVouchersSubjectConfirmationValidator.java | 8 ++---
...ultSAML20AssertionValidationContextBuilder.java | 2 +-
.../security/impl/MetadataCredentialResolver.java | 6 ++--
...MetadataSignatureSigningParametersResolver.java | 2 +-
.../BasicHttpClientSecurityParametersResolver.java | 2 +-
.../impl/SecurityEnhancedTLSSocketFactory.java | 4 +--
.../impl/BaseClientCertAuthSecurityHandler.java | 2 +-
.../impl/BasicX509CredentialNameEvaluator.java | 2 +-
...BasicClientTLSValidationParametersResolver.java | 2 +-
.../soap/wssecurity/AttributedDateTime.java | 8 ++---
.../http/impl/HttpClientRequestSOAP11Encoder.java | 2 +-
.../encoder/http/impl/HTTPSOAP11Encoder.java | 2 +-
.../impl/AbstractWSSecurityObjectMarshaller.java | 1 -
.../impl/AbstractWSSecurityObjectUnmarshaller.java | 1 -
.../storage/AbstractMapBackedStorageService.java | 2 +-
.../storage/annotation/AnnotationSupport.java | 8 ++---
.../xmlsec/algorithm/AlgorithmSupport.java | 2 +-
.../xmlsec/encryption/support/Decrypter.java | 6 ++--
.../xmlsec/signature/support/SignatureSupport.java | 2 +-
.../impl/BasicDecryptionParametersResolver.java | 2 +-
.../impl/BasicEncryptionParametersResolver.java | 2 +-
.../BasicSignatureSigningParametersResolver.java | 2 +-
...BasicSignatureValidationParametersResolver.java | 2 +-
.../BasicProviderKeyInfoCredentialResolver.java | 3 +-
.../impl/LocalKeyInfoCredentialResolver.java | 2 +-
68 files changed, 184 insertions(+), 151 deletions(-)
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java b/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
index c9b0a03..d46f2a6 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/Configuration.java
@@ -44,7 +44,7 @@ public interface Configuration {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered, typically an interface
- * @param <I> the configuration implementation being registered, which will be an instance of <T>
+ * @param <I> the configuration implementation being registered, which will be an instance of {@link T}
*
* @param configClass the type of configuration class being registered, typically an interface
* @param configInstance the configuration implementation instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java b/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
index 7e9fea6..07f6233 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/ConfigurationService.java
@@ -91,7 +91,7 @@ public class ConfigurationService {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered
- * @param <I> the configuration object instance type being registered, which must be an instance of <T>
+ * @param <I> the configuration object instance type being registered, which must be an instance of {@link T}
*
* @param configClass the type of configuration being registered
* @param configInstance the configuration object instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java b/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
index ad013e7..d04e0e7 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/config/provider/MapBasedConfiguration.java
@@ -55,7 +55,7 @@ public class MapBasedConfiguration implements Configuration {
* Register a configuration instance.
*
* @param <T> the type of configuration being registered, typically an interface
- * @param <I> the configuration implementation being registered, which will be an instance of <T>
+ * @param <I> the configuration implementation being registered, which will be an instance of {@link T}
*
* @param configClass the type of configuration class being registered, typically an interface
* @param configuration the configuration implementation instance being registered
diff --git a/opensaml-core/src/main/java/org/opensaml/core/criterion/SatisfyAnyCriterion.java b/opensaml-core/src/main/java/org/opensaml/core/criterion/SatisfyAnyCriterion.java
index c3bfeb8..cc0a54a 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/criterion/SatisfyAnyCriterion.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/criterion/SatisfyAnyCriterion.java
@@ -34,9 +34,6 @@ public class SatisfyAnyCriterion implements Criterion {
/**
* Constructor.
- *
- * <p></p>
- *
*/
public SatisfyAnyCriterion() {
satisfyAny = Boolean.TRUE;
diff --git a/opensaml-core/src/main/java/org/opensaml/core/xml/XMLObject.java b/opensaml-core/src/main/java/org/opensaml/core/xml/XMLObject.java
index 678ad34..bf9af8d 100644
--- a/opensaml-core/src/main/java/org/opensaml/core/xml/XMLObject.java
+++ b/opensaml-core/src/main/java/org/opensaml/core/xml/XMLObject.java
@@ -210,7 +210,7 @@ public interface XMLObject {
* element content, but not element attributes.
* </p>
*
- * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils"/>
+ * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils">XML Schema: Nil Values</a>
*
* @return whether the object's content model is null
*/
@@ -233,7 +233,7 @@ public interface XMLObject {
* element content, but not element attributes.
* </p>
*
- * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils/>
+ * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils">XML Schema: Nil Values</a>
*
* @return whether the object's content model is null
*/
@@ -255,7 +255,7 @@ public interface XMLObject {
* element content, but not element attributes.
* </p>
*
- * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils/>
+ * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils">XML Schema: Nil Values</a>
*
* @param newNil whether the object's content model is expressed as null
*/
@@ -277,7 +277,7 @@ public interface XMLObject {
* element content, but not element attributes.
* </p>
*
- * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils/>
+ * @see <a href="http://www.w3.org/TR/xmlschema-0/#Nils">XML Schema: Nil Values</a>
*
* @param newNil whether the object's content model is expressed as null
*/
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
index b810252..527cfff 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/context/BaseContext.java
@@ -136,7 +136,7 @@ public abstract class BaseContext implements Iterable<BaseContext> {
*
* @param className the name of the class type to obtain
* @return the held instance of the class, or null
- * @throws ClassNotFoundException
+ * @throws ClassNotFoundException if the named class does not exist
*/
@Nullable public BaseContext getSubcontext(@Nonnull @NotEmpty final String className)
throws ClassNotFoundException {
@@ -155,7 +155,7 @@ public abstract class BaseContext implements Iterable<BaseContext> {
* @param className the name of the class type to obtain
* @param autocreate flag indicating whether the subcontext instance should be auto-created
* @return the held instance of the class, or null
- * @throws ClassNotFoundException
+ * @throws ClassNotFoundException if the named class does not exist
*/
@Nullable public BaseContext getSubcontext(@Nonnull @NotEmpty final String className, final boolean autocreate)
throws ClassNotFoundException {
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 34a4b70..e0e60fa 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,7 +41,7 @@ import org.slf4j.LoggerFactory;
/**
* Action that encodes an outbound response from the outbound {@link MessageContext}.
*
- * <p>The {@link MessageEncoderFactory} is used to obtain a new {@link MessageEncoder} to
+ * <p>The {@link #encoderFactory} is used to obtain a new {@link MessageEncoder} to
* use, and the encoder is destroyed upon completion.</p>
*
*
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/AbstractSAMLObjectUnmarshaller.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/AbstractSAMLObjectUnmarshaller.java
index 9aa7763..390302c 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/AbstractSAMLObjectUnmarshaller.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/AbstractSAMLObjectUnmarshaller.java
@@ -25,8 +25,8 @@ import org.opensaml.core.xml.io.UnmarshallingException;
import org.w3c.dom.Attr;
/**
- * An thread safe abstract unmarshaller. This abstract unmarshaller only works with
- * {@link org.opensaml.saml.common.AbstractSAMLObject}.
+ * A thread safe abstract unmarshaller. This abstract unmarshaller only works with
+ * {@link SAMLObject}.
*/
@ThreadSafe
public abstract class AbstractSAMLObjectUnmarshaller extends AbstractXMLObjectUnmarshaller {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLSubjectNameIdentifierContext.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLSubjectNameIdentifierContext.java
index 6745994..487fdb1 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLSubjectNameIdentifierContext.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLSubjectNameIdentifierContext.java
@@ -37,14 +37,13 @@ import org.slf4j.LoggerFactory;
* {@link #getSAML2SubjectNameID()} will attempt to dynamically resolve the appropriate data from
* the SAML message held in the parent message context if the data has not been set statically by
* the corresponding setter method. This evaluation will be attempted only if:
+ * </p>
* <ul>
* <li>this context instance is an immediate child of a {@link MessageContext} as returned by {@link #getParent()}
* <li>that message context holds a SAML 1 or 2 protocol message as an instance of {@link SAMLObject}</li>
* <li>that SAML message is a type that may carry a subject: {@link org.opensaml.saml.saml1.core.SubjectQuery},
* {@link org.opensaml.saml.saml2.core.SubjectQuery} or {@link org.opensaml.saml.saml2.core.AuthnRequest}.
* </ul>
- * </p>
- *
*/
public final class SAMLSubjectNameIdentifierContext extends BaseContext {
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 249036e..a49c512 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
@@ -26,8 +26,9 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:Publication></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:Publication></code> element.
+ *
+ * @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 d2cfcfd..c1366dd 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
@@ -27,8 +27,9 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:PublicationInfo></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:PublicationInfo></code> element.
+ *
+ * @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 500a34e..f7f9313 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,8 +25,9 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:PublicationPath></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:PublicationPath></code> element.
+ *
+ * @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 b9f7044..96752c1 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
@@ -27,8 +27,9 @@ import org.opensaml.saml.common.SAMLObject;
import org.opensaml.saml.common.xml.SAMLConstants;
/**
- * * Representation of the <code><mdrpi:RegistrationInfo></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:RegistrationInfo></code> element.
+ *
+ * @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 899089d..4695c97 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
@@ -26,8 +26,9 @@ import org.opensaml.saml.saml2.metadata.LocalizedURI;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
/**
- * Representation of the <code><mdrpi:RegistrationPolicy></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:RegistrationPolicy></code> element.
+ *
+ * @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 000431a..9f4cbca 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
@@ -26,8 +26,9 @@ import org.opensaml.saml.saml2.metadata.LocalizedURI;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
/**
- * Representation of the <code><mdrpi:UsagePolicy></code> element. <br/>
- * See <a
+ * Representation of the <code><mdrpi:UsagePolicy></code> element.
+ *
+ * @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/saml2mdui/DiscoHints.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DiscoHints.java
index 55542ef..b4d2005 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DiscoHints.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DiscoHints.java
@@ -49,22 +49,25 @@ public interface DiscoHints extends SAMLObject {
new QName(SAMLConstants.SAML20MDUI_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MDUI_PREFIX);
/**
- * The <IPHint> element specifies a set of [CIDR] blocks associated with,
- * or serviced by, the entity. Both IPv4 and IPv6 CIDR blocks MUST be supported.
+ * The <IPHint> element specifies a set of [CIDR] blocks associated with,
+ * or serviced by, the entity. Both IPv4 and IPv6 CIDR blocks MUST be supported.
*
* @return hints
*/
public List <IPHint> getIPHints();
- /** The <DomainHint> element specifies a set of DNS domains associated with,
+ /**
+ * The <DomainHint> element specifies a set of DNS domains associated with,
* or serviced by, the entity.
+ *
* @return hints.
*/
public List <DomainHint> getDomainHints();
- /** The <GeolocationHint> element specifies the geographic coordinates associated
- * with, or serviced by, the entity. Coordinates are given in decimal form using
- * the World Geodetic System (2d) coordinate system.
+ /**
+ * The <GeolocationHint> element specifies the geographic coordinates associated
+ * with, or serviced by, the entity. Coordinates are given in decimal form using
+ * the World Geodetic System (2d) coordinate system.
*
* @return hints
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
index bb49cbd..5f7f078 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/DomainHint.java
@@ -36,7 +36,7 @@ import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.Object
*
* @author Rod Widdowson August 2010
*
- * The <DomainHint> element specifies a set of DNS domains associated with,
+ * The <DomainHint> element specifies a set of DNS domains associated with,
* or serviced by, the entity.
*/
public interface DomainHint extends SAMLObject, XSString {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
index 13a3e79..6f0e293 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/GeolocationHint.java
@@ -36,7 +36,7 @@ import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.Object
*
* @author Rod Widdowson August 2010
*
- * The <GeolocationHint> element specifies the geographic coordinates associated
+ * The <GeolocationHint> element specifies the geographic coordinates associated
* with, or serviced by, the entity. Coordinates are given in decimal form using
* the World Geodetic System (2d) coordinate system.
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
index 8c988c3..fcbe8cc 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/IPHint.java
@@ -36,7 +36,7 @@ import net.shibboleth.utilities.java.support.primitive.DeprecationSupport.Object
*
* @author Rod Widdowson August 2010
*
- * The <IPHint> element specifies a set of [CIDR] blocks associated with,
+ * The <IPHint> element specifies a set of [CIDR] blocks associated with,
* or serviced by, the entity. Both IPv4 and IPv6 CIDR blocks MUST be supported.
*/
public interface IPHint extends SAMLObject, XSString {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/UIInfo.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/UIInfo.java
index 5bc0447..faf802e 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/UIInfo.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/ext/saml2mdui/UIInfo.java
@@ -52,17 +52,22 @@ public interface UIInfo extends SAMLObject {
/**
* Get the Display Names
*
- * The <DisplayName> element specifies a set of localized names fit for
+ * <p>
+ * The <DisplayName> element specifies a set of localized names fit for
* display to users. Such names are meant to allow a user to distinguish
* and identify the entity acting in a particular role.
+ * </p>
+ *
* @return the names
*/
public List <DisplayName> getDisplayNames();
/**
* Get the keywords.
- *
- * The <Keywords> element specifies a set of keywords associated with the entity.
+ *
+ * <p>
+ * The <Keywords> element specifies a set of keywords associated with the entity.
+ * </p>
*
* @return a list of keywords
*/
@@ -70,13 +75,16 @@ public interface UIInfo extends SAMLObject {
/**
* Return the descriptions.
- *
- * The <Description> element specifies a set of brief, localized descriptions
+ *
+ * <p>
+ * The <Description> element specifies a set of brief, localized descriptions
* fit for display to users. In the case of service providers this SHOULD be a
* description of the service being offered. In the case of an identity provider
* this SHOULD be a description of the community serviced. In all cases this text
* SHOULD be standalone, meaning it is not meant to be filled in to some template
* text (e.g. 'This service offers $description').
+ * </p>
+ *
* @return descriptions
*/
public List <Description> getDescriptions();
@@ -84,7 +92,7 @@ public interface UIInfo extends SAMLObject {
/**
* Get the logos.
*
- * The <Logo> element specifies a set of localized logos fit for display to users.
+ * <p>The <Logo> element specifies a set of localized logos fit for display to users.</p>
*
* @return a list of logos
*/
@@ -92,23 +100,27 @@ public interface UIInfo extends SAMLObject {
/**
* Get the URLs.
- *
- * The <InformationURL> specifies URLs to localized information, about the entity
+ *
+ * <p>
+ * The <InformationURL> specifies URLs to localized information, about the entity
* acting in a given role, meant to be viewed by users. The contents found at
* these URLs SHOULD give a more complete set of information about than what is
- * provided by the <Description> element
- *
+ * provided by the <Description> element.
+ * </p>
+ *
* @return the URLs
*/
public List <InformationURL> getInformationURLs();
/**
* Get the Privacy Statement URLs.
- *
- * The <PrivacyStatementURL> specifies URLs to localized privacy statements.
+ *
+ * <p>
+ * The <PrivacyStatementURL> specifies URLs to localized privacy statements.
* Such statements are meant to provide a user with information about how
- * information will be used and managed by the entity
- *
+ * information will be used and managed by the entity.
+ * </p>
+ *
* @return the URLs
*/
public List <PrivacyStatementURL> getPrivacyStatementURLs();
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/filter/MetadataFilter.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/filter/MetadataFilter.java
index 21bcd0f..43dcc0d 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/filter/MetadataFilter.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/resolver/filter/MetadataFilter.java
@@ -36,7 +36,7 @@ import org.opensaml.core.xml.XMLObject;
* <p>
* If a filter wishes to completely remove the top-level document element, or otherwise indicate that it
* has successfully produced an empty data set from the input document, <code>null</code> may be returned
- * by the filter's {@link #filter(XMLObject)} method.
+ * by the filter's {@link #filter(XMLObject, MetadataFilterContext)} method.
* </p>
*/
public interface MetadataFilter {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/AttributeConsumingServiceSelector.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/AttributeConsumingServiceSelector.java
index 0b97b17..c0af03a 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/AttributeConsumingServiceSelector.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/AttributeConsumingServiceSelector.java
@@ -33,12 +33,12 @@ import org.slf4j.LoggerFactory;
* <p>
* This implementation supports selecting an AttributeConsumingService from parent role descriptors of the following
* types:
+ * </p>
*
* <ol>
* <li>the standard SAML 2 metadata type {@link SPSSODescriptor}</li>
* <li>the extension type {@link AttributeQueryDescriptorType}</li>
* </ol>
- * </p>
*
* <p>
* Subclasses should override {@link #getCandidates()} if support for additional sources of attribute consuming services
@@ -47,6 +47,7 @@ import org.slf4j.LoggerFactory;
*
* <p>
* The selection algorithm is:
+ * </p>
* <ol>
* <li>If an index is supplied, the service with that index is returned. If no such service exists in metadata: if
* {@link #isOnBadIndexUseDefault()} is true, then the default service is returned as described below; otherwise null is
@@ -55,7 +56,6 @@ import org.slf4j.LoggerFactory;
* isDefault of true is returned. If no such service exists, then the first service without an explicit isDefault is
* returned. If no service is yet selected, then the first service listed in metadata is returned.</li>
* </ol>
- * </p>
*/
public class AttributeConsumingServiceSelector {
@@ -163,12 +163,12 @@ public class AttributeConsumingServiceSelector {
* <p>
* This implementation supports selecting an AttributeConsumingService from parent role descriptors of the following
* types:
+ * </p>
*
* <ol>
* <li>the standard SAML 2 metadata type {@link SPSSODescriptor}</li>
* <li>the extension type {@link AttributeQueryDescriptorType}</li>
* </ol>
- * </p>
*
* <p>
* Subclasses should override if support for additional sources of attribute consuming services is needed.
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/SAML2MetadataSupport.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/SAML2MetadataSupport.java
index f4eb74d..add63f3 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/SAML2MetadataSupport.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/metadata/support/SAML2MetadataSupport.java
@@ -36,13 +36,12 @@ public final class SAML2MetadataSupport {
*
* <p>
* The algorithm used is:
+ * </p>
* <ol>
* <li>Select the first endpoint with an explicit <code>isDefault=true</code></li>
* <li>Select the first endpoint with no explicit <code>isDefault</code></li>
* <li>Select the first endpoint</li>
* </ol>
- * </p>
- *
*
* @param candidates the list of candidate indexed endpoints
* @return the selected candidate (or null if the list is null or empty)
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/core/StatusCode.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/core/StatusCode.java
index 52c4eb9..8425e1d 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/core/StatusCode.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/core/StatusCode.java
@@ -106,7 +106,6 @@ public interface StatusCode extends SAMLObject {
* Sets the second level status code.
*
* @param statusCode second level status code
- * @throws IllegalArgumentException
*/
public void setStatusCode(StatusCode statusCode);
}
\ No newline at end of file
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 6f33dc3..aeae816 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
@@ -62,6 +62,8 @@ import org.w3c.dom.Element;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
+ *
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#SIGNATURE_REQUIRED}:
@@ -84,10 +86,11 @@ import org.w3c.dom.Element;
* will be used.
* </li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
+ *
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#CONFIRMED_SUBJECT_CONFIRMATION}:
@@ -95,9 +98,7 @@ import org.w3c.dom.Element;
* Will be present after validation iff subject confirmation was successfully performed.
* </li>
* </ul>
- * </p>
- *
- * */
+ */
public class SAML20AssertionValidator {
/** Default clock skew of 5 minutes. */
@@ -246,7 +247,7 @@ public class SAML20AssertionValidator {
* Log the Assertion which is being validated, along with the supplied validation context parameters.
*
* @param assertion the SAML 2 Assertion being validated
- * @param context
+ * @param context current validation context
*/
protected void log(@Nonnull final Assertion assertion, @Nonnull final ValidationContext context) {
if (log.isTraceEnabled()) {
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/encryption/Encrypter.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/encryption/Encrypter.java
index 17df52a..84bdb31 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/encryption/Encrypter.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/encryption/Encrypter.java
@@ -78,11 +78,15 @@ import com.google.common.base.Strings;
* <p>
* Support is also provided for differing placement options for any associated EncryptedKeys that may be generated. The
* options are:
+ * </p>
+ *
* <ul>
* <li><code>INLINE</code>: EncryptedKeys will placed inside the KeyInfo element of the EncryptedData element</li>
* <li><code>PEER</code>: EncryptedKeys will be placed as peer elements of the EncryptedData inside the
* EncryptedElementType element</li>
* </ul>
+ *
+ * <p>
* The default placement is <code>PEER</code>.
* </p>
*
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SPSSODescriptor.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SPSSODescriptor.java
index ce72594..f15f694 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SPSSODescriptor.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SPSSODescriptor.java
@@ -116,12 +116,12 @@ public interface SPSSODescriptor extends SSODescriptor {
*
* <p>
* The selection algorithm used is:
+ * </p>
* <ol>
* <li>Select the first service with an explicit <code>isDefault=true</code></li>
* <li>Select the first service with no explicit <code>isDefault</code></li>
* <li>Select the first service</li>
* </ol>
- * </p>
*
* @return default assertion consumer service (or null if there are no assertion consumer services defined)
*/
@@ -139,12 +139,12 @@ public interface SPSSODescriptor extends SSODescriptor {
*
* <p>
* The selection algorithm used is:
+ * </p>
* <ol>
* <li>Select the first service with an explicit <code>isDefault=true</code></li>
* <li>Select the first service with no explicit <code>isDefault</code></li>
* <li>Select the first service</li>
* </ol>
- * </p>
*
* @return default attribute consuming service (or null if there are no attribute consuming services defined)
*/
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SSODescriptor.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SSODescriptor.java
index 4765886..a73b2c3 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SSODescriptor.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/metadata/SSODescriptor.java
@@ -54,12 +54,12 @@ public interface SSODescriptor extends RoleDescriptor {
*
* <p>
* The selection algorithm used is:
+ * </p>
* <ol>
* <li>Select the first service with an explicit <code>isDefault=true</code></li>
* <li>Select the first service with no explicit <code>isDefault</code></li>
* <li>Select the first service</li>
* </ol>
- * </p>
*
* @return default artifact resolution service (or null if there are no artifact resolution services defined)
*
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/BasicDynamicTrustedNamesStrategy.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/BasicDynamicTrustedNamesStrategy.java
index f7645ba..88e338e 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/BasicDynamicTrustedNamesStrategy.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/BasicDynamicTrustedNamesStrategy.java
@@ -39,6 +39,7 @@ import org.opensaml.saml.saml2.metadata.RoleDescriptor;
*
* <p>
* Names are extracted as follows from these signed metadata element types:
+ * </p>
* <ul>
* <li><code>EntityDescriptor</code>: the <code>entityID</code> attribute</li>
* <li><code>EntitiesDescriptor</code>: the <code>Name</code> attribute</li>
@@ -47,7 +48,6 @@ import org.opensaml.saml.saml2.metadata.RoleDescriptor;
* <li><code>AffiliationDescriptor</code>: 1) the <code>affiliationOwnerID</code> attribute and
* 2) the <code>entityID</code> attribute of the parent <code>EntityDescriptor</code></li>
* </ul>
- * </p>
*/
public class BasicDynamicTrustedNamesStrategy implements Function<XMLObject, Set<String>> {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/ByReferenceMetadataFilter.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/ByReferenceMetadataFilter.java
index 2dbaa59..9907f00 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/ByReferenceMetadataFilter.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/filter/impl/ByReferenceMetadataFilter.java
@@ -38,7 +38,7 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* A {@link MetadataFilter} that associates other filters with specific
- * {@link MetadataResolver} instances by ID.
+ * {@link org.opensaml.saml.metadata.resolver.MetadataResolver} instances by ID.
*
* <p>The {@link MetadataFilterContext} is used to identify which resolver is actually
* running, to properly identify which filters to apply.</p>
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractBatchMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractBatchMetadataResolver.java
index 1368a9b..97af7c2 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractBatchMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractBatchMetadataResolver.java
@@ -321,11 +321,11 @@ public abstract class AbstractBatchMetadataResolver extends AbstractMetadataReso
*
* <p>
* Adds the following to parent impl:
+ * </p>
* <ol>
* <li>capable of storing the original metadata document on which the backing store is based</li>
* <li>stores data for any secondary indexes defined</li>
* </ol>
- * </p>
*/
protected class BatchEntityBackingStore extends EntityBackingStore {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
index a63d74a..284e321 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/AbstractDynamicHTTPMetadataResolver.java
@@ -140,25 +140,32 @@ public abstract class AbstractDynamicHTTPMetadataResolver extends AbstractDynami
*
* <p>
* For all TLS-related parameters, must be used in conjunction with an HttpClient instance
- * which is configured with either a:
+ * which is configured with either:
+ * </p>
* <ul>
* <li>
* a {@link net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory}
* </li>
* <li>
- * {@link org.opensaml.security.httpclient.impl.SecurityEnhancedTLSSocketFactory} which wraps
+ * a {@link org.opensaml.security.httpclient.impl.SecurityEnhancedTLSSocketFactory} which wraps
* an instance of {@link net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory}, with
* the latter likely configured in a "no trust" configuration. This variant is required if either a
* trust engine or a client TLS credential is to be used.
* </li>
+ * </ul>
+ *
+ * <p>
* For convenience methods for building a
* {@link net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory},
* see {@link net.shibboleth.utilities.java.support.httpclient.HttpClientSupport}.
- * </ul>
+ * </p>
+ *
+ * <p>
* If the appropriate TLS socket factory is not configured and a trust engine is specified,
* then this will result in no TLS trust evaluation being performed and a
* {@link ResolverException} will ultimately be thrown.
* </p>
+ *
* @param params the security parameters
*/
public void setHttpClientSecurityParameters(@Nullable final HttpClientSecurityParameters params) {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
index de29714..2617cf2 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/HTTPMetadataResolver.java
@@ -140,6 +140,8 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
* <p>
* For all TLS-related parameters, must be used in conjunction with an HttpClient instance
* which is configured with either a:
+ * </p>
+ *
* <ul>
* <li>
* a {@link net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory}
@@ -150,14 +152,20 @@ public class HTTPMetadataResolver extends AbstractReloadingMetadataResolver {
* the latter likely configured in a "no trust" configuration. This variant is required if either a
* trust engine or a client TLS credential is to be used.
* </li>
+ * </ul>
+ *
+ * <p>
* For convenience methods for building a
* {@link net.shibboleth.utilities.java.support.httpclient.TLSSocketFactory},
* see {@link net.shibboleth.utilities.java.support.httpclient.HttpClientSupport}.
- * </ul>
+ * </p>
+ *
+ * <p>
* If the appropriate TLS socket factory is not configured and a trust engine is specified,
* then this will result in no TLS trust evaluation being performed and a
* {@link ResolverException} will ultimately be thrown.
* </p>
+ *
* @param params the security parameters
*/
public void setHttpClientSecurityParameters(@Nullable final HttpClientSecurityParameters params) {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/RegexRequestURLBuilder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/RegexRequestURLBuilder.java
index f746451..6c187ef 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/RegexRequestURLBuilder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/RegexRequestURLBuilder.java
@@ -44,6 +44,7 @@ import org.slf4j.LoggerFactory;
*
* <p>
* The runtime logic is effectively:
+ * </p>
* <blockquote><pre>
* Pattern pattern = Pattern.compile(regex);
* Matcher matcher = pattern.matcher(entityID);
@@ -53,7 +54,6 @@ import org.slf4j.LoggerFactory;
* return null;
* }
* </pre></blockquote>
- * </p>
*
* <p>
* For supported regular expression syntax see {@link Pattern}. For details on the replacement operation,
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/package-info.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/package-info.java
index 762d70c..55dd4ee 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/package-info.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/impl/package-info.java
@@ -15,13 +15,17 @@
* limitations under the License.
*/
-/**Class for retrieving, filtering, and querying metadata.
- * <br/>Information on using this library can be found in the
-<a href="https://wiki.shibboleth.net/confluence/display/SHIB/OSTwoUserManual">User's Manual</a> and information
-on extending its functionality can be found in the
-<a href="https://wiki.shibboleth.net/confluence/display/SHIB/OSTwoDeveloperManual">Developer's Manual</a>.
-
- at see <a href="https://wiki.shibboleth.net/confluence/display/SHIB/OpenSAML">OpenSAML Wiki</a>
+/**
+ * Classes for retrieving, filtering, and querying metadata.
+ *
+ * <p>
+ * Information on using this library can be found in the
+ * <a href="https://wiki.shibboleth.net/confluence/display/SHIB/OSTwoUserManual">User's Manual</a>
+ * and information on extending its functionality can be found in the
+ * <a href="https://wiki.shibboleth.net/confluence/display/SHIB/OSTwoDeveloperManual">Developer's Manual</a>.
+ * </p>
+ *
+ * @see <a href="https://wiki.shibboleth.net/confluence/display/SHIB/OpenSAML">OpenSAML Wiki</a>
*/
package org.opensaml.saml.metadata.resolver.impl;
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/index/impl/SAMLArtifactMetadataIndex.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/index/impl/SAMLArtifactMetadataIndex.java
index cc8bfc8..54832ff 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/index/impl/SAMLArtifactMetadataIndex.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/metadata/resolver/index/impl/SAMLArtifactMetadataIndex.java
@@ -73,12 +73,12 @@ public class SAMLArtifactMetadataIndex implements MetadataIndex {
*
* <p>
* The descriptor indexing functions will be:
+ * </p>
* <ul>
* <li>{@link EntityIDToSHA1SourceIDIndexingFunction}</li>
* <li>{@link SourceIDExtensionIndexingFunction}</li>
* <li>{@link SourceLocationIndexingFunction}</li>
* </ul>
- * </p>
*/
public SAMLArtifactMetadataIndex() {
this(Arrays.asList(
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 4fe74d1..071208d 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
@@ -49,6 +49,7 @@ import org.slf4j.LoggerFactory;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#SC_VALID_ADDRESSES}:
@@ -59,14 +60,13 @@ import org.slf4j.LoggerFactory;
* Required.
* </li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public abstract class AbstractSubjectConfirmationValidator implements SubjectConfirmationValidator {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidator.java
index 657316c..f084dde 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/AudienceRestrictionConditionValidator.java
@@ -43,20 +43,20 @@ import org.slf4j.LoggerFactory;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#COND_VALID_AUDIENCES}:
* Required.
* </li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*
*/
@ThreadSafe
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/BearerSubjectConfirmationValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/BearerSubjectConfirmationValidator.java
index d412a1f..236c24f 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/BearerSubjectConfirmationValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/BearerSubjectConfirmationValidator.java
@@ -34,18 +34,17 @@ import org.opensaml.saml.saml2.core.SubjectConfirmation;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
- *
*/
@ThreadSafe
public class BearerSubjectConfirmationValidator extends AbstractSubjectConfirmationValidator {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/DelegationRestrictionConditionValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/DelegationRestrictionConditionValidator.java
index 1ab6279..da4b311 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/DelegationRestrictionConditionValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/DelegationRestrictionConditionValidator.java
@@ -43,17 +43,17 @@ import org.opensaml.saml.saml2.core.Condition;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public class DelegationRestrictionConditionValidator implements ConditionValidator {
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 e06bcfe..d68d492 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
@@ -55,6 +55,7 @@ import org.slf4j.LoggerFactory;
* <p>
* A subject confirmation is considered confirmed if one of the
* following checks has passed:
+ * </p>
* <ul>
* <li>
* the presenter's public key (either given explicitly or extracted from the given certificate) matches a
@@ -65,6 +66,7 @@ import org.slf4j.LoggerFactory;
* {@link KeyInfo} entries in the confirmation data
* </li>
* </ul>
+ * <p>
* In both cases a "match" is determined via Java <code>equals()</code> comparison.
* </p>
*
@@ -75,6 +77,7 @@ import org.slf4j.LoggerFactory;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#SC_HOK_PRESENTER_CERT}:
@@ -85,12 +88,14 @@ import org.slf4j.LoggerFactory;
* Optional if certificate is supplied, otherwise required.
* </li>
* </ul>
+ * <p>
* If both key and certificate are supplied, the public key of the supplied certificate must match the
* supplied public key, otherwise a evaluation results in {@link ValidationResult#INDETERMINATE}.
* </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#SC_HOK_CONFIRMED_KEYINFO}:
@@ -98,7 +103,6 @@ import org.slf4j.LoggerFactory;
* Will be present after validation iff Holder of Key subject confirmation was successfully performed.
* </li>
* </ul>
- * </p>
*/
@ThreadSafe
public class HolderOfKeySubjectConfirmationValidator extends AbstractSubjectConfirmationValidator {
@@ -322,8 +326,6 @@ public class HolderOfKeySubjectConfirmationValidator extends AbstractSubjectConf
* @param keyValues candidate KeyValue elements
*
* @return true if the public key in the certificate matches one of the key values, false otherwise
- *
- * @throws AssertionValidationException thrown if there is a problem matching the key value
*/
protected boolean matchesKeyValue(@Nonnull final PublicKey key, @Nullable final List<KeyValue> keyValues) {
@@ -363,8 +365,6 @@ public class HolderOfKeySubjectConfirmationValidator extends AbstractSubjectConf
* @param derEncodedKeyValues candidate DEREncodedKeyValue elements
*
* @return true if the public key in the certificate matches one of the DER-encoded key values, false otherwise
- *
- * @throws AssertionValidationException thrown if there is a problem matching the key value
*/
protected boolean matchesDEREncodedKeyValue(@Nonnull final PublicKey key,
@Nullable final List<DEREncodedKeyValue> derEncodedKeyValues) {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidator.java
index faf44fa..133bdb4 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/OneTimeUseConditionValidator.java
@@ -49,6 +49,7 @@ import org.slf4j.LoggerFactory;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
* <li>
* {@link SAML2AssertionValidationParameters#COND_ONE_TIME_USE_EXPIRES}:
@@ -56,14 +57,13 @@ import org.slf4j.LoggerFactory;
* the default value, as retrieved via {@link #getReplayCacheExpires()}.
* </li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public class OneTimeUseConditionValidator implements ConditionValidator {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/ProxyRestrictionConditionValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/ProxyRestrictionConditionValidator.java
index 804d464..19f6916 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/ProxyRestrictionConditionValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/ProxyRestrictionConditionValidator.java
@@ -43,17 +43,17 @@ import org.opensaml.saml.saml2.core.ProxyRestriction;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public class ProxyRestrictionConditionValidator implements ConditionValidator {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/SenderVouchersSubjectConfirmationValidator.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/SenderVouchersSubjectConfirmationValidator.java
index 0a47fa7..997e4a6 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/SenderVouchersSubjectConfirmationValidator.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/assertion/impl/SenderVouchersSubjectConfirmationValidator.java
@@ -33,17 +33,17 @@ import org.opensaml.saml.saml2.core.SubjectConfirmation;
*
* <p>
* Supports the following {@link ValidationContext} static parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*
* <p>
* Supports the following {@link ValidationContext} dynamic parameters:
+ * </p>
* <ul>
- * None.
+ * <li>None.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public class SenderVouchersSubjectConfirmationValidator extends AbstractSubjectConfirmationValidator {
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/wssecurity/messaging/impl/DefaultSAML20AssertionValidationContextBuilder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/wssecurity/messaging/impl/DefaultSAML20AssertionValidationContextBuilder.java
index 59c596a..e7eed2c 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/wssecurity/messaging/impl/DefaultSAML20AssertionValidationContextBuilder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/wssecurity/messaging/impl/DefaultSAML20AssertionValidationContextBuilder.java
@@ -266,6 +266,7 @@ public class DefaultSAML20AssertionValidationContextBuilder
*
* <p>
* This implementation returns a set containing the 2 values;
+ * </p>
* <ol>
* <li>
* {@link javax.servlet.http.HttpServletRequest#getRequestURL()}
@@ -274,7 +275,6 @@ public class DefaultSAML20AssertionValidationContextBuilder
* if present, {@link SAMLSelfEntityContext#getEntityId()}
* </li>
* </ol>
- * </p>
*
* @param input the assertion validation input
*
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/MetadataCredentialResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/MetadataCredentialResolver.java
index f201f46..3b3b2d8 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/MetadataCredentialResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/MetadataCredentialResolver.java
@@ -66,8 +66,9 @@ import org.slf4j.LoggerFactory;
* <p>
* The following resolution modes and associated {@link net.shibboleth.utilities.java.support.resolver.Criterion}
* inputs are supported:
+ * </p>
*
- * Direct resolution from a supplied {@link RoleDescriptor}:
+ * <p>Direct resolution from a supplied {@link RoleDescriptor}:</p>
*
* <ul>
* <li>{@link RoleDescriptorCriterion} - required</li>
@@ -75,7 +76,7 @@ import org.slf4j.LoggerFactory;
* {@link UsageType#UNSPECIFIED} will be used for credential resolution.</li>
* </ul>
*
- * Resolution from a metadata source using a {@link RoleDescriptorResolver}:
+ * <p>Resolution from a metadata source using a {@link RoleDescriptorResolver}:</p>
*
* <ul>
* <li>{@link EntityIdCriterion} - required</li>
@@ -85,7 +86,6 @@ import org.slf4j.LoggerFactory;
* <li>{@link UsageCriterion} - optional; if absent, the effective value
* {@link UsageType#UNSPECIFIED} will be used for credential resolution.</li>
* </ul>
- * </p>
*
* <p>
* In order to support resolution from a metadata source using {@link EntityIdCriterion} + {@link EntityRoleCriterion},
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataSignatureSigningParametersResolver.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataSignatureSigningParametersResolver.java
index 0813767..bfed4f3 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataSignatureSigningParametersResolver.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/security/impl/SAMLMetadataSignatureSigningParametersResolver.java
@@ -50,10 +50,10 @@ import org.slf4j.LoggerFactory;
* <p>
* In addition to the {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs documented in
* {@link BasicSignatureSigningParametersResolver}, the following inputs are also supported:
+ * </p>
* <ul>
* <li>{@link RoleDescriptorCriterion} - optional</li>
* </ul>
- * </p>
*/
public class SAMLMetadataSignatureSigningParametersResolver extends BasicSignatureSigningParametersResolver {
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/BasicHttpClientSecurityParametersResolver.java b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/BasicHttpClientSecurityParametersResolver.java
index 61430ec..5196dc6 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/BasicHttpClientSecurityParametersResolver.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/httpclient/impl/BasicHttpClientSecurityParametersResolver.java
@@ -44,10 +44,10 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link HttpClientSecurityConfigurationCriterion} - required</li>
* </ul>
- * </p>
*/
public class BasicHttpClientSecurityParametersResolver implements HttpClientSecurityParametersResolver {
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 dfc4e37..7d4d252 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
@@ -60,6 +60,7 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
*
* <p>
* This implementation wraps an existing TLS socket factory instance, decorating it with additional support for:
+ * </p>
* <ul>
* <li>Verifying the server TLS certificate and chain via a
* {@link TrustEngine}<code><</code>{@link org.opensaml.security.credential.Credential}<code>></code>
@@ -67,10 +68,10 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
*
* <li>Loading and clearing a thread-local instance of {@link X509Credential} used for client TLS.</li>
* </ul>
- * </p>
*
* <p>
* The context keys used by this component are as follows, defined in {@link HttpClientSecurityConstants}:
+ * </p>
* <ul>
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_TRUST_ENGINE}: The trust engine instance used.
* Supplied by the HttpClient caller. Must be an instance of
@@ -85,7 +86,6 @@ import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
* <li>{@link HttpClientSecurityConstants#CONTEXT_KEY_CLIENT_TLS_CREDENTIAL}: The client TLS credential used.
* Supplied by the HttpClient caller. Must be an instance of {@link X509Credential}.</li>
* </ul>
- * </p>
*
* <p>
* If the trust engine context attribute is not populated by the caller and {@link #isTrustEngineRequired()}
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/messaging/impl/BaseClientCertAuthSecurityHandler.java b/opensaml-security-impl/src/main/java/org/opensaml/security/messaging/impl/BaseClientCertAuthSecurityHandler.java
index bd200ce..584e652 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/messaging/impl/BaseClientCertAuthSecurityHandler.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/messaging/impl/BaseClientCertAuthSecurityHandler.java
@@ -340,6 +340,7 @@ public abstract class BaseClientCertAuthSecurityHandler extends BaseTrustEngineS
* <p>
* Configured certificate name types are derived as candidate presenter entity ID's and processed in the following
* order:
+ * </p>
* <ol>
* <li>The certificate subject DN string as serialized by the X500DNHandler obtained via
* {@link CertificateNameOptions#getX500DNHandler()} and using the output format indicated by
@@ -348,7 +349,6 @@ public abstract class BaseClientCertAuthSecurityHandler extends BaseTrustEngineS
* Note that this is a LinkedHashSet, so the order of evaluation is the order of insertion.</li>
* <li>The first common name (CN) value appearing in the certificate subject DN.</li>
* </ol>
- * </p>
*
* <p>
* The first one of the above which is successfully evaluated by the trust engine using criteria built from
diff --git a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/impl/BasicX509CredentialNameEvaluator.java b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/impl/BasicX509CredentialNameEvaluator.java
index eb6e32f..3fa9b64 100644
--- a/opensaml-security-impl/src/main/java/org/opensaml/security/x509/impl/BasicX509CredentialNameEvaluator.java
+++ b/opensaml-security-impl/src/main/java/org/opensaml/security/x509/impl/BasicX509CredentialNameEvaluator.java
@@ -49,12 +49,12 @@ import com.google.common.base.Strings;
*
* <p>
* Supported types of entity certificate-derived names for name checking purposes are:
+ * </p>
* <ol>
* <li>Subject alternative names.</li>
* <li>The first (i.e. most specific) common name (CN) from the subject distinguished name.</li>
* <li>The complete subject distinguished name.</li>
* </ol>
- * </p>
*
* <p>
* Name checking is enabled by default for all of the supported name types. The types of subject alternative names to
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 9290f69..33e3224 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
@@ -40,10 +40,10 @@ import org.opensaml.security.x509.tls.ClientTLSValidationParametersResolver;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link ClientTLSValidationConfigurationCriterion} - required</li>
* </ul>
- * </p>
*/
public class BasicClientTLSValidationParametersResolver implements ClientTLSValidationParametersResolver {
diff --git a/opensaml-soap-api/src/main/java/org/opensaml/soap/wssecurity/AttributedDateTime.java b/opensaml-soap-api/src/main/java/org/opensaml/soap/wssecurity/AttributedDateTime.java
index c347f51..5c190c6 100644
--- a/opensaml-soap-api/src/main/java/org/opensaml/soap/wssecurity/AttributedDateTime.java
+++ b/opensaml-soap-api/src/main/java/org/opensaml/soap/wssecurity/AttributedDateTime.java
@@ -38,17 +38,17 @@ public interface AttributedDateTime extends XSString, IdBearing, AttributeExtens
new QName(WSSecurityConstants.WSU_NS, TYPE_LOCAL_NAME, WSSecurityConstants.WSU_PREFIX);
/**
- * Returns the DateTime content or attribute value.
+ * Returns the Instant content or attribute value.
*
- * @return the {@link DateTime} object.
+ * @return the {@link Instant} object.
*/
public Instant getDateTime();
/**
- * Sets the DateTime content or attribute value.
+ * Sets the Instant content or attribute value.
*
* @param dateTime
- * the {@link DateTime} object to set.
+ * the {@link Instant} object to set.
*/
public void setDateTime(Instant dateTime);
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
index b21c5d2..a41d841 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
@@ -183,11 +183,11 @@ public class HttpClientRequestSOAP11Encoder extends BaseHttpClientRequestXMLMess
/**
* <p>
* This implementation performs the following actions on the context's {@link HttpRequest}:
+ * </p>
* <ol>
* <li>Sets the SOAPAction HTTP header the value returned by {@link #getSOAPAction()}, if
* that returns non-null.</li>
* </ol>
- * </p>
*
* <p>
* Subclasses should NOT set the SOAPAction HTTP header in this method. Instead, they should override
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
index 8d7fb10..631b1c4 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
@@ -153,6 +153,7 @@ public class HTTPSOAP11Encoder extends BaseHttpServletResponseXMLMessageEncoder
/**
* <p>
* This implementation performs the following actions on the context's {@link HttpServletResponse}:
+ * </p>
* <ol>
* <li>Adds the HTTP header: "Cache-control: no-cache, no-store"</li>
* <li>Adds the HTTP header: "Pragma: no-cache"</li>
@@ -161,7 +162,6 @@ public class HTTPSOAP11Encoder extends BaseHttpServletResponseXMLMessageEncoder
* <li>Sets the SOAPAction HTTP header the value returned by {@link #getSOAPAction()}, if
* that returns non-null.</li>
* </ol>
- * </p>
*
* <p>
* Subclasses should NOT set the SOAPAction HTTP header in this method. Instead, they should override
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectMarshaller.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectMarshaller.java
index ea9f71e..26fb9e2 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectMarshaller.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectMarshaller.java
@@ -29,7 +29,6 @@ public abstract class AbstractWSSecurityObjectMarshaller extends AbstractXMLObje
/**
* Constructor.
- * <p>
*/
protected AbstractWSSecurityObjectMarshaller() {
super();
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectUnmarshaller.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectUnmarshaller.java
index 2f0e98a..e640325 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectUnmarshaller.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/wssecurity/impl/AbstractWSSecurityObjectUnmarshaller.java
@@ -36,7 +36,6 @@ public abstract class AbstractWSSecurityObjectUnmarshaller extends AbstractXMLOb
/**
* Constructor.
- * <p>
*/
protected AbstractWSSecurityObjectUnmarshaller() {
super();
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractMapBackedStorageService.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractMapBackedStorageService.java
index 1563690..8c026f5 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractMapBackedStorageService.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/AbstractMapBackedStorageService.java
@@ -42,7 +42,7 @@ import org.slf4j.LoggerFactory;
* using a simple map.
*
* <p>Abstract methods supply the map of data to manipulate and the lock to use, which allows
- * optimizations in cases where locking isn't required or data isn't shared.<p>
+ * optimizations in cases where locking isn't required or data isn't shared.</p>
*/
public abstract class AbstractMapBackedStorageService extends AbstractStorageService {
diff --git a/opensaml-storage-api/src/main/java/org/opensaml/storage/annotation/AnnotationSupport.java b/opensaml-storage-api/src/main/java/org/opensaml/storage/annotation/AnnotationSupport.java
index b27bbba..72b2a80 100644
--- a/opensaml-storage-api/src/main/java/org/opensaml/storage/annotation/AnnotationSupport.java
+++ b/opensaml-storage-api/src/main/java/org/opensaml/storage/annotation/AnnotationSupport.java
@@ -156,12 +156,12 @@ public final class AnnotationSupport {
*
* <p>The value is returned as a long, in milliseconds since the beginning of the Unix epoch.
* The following data types are supported:
+ * </p>
* <ul>
* <li><code>long</code></li>
* <li>{@link Date}</li>
- * <li>{@link ReadableInstant}</li>
+ * <li>{@link Instant}</li>
* </ul>
- * </p>
*
* @param target Object from which to get expiration
*
@@ -189,12 +189,12 @@ public final class AnnotationSupport {
*
* <p>The expiration is expressed in milliseconds since the beginning of the Unix epoch.
* The following data types are supported:
+ * </p>
* <ul>
* <li><code>long</code></li>
* <li>{@link Date}</li>
- * <li>{@link ReadableInstant}</li>
+ * <li>{@link Instant}</li>
* </ul>
- * </p>
*
* @param target object on which to set expiration
* @param expiration value to set
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 aed0f19..a266468 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
@@ -362,7 +362,7 @@ public final class AlgorithmSupport {
*
* @param algorithmURI The XML Encryption algorithm URI
* @return a basic credential containing a randomly generated symmetric key
- * @throws KeyException
+ * @throws KeyException thrown if the length of key to generate could not be determined
* @throws NoSuchAlgorithmException algorithm not found
*/
@Nonnull public static Credential generateSymmetricKeyAndCredential(@Nonnull final String algorithmURI)
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
index 84efe15..b0d19e5 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/encryption/support/Decrypter.java
@@ -83,6 +83,8 @@ import com.google.common.base.Strings;
*
* <p>
* Details on the components specified as constructor options are as follows:
+ * </p>
+ *
* <ol>
*
* <li>
@@ -110,7 +112,6 @@ import com.google.common.base.Strings;
* </li>
*
* </ol>
- * </p>
*
* <p>
* XML Encryption can encrypt either a single {@link Element} or the contents of an Element. The caller of this class
@@ -190,9 +191,6 @@ public class Decrypter {
/** Unmarshaller factory, used in decryption of EncryptedData objects. */
private final UnmarshallerFactory unmarshallerFactory;
- /** Load-and-Save DOM Implementation singleton. */
- // private DOMImplementationLS domImplLS;
-
/** Class logger. */
private final Logger log = LoggerFactory.getLogger(Decrypter.class);
diff --git a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/signature/support/SignatureSupport.java b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/signature/support/SignatureSupport.java
index bad5b49..38f1df3 100644
--- a/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/signature/support/SignatureSupport.java
+++ b/opensaml-xmlsec-api/src/main/java/org/opensaml/xmlsec/signature/support/SignatureSupport.java
@@ -81,6 +81,7 @@ public final class SignatureSupport {
*
* <p>
* The following Signature values will be added:
+ * </p>
* <ul>
* <li>signing credential</li>
* <li>signature algorithm URI</li>
@@ -89,7 +90,6 @@ public final class SignatureSupport {
* <li>HMAC output length (if applicable and a value is configured)</li>
* <li>a {@link KeyInfo} element representing the signing credential</li>
* </ul>
- * </p>
*
* <p>
* Existing (non-null) values of these parameters on the specified signature will <strong>NOT</strong> be
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicDecryptionParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicDecryptionParametersResolver.java
index cf9b4c4..93fd0fe 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicDecryptionParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicDecryptionParametersResolver.java
@@ -40,10 +40,10 @@ import org.slf4j.LoggerFactory;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link DecryptionConfigurationCriterion} - required</li>
* </ul>
- * </p>
*/
public class BasicDecryptionParametersResolver extends AbstractSecurityParametersResolver<DecryptionParameters>
implements DecryptionParametersResolver {
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 f8a00c4..6d6601f 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
@@ -55,12 +55,12 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link EncryptionConfigurationCriterion} - required</li>
* <li>{@link KeyInfoGenerationProfileCriterion} - optional</li>
* <li>{@link EncryptionOptionalCriterion} - optional</li>
* </ul>
- * </p>
*/
public class BasicEncryptionParametersResolver extends AbstractSecurityParametersResolver<EncryptionParameters>
implements EncryptionParametersResolver {
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureSigningParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureSigningParametersResolver.java
index 580ce7c..baa0ba3 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureSigningParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureSigningParametersResolver.java
@@ -50,11 +50,11 @@ import org.slf4j.LoggerFactory;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link SignatureSigningConfigurationCriterion} - required</li>
* <li>{@link KeyInfoGenerationProfileCriterion} - optional</li>
* </ul>
- * </p>
*/
public class BasicSignatureSigningParametersResolver
extends AbstractSecurityParametersResolver<SignatureSigningParameters>
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureValidationParametersResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureValidationParametersResolver.java
index 851ab43..57dac45 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureValidationParametersResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/BasicSignatureValidationParametersResolver.java
@@ -39,10 +39,10 @@ import org.slf4j.LoggerFactory;
*
* <p>
* The following {@link net.shibboleth.utilities.java.support.resolver.Criterion} inputs are supported:
+ * </p>
* <ul>
* <li>{@link SignatureValidationConfigurationCriterion} - required</li>
* </ul>
- * </p>
*/
public class BasicSignatureValidationParametersResolver
extends AbstractSecurityParametersResolver<SignatureValidationParameters>
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicProviderKeyInfoCredentialResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicProviderKeyInfoCredentialResolver.java
index e3d61c3..4a9576a 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicProviderKeyInfoCredentialResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/BasicProviderKeyInfoCredentialResolver.java
@@ -71,6 +71,7 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
*
* <p>
* Processing of the supplied KeyInfo element proceeds as follows:
+ * </p>
* <ol>
* <li>A {@link KeyInfoResolutionContext} is instantiated. This resolution context is used to hold state shared amongst
* all the providers and processing hooks which run within the resolver.</li>
@@ -103,8 +104,6 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* default set of credentials, or to use non-KeyInfo-derived criteria or contextual information to determine the
* credential or credentials to return.</li>
* </ol>
- * </p>
- *
*/
public class BasicProviderKeyInfoCredentialResolver extends AbstractCriteriaFilteringCredentialResolver implements
KeyInfoCredentialResolver {
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/LocalKeyInfoCredentialResolver.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/LocalKeyInfoCredentialResolver.java
index cebba36..2ac6f4c 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/LocalKeyInfoCredentialResolver.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/keyinfo/impl/LocalKeyInfoCredentialResolver.java
@@ -53,6 +53,7 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
*
* <p>
* Resolution proceeds as follows:
+ * </p>
* <ol>
* <li>Any credential resolved via the standard {@link BasicProviderKeyInfoCredentialResolver}
* resolution process which is not a local credential will be removed
@@ -66,7 +67,6 @@ import net.shibboleth.utilities.java.support.resolver.ResolverException;
* be used as resolution criteria for local credentials and the resultant credentials
* added to the set to be returned.</li>
* </ol>
- * </p>
*/
public class LocalKeyInfoCredentialResolver extends BasicProviderKeyInfoCredentialResolver {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list