[java-identity-provider] branch master updated: Fix some javadoc warnings.

Scott Cantor cantor.2 at osu.edu
Tue Apr 23 12:31:38 EDT 2019


This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch master
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=759b2d533e6804429eb259050610a0f738f3d7e6

The following commit(s) were added to refs/heads/master by this push:
       new  759b2d5   Fix some javadoc warnings.
759b2d5 is described below

commit 759b2d533e6804429eb259050610a0f738f3d7e6
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Tue Apr 23 12:31:35 2019 -0400

    Fix some javadoc warnings.
---
 .../cas/config/impl/AbstractProtocolConfiguration.java   |  4 ++--
 .../idp/cas/config/impl/LoginConfiguration.java          | 16 ++++++++--------
 .../idp/profile/config/AbstractProfileConfiguration.java | 12 ++++++------
 .../profile/config/AbstractSAMLProfileConfiguration.java |  4 ++--
 .../AbstractSAML1ArtifactAwareProfileConfiguration.java  |  4 ++--
 .../AbstractSAML2ArtifactAwareProfileConfiguration.java  |  4 ++--
 .../config/AbstractSAML2ProfileConfiguration.java        |  2 +-
 .../profile/config/BrowserSSOProfileConfiguration.java   |  2 +-
 .../profile/config/SingleLogoutProfileConfiguration.java |  2 +-
 .../java/net/shibboleth/idp/saml/impl/TestSources.java   |  2 +-
 10 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/AbstractProtocolConfiguration.java b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/AbstractProtocolConfiguration.java
index 1d3e389..a498209 100644
--- a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/AbstractProtocolConfiguration.java
+++ b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/AbstractProtocolConfiguration.java
@@ -50,7 +50,7 @@ public abstract class AbstractProtocolConfiguration extends AbstractConditionalP
     /** Default ticket validity. */
     @Nonnull public static final Duration DEFAULT_TICKET_VALIDITY_PERIOD = Duration.ofSeconds(15);
 
-    /** Lookup function to supply {@link #ticketValidityPeriod} property. */
+    /** Lookup function to supply ticketValidityPeriod property. */
     @Nonnull private Function<ProfileRequestContext,Duration> ticketValidityPeriodLookupStrategy;
 
     /** Whether attributes should be resolved in the course of the profile. */
@@ -110,7 +110,7 @@ public abstract class AbstractProtocolConfiguration extends AbstractConditionalP
     }
 
     /**
-     * Set a lookup strategy for the {@link #ticketValidityPeriod} property.
+     * Set a lookup strategy for the ticket validity period.
      * 
      * @param strategy lookup strategy
      * 
diff --git a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/LoginConfiguration.java b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/LoginConfiguration.java
index d5fbcf2..f51c5c3 100644
--- a/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/LoginConfiguration.java
+++ b/idp-cas-impl/src/main/java/net/shibboleth/idp/cas/config/impl/LoginConfiguration.java
@@ -63,17 +63,17 @@ public class LoginConfiguration extends AbstractProtocolConfiguration
     /** Default ticket length (random part). */
     public static final int DEFAULT_TICKET_LENGTH = 25;
 
-    /** Lookup function to supply {@link #authenticationFlows} property. */
+    /** Lookup function to supply authenticationFlows property. */
     @Nonnull private Function<ProfileRequestContext,Set<String>> authenticationFlowsLookupStrategy;
 
-    /** Lookup function to supply {@link #postAuthenticationFlows} property. */
+    /** Lookup function to supply postAuthenticationFlows property. */
     @Nonnull private Function<ProfileRequestContext,Collection<String>> postAuthenticationFlowsLookupStrategy;
 
-    /** Lookup function to supply {@link #defaultAuthenticationContexts} property. */
+    /** Lookup function to supply defaultAuthenticationContexts property. */
     @Nonnull private Function<ProfileRequestContext,Collection<AuthnContextClassRefPrincipal>>
             defaultAuthenticationContextsLookupStrategy;
 
-    /** Lookup function to supply {@link #nameIDFormatPrecedence} property. */
+    /** Lookup function to supply nameIDFormatPrecedence property. */
     @Nonnull private Function<ProfileRequestContext,Collection<String>> nameIDFormatPrecedenceLookupStrategy;
     
     /** Whether to mandate forced authentication for the request. */
@@ -113,7 +113,7 @@ public class LoginConfiguration extends AbstractProtocolConfiguration
     }
 
     /**
-     * Set a lookup strategy for the {@link #defaultAuthenticationContexts} property.
+     * Set a lookup strategy for the default authentication contexts to use.
      *
      * @param strategy  lookup strategy
      */
@@ -143,7 +143,7 @@ public class LoginConfiguration extends AbstractProtocolConfiguration
     }
 
     /**
-     * Set a lookup strategy for the {@link #authenticationFlows} property.
+     * Set a lookup strategy for the authentication flows to use.
      *
      * @param strategy  lookup strategy
      */
