Various fixes to the site build

apache · Apr 8, 2018 · a03cf45 · a03cf45
1 parent 7bed274
commit a03cf45
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 46 deletions.
diff --git a/log4j-jdbc-dbcp2/pom.xml b/log4j-jdbc-dbcp2/pom.xml
@@ -19,7 +19,7 @@
   <artifactId>log4j-jdbc-dbcp2</artifactId>
   <name>Apache Log4j JDBC DBCP 2</name>
   <description>
-    Connection source for the JDBC Appender using on Apache Commons DBCP 2.
+    Connection source for the JDBC Appender using Apache Commons DBCP2.
   </description>
   <properties>
     <log4jParentDir>${basedir}/..</log4jParentDir>

diff --git a/log4j-jms/src/main/java/org/apache/logging/log4j/jms/appender/JmsAppender.java b/log4j-jms/src/main/java/org/apache/logging/log4j/jms/appender/JmsAppender.java
@@ -49,7 +49,7 @@ public class JmsAppender extends AbstractAppender {
 
     public static class Builder implements org.apache.logging.log4j.core.util.Builder<JmsAppender> {
 
-        public static final int DEFAULT_RECONNECT_INTERVAL_MILLIS = 5000;
+        private static final int DEFAULT_RECONNECT_INTERVAL_MILLIS = 5000;
 
         @PluginBuilderAttribute
         @Required(message = "A name for the JmsAppender must be specified")
@@ -184,7 +184,10 @@ public Builder setPassword(final char[] password) {
         }
 
         /**
+         * Sets the Password.
+         * @param password The new password.
          * @deprecated Use setPassword(char[])
+         * @return the Builder.
          */
         @Deprecated
         public Builder setPassword(final String password) {
@@ -218,7 +221,10 @@ public Builder setUrlPkgPrefixes(final String urlPkgPrefixes) {
         }
 
         /**
+         * Sets the user name.
+         * @param username The user's name.
          * @deprecated Use {@link #setUserName(String)}.
+         * @return the Builder.
          */
         @Deprecated
         public Builder setUsername(final String username) {
@@ -254,9 +260,13 @@ public static Builder newBuilder() {
     private volatile JmsManager manager;
 
     /**
-     *
+     * @param name The Appender's name.
+     * @param filter The filter to attach to the Appender, if any.
+     * @param layout The layout to use to render the event.
+     * @param ignoreExceptions true if exceptions should be ignore, false otherwise.
+     * @param manager The JMSManager.
      * @throws JMSException
-     *             not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0
+     *             not thrown as of 2.9 but retained in the signature for compatibility, will be removed in 3.0.
      */
     protected JmsAppender(final String name, final Filter filter, final Layout<? extends Serializable> layout,
             final boolean ignoreExceptions, final JmsManager manager) throws JMSException {

diff --git a/log4j-jms/src/main/java/org/apache/logging/log4j/jms/appender/JmsManager.java b/log4j-jms/src/main/java/org/apache/logging/log4j/jms/appender/JmsManager.java
@@ -206,23 +206,14 @@ public void shutdown() {
     /**
      * Gets a JmsManager using the specified configuration parameters.
      *
-     * @param name
-     *            The name to use for this JmsManager.
-     * @param connectionFactoryName
-     *            The binding name for the {@link javax.jms.ConnectionFactory}.
-     * @param destinationName
-     *            The binding name for the {@link javax.jms.Destination}.
-     * @param userName
-     *            The userName to connect with or {@code null} for no authentication.
-     * @param password
-     *            The password to use with the given userName or {@code null} for no authentication.
-     * @param immediateFail
-     *            Whether or not to fail immediately with a {@link AppenderLoggingException} when connecting to JMS
-     *            fails.
-     * @param reconnectIntervalMillis
-     *            How to log sleep in milliseconds before trying to reconnect to JMS.
-     * @param jndiManager
-     *            The JndiManager to look up JMS information through.
+     * @param name The name to use for this JmsManager.
+     * @param connectionFactoryName The binding name for the {@link javax.jms.ConnectionFactory}.
+     * @param destinationName The binding name for the {@link javax.jms.Destination}.
+     * @param userName The userName to connect with or {@code null} for no authentication.
+     * @param password The password to use with the given userName or {@code null} for no authentication.
+     * @param immediateFail Whether or not to fail immediately with a {@link AppenderLoggingException} when
+     *                      connecting to JMS fails.
+     * @param reconnectIntervalMillis How to log sleep in milliseconds before trying to reconnect to JMS.
      * @return The JmsManager as configured.
      */
     public static JmsManager getJmsManager(final String name, final Properties jndiProperties,
@@ -352,7 +343,7 @@ private Destination createDestination(final JndiManager jndiManager) throws Nami
      * @param object
      *            The LogEvent or String message to wrap.
      * @return A new JMS message containing the provided object.
-     * @throws JMSException
+     * @throws JMSException if an error occurs.
      */
     public Message createMessage(final Serializable object) throws JMSException {
         if (object instanceof String) {
@@ -373,7 +364,7 @@ private void createMessageAndSend(final LogEvent event, final Serializable seria
      * Creates a MessageConsumer on this Destination using the current Session.
      *
      * @return A MessageConsumer on this Destination.
-     * @throws JMSException
+     * @throws JMSException if an error occurs.
      */
     public MessageConsumer createMessageConsumer() throws JMSException {
         return this.session.createConsumer(this.destination);
@@ -387,7 +378,7 @@ public MessageConsumer createMessageConsumer() throws JMSException {
      * @param destination
      *            The JMS Destination for the MessageProducer
      * @return A MessageProducer on this Destination.
-     * @throws JMSException
+     * @throws JMSException if an error occurs.
      */
     public MessageProducer createMessageProducer(final Session session, final Destination destination)
             throws JMSException {

diff --git a/log4j-layout-jackson-json/pom.xml b/log4j-layout-jackson-json/pom.xml
@@ -124,15 +124,14 @@
         </reportSets>
       </plugin>
       <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>findbugs-maven-plugin</artifactId>
-        <version>${findbugs.plugin.version}</version>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
         <configuration>
           <fork>true</fork>
           <jvmArgs>-Duser.language=en</jvmArgs>
           <threshold>Normal</threshold>
           <effort>Default</effort>
-          <excludeFilterFile>${log4jParentDir}/findbugs-exclude-filter.xml</excludeFilterFile>
+          <excludeFilterFile>${log4jParentDir}/spotbugs-exclude-filter.xml</excludeFilterFile>
         </configuration>
       </plugin>
       <plugin>

diff --git a/log4j-layout-jackson-xml/pom.xml b/log4j-layout-jackson-xml/pom.xml
@@ -128,15 +128,14 @@
         </reportSets>
       </plugin>
       <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>findbugs-maven-plugin</artifactId>
-        <version>${findbugs.plugin.version}</version>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
         <configuration>
           <fork>true</fork>
           <jvmArgs>-Duser.language=en</jvmArgs>
           <threshold>Normal</threshold>
           <effort>Default</effort>
-          <excludeFilterFile>${log4jParentDir}/findbugs-exclude-filter.xml</excludeFilterFile>
+          <excludeFilterFile>${log4jParentDir}/spotbugs-exclude-filter.xml</excludeFilterFile>
         </configuration>
       </plugin>
       <plugin>

diff --git a/log4j-layout-jackson-yaml/pom.xml b/log4j-layout-jackson-yaml/pom.xml
@@ -128,15 +128,14 @@
         </reportSets>
       </plugin>
       <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>findbugs-maven-plugin</artifactId>
-        <version>${findbugs.plugin.version}</version>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
         <configuration>
           <fork>true</fork>
           <jvmArgs>-Duser.language=en</jvmArgs>
           <threshold>Normal</threshold>
           <effort>Default</effort>
-          <excludeFilterFile>${log4jParentDir}/findbugs-exclude-filter.xml</excludeFilterFile>
+          <excludeFilterFile>${log4jParentDir}/spotbugs-exclude-filter.xml</excludeFilterFile>
         </configuration>
       </plugin>
       <plugin>

diff --git a/log4j-layout-jackson/pom.xml b/log4j-layout-jackson/pom.xml
@@ -171,15 +171,14 @@
         </reportSets>
       </plugin>
       <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>findbugs-maven-plugin</artifactId>
-        <version>${findbugs.plugin.version}</version>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
         <configuration>
           <fork>true</fork>
           <jvmArgs>-Duser.language=en</jvmArgs>
           <threshold>Normal</threshold>
           <effort>Default</effort>
-          <excludeFilterFile>${log4jParentDir}/findbugs-exclude-filter.xml</excludeFilterFile>
+          <excludeFilterFile>${log4jParentDir}/spotbugs-exclude-filter.xml</excludeFilterFile>
         </configuration>
       </plugin>
       <plugin>

diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
@@ -34,8 +34,9 @@ dt { margin: 15px 0 5px 0; font-size: 1.2em }
 
 .sidebar-nav { padding: 9px 0; }
 
-.logo-left { margin: 10px; float: left }
-.logo-right { margin: 5px; float: right; height: 100px }
+.logo-left { margin: 10px; float: left; height: 100px}
+.logo-center {margin-left: auto; margin-right: auto; display: block; width: 20%}
+.logo-right { margin: 5px; float: right; height: 100px}
 
 .navbar .nav { margin-left: 40px; }
 

diff --git a/src/site/site.vm b/src/site/site.vm
@@ -473,10 +473,14 @@
 		#googleAnalytics( $decoration.googleAnalyticsAccountId )
 	</head>
 	<body class="composite">
-		<a href="https://logging.apache.org/">
-			<img class="logo-left" src="$relativePath/images/ls-logo.jpg" alt="Apache logging services logo" />
-		</a>
-		<img class="logo-right" src="$relativePath/images/logo.png" alt="Apache log4j logo" />
+        <a  href="http://www.apache.org/events/current-event.html">
+          <img class=logo-left src="http://www.apache.org/events/current-event-234x60.png"/>
+        </a>
+        <img class="logo-right" src="$relativePath/images/logo.png" alt="Apache log4j logo" />
+        <a href="https://logging.apache.org/">
+          <img class="logo-center" src="$relativePath/images/ls-logo.jpg" alt="Apache logging services logo" />
+        </a>
+
 		<div class="clear"></div>
 
 		<div class="navbar">