fixed javadoc issue

build.gradle

@@ -72,6 +72,10 @@ subprojects {
     test.resources.srcDirs = ["${projectDir}/src/test/resources", "${projectDir}/src/test/java"]
   }
 
+  javadoc {
+    classpath += configurations.provided
+  }
+
   dependencies {
     compile group: 'org.aspectj', name: 'aspectjrt', version:'1.8.6'
     compile group: 'org.aspectj', name: 'aspectjweaver', version:'1.8.6'

cas-server-core-api/src/main/java/org/jasig/cas/authentication/AuthenticationHandler.java

@@ -71,7 +71,7 @@ public interface AuthenticationHandler {
     /**
      * Determines whether the handler has the capability to authenticate the given credential. In practical terms,
      * the {@link #authenticate(Credential)} method MUST be capable of processing a given credential if
-     * <code>supports</code> returns true on the same credential.
+     * {@code supports} returns true on the same credential.
      *
      * @param credential The credential to check.
      *

cas-server-core-api/src/main/java/org/jasig/cas/authentication/AuthenticationMetaDataPopulator.java

@@ -42,7 +42,7 @@ public interface AuthenticationMetaDataPopulator {
     /**
      * Determines whether the populator has the capability to perform tasks on the given credential.
      * In practice, the {@link #populateAttributes(AuthenticationBuilder, Credential)} needs to be able
-     * to operate on said credentials only if the return result here is <code>true</code>.
+     * to operate on said credentials only if the return result here is {@code true}.
      *
      * @param credential The credential to check.
      * @return True if populator supports the Credential, false otherwise.

cas-server-core-api/src/main/java/org/jasig/cas/authentication/RootCasException.java

@@ -38,8 +38,8 @@ public abstract class RootCasException extends Exception {
   private final String code;
 
   /**
-   * Constructor that takes a <code>code</code> description of the error along with the exception
-   * <code>msg</code> generally for logging purposes. These codes normally have a corresponding
+   * Constructor that takes a {@code code} description of the error along with the exception
+   * {@code msg} generally for logging purposes. These codes normally have a corresponding
    * entries in the messages file for the internationalization of error messages.
    *
    * @param code the code to describe what type of exception this is.
@@ -74,7 +74,7 @@ public RootCasException(@NotNull final String code, final Throwable throwable) {
 
   /**
    * @return Returns the code. If there is a chained exception it recursively
-   * calls <code>getCode()</code> on the cause of the chained exception rather than the returning
+   * calls {@code getCode()} on the cause of the chained exception rather than the returning
    * the code itself.
    */
   public final String getCode() {

cas-server-core-api/src/main/java/org/jasig/cas/authentication/principal/WebApplicationService.java

@@ -42,7 +42,7 @@ public interface WebApplicationService extends Service {
     String getArtifactId();
 
     /**
-     * Return the original url provided (as <code>service</code> or <code>targetService</code> request parameter).
+     * Return the original url provided (as {@code service} or {@code targetService} request parameter).
      * Used to reconstruct the redirect url.
      *
      * @return the original url provided.

cas-server-core-authentication/src/main/java/org/jasig/cas/authentication/AnyAuthenticationPolicy.java

@@ -31,13 +31,13 @@
 @Component("anyAuthenticationPolicy")
 public class AnyAuthenticationPolicy implements AuthenticationPolicy {
 
-    /** Flag to try all credentials before policy is satisfied. Defaults to <code>false</code>.*/
+    /** Flag to try all credentials before policy is satisfied. Defaults to {@code false}.*/
     private boolean tryAll;
 
     /**
      * Sets the flag to try all credentials before the policy is satisfied.
      * This flag is disabled by default such that the policy is satisfied immediately upon the first
-     * successfully authenticated credential. Defaults to <code>false</code>.
+     * successfully authenticated credential. Defaults to {@code false}.
      *
      * @param tryAll True to force all credentials to be authenticated, false otherwise.
      */

cas-server-core-authentication/src/main/java/org/jasig/cas/authentication/FileTrustStoreSslSocketFactory.java

@@ -60,7 +60,7 @@ public final class FileTrustStoreSslSocketFactory extends SSLConnectionSocketFac
 
     /**
      * Instantiates a new trusted proxy authentication trust store ssl socket factory.
-     * Defaults to <code>TLSv1</code> and {@link SSLConnectionSocketFactory#BROWSER_COMPATIBLE_HOSTNAME_VERIFIER}
+     * Defaults to {@code TLSv1} and {@link SSLConnectionSocketFactory#BROWSER_COMPATIBLE_HOSTNAME_VERIFIER}
      * for the supported protocols and hostname verification.
      * @param trustStoreFile the trust store file
      * @param trustStorePassword the trust store password

cas-server-core-authentication/src/main/java/org/jasig/cas/authentication/handler/support/JaasAuthenticationHandler.java

@@ -149,15 +149,15 @@ public void setRealm(final String realm) {
     }
 
     /**
-     * Typically, the default realm and the KDC for that realm are indicated in the Kerberos <code>krb5.conf</code> configuration file.
+     * Typically, the default realm and the KDC for that realm are indicated in the Kerberos {@code krb5.conf} configuration file.
      * However, if you like, you can instead specify the realm value by setting this following system property value.
      * <p>If you set the realm property, you SHOULD also configure the {@link #setKerberosKdcSystemProperty(String)}.
      * <p>Also note that if you set these properties, then no cross-realm authentication is possible unless
-     * a <code>krb5.conf</code> file is also provided from which the additional information required for cross-realm authentication
+     * a {@code krb5.conf} file is also provided from which the additional information required for cross-realm authentication
      * may be obtained.
      * <p>If you set values for these properties, then they override the default realm and KDC values specified
-     * in <code>krb5.conf</code> (if such a file is found). The <code>krb5.conf</code> file is still consulted if values for items
-     * other than the default realm and KDC are needed. If no <code>krb5.conf</code> file is found,
+     * in {@code krb5.conf} (if such a file is found). The {@code krb5.conf} file is still consulted if values for items
+     * other than the default realm and KDC are needed. If no {@code krb5.conf} file is found,
      * then the default values used for these items are implementation-specific.
      * @param kerberosRealmSystemProperty system property to indicate realm.
      * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/jgss/tutorials/KerberosReq.html">
@@ -169,15 +169,15 @@ public final void setKerberosRealmSystemProperty(final String kerberosRealmSyste
     }
 
     /**
-     * Typically, the default realm and the KDC for that realm are indicated in the Kerberos <code>krb5.conf</code> configuration file.
+     * Typically, the default realm and the KDC for that realm are indicated in the Kerberos {@code krb5.conf} configuration file.
      * However, if you like, you can instead specify the kdc value by setting this system property value.
      * <p>If you set the realm property, you SHOULD also configure the {@link #setKerberosRealmSystemProperty(String)}.
      * <p>Also note that if you set these properties, then no cross-realm authentication is possible unless
-     * a <code>krb5.conf</code> file is also provided from which the additional information required for cross-realm authentication
+     * a {@code krb5.conf} file is also provided from which the additional information required for cross-realm authentication
      * may be obtained.
      * <p>If you set values for these properties, then they override the default realm and KDC values specified
-     * in <code>krb5.conf</code> (if such a file is found). The <code>krb5.conf</code> file is still consulted if values for items
-     * other than the default realm and KDC are needed. If no <code>krb5.conf</code> file is found,
+     * in {@code krb5.conf} (if such a file is found). The {@code krb5.conf} file is still consulted if values for items
+     * other than the default realm and KDC are needed. If no {@code krb5.conf} file is found,
      * then the default values used for these items are implementation-specific.
      * @param kerberosKdcSystemProperty system property to indicate kdc
      * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/jgss/tutorials/KerberosReq.html">

cas-server-core-authentication/src/main/java/org/jasig/cas/web/flow/AuthenticationExceptionHandler.java

@@ -108,7 +108,7 @@ public void setMessageBundlePrefix(final String prefix) {
      * @return Name of next flow state to transition to or {@value #UNKNOWN}
      * {@link org.jasig.cas.authentication.AuthenticationException#getHandlerErrors()} with highest precedence.
      * Also sets an ERROR severity message in the message context of the form
-     * <code>[messageBundlePrefix][exceptionClassSimpleName]</code> for each handler error that is
+     * {@code [messageBundlePrefix][exceptionClassSimpleName]} for each handler error that is
      * configured. If not match is found, {@value #UNKNOWN} is returned.
      */
     public String handle(final AuthenticationException e, final MessageContext messageContext) {

cas-server-core-authentication/src/test/java/org/jasig/cas/authentication/FileTrustStoreSslSocketFactoryTests.java

@@ -28,7 +28,7 @@
 import static org.junit.Assert.*;
 
 /**
- * Tests for the <code>FileTrustStoreSslSocketFactory</code> class, checking for self-signed
+ * Tests for the {@code FileTrustStoreSslSocketFactory} class, checking for self-signed
  * and missing certificates via a local truststore.
  * @author Misagh Moayyed
  * @since 4.1.0

cas-server-core-events/src/main/java/org/jasig/cas/support/events/AbstractCasEvent.java

@@ -24,11 +24,9 @@
 
 /**
  * Base Spring {@code ApplicationEvent} representing a abstract single sign on action executed within running CAS server.
- * <p/>
  * This event encapsulates {@link org.jasig.cas.authentication.Authentication} that is associated with an SSO action
  * executed in a CAS server and an SSO session
  * token in the form of ticket granting ticket id.
- * <p/>
  * More concrete events are expected to subclass this abstract type.
  *
  * @author Dmitriy Kopylenko

cas-server-core-events/src/main/java/org/jasig/cas/support/events/CasServiceTicketValidatedEvent.java

@@ -23,7 +23,7 @@
 import org.jasig.cas.validation.Assertion;
 
 /**
- * Concrete subclass of <code>AbstractCasEvent</code> representing validation of a
+ * Concrete subclass of {@code AbstractCasEvent} representing validation of a
  * service ticket by a CAS server.
  * @author Dmitriy Kopylenko
  * @since 4.2

cas-server-core-logging/src/main/java/org/jasig/cas/util/CasLoggerContextInitializer.java

@@ -165,7 +165,7 @@ private ServletContextListener prepareAndgetContextListener() {
      * may be initialized twice, there are safety checks
      * added to ensure we don't create duplicate log
      * environments.</p>
-     * @param servletContext
+     * @param servletContext the servlet context
      */
     @Override
     public void setServletContext(final ServletContext servletContext) {

cas-server-core-logging/src/main/java/org/slf4j/impl/CasLoggerFactory.java

@@ -50,7 +50,7 @@ public final class CasLoggerFactory implements ILoggerFactory {
     private final Class<? extends ILoggerFactory> realLoggerFactoryClass;
     /**
      * Instantiates a new Cas logger factory.
-     * Configures the reflection scanning engine to be prepared to scan <code>org.slf4j.impl</code>
+     * Configures the reflection scanning engine to be prepared to scan {@code org.slf4j.impl}
      * in order to find other available factories.
      */
     public CasLoggerFactory() {
@@ -82,7 +82,7 @@ public CasLoggerFactory() {
 
     /**
      * {@inheritDoc}
-     * <p>Attempts to find the <strong>real</strong> <code>Logger</code> instance that
+     * <p>Attempts to find the <strong>real</strong> {@code Logger} instance that
      * is doing the heavy lifting and routes the request to an instance of
      * {@link CasDelegatingLogger}. The instance is cached by the logger name.</p>
      */
@@ -101,7 +101,7 @@ public Logger getLogger(final String name) {
     }
 
     /**
-     * Find the actual <code>Logger</code> instance that is available on the classpath.
+     * Find the actual {@code Logger} instance that is available on the classpath.
      * This is usually the logger adapter that is provided by the real logging framework,
      * such as log4j, etc. The method will scan the runtime to find logger factories that
      * are of type {@link org.slf4j.ILoggerFactory}. It will remove itself from this list

cas-server-core-logging/src/main/java/org/slf4j/impl/StaticLoggerBinder.java

@@ -24,7 +24,7 @@
 /**
  * The static binder for slf4j logging, which allows CAS
  * to select its own {@link org.slf4j.ILoggerFactory} instance at runtime.
- * Note that this class MUST reside in the <code>org.slf4j.impl</code>
+ * Note that this class MUST reside in the {@code org.slf4j.impl}
  * package so it can be loaded by the runtime dynamic lookup.
  * @author Misagh Moayyed
  * @since 4.1.0

cas-server-core-logout/src/main/java/org/jasig/cas/logout/LogoutManagerImpl.java

@@ -284,7 +284,7 @@ private final class LogoutHttpMessage extends HttpMessage {
 
         /**
          * {@inheritDoc}.
-         * Prepends the string "<code>logoutRequest=</code>" to the message body.
+         * Prepends the string "{@code logoutRequest=}" to the message body.
          */
         @Override
         protected String formatOutputMessageInternal(final String message) {

cas-server-core-logout/src/main/java/org/jasig/cas/logout/SamlCompliantLogoutMessageCreator.java

@@ -26,7 +26,7 @@
 import org.springframework.stereotype.Component;
 
 /**
- * A builder that uses the saml standard's <code>LogoutRequest</code> template in order
+ * A builder that uses the saml standard's {@code LogoutRequest} template in order
  * to build the logout request.
  * @author Misagh Moayyed
  * @see DefaultLogoutRequest

cas-server-core-services/src/main/java/org/jasig/cas/authentication/principal/AbstractWebApplicationService.java

@@ -94,7 +94,7 @@ public final Map<String, Object> getAttributes() {
     }
 
     /**
-     * Return the original url provided (as <code>service</code> or <code>targetService</code> request parameter).
+     * Return the original url provided (as {@code service} or {@code targetService} request parameter).
      * Used to reconstruct the redirect url.
      *
      * @return the original url provided.

cas-server-core-services/src/main/java/org/jasig/cas/services/AbstractRegisteredService.java

@@ -360,7 +360,7 @@ public void copyFrom(final RegisteredService source) {
 
     /**
      * {@inheritDoc}
-     * Compares this instance with the <code>other</code> registered service based on
+     * Compares this instance with the {@code other} registered service based on
      * evaluation order, name. The name comparison is case insensitive.
      *
      * @see #getEvaluationOrder()

cas-server-core-services/src/main/java/org/jasig/cas/services/JsonServiceRegistryDao.java

@@ -48,7 +48,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- * Implementation of <code>ServiceRegistryDao</code> that reads services definition from JSON
+ * Implementation of {@code ServiceRegistryDao} that reads services definition from JSON
  * configuration file at the Spring Application Context initialization time. JSON files are
  * expected to be found inside a directory location and this DAO will recursively look through
  * the directory structure to find relevant JSON files. Files are expected to have the
@@ -272,7 +272,7 @@ Path getServiceRegistryDirectory() {
 
     /**
      * Creates a JSON file for a registered service.
-     * The file is named as <code>[SERVICE-NAME]-[SERVICE-ID]-.{@value #FILE_EXTENSION}</code>
+     * The file is named as {@code [SERVICE-NAME]-[SERVICE-ID]-.{@value #FILE_EXTENSION}}
      *
      * @param service Registered service.
      * @return JSON file in service registry directory.

cas-server-core-services/src/main/java/org/jasig/cas/services/UnauthorizedProxyingException.java

@@ -29,7 +29,7 @@ public class UnauthorizedProxyingException extends UnauthorizedServiceException
     public static final String CODE = "UNAUTHORIZED_SERVICE_PROXY";
 
     /**
-     * Comment for <code>serialVersionUID</code>.
+     * Comment for {@code serialVersionUID}.
      */
     private static final long serialVersionUID = -7307803750894078575L;
 

cas-server-core-services/src/main/java/org/jasig/cas/services/UnauthorizedSsoServiceException.java

@@ -30,7 +30,7 @@ public class UnauthorizedSsoServiceException extends
     UnauthorizedServiceException {
 
     /**
-     * Comment for <code>serialVersionUID</code>.
+     * Comment for {@code serialVersionUID}.
      */
     private static final long serialVersionUID = 8909291297815558561L;
 

cas-server-core-services/src/main/java/org/jasig/cas/services/support/RegisteredServiceRegexAttributeFilter.java

@@ -81,12 +81,12 @@ public Pattern getPattern() {
      * <ul>
      * <li>The filtering operation is non-recursive. </li>
      * <li>Multi-valued attributes such as those of type {@link Collection} and
-     * {@link Map} are expected to allow casting to <code>Map&lt;String, String&gt;</code>
-     * or <code>Collection&lt;String&gt;</code>.
-     * Values that are of type array are expected to allow casting to <code>String[]</code>.
+     * {@link Map} are expected to allow casting to {@code Map&lt;String, String&gt;}
+     * or {@code Collection&lt;String&gt;}.
+     * Values that are of type array are expected to allow casting to {@code String[]}.
      * </li>
      * <li>Multi-valued attributes are always put back into the final released collection of
-     * attributes as <code>String[]</code>.</li>
+     * attributes as {@code String[]}.</li>
      * <li>If the final filtered collection is empty, it will not be put into the collection of attributes.</li>
      * </ul>
      */

cas-server-core-services/src/test/java/org/jasig/cas/services/DefaultServicesManagerImplTests.java

@@ -217,7 +217,7 @@ public void verifyEvaluationOrderOfServices() {
     private static class SimpleService implements Service {
 
         /**
-         * Comment for <code>serialVersionUID</code>.
+         * Comment for {@code serialVersionUID}.
          */
         private static final long serialVersionUID = 6572142033945243669L;
 

cas-server-core-tickets/src/main/java/org/jasig/cas/util/HostNameBasedUniqueTicketIdGenerator.java

@@ -26,15 +26,15 @@
  * the suffix based on the underlying host name.
  *
  * <p>In order to assist with multi-node deployments, in scenarios where CAS configuration
- * and specially <code>cas.properties</code> file is externalized, it would be ideal to simply just have one set
- * of configuration files for all nodes, such that there would for instance be one <code>cas.properties</code> file
+ * and specially {@code cas.properties} file is externalized, it would be ideal to simply just have one set
+ * of configuration files for all nodes, such that there would for instance be one {@code cas.properties} file
  * for all nodes. This would remove the need to copy/sync config files over across nodes, again in a
  * situation where they are externalized.
- * <p>The drawback is that in keeping only one <code>cas.properties</code> file, we'd lose the ability
- * to define unique <code>host.name</code> property values for each node as the suffix, which would assist with troubleshooting
- * and diagnostics. To provide a remedy, this ticket generator is able to retrieve the <code>host.name</code> value directly from
+ * <p>The drawback is that in keeping only one {@code cas.properties} file, we'd lose the ability
+ * to define unique {@code host.name} property values for each node as the suffix, which would assist with troubleshooting
+ * and diagnostics. To provide a remedy, this ticket generator is able to retrieve the {@code host.name} value directly from
  * the actual node name, rather than relying on the configuration, only if one isn't specified in
- * the <code>cas.properties</code> file. </p>
+ * the {@code cas.properties} file. </p>
  * @author Misagh Moayyed
  * @since 4.1.0
  */
@@ -53,10 +53,10 @@ public HostNameBasedUniqueTicketIdGenerator(final int maxLength) {
      * so as to moderately provide a relevant unique value mapped to
      * the host name AND not auto-leak infrastructure data out into the configuration and logs.
      * <ul>
-     * <li>If the CAS node name is <code>cas-01.sso.edu</code> then, the suffix
-     * determined would just be <code>cas-01</code></li>
-     * <li>If the CAS node name is <code>cas-01</code> then, the suffix
-     * determined would just be <code>cas-01</code></li>
+     * <li>If the CAS node name is {@code cas-01.sso.edu} then, the suffix
+     * determined would just be {@code cas-01}</li>
+     * <li>If the CAS node name is {@code cas-01} then, the suffix
+     * determined would just be {@code cas-01}</li>
      * </ul>
      * @return the shortened ticket suffix based on the hostname
      * @since 4.1.0

cas-server-core-util/src/main/java/org/jasig/cas/util/CompressionUtils.java

@@ -60,7 +60,7 @@ private CompressionUtils() {
      * Inflate the given byte array by {@link #INFLATED_ARRAY_LENGTH}.
      *
      * @param bytes the bytes
-     * @return the array as a string with <code>UTF-8</code> encoding
+     * @return the array as a string with {@code UTF-8} encoding
      */
     public static String inflate(final byte[] bytes) {
         final Inflater inflater = new Inflater(true);
@@ -156,7 +156,7 @@ public static byte[] encodeBase64ToByteArray(final byte[] data) {
 
     /**
      * Base64 decode operation, which retrieves the equivalent
-     * byte[] of the data in <code>UTF-8</code> encoding
+     * byte[] of the data in {@code UTF-8} encoding
      * and decodes the result.
      *
      * @param data the data to encode

cas-server-core-util/src/main/java/org/jasig/cas/util/ShiroCipherExecutor.java

@@ -39,7 +39,7 @@
 public class ShiroCipherExecutor extends AbstractCipherExecutor<byte[], byte[]> {
     private static final String UTF8_ENCODING = "UTF-8";
 
-    /** Secret key IV algorithm. Default is <code>AES</code>. */
+    /** Secret key IV algorithm. Default is {@code AES}. */
     private String secretKeyAlgorithm = "AES";
 
     private final String encryptionSecretKey;