@@ -173,7 +173,7 @@ public class LoginConfiguration extends AbstractProtocolConfiguration
     }
 
     /**
-     * Set a lookup strategy for the {@link #postAuthenticationFlows} property.
+     * Set a lookup strategy for the post-authentication interceptor flows to enable.
      *
      * @param strategy  lookup strategy
      */
@@ -201,7 +201,7 @@ public class LoginConfiguration extends AbstractProtocolConfiguration
     }
 
     /**
-     * Set a lookup strategy for the {@link #nameIDFormatPrecedence} property.
+     * Set a lookup strategy for the name identifier formats to use.
      *
      * @param strategy  lookup strategy
      */
diff --git a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/config/AbstractProfileConfiguration.java b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/config/AbstractProfileConfiguration.java
index 316c1a9..43d39f6 100644
--- a/idp-profile-api/src/main/java/net/shibboleth/idp/profile/config/AbstractProfileConfiguration.java
+++ b/idp-profile-api/src/main/java/net/shibboleth/idp/profile/config/AbstractProfileConfiguration.java
@@ -50,13 +50,13 @@ public abstract class AbstractProfileConfiguration extends AbstractIdentifiableI
     /** Class logger. */
     @Nonnull private final Logger log = LoggerFactory.getLogger(AbstractProfileConfiguration.class);
 
-    /** Lookup function to supply {@link #inboundFlows} property. */
+    /** Lookup function to supply inboundFlows property. */
     @Nonnull private Function<ProfileRequestContext,List<String>> inboundFlowsLookupStrategy;
 
-    /** Lookup function to supply {@link #outboundFlows} property. */
+    /** Lookup function to supply #outboundFlows property. */
     @Nonnull private Function<ProfileRequestContext,List<String>> outboundFlowsLookupStrategy;
 
-    /** Lookup function to supply {@link #securityConfiguration} property. */
+    /** Lookup function to supply securityConfiguration property. */
     @Nonnull private Function<ProfileRequestContext,SecurityConfiguration> securityConfigurationLookupStrategy;
 
     /** Lookup function to return a bitmask of request features to disallow. */
@@ -91,7 +91,7 @@ public abstract class AbstractProfileConfiguration extends AbstractIdentifiableI
     }
 
     /**
-     * Set a lookup strategy for the {@link #securityConfiguration} property.
+     * Set a lookup strategy for the security configuration.
      *
      * @param strategy  lookup strategy
      * 
@@ -123,7 +123,7 @@ public abstract class AbstractProfileConfiguration extends AbstractIdentifiableI
     }
 
     /**
-     * Set a lookup strategy for the {@link #inboundFlows} property.
+     * Set a lookup strategy for the inbound interceptor flows to enable.
      *
      * @param strategy  lookup strategy
      * 
@@ -155,7 +155,7 @@ public abstract class AbstractProfileConfiguration extends AbstractIdentifiableI
     }
 
     /**
-     * Set a lookup strategy for the {@link #outboundFlows} property.
+     * Set a lookup strategy for the outbound interceptor flows to enable.
      *
      * @param strategy  lookup strategy
      * 
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractSAMLProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractSAMLProfileConfiguration.java
index f148f66..d5e1da6 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractSAMLProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/profile/config/AbstractSAMLProfileConfiguration.java
@@ -66,10 +66,10 @@ public abstract class AbstractSAMLProfileConfiguration extends AbstractCondition
     /** Controls whether to include a NotBefore attribute in the Conditions of generated assertions. */
     @Nonnull private Predicate<ProfileRequestContext> includeNotBeforePredicate;
 
-    /** Lookup function to supply {@link #assertionLifetime} property. */
+    /** Lookup function to supply assertionLifetime property. */
     @Nonnull private Function<ProfileRequestContext,Duration> assertionLifetimeLookupStrategy;
 
