Skip to content

Commit 120d7bb

Browse files
jeremiahjstaceyjeremiahjstacey
committed
Renaming Files
Renamed SLF4JLogHander (and subclasses) to be SLF4JLogLevelHandler* Updated uses to match altered class names.
1 parent 2cb045a commit 120d7bb

6 files changed

Lines changed: 36 additions & 36 deletions

File tree

‎src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogBridgeImpl.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public class Slf4JLogBridgeImpl implements Slf4JLogBridge {
3333
//BasicMarkerFactory uses ConcurrentHashMap to track data. This *should be* thread safe.
3434
private static final IMarkerFactory MARKER_FACTORY = new BasicMarkerFactory();
3535
/** Configuration providing associations between esapi log levels and SLF4J levels.*/
36-
private final Map<Integer,Slf4JLogHandler> esapiSlfLevelMap;
36+
private final Map<Integer,Slf4JLogLevelHandler> esapiSlfLevelMap;
3737
/** Cleaner used for log content.*/
3838
private final LogScrubber scrubber;
3939

@@ -42,14 +42,14 @@ public class Slf4JLogBridgeImpl implements Slf4JLogBridge {
4242
* @param logScrubber Log message cleaner.
4343
* @param esapiSlfHandlerMap Map identifying ESAPI -> SLF4J log level associations.
4444
*/
45-
public Slf4JLogBridgeImpl(LogScrubber logScrubber, Map<Integer, Slf4JLogHandler> esapiSlfHandlerMap) {
45+
public Slf4JLogBridgeImpl(LogScrubber logScrubber, Map<Integer, Slf4JLogLevelHandler> esapiSlfHandlerMap) {
4646
//Defensive copy to prevent external mutations.
4747
this.esapiSlfLevelMap = new HashMap<>(esapiSlfHandlerMap);
4848
this.scrubber = logScrubber;
4949
}
5050
@Override
5151
public void log(Logger logger, int esapiLevel, EventType type, String message) {
52-
Slf4JLogHandler handler = esapiSlfLevelMap.get(esapiLevel);
52+
Slf4JLogLevelHandler handler = esapiSlfLevelMap.get(esapiLevel);
5353
if (handler == null) {
5454
throw new IllegalArgumentException("Unable to lookup SLF4J level mapping for esapi value of " + esapiLevel);
5555
}
@@ -61,7 +61,7 @@ public void log(Logger logger, int esapiLevel, EventType type, String message) {
6161
}
6262
@Override
6363
public void log(Logger logger, int esapiLevel, EventType type, String message, Throwable throwable) {
64-
Slf4JLogHandler handler = esapiSlfLevelMap.get(esapiLevel);
64+
Slf4JLogLevelHandler handler = esapiSlfLevelMap.get(esapiLevel);
6565
if (handler == null) {
6666
throw new IllegalArgumentException("Unable to lookup SLF4J level mapping for esapi value of " + esapiLevel);
6767
}

‎src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogFactory.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ public class Slf4JLogFactory implements LogFactory {
5353
boolean encodeLog = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_ENCODING_REQUIRED);
5454
SLF4J_LOG_SCRUBBER = createLogScrubber(encodeLog);
5555

56-
Map<Integer, Slf4JLogHandler> levelLookup = new HashMap<>();
57-
levelLookup.put(Logger.ALL, Slf4JLogHandlers.TRACE);
58-
levelLookup.put(Logger.TRACE, Slf4JLogHandlers.TRACE);
59-
levelLookup.put(Logger.DEBUG, Slf4JLogHandlers.DEBUG);
60-
levelLookup.put(Logger.INFO, Slf4JLogHandlers.INFO);
61-
levelLookup.put(Logger.ERROR, Slf4JLogHandlers.ERROR);
62-
levelLookup.put(Logger.WARNING, Slf4JLogHandlers.WARN);
63-
levelLookup.put(Logger.FATAL, Slf4JLogHandlers.ERROR);
56+
Map<Integer, Slf4JLogLevelHandler> levelLookup = new HashMap<>();
57+
levelLookup.put(Logger.ALL, Slf4JLogLevelHandlers.TRACE);
58+
levelLookup.put(Logger.TRACE, Slf4JLogLevelHandlers.TRACE);
59+
levelLookup.put(Logger.DEBUG, Slf4JLogLevelHandlers.DEBUG);
60+
levelLookup.put(Logger.INFO, Slf4JLogLevelHandlers.INFO);
61+
levelLookup.put(Logger.ERROR, Slf4JLogLevelHandlers.ERROR);
62+
levelLookup.put(Logger.WARNING, Slf4JLogLevelHandlers.WARN);
63+
levelLookup.put(Logger.FATAL, Slf4JLogLevelHandlers.ERROR);
6464
//LEVEL.OFF not used. If it's off why would we try to log it?
6565

6666
LOG_BRIDGE = new Slf4JLogBridgeImpl(SLF4J_LOG_SCRUBBER, levelLookup);

src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogHandler.java renamed to src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogLevelHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
/**
2020
* Contract used to isolate translations for each SLF4J Logging Level.
2121
*
22-
* @see Slf4JLogHandlers
22+
* @see Slf4JLogLevelHandlers
2323
* @see Slf4JLogBridgeImpl
2424
*
2525
*/
26-
interface Slf4JLogHandler {
26+
interface Slf4JLogLevelHandler {
2727
/** Check if the logging level is enabled for the specified logger.*/
2828
boolean isEnabled(Logger logger);
2929
/**

src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogHandlers.java renamed to src/main/java/org/owasp/esapi/logging/slf4j/Slf4JLogLevelHandlers.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* Enumeration capturing the propagation of SLF4J level events.
2222
*
2323
*/
24-
public enum Slf4JLogHandlers implements Slf4JLogHandler {
24+
public enum Slf4JLogLevelHandlers implements Slf4JLogLevelHandler {
2525
ERROR {
2626
@Override
2727
public boolean isEnabled(Logger logger) {

‎src/test/java/org/owasp/esapi/logging/slf4j/Slf4JLogBridgeImplTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ public class Slf4JLogBridgeImplTest {
3939
public ExpectedException exEx = ExpectedException.none();
4040

4141
private LogScrubber mockScrubber = Mockito.mock(LogScrubber.class);
42-
private Slf4JLogHandler mockHandler = Mockito.mock(Slf4JLogHandler.class);
42+
private Slf4JLogLevelHandler mockHandler = Mockito.mock(Slf4JLogLevelHandler.class);
4343
private org.slf4j.Logger mockSlf4JLogger = Mockito.mock(org.slf4j.Logger.class);
4444
private Throwable testEx = new Throwable(testName.getMethodName());
4545
private Slf4JLogBridge bridge;
4646

4747
@Before
4848
public void setup() {
49-
Map<Integer, Slf4JLogHandler> levelLookup = new HashMap<>();
49+
Map<Integer, Slf4JLogLevelHandler> levelLookup = new HashMap<>();
5050
levelLookup.put(Logger.ALL, mockHandler);
5151

5252
bridge = new Slf4JLogBridgeImpl(mockScrubber, levelLookup);
@@ -56,15 +56,15 @@ public void setup() {
5656
public void testLogMessageWithUnmappedEsapiLevelThrowsException() {
5757
exEx.expect(IllegalArgumentException.class);
5858
exEx.expectMessage("Unable to lookup SLF4J level mapping");
59-
Map<Integer, Slf4JLogHandler> emptyMap = Collections.emptyMap();
59+
Map<Integer, Slf4JLogLevelHandler> emptyMap = Collections.emptyMap();
6060
new Slf4JLogBridgeImpl(mockScrubber, emptyMap).log(mockSlf4JLogger, 0, Logger.EVENT_UNSPECIFIED, "This Should fail");
6161
}
6262

6363
@Test
6464
public void testLogMessageAndExceptionWithUnmappedEsapiLevelThrowsException() {
6565
exEx.expect(IllegalArgumentException.class);
6666
exEx.expectMessage("Unable to lookup SLF4J level mapping");
67-
Map<Integer, Slf4JLogHandler> emptyMap = Collections.emptyMap();
67+
Map<Integer, Slf4JLogLevelHandler> emptyMap = Collections.emptyMap();
6868
new Slf4JLogBridgeImpl(mockScrubber, emptyMap).log(mockSlf4JLogger, 0, Logger.EVENT_UNSPECIFIED, "This Should fail", testEx);
6969
}
7070

src/test/java/org/owasp/esapi/logging/slf4j/Slf4JLogHandlersTest.java renamed to src/test/java/org/owasp/esapi/logging/slf4j/Slf4JLogLevelHandlersTest.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,20 @@
2222
import org.slf4j.Marker;
2323
import org.slf4j.helpers.BasicMarkerFactory;
2424

25-
public class Slf4JLogHandlersTest {
25+
public class Slf4JLogLevelHandlersTest {
2626

2727
private Logger mockLogger = Mockito.mock(Logger.class);
2828
@Rule
2929
public TestName testName = new TestName();
3030

31-
private Marker marker = new BasicMarkerFactory().getMarker(Slf4JLogHandlersTest.class.getSimpleName());
31+
private Marker marker = new BasicMarkerFactory().getMarker(Slf4JLogLevelHandlersTest.class.getSimpleName());
3232
private Throwable testException = new Throwable("Expected for testing");
3333

3434
@Test
3535
public void testErrorDelegation() {
36-
Slf4JLogHandlers.ERROR.isEnabled(mockLogger);
37-
Slf4JLogHandlers.ERROR.log(mockLogger, marker, testName.getMethodName());
38-
Slf4JLogHandlers.ERROR.log(mockLogger, marker, testName.getMethodName(), testException);
36+
Slf4JLogLevelHandlers.ERROR.isEnabled(mockLogger);
37+
Slf4JLogLevelHandlers.ERROR.log(mockLogger, marker, testName.getMethodName());
38+
Slf4JLogLevelHandlers.ERROR.log(mockLogger, marker, testName.getMethodName(), testException);
3939

4040
Mockito.verify(mockLogger, Mockito.times(1)).isErrorEnabled();
4141
Mockito.verify(mockLogger, Mockito.times(1)).error(marker, testName.getMethodName());
@@ -45,9 +45,9 @@ public void testErrorDelegation() {
4545

4646
@Test
4747
public void testWarnDelegation() {
48-
Slf4JLogHandlers.WARN.isEnabled(mockLogger);
49-
Slf4JLogHandlers.WARN.log(mockLogger, marker, testName.getMethodName());
50-
Slf4JLogHandlers.WARN.log(mockLogger, marker, testName.getMethodName(), testException);
48+
Slf4JLogLevelHandlers.WARN.isEnabled(mockLogger);
49+
Slf4JLogLevelHandlers.WARN.log(mockLogger, marker, testName.getMethodName());
50+
Slf4JLogLevelHandlers.WARN.log(mockLogger, marker, testName.getMethodName(), testException);
5151

5252
Mockito.verify(mockLogger, Mockito.times(1)).isWarnEnabled();
5353
Mockito.verify(mockLogger, Mockito.times(1)).warn(marker, testName.getMethodName());
@@ -56,9 +56,9 @@ public void testWarnDelegation() {
5656
}
5757
@Test
5858
public void testInfoDelegation() {
59-
Slf4JLogHandlers.INFO.isEnabled(mockLogger);
60-
Slf4JLogHandlers.INFO.log(mockLogger, marker, testName.getMethodName());
61-
Slf4JLogHandlers.INFO.log(mockLogger, marker, testName.getMethodName(), testException);
59+
Slf4JLogLevelHandlers.INFO.isEnabled(mockLogger);
60+
Slf4JLogLevelHandlers.INFO.log(mockLogger, marker, testName.getMethodName());
61+
Slf4JLogLevelHandlers.INFO.log(mockLogger, marker, testName.getMethodName(), testException);
6262

6363
Mockito.verify(mockLogger, Mockito.times(1)).isInfoEnabled();
6464
Mockito.verify(mockLogger, Mockito.times(1)).info(marker, testName.getMethodName());
@@ -67,9 +67,9 @@ public void testInfoDelegation() {
6767
}
6868
@Test
6969
public void testDebugDelegation() {
70-
Slf4JLogHandlers.DEBUG.isEnabled(mockLogger);
71-
Slf4JLogHandlers.DEBUG.log(mockLogger, marker, testName.getMethodName());
72-
Slf4JLogHandlers.DEBUG.log(mockLogger, marker, testName.getMethodName(), testException);
70+
Slf4JLogLevelHandlers.DEBUG.isEnabled(mockLogger);
71+
Slf4JLogLevelHandlers.DEBUG.log(mockLogger, marker, testName.getMethodName());
72+
Slf4JLogLevelHandlers.DEBUG.log(mockLogger, marker, testName.getMethodName(), testException);
7373

7474
Mockito.verify(mockLogger, Mockito.times(1)).isDebugEnabled();
7575
Mockito.verify(mockLogger, Mockito.times(1)).debug(marker, testName.getMethodName());
@@ -78,9 +78,9 @@ public void testDebugDelegation() {
7878
}
7979
@Test
8080
public void testTraceDelegation() {
81-
Slf4JLogHandlers.TRACE.isEnabled(mockLogger);
82-
Slf4JLogHandlers.TRACE.log(mockLogger, marker, testName.getMethodName());
83-
Slf4JLogHandlers.TRACE.log(mockLogger, marker, testName.getMethodName(), testException);
81+
Slf4JLogLevelHandlers.TRACE.isEnabled(mockLogger);
82+
Slf4JLogLevelHandlers.TRACE.log(mockLogger, marker, testName.getMethodName());
83+
Slf4JLogLevelHandlers.TRACE.log(mockLogger, marker, testName.getMethodName(), testException);
8484

8585
Mockito.verify(mockLogger, Mockito.times(1)).isTraceEnabled();
8686
Mockito.verify(mockLogger, Mockito.times(1)).trace(marker, testName.getMethodName());

0 commit comments

Comments
 (0)