org.owasp.security.logging.util

Class SecurityUtil

java.lang.Object

org.owasp.security.logging.util.SecurityUtil

public class SecurityUtil
extends Object

Various logging features to consider adding to your own programs.

Author:

Milton Smith

See Also:

"http://stackoverflow.com/questions/11187461/redirect-system-out-and-system-err-to-slf4j"

Field Summary

Fields

Modifier and Type	Field and Description
static PrintStream	syserr
static PrintStream	sysout

Method Summary

Modifier and Type	Method and Description
static void	bindSystemStreamsToSLF4J() Redirect System.out and System.err streams to SLF4J logger.
static void	bindSystemStreamsToSLF4J(org.slf4j.Logger newSysOutLogger, org.slf4j.Logger newSysErrLogger) Redirect System.out and System.err streams to the given SLF4J loggers.
static void	logCommandLineArguments(String[] args) Log command line arguments.
static void	logJavaSystemProperties() Log Java system properties.
static void	logMessage(String message) Log the formatted message at the INFO priority.
static void	logShellEnvironmentVariables() Log shell environment variables associated with Java process.
static void	unbindSystemStreams() Unbined bound system loggers and restore these streams to their original state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sysout

public static final PrintStream sysout

syserr

public static final PrintStream syserr

Method Detail

bindSystemStreamsToSLF4J

public static void bindSystemStreamsToSLF4J()

Redirect System.out and System.err streams to SLF4J logger. This is a benefit if you have a legacy console logger application. Does not provide benefit of a full implementation. For example, no hierarchical or logger inheritence support but there are some ancilarity benefits like, 1) capturing messages that would otherwise be lost, 2) redirecting console messages to centralized log services, 3) formatting console messages in other types of output (e.g., HTML).

bindSystemStreamsToSLF4J

public static void bindSystemStreamsToSLF4J(org.slf4j.Logger newSysOutLogger,
                                            org.slf4j.Logger newSysErrLogger)

Redirect System.out and System.err streams to the given SLF4J loggers. This is a benefit if you have a legacy console logger application. Does not provide benefit of a full implementation. For example, no hierarchical or logger inheritance support but there are some ancillary benefits like, 1) capturing messages that would otherwise be lost, 2) redirecting console messages to centralized log services, 3) formatting console messages in other types of output (e.g., HTML).

Parameters:

newSysOutLogger - Logger to use for System.out

newSysErrLogger - Logger to use for System.err

unbindSystemStreams

public static void unbindSystemStreams()

Unbined bound system loggers and restore these streams to their original state.

See Also:

bindSystemStreamsToSLF4J()

logCommandLineArguments

public static void logCommandLineArguments(String[] args)

Log command line arguments. Mostly for use inside a main() method to quickly print arguments for future diagnostics.

Parameters:

args - Command line arguments

logShellEnvironmentVariables

public static void logShellEnvironmentVariables()

Log shell environment variables associated with Java process.

logJavaSystemProperties

public static void logJavaSystemProperties()

Log Java system properties.

logMessage

public static void logMessage(String message)

Log the formatted message at the INFO priority. Override this method to log your status using security markers or different log levels like the following, tbd

Parameters:

message - Message to log.