[java-identity-provider COMMIT] in /trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou: TermsOfUseEngineImpl.jav...

[noreply at shibboleth.net]

Author: iay
Date: Fri Mar 21 06:24:33 2014
New Revision: 5623

URL: http://svn.shibboleth.net/view/java-identity-provider?rev=5623&view=rev
Log:
Javadoc fixes.

Modified:
    trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/TermsOfUseEngineImpl.java
    trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUAcceptance.java
    trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUHelper.java
    trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/storage/CacheStorage.java
    trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/storage/JDBCStorage.java

Modified: trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/TermsOfUseEngineImpl.java
URL: http://svn.shibboleth.net/view/java-identity-provider/trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/TermsOfUseEngineImpl.java?rev=5623&r1=5622&r2=5623&view=diff
==============================================================================
--- trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/TermsOfUseEngineImpl.java (original)
+++ trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/TermsOfUseEngineImpl.java Fri Mar 21 06:24:33 2014
@@ -32,13 +32,13 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.util.Assert;
 
-/** Implements @see TermsOfUseEngine. */
+/** Implements {@link TermsOfUseEngine}. */
 public class TermsOfUseEngineImpl implements TermsOfUseEngine {
 
     /** Class logger. */
     private final Logger logger = LoggerFactory.getLogger(TermsOfUseEngineImpl.class);
 
-    /** The @see Storage instance which is used. */
+    /** The {@link Storage} instance which is used. */
     @Resource(name = "tou.storage")
     private Storage storage;
 
@@ -46,7 +46,7 @@
     @Resource(name = "tou.config.touMap")
     private Map<String, ToU> touMap;
 
-    /** The id of the @see Attribute which should be used for user identifcation. */
+    /** The id of the {@link net.shibboleth.idp.attribute.IdPAttribute} which should be used for user identification. */
     @Resource(name = "tou.config.userIdAttribute")
     private String userIdAttribute;
 

Modified: trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUAcceptance.java
URL: http://svn.shibboleth.net/view/java-identity-provider/trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUAcceptance.java?rev=5623&r1=5622&r2=5623&view=diff
==============================================================================
--- trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUAcceptance.java (original)
+++ trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUAcceptance.java Fri Mar 21 06:24:33 2014
@@ -50,7 +50,7 @@
     /**
      * Constructs a terms of use acceptance using a terms of use and an acceptance date.
      * 
-     * @param tou The {@see Tou}.
+     * @param tou The {@link ToU}.
      * @param acceptanceDate The acceptance date.
      */
     private ToUAcceptance(final ToU tou, final DateTime acceptanceDate) {
@@ -89,7 +89,7 @@
     /**
      * Creates a terms of use acceptance.
      * 
-     * @param tou The {@see Tou}.
+     * @param tou The {@link ToU}.
      * @param acceptanceDate The acceptance date.
      * @return Returns a terms of use acceptance.
      */
@@ -109,7 +109,7 @@
     /**
      * Checks if this terms of acceptance contains a specific terms of use.
      * 
-     * @param tou The {@see Tou}.
+     * @param tou The {@link ToU}.
      * @return Returns true if version and fingerprint equals, false otherwise.
      */
     public boolean contains(final ToU tou) {

Modified: trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUHelper.java
URL: http://svn.shibboleth.net/view/java-identity-provider/trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUHelper.java?rev=5623&r1=5622&r2=5623&view=diff
==============================================================================
--- trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUHelper.java (original)
+++ trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/ToUHelper.java Fri Mar 21 06:24:33 2014
@@ -102,11 +102,11 @@
     }
 
     /**
-     * Retrieves the mapped {@see ToU} for a specific relying party.
+     * Retrieves the mapped {@link ToU} for a specific relying party.
      * 
      * @param touMap The relying party / terms of use map.
      * @param entityId The relying party id.
-     * @return Returns the mapped {@see ToU} for this relying party id or <code>null</code>.
+     * @return Returns the mapped {@link ToU} for this relying party id or <code>null</code>.
      */
     public static ToU getToUForRelyingParty(final Map<String, ToU> touMap, final String entityId) {
         Pattern pattern;
@@ -125,7 +125,7 @@
     /**
      * Gets the terms of use fingerprint.
      * 
-     * @param tou The {@see Tou}.
+     * @param tou The {@link ToU}.
      * @return Returns the terms of use fingerprint.
      */
     public static String getToUFingerprint(final ToU tou) {

Modified: trunk/idp-tou-impl/src/main/java/net/shibboleth/idp/tou/storage/CacheStorage.java

[... 42 lines stripped ...]