-    /** Lookup function to supply {@link #assertionAudiences} property. */
+    /** Lookup function to supply assertionAudiences property. */
     @Nonnull private Function<ProfileRequestContext,Collection<String>> assertionAudiencesLookupStrategy;
 
     /**
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml1/profile/config/AbstractSAML1ArtifactAwareProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml1/profile/config/AbstractSAML1ArtifactAwareProfileConfiguration.java
index 0a8905c..b5a48b2 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml1/profile/config/AbstractSAML1ArtifactAwareProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml1/profile/config/AbstractSAML1ArtifactAwareProfileConfiguration.java
@@ -39,7 +39,7 @@ import net.shibboleth.utilities.java.support.logic.FunctionSupport;
 public abstract class AbstractSAML1ArtifactAwareProfileConfiguration extends AbstractSAMLProfileConfiguration
         implements SAML1ProfileConfiguration, SAMLArtifactAwareProfileConfiguration {
     
-    /** Lookup function to supply <code>artifactConfiguration</code> property. */
+    /** Lookup function to supply artifactConfiguration property. */
     @Nonnull private Function<ProfileRequestContext,SAMLArtifactConfiguration> artifactConfigurationLookupStrategy;
 
     /**
@@ -69,7 +69,7 @@ public abstract class AbstractSAML1ArtifactAwareProfileConfiguration extends Abs
     }
 
     /**
-     * Set a lookup strategy for the <code>artifactConfiguration</code> property.
+     * Set a lookup strategy for the SAML artifact configuration.
      *
      * @param strategy  lookup strategy
      * 
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ArtifactAwareProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ArtifactAwareProfileConfiguration.java
index fcd82fc..a0f7664 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ArtifactAwareProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ArtifactAwareProfileConfiguration.java
@@ -44,7 +44,7 @@ import net.shibboleth.utilities.java.support.logic.FunctionSupport;
 public abstract class AbstractSAML2ArtifactAwareProfileConfiguration extends AbstractSAML2ProfileConfiguration
         implements SAMLArtifactAwareProfileConfiguration, SAMLArtifactConsumerProfileConfiguration {
     
-    /** Lookup function to supply <code>artifactConfiguration</code> property. */
+    /** Lookup function to supply artifactConfiguration property. */
     @Nonnull private Function<ProfileRequestContext,SAMLArtifactConfiguration> artifactConfigurationLookupStrategy;
     
     /** Predicate used to determine if artifact resolution requests should be signed. */
@@ -81,7 +81,7 @@ public abstract class AbstractSAML2ArtifactAwareProfileConfiguration extends Abs
     }
 
     /**
-     * Set a lookup strategy for the <code>artifactConfiguration</code> property.
+     * Set a lookup strategy for the SAML artifact configuration.
      *
      * @param strategy  lookup strategy
      * 
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ProfileConfiguration.java
index 57f23f2..97b2c01 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/AbstractSAML2ProfileConfiguration.java
@@ -58,7 +58,7 @@ public abstract class AbstractSAML2ProfileConfiguration extends AbstractSAMLProf
     /** Predicate used to determine if attributes should be encrypted. */
     @Nonnull private Predicate<ProfileRequestContext> encryptAttributesPredicate;
 
-    /** Lookup function to supply {@link #proxyCount} property. */
+    /** Lookup function to supply proxyCount property. */
     @Nonnull private Function<ProfileRequestContext,Long> proxyCountLookupStrategy;
 
     /** Lookup function to supply proxy audiences. */
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/BrowserSSOProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/BrowserSSOProfileConfiguration.java
index ac01345..1e37e34 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/BrowserSSOProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/BrowserSSOProfileConfiguration.java
@@ -275,7 +275,7 @@ public class BrowserSSOProfileConfiguration extends AbstractSAML2ArtifactAwarePr
     }
     
     /**
-     * Set a lookup strategy for the {@link #maximumSPSessionLifetime} property.
+     * Set a lookup strategy for the maximum amount of time the service provider should maintain a session for the user.
      * 
      * @param strategy  lookup strategy
      * 
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/SingleLogoutProfileConfiguration.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/SingleLogoutProfileConfiguration.java
index 913f6aa..2f99a6f 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/SingleLogoutProfileConfiguration.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/saml2/profile/config/SingleLogoutProfileConfiguration.java
@@ -51,7 +51,7 @@ public class SingleLogoutProfileConfiguration extends AbstractSAML2ArtifactAware
     /** Predicate used to determine if SOAP-based requests should use client TLS. */
     @Nonnull private Predicate<MessageContext> clientTLSSOAPRequestsPredicate;
     
-    /** Lookup function to supply {@link #qualifiedNameIDFormats} property. */
+    /** Lookup function to supply qualifiedNameIDFormats property. */
     @Nonnull private Function<ProfileRequestContext,Collection<String>> qualifiedNameIDFormatsLookupStrategy;
     
     /** Constructor. */
diff --git a/idp-saml-impl/src/test/java/net/shibboleth/idp/saml/impl/TestSources.java b/idp-saml-impl/src/test/java/net/shibboleth/idp/saml/impl/TestSources.java
index 4b583be..26651a7 100644
--- a/idp-saml-impl/src/test/java/net/shibboleth/idp/saml/impl/TestSources.java
+++ b/idp-saml-impl/src/test/java/net/shibboleth/idp/saml/impl/TestSources.java
@@ -93,7 +93,7 @@ public final class TestSources {
     public static final StringAttributeValue ATTRIBUTE_ATTRIBUTE_VALUE_RESULT = new StringAttributeValue(
             ATTRIBUTE_ATTRIBUTE_VALUE_STRING);
 
-    /** Regexp. for CONNECTOR_ATTRIBUTE_VALUE (for map & regexp testing). */
+    /** Regexp. for CONNECTOR_ATTRIBUTE_VALUE (for map and regexp testing). */
 
     public static final String CONNECTOR_ATTRIBUTE_VALUE_REGEXP = "at1-(.+)or";
 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list