summaryrefslogtreecommitdiffstats
path: root/reference/logging-filter/README.md
blob: c861a54e4ba5e6b97d5c86cbb4f3a2b37d2f13fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Logging-Filter

The base project is meant to have very minimal dependencies for maximum re-use. The spring artifact is provided for any clients already using spring.

## Current Layout
- logging-filter (houses the parent pom)
  - **base** this artifact should only depend on javax.servlet-api, javax.ws.rs-api, slf4j-api and org.onap.logging-analytics:logging-slf4j
  - **spring** this artifact depends on base as well as spring.

## Design Principles
- minimize dependencies for maximum re-use
- code to APIs jaxrs vs jersey, slf4j vs logback, etc...
- no application specific code in this library
- write extensible code so applications can add on application specific code
- target Casablanca logging spec

## Code Formatting
ONAP code formatting standards are validated on builds. If you find a build failing due to a formatting issue, format your code by running `mvn process-sources -P format`