[java-identity-provider] branch master updated: JPAR-115 - Javadoc fixes for Java 9, 10

Ian Young ian at iay.org.uk
Wed Nov 28 12:09:10 EST 2018


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

iay 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=63c436fda415f04e15dbc0820cfefe82ac37bfc0

The following commit(s) were added to refs/heads/master by this push:
       new  63c436f   JPAR-115 - Javadoc fixes for Java 9,10
63c436f is described below

commit 63c436fda415f04e15dbc0820cfefe82ac37bfc0
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Wed Nov 28 17:09:04 2018 +0000

    JPAR-115 - Javadoc fixes for Java 9,10
---
 .../idp/attribute/filter/AttributeRule.java        | 43 +++++++++++++++-------
 .../AttributeRequesterInEntityGroupPolicyRule.java |  3 +-
 .../impl/AttributeFilterPolicyGroupParser.java     |  2 +-
 .../dc/http/impl/HTTPResponseMappingStrategy.java  |  2 +-
 .../dc/impl/BaseComputedIDDataConnectorParser.java |  4 +-
 .../dc/ldap/impl/LDAPDataConnectorParser.java      |  2 +-
 .../idp/authn/duo/impl/DuoAuthAPIResponse.java     |  3 +-
 .../idp/authn/duo/impl/DuoAuthResponse.java        |  2 +-
 .../shibboleth/idp/authn/duo/impl/DuoDevice.java   |  3 +-
 .../idp/authn/duo/impl/DuoPreauthResponse.java     |  2 +-
 .../shibboleth/idp/authn/duo/impl/DuoSupport.java  | 10 ++---
 .../cas/ticket/TicketPrincipalLookupFunction.java  |  4 +-
 .../consent/flow/impl/ConsentFlowDescriptor.java   |  8 ++--
 .../BasicResourceCredentialFactoryBean.java        |  2 +-
 .../impl/AnonymousRelyingPartyParser.java          |  2 +-
 .../impl/DefaultRelyingPartyParser.java            |  2 +-
 .../relyingparty/impl/RelyingPartyParser.java      |  2 +-
 .../impl/InlineMetadataProviderParser.java         |  2 +-
 .../AbstractSAMLAttributeDesignatorsMapper.java    |  4 +-
 .../mapping/AbstractSAMLAttributesMapper.java      |  4 +-
 .../idp/session/impl/DetectIdentitySwitch.java     |  2 +-
 .../idp/ui/context/RelyingPartyUIContext.java      |  2 +-
 .../idp/ui/taglib/ServiceContactTag.java           |  6 +--
 .../shibboleth/idp/ui/taglib/ServiceLogoTag.java   |  4 +-
 24 files changed, 69 insertions(+), 51 deletions(-)

diff --git a/idp-attribute-filter-api/src/main/java/net/shibboleth/idp/attribute/filter/AttributeRule.java b/idp-attribute-filter-api/src/main/java/net/shibboleth/idp/attribute/filter/AttributeRule.java
index 9e5075b..70b736c 100644
--- a/idp-attribute-filter-api/src/main/java/net/shibboleth/idp/attribute/filter/AttributeRule.java
+++ b/idp-attribute-filter-api/src/main/java/net/shibboleth/idp/attribute/filter/AttributeRule.java
@@ -39,15 +39,22 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+// Checkstyle: Javadoc OFF
+// See https://github.com/checkstyle/checkstyle/issues/3351
 /**
- * Represents a value filtering rule for a particular attribute. <code>
-     <element name="AttributeRule" type="afp:AttributeRuleType">
-        <annotation>
-            <documentation>A rule that describes how values of an attribute will be filtered.</documentation>
-        </annotation>
-    </element>
- </code>
+ * Represents a value filtering rule for a particular attribute.
+ *
+ * <pre>
+ * {@code
+ * <element name="AttributeRule" type="afp:AttributeRuleType">
+ *     <annotation>
+ *         <documentation>A rule that describes how values of an attribute will be filtered.</documentation>
+ *     </annotation>
+ * </element>
+ * }
+ * </pre>
  */
