[java-opensaml] branch master updated: Javadoc fixes.
Brent Putman
putmanb at georgetown.edu
Fri Jan 31 00:08:23 EST 2020
This is an automated email from the git hooks/post-receive script.
putmanb 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=2ea39b4891e004f229a01ee7b1072891d9e5015f
The following commit(s) were added to refs/heads/master by this push:
new 2ea39b4 Javadoc fixes.
2ea39b4 is described below
commit 2ea39b4891e004f229a01ee7b1072891d9e5015f
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Fri Jan 31 00:08:02 2020 -0500
Javadoc fixes.
---
.../java/org/opensaml/saml/common/binding/SAMLBindingSupport.java | 4 +++-
.../messaging/context/SAMLMessageReceivedEndpointContext.java | 2 +-
.../saml/common/profile/logic/InboundMessageSignedPredicate.java | 8 +++++---
.../saml/saml2/assertion/SAML2AssertionValidationParameters.java | 2 +-
.../src/main/java/org/opensaml/saml/saml2/core/Conditions.java | 2 ++
5 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
index 38fab86..7c54bf6 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/SAMLBindingSupport.java
@@ -36,6 +36,7 @@ import org.opensaml.saml.common.messaging.context.SAMLBindingContext;
import org.opensaml.saml.common.messaging.context.SAMLEndpointContext;
import org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext;
import org.opensaml.saml.saml2.metadata.Endpoint;
+import org.opensaml.xmlsec.signature.Signature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -212,7 +213,8 @@ public final class SAMLBindingSupport {
* </p>
*
* @param messageContext current message context
- * @param presenceSatisfies whether the presence of a non-null {@link Signature} member satisfies the evaluation
+ * @param presenceSatisfies whether the presence of a non-null {@link org.opensaml.xmlsec.signature.Signature}
+ * member satisfies the evaluation
* @return true if the message is considered to be digitally signed, false otherwise
*/
public static boolean isMessageSigned(@Nonnull final MessageContext messageContext,
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLMessageReceivedEndpointContext.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLMessageReceivedEndpointContext.java
index 5fc746d..b420392 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLMessageReceivedEndpointContext.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/messaging/context/SAMLMessageReceivedEndpointContext.java
@@ -56,7 +56,7 @@ public class SAMLMessageReceivedEndpointContext extends BaseContext {
* relevant information to the properties of this class.
* </p>
*
- * @param request
+ * @param request the HTTP request
*/
public SAMLMessageReceivedEndpointContext(@Nonnull final HttpServletRequest request) {
super();
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/InboundMessageSignedPredicate.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/InboundMessageSignedPredicate.java
index c86ba9b..196b1cf 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/InboundMessageSignedPredicate.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/common/profile/logic/InboundMessageSignedPredicate.java
@@ -29,13 +29,15 @@ import org.opensaml.saml.common.binding.SAMLBindingSupport;
*/
public class InboundMessageSignedPredicate implements Predicate<ProfileRequestContext> {
- /** Flag indicating whether the presence of a non-null {@link Signature} member satisfies the evaluation. */
+ /** Flag indicating whether the presence of a non-null {@link org.opensaml.xmlsec.signature.Signature}
+ * member satisfies the evaluation. */
private boolean presenceSatisfies;
/**
- * Set whether the presence of a non-null {@link Signature} member satisfies the evaluation.
+ * Set whether the presence of a non-null {@link org.opensaml.xmlsec.signature.Signature}
+ * member satisfies the evaluation.
*
- * @param flag whether the presence of a non-null {@link Signature} is considered
+ * @param flag whether the presence of a non-null {@link org.opensaml.xmlsec.signature.Signature} is considered
*/
public void setPresenceSatisfies(final boolean flag) {
presenceSatisfies = flag;
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 795977b..d3a0e9a 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
@@ -152,7 +152,7 @@ public final class SAML2AssertionValidationParameters {
public static final String SC_HOK_CONFIRMED_KEYINFO = STD_PREFIX + SC_INFIX + ".HoK.ConfirmedKeyInfo";
/**
- * Carries a {@link java.util.Set}<code><</code>{@link javax.xml.QName}<code>></code>
+ * Carries a {@link java.util.Set}<code><</code>{@link javax.xml.namespace.QName}<code>></code>
* of required conditions which must be present in the assertion.
*/
public static final String COND_REQUIRED_CONDITIONS = STD_PREFIX + COND_INFIX + ".RequiredConditions";
diff --git a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/core/Conditions.java b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/core/Conditions.java
index 8e942e6..4eb2d47 100644
--- a/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/core/Conditions.java
+++ b/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/core/Conditions.java
@@ -98,6 +98,8 @@ public interface Conditions extends SAMLObject {
* Gets the list of conditions that match a particular QName.
*
* @param typeOrName the QName of the conditions to return
+ *
+ * @return the list of conditions that match the specified QName
*/
List<Condition> getConditions(@Nonnull final QName typeOrName);
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list