Fixed Javadoc

git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@864 d688527b-c9ab-4aba-bd8d-4036d912da1d

13 files changed, 33 insertions, 31 deletions

diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java b/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java
index 0d3166090..a79cba4d7 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java
@@ -992,14 +992,14 @@ public class AuthenticationServer implements MOAIDAuthConstants {
 
   /**
    * Sets the sessionTimeOut.
-   * @param sessionTimeOut time out in seconds
+   * @param seconds Time out of the session in seconds
    */
   public void setSecondsSessionTimeOut(long seconds) {
     sessionTimeOut = 1000 * seconds;
   }
   /**
    * Sets the authDataTimeOut.
-   * @param authDataTimeOut time out in seconds
+   * @param seconds Time out for signing AuthData in seconds
    */
   public void setSecondsAuthDataTimeOut(long seconds) {
     authDataTimeOut = 1000 * seconds;
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java
index 4493333c2..60cd11ed6 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java
@@ -76,7 +76,7 @@ public class AuthenticationBlockAssertionBuilder extends AuthenticationAssertion
    *                          element derived from the Identitylink; this is the
    *                          value of the <code>wbPK</code>;
    *                          maybe <code>null</code> if the application is a public service
-   * @param identiyLinkType   the content of the <code>&lt;pr:Type&gt;</code>
+   * @param identityLinkType  the content of the <code>&lt;pr:Type&gt;</code>
    *                          child element of the <code>&lt;pr:Identification&gt;</code>
    *                          element derived from the Identitylink; this includes the
    *                          URN prefix and the identification number of the business
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java
index a5614655b..3a2ee07de 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java
@@ -13,13 +13,13 @@ public class Builder {
   
   /**
    * Replaces a given number of occurences of a special tag in an XML or HTML template by a value.
-   * @param htmlTemplate template
+   * @param template html template
    * @param tag special tag
    * @param value value replacing the tag
    * @param expected specifies if the tag is expected to present; if <code>true</code> and the tag
    *                 is not present, an exception is thrown; if <code>false</code> and the tag is
    *                 not present, the original string is returned
-   * @param maxreplacements: -1 to replace each occurence of tag, or limit replacements by a given positive number  
+   * @param maxreplacements Set -1 to replace each occurence of tag, or limit replacements by a given positive number  
    * @return XML or HTML code, the tag replaced
    * @throws BuildException when template does not contain the tag
    */
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java
index 51429251e..e9a9f308d 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java
@@ -47,7 +47,7 @@ public class CreateXMLSignatureRequestBuilder implements Constants {
 	 * Builds the <code>&lt;CreateXMLSignatureRequest&gt;</code>.
 	 * 
 	 * @param authBlock String representation of XML authentication block
-	 * @param keyBoxIdentfier the key box identifier which will be used (e.g. CertifiedKeypair)
+	 * @param keyBoxIdentifier the key box identifier which will be used (e.g. CertifiedKeypair)
    * @param slVersion12 specifies whether the Security Layer version number is 1.2 or not
 	 * @return String representation of <code>&lt;CreateXMLSignatureRequest&gt;</code>
 	 */
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java
index 12d29ba82..90d79a46d 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java
@@ -126,7 +126,7 @@ public class AuthenticationSession {
 
   /**
    * Sets the sessionID.
-   * @param sessionID The sessionID to set
+   * @param sessionId The sessionID to set
    */
   public void setSessionID(String sessionId) {
     this.sessionID = sessionId;
@@ -168,24 +168,24 @@ public class AuthenticationSession {
    * Sets the oaURLRequested.
    * @param oaURLRequested The oaURLRequested to set
    */
-  public void setOAURLRequested(String url) {
-    this.oaURLRequested = url;
+  public void setOAURLRequested(String oaURLRequested) {
+    this.oaURLRequested = oaURLRequested;
   }
 
   /**
    * Sets the oaPublicURLPrefix
-   * @param url The oaPublicURLPrefix to set
+   * @param oaPublicURLPrefix The oaPublicURLPrefix to set
    */
-  public void setPublicOAURLPrefix(String url) {
-    this.oaPublicURLPrefix = url;
+  public void setPublicOAURLPrefix(String oaPublicURLPrefix) {
+    this.oaPublicURLPrefix = oaPublicURLPrefix;
   }
   
   /**
    * Sets the bkuURL
-   * @param url The BKU URL to set
+   * @param bkuURL The BKU URL to set
    */
-  public void setBkuURL(String url) {
-    this.bkuURL = url;
+  public void setBkuURL(String bkuURL) {
+    this.bkuURL = bkuURL;
   }
 
   /**
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java
index 81945f644..d121f2c55 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java
@@ -54,7 +54,7 @@ public void setSamlAssertion(Element samlAssertion) {
 
 /**
  * Sets the samlAttribute.
- * @param samlAttribute The samlAttribute to set
+ * @param samlAttributes The samlAttributes to set
  */
 public void setSamlAttributes(SAMLAttribute[] samlAttributes) {
   this.samlAttributes = samlAttributes;
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java
index 9aedd86e6..27b512717 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java
@@ -100,7 +100,7 @@ public class ExtendedSAMLAttributeImpl implements ExtendedSAMLAttribute {
    *            {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK_ONLY}
    *            </li>
    *        </ul>
-   *    {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK) 
+   *    {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK} 
    */
   public void setAddToAUTHBlock(int addToAUTHBlock) {
     addToAUTHBlock_ = addToAUTHBlock;
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java
index fcfc054d8..123d57157 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java
@@ -190,7 +190,7 @@ public class InfoboxValidatorParamsImpl implements InfoboxValidatorParams {
   }
   
   /**
-   * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams#hideStammzahl
+   * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams#getHideStammzahl()
    */
   public boolean getHideStammzahl() {
     return hideStammzahl_;
@@ -334,7 +334,8 @@ public class InfoboxValidatorParamsImpl implements InfoboxValidatorParams {
   }
 
   /**
-   * Sets the {@link #hideStammzahl_} parameter.
+   * Sets the hideStammzahl_ parameter. This indicates whether source pins 
+   * (<code>Stammzahl</code>en) must be hidden or not.
    *
    * @param hideStammzahl <code>True</code> if source pins (<code>Stammzahl</code>en) should
    *                      be hidden, otherwise <code>false</code>.
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java
index 5e1df5157..a8b870f04 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java
@@ -71,10 +71,10 @@ public class CreateXMLSignatureResponseParser {
    * Parses and validates the document given as stream and extracts the 
    * root element.
    * 
-   * @param xmlResponse <code>&lt;CreateXMLSignatureResponse&gt;</code> as String
+   * @param is <code>&lt;InfoboxReadResponse&gt;</code> as InputStream
    * 
-   * @throws AuthenticationException if any authentication error occurs
-   * @throws ParseException if an element cannot be parsed
+   * @throws AuthenticationException If any authentication error occurs
+   * @throws ParseException If an element cannot be parsed
    */
   public CreateXMLSignatureResponseParser(InputStream is) throws AuthenticationException, ParseException {
     init(is); 
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java
index 8edeec8ae..e3c54095d 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java
@@ -62,7 +62,7 @@ public class ErrorResponseParser {
 
   /**
    * Returns the information included in this error response.
-   * @return
+   * @return The error infomation String
    */
   public String getErrorInfo() {
     return errorInfo_ ;
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java
index 0cedda28d..e59c88ddc 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java
@@ -28,7 +28,8 @@ public class InfoboxReadResponseParser {
    * root element.
    * 
    * @param xmlResponse <code>&lt;InfoboxReadResponse&gt;</code> as String
-   * @throws ParseException on any parsing error
+   * @throws ParseException If an element cannot be parsed
+   * @throws AuthenticationException If any authentication error occurs
    */
   public InfoboxReadResponseParser(String xmlResponse) throws ParseException, AuthenticationException {
     
@@ -45,8 +46,9 @@ public class InfoboxReadResponseParser {
    * Parses and validates the document given as stream and extracts the 
    * root element.
    * 
-   * @param xmlResponse <code>&lt;InfoboxReadResponse&gt;</code> as InputStream
-   * @throws ParseException on any parsing error
+   * @param is <code>&lt;InfoboxReadResponse&gt;</code> as InputStream
+   * @throws ParseException If an element cannot be parsed
+   * @throws AuthenticationException If any authentication error occurs
    */
   public InfoboxReadResponseParser(InputStream is) throws ParseException, AuthenticationException {
     init(is);
@@ -58,7 +60,7 @@ public class InfoboxReadResponseParser {
    * root element.
    * 
    * @param is  The InfoBoxReadResponse as stream.
-   * @throws AuthenticationException if an authentication error occurs.
+   * @throws AuthenticationException If an authentication error occurs.
    * @throws ParseException If an error occurs on parsing the the document.
    */
   private void init(InputStream is) throws AuthenticationException, ParseException {
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java b/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java
index efb33ea59..e6c9f4bee 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java
@@ -51,8 +51,7 @@ public class CreateXMLSignatureResponseValidator {
   /**
    * The Method validate is used for validating an explicit {@link CreateXMLSignatureResponse}
    * @param createXMLSignatureResponse
-   * @param gbTarget
-   * @param oaURL
+   * @param session
    * @throws ValidateException
    */
   public void validate(CreateXMLSignatureResponse createXMLSignatureResponse, AuthenticationSession session)
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java b/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java
index 3f08f103c..1f2ebc37c 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java
@@ -129,8 +129,8 @@ public class VerifyXMLSignatureResponseValidator {
 
   /**
    * Method validateCertificate.
-   * @param vsr is the VerifyXMLSignatureResponse
-   * @param idl
+   * @param verifyXMLSignatureResponse The VerifyXMLSignatureResponse
+   * @param idl The Identitylink
    * @throws ValidateException
    */
   public void validateCertificate(