Skip to content

Commit 19d8251

Browse files
jeremiahjstaceyjeremiahjstacey
committed
Whitespace cleanup
1 parent b10a919 commit 19d8251

File tree

6 files changed

+65
-66
lines changed

6 files changed

+65
-66
lines changed

‎src/main/java/org/owasp/esapi/logging/java/ESAPIErrorJavaLevel.java‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,19 @@ public class ESAPIErrorJavaLevel extends Level {
2525
protected static final long serialVersionUID = 1L;
2626

2727
/**
28-
* Defines a custom error level below SEVERE but above WARNING since this level isn't defined directly
29-
* by java.util.Logger already.
30-
*/
31-
public static final Level ERROR_LEVEL = new ESAPIErrorJavaLevel( "ERROR", Level.SEVERE.intValue() - 1);
32-
33-
/**
34-
* Constructs an instance of a JavaLoggerLevel which essentially provides a mapping between the name of
35-
* the defined level and its numeric value.
36-
*
37-
* @param name The name of the JavaLoggerLevel
38-
* @param value The associated numeric value
39-
*/
40-
private ESAPIErrorJavaLevel(String name, int value) {
41-
super(name, value);
42-
}
28+
* Defines a custom error level below SEVERE but above WARNING since this level isn't defined directly
29+
* by java.util.Logger already.
30+
*/
31+
public static final Level ERROR_LEVEL = new ESAPIErrorJavaLevel( "ERROR", Level.SEVERE.intValue() - 1);
32+
33+
/**
34+
* Constructs an instance of a JavaLoggerLevel which essentially provides a mapping between the name of
35+
* the defined level and its numeric value.
36+
*
37+
* @param name The name of the JavaLoggerLevel
38+
* @param value The associated numeric value
39+
*/
40+
private ESAPIErrorJavaLevel(String name, int value) {
41+
super(name, value);
42+
}
4343
}
44-

‎src/main/java/org/owasp/esapi/logging/java/JavaLogBridge.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ public interface JavaLogBridge {
4040
* @param throwable ESAPI event Throwable content
4141
*/
4242
void log(Logger logger, int esapiLevel, EventType type, String message, Throwable throwable) ;
43-
43+
4444
}

