Clean project

Author: pitbulk

README.md

@@ -145,7 +145,7 @@ Let's start describing them:
 #### core (com.onelogin:java-saml-core) ####
 This folder contains a maven project with the heart of java-saml, classes and methods to handle AuthNRequest, SAMLResponse, LogoutRequest, LogoutResponse and Metadata (low level API). In addition contains classes to load the settings of the toolkit and the HttpRequest class, a framework-agnostic representation of an HTTP request.
 
-In the repo, at *src/main/java* you will find the source, at *src/main/main/resources/schemas* there are xsd schemas used to validate the SAML messages, at *src/test/java* are the tests for its classes and at *src/test/resources* different settings, SAML messages and certificates used on the junit tests.
+In the repo, at *src/main/java* you will find the source, at *src/main/resources/schemas* there are xsd schemas used to validate the SAML messages, at *src/test/java* are the tests for its classes and at *src/test/resources* different settings, SAML messages and certificates used on the junit tests.
 
 
 #### toolkit (com.onelogin:java-saml) ####

core/pom.xml

@@ -116,7 +116,7 @@
 						<configuration>
 							<rules>
 								<evaluateBeanshell>
-									<condition>javax.crypto.Cipher.getMaxAllowedKeyLength("AES") > 128</condition>
+									<condition>javax.crypto.Cipher.getMaxAllowedKeyLength("AES") &gt; 128</condition>
 								</evaluateBeanshell>
 							</rules>
 						</configuration>

core/src/main/java/com/onelogin/saml2/util/Preconditions.java

@@ -6,10 +6,12 @@ public final class Preconditions {
      *
      * @param t       the value to check for null
      * @param message the message to include in the thrown exception
-     * @return t
+     *
+     * @return T 
+     *
      * @throws NullPointerException if {@code t} is null
      */
-    public static <T> T checkNotNull(T t, String message) {
+    public static <T>T checkNotNull(T t, String message) {
         if (t == null) {
             throw new NullPointerException(message);
         } else {

core/src/main/java/com/onelogin/saml2/util/Util.java

@@ -348,7 +348,7 @@ public static String convertDocumentToString(Document doc) {
 	}
 
 	/**
-	 * Returns a certificate in String format (adding header & footer if required)
+	 * Returns a certificate in String format (adding header and footer if required)
 	 *
 	 * @param cert
 	 * 				A x509 unformatted cert
@@ -375,7 +375,7 @@ public static String formatCert(String cert, Boolean heads) {
 	}
 
 	/**
-	 * Returns a private key (adding header & footer if required).
+	 * Returns a private key (adding header and footer if required).
 	 *
 	 * @param key
 	 * 				A private key
@@ -1344,6 +1344,7 @@ public static long getExpireTime(String cacheDuration, long validUntil) {
 	 * Create string form time In Millis with format yyyy-MM-ddTHH:mm:ssZ
 	 *
 	 * @param timeInMillis
+	 * 				The time in Millis
 	 *
 	 * @return string with format yyyy-MM-ddTHH:mm:ssZ
 	 */
@@ -1354,16 +1355,18 @@ public static String formatDateTime(long timeInMillis) {
 	/**
 	 * Create string form time In Millis with format yyyy-MM-ddTHH:mm:ssZ
 	 *
-	 * @param timeInMillis
+	 * @param time
+	 * 			The time
 	 * @param millis
+	 * 			Defines if the time is in Millis
 	 *
 	 * @return string with format yyyy-MM-ddTHH:mm:ssZ
 	 */
-	public static String formatDateTime(long timeInMillis, boolean millis) {
+	public static String formatDateTime(long time, boolean millis) {
 		if (millis) {
-			return DATE_TIME_FORMAT_MILLS.print(timeInMillis);
+			return DATE_TIME_FORMAT_MILLS.print(time);
 		} else {
-			return formatDateTime(timeInMillis);
+			return formatDateTime(time);
 		}
 	}
 

pom.xml

@@ -172,6 +172,9 @@
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-javadoc-plugin</artifactId>
 						<version>2.9.1</version>
+						<configuration>
+							<additionalparam>-Xdoclint:none</additionalparam>
+						</configuration>
 						<executions>
 							<execution>
 								<id>attach-javadocs</id>

samples/java-saml-tookit-jspsample/src/main/webapp/attrs.jsp

@@ -28,6 +28,7 @@
     	<h1>A Java SAML Toolkit by OneLogin demo</h1>
 	<%
 		Boolean found = false;
+		@SuppressWarnings("unchecked")
 		Enumeration<String> elems = (Enumeration<String>) session.getAttributeNames();	
 	
 		while (elems.hasMoreElements() && !found) {
@@ -39,6 +40,7 @@
 	
 		if (found) {
 			String nameId = (String) session.getAttribute("nameId");
+			@SuppressWarnings("unchecked")
 			Map<String, List<String>> attributes = (Map<String, List<String>>) session.getAttribute("attributes");
 
 			if (!nameId.isEmpty()) {

toolkit/src/main/java/com/onelogin/saml2/Auth.java

@@ -708,7 +708,21 @@ public String buildResponseSignature(String samlResponse, String relayState, Str
 	{
 		return buildSignature(samlResponse, relayState, signAlgorithm, "SAMLResponse");
 	}
-	
+
+	/**
+	 * Generates the Signature for a SAML Response
+	 *
+	 * @param samlResponse
+	 *				The SAML Response
+	 * @param relayState
+	 *				The RelayState
+	 * @param signAlgorithm
+	 *				Signature algorithm method
+	 * @param type
+	 *              The type of the message
+	 *
+	 * @return the base64 encoded signature
+	 */
 	private String buildSignature(String samlMessage, String relayState, String signAlgorithm, String type)
 	{
 		 String signature = "";

toolkit/src/main/java/com/onelogin/saml2/servlet/ServletUtils.java

@@ -32,7 +32,7 @@ private ServletUtils() {
      * @return a HttpRequest
      */
     public static HttpRequest makeHttpRequest(HttpServletRequest req) {
-        //noinspection unchecked
+    	@SuppressWarnings("unchecked")
         final Map<String, String[]> paramsAsArray = (Map<String, String[]>) req.getParameterMap();
         final Map<String, List<String>> paramsAsList = new HashMap<>();
         for (Map.Entry<String, String[]> param : paramsAsArray.entrySet()) {