+//Checkstyle: Javadoc ON
 @ThreadSafe
 public class AttributeRule extends AbstractIdentifiableInitializableComponent implements
         UnmodifiableComponent {
@@ -58,15 +65,23 @@ public class AttributeRule extends AbstractIdentifiableInitializableComponent im
     /** Log prefix. */
     private String logPrefix;
 
+    // Checkstyle: Javadoc OFF
+    // See https://github.com/checkstyle/checkstyle/issues/3351
     /**
-     * Unique ID of the attribute this rule applies to. <code>
-        <attribute name="attributeID" type="string" use="required">
-            <annotation>
-                <documentation>The ID of the attribute to which this rule applies.</documentation>
-            </annotation>
-        </attribute>
-      </code>
+     * Unique ID of the attribute this rule applies to.
+     *
+     * <pre>
+     * {@code
+     * <attribute name="attributeID" type="string" use="required">
+     *     <annotation>
+     *         <documentation>The ID of the attribute to which this rule applies.</documentation>
+     *     </annotation>
+     * </attribute>
+     * }
+     * </pre>
      */
+    // Checkstyle: Javadoc ON
+
     private String attributeId;
 
     /**
diff --git a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AttributeRequesterInEntityGroupPolicyRule.java b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AttributeRequesterInEntityGroupPolicyRule.java
index d5c6d18..5762db1 100644
--- a/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AttributeRequesterInEntityGroupPolicyRule.java
+++ b/idp-attribute-filter-impl/src/main/java/net/shibboleth/idp/attribute/filter/policyrule/saml/impl/AttributeRequesterInEntityGroupPolicyRule.java
@@ -70,7 +70,8 @@ public class AttributeRequesterInEntityGroupPolicyRule extends AbstractPolicyRul
     }
     
     /**
-     * Set whether to check a supplied {@link MetadataResolver} for membership in an AffiliationDescriptor
+     * Set whether to check a supplied {@link org.opensaml.saml.metadata.resolver.MetadataResolver}
+     * for membership in an AffiliationDescriptor
      * as a form of group policy.
      * 
      * <p>Defaults to false.</p>
diff --git a/idp-attribute-filter-spring/src/main/java/net/shibboleth/idp/attribute/filter/spring/impl/AttributeFilterPolicyGroupParser.java b/idp-attribute-filter-spring/src/main/java/net/shibboleth/idp/attribute/filter/spring/impl/AttributeFilterPolicyGroupParser.java
index 60814c8..c19a7c9 100644
--- a/idp-attribute-filter-spring/src/main/java/net/shibboleth/idp/attribute/filter/spring/impl/AttributeFilterPolicyGroupParser.java
+++ b/idp-attribute-filter-spring/src/main/java/net/shibboleth/idp/attribute/filter/spring/impl/AttributeFilterPolicyGroupParser.java
@@ -35,7 +35,7 @@ import org.springframework.beans.factory.xml.ParserContext;
 import org.w3c.dom.Element;
 
 /**
- * Bean definition parser for <afp:AttributeFilterPolicyGroup>, top top level of the filter "stack". <br.>
+ * Bean definition parser for <afp:AttributeFilterPolicyGroup>, top top level of the filter "stack". <br/>
  * 
  * There is no bean being summoned up here. Rather we just parse all the children. Then over in the service all the *
  * {@link net.shibboleth.idp.attribute.filter.AttributeFilterPolicy} beans are sucked out of spring by type and injected
diff --git a/idp-attribute-resolver-impl/src/main/java/net/shibboleth/idp/attribute/resolver/dc/http/impl/HTTPResponseMappingStrategy.java b/idp-attribute-resolver-impl/src/main/java/net/shibboleth/idp/attribute/resolver/dc/http/impl/HTTPResponseMappingStrategy.java
index 1a27f87..0105b41 100644
--- a/idp-attribute-resolver-impl/src/main/java/net/shibboleth/idp/attribute/resolver/dc/http/impl/HTTPResponseMappingStrategy.java
+++ b/idp-attribute-resolver-impl/src/main/java/net/shibboleth/idp/attribute/resolver/dc/http/impl/HTTPResponseMappingStrategy.java
@@ -25,7 +25,7 @@ import net.shibboleth.idp.attribute.IdPAttribute;
 import net.shibboleth.idp.attribute.resolver.dc.MappingStrategy;
 
 /**
- * Strategy for processing an {@link org.apache.http.client.protocol.HttpClient} response into a map of 
+ * Strategy for processing an {@link org.apache.http.client.HttpClient} response into a map of 
  * {@link net.shibboleth.idp.attribute.IdPAttribute}s.
  */
 public interface HTTPResponseMappingStrategy extends MappingStrategy<Map<String,IdPAttribute>>,
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/BaseComputedIDDataConnectorParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/BaseComputedIDDataConnectorParser.java
index 22a5d5f..cfb298b 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/BaseComputedIDDataConnectorParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/impl/BaseComputedIDDataConnectorParser.java
@@ -45,7 +45,7 @@ import org.w3c.dom.Element;
 /**
  * Spring bean definition parser for configuring
  * {@link net.shibboleth.idp.saml.attribute.resolver.impl.ComputedIDDataConnector} and
- * {@link net.shibboleth.idp.saml.nameid.impl.StoredIDDataConnector}.
+ * {@link net.shibboleth.idp.saml.attribute.resolver.impl.StoredIDDataConnector}.
  */
 public abstract class BaseComputedIDDataConnectorParser extends BaseResolverPluginParser {
 
@@ -54,7 +54,7 @@ public abstract class BaseComputedIDDataConnectorParser extends BaseResolverPlug
 
     /**
      * Parse the common definitions for {@link net.shibboleth.idp.saml.attribute.resolver.impl.ComputedIDDataConnector}
-     * and {@link net.shibboleth.idp.saml.nameid.impl.StoredIDDataConnector}.
+     * and {@link net.shibboleth.idp.saml.attribute.resolver.impl.StoredIDDataConnector}.
      * 
      * @param config the DOM element under consideration.
      * @param parserContext Spring's context.
diff --git a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
index 1f9b680..8169a3d 100644
--- a/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
+++ b/idp-attribute-resolver-spring/src/main/java/net/shibboleth/idp/attribute/resolver/spring/dc/ldap/impl/LDAPDataConnectorParser.java
@@ -104,7 +104,7 @@ public class LDAPDataConnectorParser extends AbstractWarningDataConnectorParser
     // CheckStyle: MethodLength|CyclomaticComplexity OFF
     /**
      * Parses a version 2 configuration. <br/>
-     * The following automatically created & injected beans acquire hard wired defaults:
+     * The following automatically created & injected beans acquire hard wired defaults:
      * <ul>
      * <li>{@link SearchExecutor#setTimeLimit(long)} defaults to 3000, overridden by the "searchTimeLimit" attribute.
      * </li>
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthAPIResponse.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthAPIResponse.java
index 7f4195a..840aeb5 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthAPIResponse.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthAPIResponse.java
@@ -23,7 +23,8 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
- * Describes the results of a Duo AuthAPI call, intended for use with a jackson {@link ObjectMapper}.
+ * Describes the results of a Duo AuthAPI call, intended for use with a jackson
+ * {@link com.fasterxml.jackson.databind.ObjectMapper}.
  * 
  * @since 3.4.0
  */
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthResponse.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthResponse.java
index 8a14dce..eeee7a3 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthResponse.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoAuthResponse.java
@@ -25,7 +25,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
  * Describes the results of an authentication attempt via the Duo AuthAPI, intended for use with a jackson
- * {@link ObjectMapper}.
+ * {@link com.fasterxml.jackson.databind.ObjectMapper}.
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class DuoAuthResponse extends DuoAuthAPIResponse {
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoDevice.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoDevice.java
index 8ad3e5a..2672f55 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoDevice.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoDevice.java
@@ -28,7 +28,8 @@ import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
- * Represents a Duo device, intended for use with a jackson {@link ObjectMapper}.
+ * Represents a Duo device, intended for use with a jackson
+ * {@link com.fasterxml.jackson.databind.ObjectMapper}.
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class DuoDevice {
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoPreauthResponse.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoPreauthResponse.java
index 75b77bf..ce29434 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoPreauthResponse.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoPreauthResponse.java
@@ -33,7 +33,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class DuoPreauthResponse extends DuoAuthAPIResponse {
 
-    /** the {@link List} of {@link DuoDeivces} registered. */
+    /** the {@link List} of {@link DuoDevice}s registered. */
     @JsonProperty("devices") @Nonnull private List<DuoDevice> devices;
 
     /** the {@link URL} for the self-enrollment portal. */
diff --git a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoSupport.java b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoSupport.java
index 68a7952..cda0c7e 100644
--- a/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoSupport.java
+++ b/idp-authn-impl/src/main/java/net/shibboleth/idp/authn/duo/impl/DuoSupport.java
@@ -121,7 +121,7 @@ public final class DuoSupport {
      * 
      * @throws InvalidKeyException bad skey value
      * @throws NoSuchAlgorithmException unknown encryption algorithm
-     * @throws UnsupportedEncodingException failure from {@link URLEncoder}
+     * @throws UnsupportedEncodingException failure from {@link java.net.URLEncoder}
      * 
      * @since 3.4.0
      */
@@ -150,7 +150,7 @@ public final class DuoSupport {
      * 
      * @return the parameters to be signed in their canonical order
      * 
-     * @throws UnsupportedEncodingException failure from {@link URLEncoder}
+     * @throws UnsupportedEncodingException failure from {@link java.net.URLEncoder}
      */
     private static String canonRequest(@Nonnull final RequestBuilder request, @Nonnull final String date,
             final int sigVersion) throws UnsupportedEncodingException {
@@ -168,14 +168,14 @@ public final class DuoSupport {
     }
 
     /**
-     * Builds a string representaion of the query string with the parameter names is alphabetical order. The names and
-     * values are URL encoded and then they are concatenated with '&' in between.
+     * Builds a string representation of the query string with the parameter names is alphabetical order. The names and
+     * values are URL encoded and then they are concatenated with '&' in between.
      * 
      * @param params the name/value pairs to be joined
      * 
      * @return the canonical query string
      * 
-     * @throws UnsupportedEncodingException failure from {@link URLEncoder}
+     * @throws UnsupportedEncodingException failure from {@link java.net.URLEncoder}
      */
     private static String createQueryString(@Nonnull final List<NameValuePair> params)
             throws UnsupportedEncodingException {
diff --git a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/TicketPrincipalLookupFunction.java b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/TicketPrincipalLookupFunction.java
index a5eb928..fec8bd9 100644
--- a/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/TicketPrincipalLookupFunction.java
+++ b/idp-cas-api/src/main/java/net/shibboleth/idp/cas/ticket/TicketPrincipalLookupFunction.java
@@ -30,8 +30,8 @@ import org.opensaml.profile.context.ProfileRequestContext;
 /**
  * Looks up a principal name stored in a CAS ticket:
  *
- * {@link ProfileRequestContext} -> {@link ProtocolContext} -> {@link TicketContext} ->
- * {@link Ticket#getTicketState()} -> {@link TicketState#getPrincipalName()}.
+ * {@link ProfileRequestContext} -> {@link ProtocolContext} -> {@link TicketContext} ->
+ * {@link Ticket#getTicketState()} -> {@link TicketState#getPrincipalName()}.
  *
  * @author Marvin S. Addison
  * @since 3.3.0
diff --git a/idp-consent-impl/src/main/java/net/shibboleth/idp/consent/flow/impl/ConsentFlowDescriptor.java b/idp-consent-impl/src/main/java/net/shibboleth/idp/consent/flow/impl/ConsentFlowDescriptor.java
index df7980c..33b6859 100644
--- a/idp-consent-impl/src/main/java/net/shibboleth/idp/consent/flow/impl/ConsentFlowDescriptor.java
+++ b/idp-consent-impl/src/main/java/net/shibboleth/idp/consent/flow/impl/ConsentFlowDescriptor.java
@@ -76,7 +76,7 @@ public class ConsentFlowDescriptor extends ProfileInterceptorFlowDescriptor {
     /**
      * Get the maximum number of records to keep in the storage service if the expanded size threshold is not met.
      * 
-     * @return the maximum number of records, or <=0 for no limit
+     * @return the maximum number of records, or <=0 for no limit
      */
     public int getMaximumNumberOfStoredRecords() {
         return maxStoredRecords;
@@ -85,7 +85,7 @@ public class ConsentFlowDescriptor extends ProfileInterceptorFlowDescriptor {
     /**
      * Get the maximum number of records to keep in the storage service if the expanded size threshold is met.
      * 
-     * @return the maximum number of records, or <=0 for no limit
+     * @return the maximum number of records, or <=0 for no limit
      */
     public int getExpandedNumberOfStoredRecords() {
         return expandedMaxStoredRecords;
@@ -126,7 +126,7 @@ public class ConsentFlowDescriptor extends ProfileInterceptorFlowDescriptor {
     /**
      * Set the maximum number of records to keep in the storage service if the expanded size threshold is not met.
      * 
-     * @param maximum the maximum number of records, or <=0 for no limit
+     * @param maximum the maximum number of records, or <=0 for no limit
      */
     public void setMaximumNumberOfStoredRecords(final int maximum) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
@@ -137,7 +137,7 @@ public class ConsentFlowDescriptor extends ProfileInterceptorFlowDescriptor {
     /**
      * Set the maximum number of records to keep in the storage service if the expanded size threshold is met.
      * 
-     * @param maximum the maximum number of records, or <=0 for no limit
+     * @param maximum the maximum number of records, or <=0 for no limit
      */
     public void setExpandedNumberOfStoredRecords(final int maximum) {
         ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/BasicResourceCredentialFactoryBean.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/BasicResourceCredentialFactoryBean.java
index 76b90f0..f12d400 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/BasicResourceCredentialFactoryBean.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/factory/BasicResourceCredentialFactoryBean.java
@@ -37,7 +37,7 @@ import org.springframework.core.io.Resource;
 import com.google.common.io.ByteStreams;
 
 /**
- * Factory bean for BasicFilesystem & BasicResourceBacked Credentials.
+ * Factory bean for BasicFilesystem & BasicResourceBacked Credentials.
  */
 public class BasicResourceCredentialFactoryBean extends AbstractBasicCredentialFactoryBean {
 
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/AnonymousRelyingPartyParser.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/AnonymousRelyingPartyParser.java
index 369fe9d..ee136fc 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/AnonymousRelyingPartyParser.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/AnonymousRelyingPartyParser.java
@@ -26,7 +26,7 @@ import org.springframework.beans.factory.xml.ParserContext;
 import org.w3c.dom.Element;
 
 /**
- * Parser for the &lt:rp:AnonymousRelyingParty> element. <br/>
+ * Parser for the <rp:AnonymousRelyingParty> element. <br/>
  * The {@link com.google.common.base.Predicate} which is injected looks to see if there is metadata associated with the
  * RelyingParty and if so says TRUE.
  */
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/DefaultRelyingPartyParser.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/DefaultRelyingPartyParser.java
index 0537d18..caf14ba 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/DefaultRelyingPartyParser.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/DefaultRelyingPartyParser.java
@@ -28,7 +28,7 @@ import org.w3c.dom.Element;
 import com.google.common.base.Predicates;
 
 /**
- * Parser for the &lt:rp:AnonymousRelyingParty> element. <br/>
+ * Parser for the <rp:AnonymousRelyingParty> element. <br/>
  * The {@link com.google.common.base.Predicate} which is injected is AlwaysTrue. The {@link RelyingPartyGroupParser}
  * takes care to ensure that this element is always at the end of the list, thus implementing Default semantics.
  */
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/RelyingPartyParser.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/RelyingPartyParser.java
index 43a4e3f..a435d30 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/RelyingPartyParser.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/impl/RelyingPartyParser.java
@@ -38,7 +38,7 @@ import com.google.common.base.Functions;
 import com.google.common.base.Predicates;
 
 /**
- * Parser for the &lt:rp:RelyingParty> element.
+ * Parser for the <rp:RelyingParty> element.
  */
 public class RelyingPartyParser extends AbstractRelyingPartyParser {
 
diff --git a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/impl/InlineMetadataProviderParser.java b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/impl/InlineMetadataProviderParser.java
index 0f8aeb3..ddd1a82 100644
--- a/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/impl/InlineMetadataProviderParser.java
+++ b/idp-profile-spring/src/main/java/net/shibboleth/idp/profile/spring/relyingparty/metadata/impl/InlineMetadataProviderParser.java
@@ -31,7 +31,7 @@ import org.springframework.beans.factory.support.BeanDefinitionBuilder;
 import org.springframework.beans.factory.xml.ParserContext;
 import org.w3c.dom.Element;
 
-/** Parser for <InlineMetadataProvider&gt. */
+/** Parser for <InlineMetadataProvider>. */
 public class InlineMetadataProviderParser extends AbstractMetadataProviderParser {
 
     /** Element name. */
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributeDesignatorsMapper.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributeDesignatorsMapper.java
index 5dcfda7..c15b765 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributeDesignatorsMapper.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributeDesignatorsMapper.java
@@ -75,8 +75,8 @@ public abstract class AbstractSAMLAttributeDesignatorsMapper<OutType extends IdP
     /**
      * Constructor to create the mapping from an existing resolver.
      * 
-     * <p>This code inverts the {@link AttributeEncoder} (internal attribute -> SAML Attributes) into
-     * {@link AttributeMapper} (SAML [AttributeDesignators] -> internal [Requested] Attributes). <br/>
+     * <p>This code inverts the {@link AttributeEncoder} (internal attribute -> SAML Attributes) into
+     * {@link AttributeMapper} (SAML [AttributeDesignators] -> internal [Requested] Attributes). <br/>
      * to generate the {@link AbstractSAMLAttributeDesignatorMapper} (with no
      * {@link AbstractSAMLAttributeDesignatorMapper#getAttributeIds()}. These are accumulated into a {@link Multimap},
      * where the key is the {@link AbstractSAMLAttributeDesignatorMapper} and the values are the (IdP) attribute names.
diff --git a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributesMapper.java b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributesMapper.java
index eaf6239..7ba120b 100644
--- a/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributesMapper.java
+++ b/idp-saml-api/src/main/java/net/shibboleth/idp/saml/attribute/mapping/AbstractSAMLAttributesMapper.java
@@ -76,8 +76,8 @@ public abstract class AbstractSAMLAttributesMapper<InType extends Attribute, Out
     
     /**
      * Constructor to create the mapping from an existing resolver. <br/>
-     * This code inverts the {@link AttributeEncoder} (internal attribute -> SAML Attributes) into
-     * {@link AttributeMapper} (SAML [RequestedAttributes] -> internal [Requested] Attributes). <br/>
+     * This code inverts the {@link AttributeEncoder} (internal attribute -> SAML Attributes) into
+     * {@link AttributeMapper} (SAML [RequestedAttributes] -> internal [Requested] Attributes). <br/>
      * to generate the {@link AbstractSAMLAttributeMapper} (with no
      * {@link AbstractSAMLAttributeMapper#getAttributeIds()}. These are accumulated into a {@link Multimap}, where the
      * key is the {@link AbstractSAMLAttributeMapper} and the values are the (IdP) attribute names. The collection of
diff --git a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/DetectIdentitySwitch.java b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/DetectIdentitySwitch.java
index cd4a29b..cd1689f 100644
--- a/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/DetectIdentitySwitch.java
+++ b/idp-session-impl/src/main/java/net/shibboleth/idp/session/impl/DetectIdentitySwitch.java
@@ -59,7 +59,7 @@ import com.google.common.base.Function;
  * @event {@link EventIds#IO_ERROR}
  * @event {@link AuthnEventIds#IDENTITY_SWITCH}
  * @post If an identity switch is detected, SessionContext.getIdPSession() == null
- *  && AuthenticationContext.getActiveResults().isEmpty()
+ *  && AuthenticationContext.getActiveResults().isEmpty()
  */
 public class DetectIdentitySwitch extends AbstractAuthenticationAction {
 
diff --git a/idp-ui/src/main/java/net/shibboleth/idp/ui/context/RelyingPartyUIContext.java b/idp-ui/src/main/java/net/shibboleth/idp/ui/context/RelyingPartyUIContext.java
index 6d680fd..f3bb358 100644
--- a/idp-ui/src/main/java/net/shibboleth/idp/ui/context/RelyingPartyUIContext.java
+++ b/idp-ui/src/main/java/net/shibboleth/idp/ui/context/RelyingPartyUIContext.java
@@ -392,7 +392,7 @@ public class RelyingPartyUIContext extends BaseContext {
     }
 
     /**
-     * look for an &ltAttributeConsumeService&gt and if its there look for an appropriate description.
+     * Look for an <AttributeConsumeService> and if it's there look for an appropriate description.
      * 
      * @param lang - which language to look up
      * @return null or an appropriate description
diff --git a/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceContactTag.java b/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceContactTag.java
index af9babd..8a40545 100644
--- a/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceContactTag.java
+++ b/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceContactTag.java
@@ -112,7 +112,7 @@ public class ServiceContactTag extends ServiceTagSupport {
     }
 
     /**
-     * build an appropriate string from the &ltContact&gt.
+     * Build an appropriate string from the <Contact>.
      * 
      * @param contact who we are interested in.
      * @return either an hyperlink or straight text or null
@@ -149,9 +149,9 @@ public class ServiceContactTag extends ServiceTagSupport {
     }
 
     /**
-     * build an appropriate string from the &ltEntityDescriptor&gt.
+     * Build an appropriate string from the <EntityDescriptor>.
      * 
-     * @return either an hyperlink or straight text or null.
+     * @return either a hyperlink or straight text or null.
      */
     @Nullable protected String getContactFromEntity() {
 
diff --git a/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceLogoTag.java b/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceLogoTag.java
index 81ff1f0..96329f8 100644
--- a/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceLogoTag.java
+++ b/idp-ui/src/main/java/net/shibboleth/idp/ui/taglib/ServiceLogoTag.java
@@ -147,9 +147,9 @@ public class ServiceLogoTag extends ServiceTagSupport {
     }
 
     /**
-     * Given the url build an appropriate &lta href=...
+     * Given the url, build an appropriate <a href=...
      * 
-     * @return the contrcuted hyperlink or null
+     * @return the constructed hyperlink or null
      */
     @Nullable private String getHyperlink() {
         final String url = getLogoFromUIInfo();

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


More information about the commits mailing list