‎src/main/java/org/owasp/esapi/logging/java/JavaLogBridgeImpl.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public class JavaLogBridgeImpl implements JavaLogBridge {
3434
private final LogScrubber scrubber;
3535
/** Appender used for assembling default message content for all logs.*/
3636
private final LogAppender appender;
37-
37+
3838
/**
3939
* Constructor.
4040
* @param logScrubber Log message cleaner.
@@ -53,9 +53,9 @@ public void log(Logger logger, int esapiLevel, EventType type, String message) {
5353
throw new IllegalArgumentException("Unable to lookup Java level mapping for esapi value of " + esapiLevel);
5454
}
5555
if (handler.isEnabled(logger)) {
56-
String fullMessage = appender.appendTo(logger.getName(), type, message);
56+
String fullMessage = appender.appendTo(logger.getName(), type, message);
5757
String cleanString = scrubber.cleanMessage(fullMessage);
58-
58+
5959
handler.log(logger, cleanString);
6060
}
6161
}
@@ -66,7 +66,7 @@ public void log(Logger logger, int esapiLevel, EventType type, String message, T
6666
throw new IllegalArgumentException("Unable to lookup Java level mapping for esapi value of " + esapiLevel);
6767
}
6868
if (handler.isEnabled(logger)) {
69-
String fullMessage = appender.appendTo(logger.getName(), type, message);
69+
String fullMessage = appender.appendTo(logger.getName(), type, message);
7070
String cleanString = scrubber.cleanMessage(fullMessage);
7171

7272
handler.log(logger, cleanString, throwable);

‎src/main/java/org/owasp/esapi/logging/java/JavaLogFactory.java‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ public class JavaLogFactory implements LogFactory {
4848
private static LogScrubber JAVA_LOG_SCRUBBER;
4949
/** Bridge class for mapping esapi -> java log levels.*/
5050
private static JavaLogBridge LOG_BRIDGE;
51-
51+
5252
static {
5353
boolean encodeLog = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_ENCODING_REQUIRED);
5454
JAVA_LOG_SCRUBBER = createLogScrubber(encodeLog);
55-
56-
boolean logClientInfo = true;
57-
boolean logApplicationName = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_APPLICATION_NAME);
58-
String appName = ESAPI.securityConfiguration().getStringProp(DefaultSecurityConfiguration.APPLICATION_NAME);
59-
boolean logServerIp = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_SERVER_IP);
55+
56+
boolean logClientInfo = true;
57+
boolean logApplicationName = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_APPLICATION_NAME);
58+
String appName = ESAPI.securityConfiguration().getStringProp(DefaultSecurityConfiguration.APPLICATION_NAME);
59+
boolean logServerIp = ESAPI.securityConfiguration().getBooleanProp(DefaultSecurityConfiguration.LOG_SERVER_IP);
6060
JAVA_LOG_APPENDER = createLogAppender(logClientInfo, logServerIp, logApplicationName, appName);
61-
61+
6262
Map<Integer, JavaLogLevelHandler> levelLookup = new HashMap<>();
6363
levelLookup.put(Logger.ALL, JavaLogLevelHandlers.ALL);
6464
levelLookup.put(Logger.TRACE, JavaLogLevelHandlers.FINEST);
@@ -68,28 +68,28 @@ public class JavaLogFactory implements LogFactory {
6868
levelLookup.put(Logger.WARNING, JavaLogLevelHandlers.WARNING);
6969
levelLookup.put(Logger.FATAL, JavaLogLevelHandlers.SEVERE);
7070
//LEVEL.OFF not used. If it's off why would we try to log it?
71-
71+
7272
LOG_BRIDGE = new JavaLogBridgeImpl(JAVA_LOG_APPENDER, JAVA_LOG_SCRUBBER, levelLookup);
73-
73+
7474
readLoggerConfiguration(LogManager.getLogManager());
7575
}
76-
76+
7777
/**
7878
* Attempts to load the expected property file path into the provided LogManager reference.
7979
* @param logManager LogManager which is being configured.
8080
*/
8181
/*package*/ static void readLoggerConfiguration(LogManager logManager) {
82-
/*
82+
/*
8383
* This will load the logging properties file to control the format of the output for Java logs.
8484
*/
8585
try (InputStream stream = JavaLogFactory.class.getClassLoader().
86-
getResourceAsStream("esapi-java-logging.properties")) {
87-
logManager.readConfiguration(stream);
86+
getResourceAsStream("esapi-java-logging.properties")) {
87+
logManager.readConfiguration(stream);
8888
} catch (IOException ioe) {
89-
System.err.print(new IOException("Failed to load esapi-java-logging.properties.", ioe));
89+
System.err.print(new IOException("Failed to load esapi-java-logging.properties.", ioe));
9090
}
9191
}
92-
92+
9393
/**
9494
* Populates the default log scrubber for use in factory-created loggers.
9595
* @param requiresEncoding {@code true} if encoding is required for log content.
@@ -98,15 +98,15 @@ public class JavaLogFactory implements LogFactory {
9898
/*package*/ static LogScrubber createLogScrubber(boolean requiresEncoding) {
9999
List<LogScrubber> messageScrubber = new ArrayList<>();
100100
messageScrubber.add(new NewlineLogScrubber());
101-
101+
102102
if (requiresEncoding) {
103103
messageScrubber.add(new CodecLogScrubber(HTML_CODEC, IMMUNE_JAVA_HTML));
104104
}
105-
105+
106106
return new CompositeLogScrubber(messageScrubber);
107-
107+
108108
}
109-
109+
110110
/**
111111
* Populates the default log appender for use in factory-created loggers.
112112
* @param appName
@@ -117,19 +117,19 @@ public class JavaLogFactory implements LogFactory {
117117
* @return LogAppender instance.
118118
*/
119119
/*package*/ static LogAppender createLogAppender(boolean logClientInfo, boolean logServerIp, boolean logApplicationName, String appName) {
120-
return new LogPrefixAppender(logClientInfo, logServerIp, logApplicationName, appName);
120+
return new LogPrefixAppender(logClientInfo, logServerIp, logApplicationName, appName);
121121
}
122-
123-
122+
123+
124124
@Override
125125
public Logger getLogger(String moduleName) {
126-
java.util.logging.Logger javaLogger = java.util.logging.Logger.getLogger(moduleName);
126+
java.util.logging.Logger javaLogger = java.util.logging.Logger.getLogger(moduleName);
127127
return new JavaLogger(javaLogger, LOG_BRIDGE, Logger.ALL);
128128
}
129129

130130
@Override
131131
public Logger getLogger(@SuppressWarnings("rawtypes") Class clazz) {
132-
java.util.logging.Logger javaLogger = java.util.logging.Logger.getLogger(clazz.getName());
132+
java.util.logging.Logger javaLogger = java.util.logging.Logger.getLogger(clazz.getName());
133133
return new JavaLogger(javaLogger, LOG_BRIDGE, Logger.ALL);
134134
}
135135

