Initial version

Author: SimonTaylor

.gitignore

@@ -0,0 +1,39 @@
+*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# Eclipse
+.classpath
+.project
+.settings/
+
+# Intellij
+.idea/
+*.iml
+*.iws
+
+# Mac
+.DS_Store
+
+# Maven
+log/
+target/
+
+# General
+disabled
+
+# Jenkins
+Jenkins/*/builds
+Jenkins/*/lastStable
+Jenkins/*/lastSuccessful
+Jenkins/*/nextBuildNumber
+Jenkins/*/scm-polling.log

.travis.yml

@@ -0,0 +1,21 @@
+language: java
+
+jdk:
+  - openjdk15
+
+script:
+  - mvn test -B
+
+before_deploy:
+  - POM_VERSION=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)
+
+# Releases config copied from https://docs.travis-ci.com/user/deployment/releases/ and secure key generated by following
+# https://stackoverflow.com/questions/25302518/travis-ci-setup-releases-with-github-token#answer-57032190
+deploy:
+  provider: releases
+  api_key:
+    secure: laB7B7A4PPm3XWTAdmp+2jaQXA1tyzC8LRZjKAcz7AuIfMlVVvp1O42/mnkewtlLQemyzqTJWImvZ7D+KrAQLdmgmDZjq0hZQy9an0woKBe+loMtqmGToRi+UpGJKv0Kzq4DpBBIRreqokxW5yNId9Q25QI8gEuI5irM0w/rehV12NnyHE+w08UbXS8WO6HfE0KmOR5ncKL7gR7NVOees3nCYCsw3nI8Y0DwjkFMdpqH5rqnGk+qW4P+3U58xvUTrna3NKJ9lLo6lPOnwAGS5E8u8UtZ2Xx0tgsXSBRdbPimZpkTB+nrSyORwpNPjntkfFZH6+vLPN0xLf7/bUB2bGEpVxEbCBTV0CeQCrxh04esj0tN1ANCObISA8ZFH4020xh+OYR93JVAcJMJLHIT73bVKXh5Sv8Q0v99VJP6hmZHQFtL/l68Pmf8wTYH9E/2Akxi9ytSYojZTZh4zkiXTS7dPRfoxkvGSTy8S77nS6mtZHQm0UyKS+o6dq0VHqpWkoY8NijrPCg/a+qXDpCF532eBYDLxZQIFEdVFmF+kg4fpx63oL/03JkU9P3zptVhWbk4qkuad8HuVIC5p9R04f89KHT5wUNabWBhFP/6O0M6X48ukI359jwYbbNz8WYg5HkBZwvGlzVgzLJ9OFESRaDZ83mf5+uDz7LWcBT52GM=
+  file: "target/spt-development-logging-spring-${POM_VERSION}.jar"
+  skip_cleanup: true
+  on:
+    tags: true

README.md

@@ -1,2 +1,58 @@
-# spt-development-logging-spring
-Library for adding logging to public @RestController, @Service and @Repository class methods and @JmsListener methods.
+````
+  ____  ____ _____   ____                 _                                  _   
+ / ___||  _ \_   _| |  _ \  _____   _____| | ___  _ __  _ __ ___   ___ _ __ | |_ 
+ \___ \| |_) || |   | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __|
+  ___) |  __/ | |   | |_| |  __/\ V /  __/ | (_) | |_) | | | | | |  __/ | | | |_ 
+ |____/|_|    |_|   |____/ \___| \_/ \___|_|\___/| .__/|_| |_| |_|\___|_| |_|\__|
+                                                 |_|                                           
+ logging-spring -----------------------------------------------------------------
+````
+
+[![build_status](https://travis-ci.com/spt-development/spt-development-logging-spring.svg?branch=main)](https://travis-ci.com/spt-development/spt-development-logging-spring)
+
+A library for adding logging (at the start, end and on exception) to public methods of classes annotated with 
+`@RestController`, `@Service` or `@Repository` or methods annotated with `@JmsListener`.
+
+Usage
+=====
+
+Register the Aspects as Spring Beans manually or by adding the
+[spt-development/spt-development-logging-spring-boot](https://github.com/spt-development/spt-development-logging-spring-boot)
+starter to your project's pom.
+
+    @Bean
+    public RestControllerLogger restControllerLogger() {
+        return new RestControllerLogger();
+    }
+
+    @Bean
+    public JmsListenerLogger jmsListenerLogger() {
+        return new JmsListenerLogger();
+    }
+
+    @Bean
+    public ServiceLogger serviceLogger() {
+        return new ServiceLogger();
+    }
+
+    @Bean
+    public RepositoryLogger repositoryLogger() {
+        return new RepositoryLogger();
+    }
+
+Building locally
+================
+
+To build the library, run the following maven command:
+
+    $ mvn clean install
+
+Release
+=======
+
+To build a release and upload to Maven Central run the following maven command:
+
+    $ export GPG_TTY=$(tty) # Required on Mac OS X
+    $ mvn deploy -DskipTests -Prelease
+
+NOTE. This is currently a manual step as not currently integrated into the build.

findbugs-exclude.xml

@@ -0,0 +1,24 @@
+<FindBugsFilter>
+    <!-- Should be resolved by client applications replacing \r\n in log message config -->
+    <Match>
+        <Bug pattern="CRLF_INJECTION_LOGS" />
+    </Match>
+
+    <!-- Classes used to log the name of the method being called and its arguments -->
+    <Match>
+        <Class name="com.spt.development.logging.spring.JmsListenerLogger" />
+        <Bug pattern="SLF4J_SIGN_ONLY_FORMAT" />
+    </Match>
+    <Match>
+        <Class name="com.spt.development.logging.spring.RepositoryLogger" />
+        <Bug pattern="SLF4J_SIGN_ONLY_FORMAT" />
+    </Match>
+    <Match>
+        <Class name="com.spt.development.logging.spring.RestControllerLogger" />
+        <Bug pattern="SLF4J_SIGN_ONLY_FORMAT" />
+    </Match>
+    <Match>
+        <Class name="com.spt.development.logging.spring.ServiceLogger" />
+        <Bug pattern="SLF4J_SIGN_ONLY_FORMAT" />
+    </Match>
+</FindBugsFilter>

maven-version-rules.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset xmlns="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" comparisonMethod="maven" xsi:schemaLocation="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0 http://mojo.codehaus.org/versions-maven-plugin/xsd/rule-2.0.0.xsd">
+    <ignoreVersions>
+        <!-- Ignore Alpha’s, Beta’s, release candidates and milestones -->
+        <ignoreVersion type="regex">(?i).*Alpha(?:-?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*Beta(?:-?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*-B(?:-?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*RC(?:[-\.]?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*CR(?:-?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*M(?:-?\d+)?</ignoreVersion>
+        <ignoreVersion type="regex">(?i).*pr(?:-?\d+)?</ignoreVersion>
+    </ignoreVersions>
+
+    <rules>
+    </rules>
+</ruleset>