‎src/main/java/org/owasp/esapi/logging/java/JavaLogLevelHandler.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
* @see JavaLogBridgeImpl
2424
*
2525
*/
26-
interface JavaLogLevelHandler {
27-
/** Check if the logging level is enabled for the specified logger.*/
26+
interface JavaLogLevelHandler {
27+
/** Check if the logging level is enabled for the specified logger.*/
2828
boolean isEnabled(Logger logger);
2929
/**
3030
* Calls the appropriate log level event on the specified logger.

‎src/main/java/org/owasp/esapi/logging/java/JavaLogger.java‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public class JavaLogger implements org.owasp.esapi.Logger {
2525
private final JavaLogBridge logBridge;
2626
/** Maximum log level that will be forwarded to Java from the ESAPI context.*/
2727
private int maxLogLevel;
28-
28+
2929
/**
3030
* Constructs a new instance.
3131
* @param JavaLogger Delegate Java logger.
@@ -37,25 +37,25 @@ public JavaLogger(java.util.logging.Logger JavaLogger, JavaLogBridge bridge, int
3737
this.logBridge = bridge;
3838
maxLogLevel = defaultEsapiLevel;
3939
}
40-
40+
4141
private void log(int esapiLevel, EventType type, String message) {
4242
if (isEnabled(esapiLevel)) {
4343
logBridge.log(delegate, esapiLevel, type, message);
4444
}
4545
}
46-
46+
4747
private void log(int esapiLevel, EventType type, String message, Throwable throwable) {
4848
if (isEnabled(esapiLevel)) {
4949
logBridge.log(delegate, esapiLevel, type, message, throwable);
5050
}
5151
}
52-
52+
5353

5454
private boolean isEnabled(int esapiLevel) {
5555
//Are Logger.OFF and Logger.ALL reversed? This should be simply the less than or equal to check...
5656
return (esapiLevel <= maxLogLevel && maxLogLevel != Logger.OFF) || maxLogLevel == Logger.ALL;
5757
}
58-
58+
5959
@Override
6060
public void always(EventType type, String message) {
6161
log (Logger.ALL, type, message);
@@ -70,7 +70,7 @@ public void always(EventType type, String message, Throwable throwable) {
7070
public void trace(EventType type, String message) {
7171
log (Logger.TRACE, type, message);
7272
}
73-
73+
7474
@Override
7575
public void trace(EventType type, String message, Throwable throwable) {
7676
log (Logger.TRACE, type, message, throwable);
@@ -85,22 +85,22 @@ public void debug(EventType type, String message) {
8585
public void debug(EventType type, String message, Throwable throwable) {
8686
log (Logger.DEBUG, type, message, throwable);
8787
}
88-
88+
8989
@Override
9090
public void info(EventType type, String message) {
9191
log (Logger.INFO, type, message);
9292
}
93-
93+
9494
@Override
9595
public void info(EventType type, String message, Throwable throwable) {
9696
log (Logger.INFO, type, message, throwable);
9797
}
98-
98+
9999
@Override
100100
public void warning(EventType type, String message) {
101101
log (Logger.WARNING, type, message);
102102
}
103-
103+
104104
@Override
105105
public void warning(EventType type, String message, Throwable throwable) {
106106
log (Logger.WARNING, type, message, throwable);
@@ -125,17 +125,17 @@ public void fatal(EventType type, String message) {
125125
public void fatal(EventType type, String message, Throwable throwable) {
126126
log (Logger.FATAL, type, message, throwable);
127127
}
128-
128+
129129
@Override
130130
public int getESAPILevel() {
131131
return maxLogLevel;
132132
}
133-
133+
134134
@Override
135135
public boolean isTraceEnabled() {
136136
return isEnabled(Logger.TRACE);
137137
}
138-
138+
139139
@Override
140140
public boolean isDebugEnabled() {
141141
return isEnabled(Logger.DEBUG);
@@ -148,21 +148,21 @@ public boolean isInfoEnabled() {
148148
public boolean isWarningEnabled() {
149149
return isEnabled(Logger.WARNING);
150150
}
151-
151+
152152
@Override
153153
public boolean isErrorEnabled() {
154154
return isEnabled(Logger.ERROR);
155155
}
156-
156+
157157
@Override
158158
public boolean isFatalEnabled() {
159-
return isEnabled(Logger.FATAL);
159+
return isEnabled(Logger.FATAL);
160160
}
161-
161+
162162

163163
@Override
164164
public void setLevel(int level) {
165-
maxLogLevel = level;
165+
maxLogLevel = level;
166166
}
167-
167+
168168
}

0 commit comments

Comments
 (0)