com.goldencode.p2j.util.logging

Class LoggingUtil

java.lang.Object

com.goldencode.p2j.util.logging.LoggingUtil

public class LoggingUtil
extends java.lang.Object

Logging utilities.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger.
private static java.lang.String	PLACEHOLDER_PID The placeholder for process id.
static java.lang.String	SORTABLE_DATETIME_FORMAT Format for file names with sortable datetime to the seconds.
private static java.lang.String	VAR_PLACEHOLDER_END The characters at the end of a placeholder for var.
private static java.lang.String	VAR_PLACEHOLDER_START The characters at the start of a placeholder for var.

Constructor Summary

Constructors

Constructor and Description
LoggingUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addLeadingSymbols(java.lang.String originalValue, int totalCharsCount, char symbol) Format a text by adding leading symbols up to the defined amount of characters.
static java.lang.String	addLeadingZeros(java.lang.Integer number, int totalCharsCount) Format a number by adding leading zeros up to the defined amount of characters.
static boolean	canWriteToPath(java.lang.String filePath) Return if the process can write to the file path.
(package private) static java.util.Optional<java.util.logging.Level>	convertToLevel(java.lang.Integer levelInt) Utility method to convert integer to java.util.logging.Level.
static java.util.Optional<java.util.logging.Level>	convertToLevel(java.lang.String levelString) Utility method to convert string to java.util.logging.Level.
static java.lang.String	formatNow() Format the current datetime.
private static java.lang.String	getFirstBetween(java.lang.String text, java.lang.String start, java.lang.String end) Returns the content between the starting and the ending string.
static java.lang.String	replaceFormatterDateTime(java.lang.String filePath) Return the formatted log file path.
static java.lang.String	resolveLogFile(java.lang.String logFile, java.util.function.Supplier<java.lang.Long> processIdSupplier, java.lang.String processType, boolean isRotationDisabled) Returns the resolved log file name.
static java.lang.String	resolveLogFile(java.lang.String logFile, java.util.function.Supplier<java.lang.Long> processIdSupplier, java.lang.String processType, java.lang.String databaseName, boolean isRotationDisabled) Returns the resolved log file name.
static java.lang.String	resolveLogFile(java.lang.String logFile, java.util.function.Supplier<java.lang.Long> processIdSupplier, java.lang.String userOS, java.lang.String userFwd, java.lang.String appServerName, java.lang.String mode, java.lang.String databaseName, boolean isRotationDisabled) Returns the resolved log file name.

Methods inherited from class java.lang.Object

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

Field Detail

SORTABLE_DATETIME_FORMAT

public static final java.lang.String SORTABLE_DATETIME_FORMAT

Format for file names with sortable datetime to the seconds. java.util.Formatter specifiers.

See Also:

Constant Field Values

PLACEHOLDER_PID

private static final java.lang.String PLACEHOLDER_PID

The placeholder for process id.

See Also:

Constant Field Values

VAR_PLACEHOLDER_START

private static final java.lang.String VAR_PLACEHOLDER_START

The characters at the start of a placeholder for var.

See Also:

Constant Field Values

VAR_PLACEHOLDER_END

private static final java.lang.String VAR_PLACEHOLDER_END

The characters at the end of a placeholder for var.

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger.

Constructor Detail

LoggingUtil

public LoggingUtil()

Method Detail

resolveLogFile

public static java.lang.String resolveLogFile(java.lang.String logFile,
                                              java.util.function.Supplier<java.lang.Long> processIdSupplier,
                                              java.lang.String processType,
                                              boolean isRotationDisabled)

Returns the resolved log file name.

Parameters:

logFile - File path for the log.

processIdSupplier - Supploer for the process Id.

processType - Client, server, whatever you like.

isRotationDisabled - Flag to indicate rotation has been disabled.

Returns:

The resolved log file name.

resolveLogFile

public static java.lang.String resolveLogFile(java.lang.String logFile,
                                              java.util.function.Supplier<java.lang.Long> processIdSupplier,
                                              java.lang.String processType,
                                              java.lang.String databaseName,
                                              boolean isRotationDisabled)

Returns the resolved log file name.

Parameters:

logFile - File path for the log.

processIdSupplier - Supploer for the process Id.

processType - Client, server, whatever you like.

databaseName - The name of the database in use.

isRotationDisabled - Flag to indicate rotation has been disabled.

Returns:

The resolved log file name.

resolveLogFile

public static java.lang.String resolveLogFile(java.lang.String logFile,
                                              java.util.function.Supplier<java.lang.Long> processIdSupplier,
                                              java.lang.String userOS,
                                              java.lang.String userFwd,
                                              java.lang.String appServerName,
                                              java.lang.String mode,
                                              java.lang.String databaseName,
                                              boolean isRotationDisabled)

Returns the resolved log file name.

Parameters:

logFile - File path for the log.

processIdSupplier - Supploer for the process Id.

userOS - Operating system user.

userFwd - FWD context user.

appServerName - AppServer name.

mode - Client, server, whatever you like.

databaseName - The name of the database in use.

isRotationDisabled - Flag to indicate rotation has been disabled.

Returns:

The resolved log file name.

formatNow

public static java.lang.String formatNow()

Format the current datetime.

Returns:

The formatted datetime.

replaceFormatterDateTime

public static java.lang.String replaceFormatterDateTime(java.lang.String filePath)

Return the formatted log file path.

Parameters:

filePath - File path for the log.

Returns:

The formatted log file path.

canWriteToPath

public static boolean canWriteToPath(java.lang.String filePath)

Return if the process can write to the file path.

Parameters:

filePath - File path for the log.

Returns:

true if the process can write to the file path, false otherwise.

convertToLevel

public static java.util.Optional<java.util.logging.Level> convertToLevel(java.lang.String levelString)

Utility method to convert string to java.util.logging.Level. Not the same as Level.parse(String) that throws exceptions with invalid values.

Parameters:

levelString - The string representation of the level.

Returns:

Optional for the parsed java.util.logging.Level.

convertToLevel

static java.util.Optional<java.util.logging.Level> convertToLevel(java.lang.Integer levelInt)

Utility method to convert integer to java.util.logging.Level. Not the same as Level.parse(String) that throws exceptions with invalid values.

Parameters:

levelInt - The integer representation of the level.

Returns:

Optional for the parsed java.util.logging.Level.

getFirstBetween

private static java.lang.String getFirstBetween(java.lang.String text,
                                                java.lang.String start,
                                                java.lang.String end)

Returns the content between the starting and the ending string.

Parameters:

text - The text to search in.

start - The wrapper start. To be excluded.

end - The wrapper end. To be excluded.

Returns:

The content between the starting and the ending string.

addLeadingZeros

public static java.lang.String addLeadingZeros(java.lang.Integer number,
                                               int totalCharsCount)

Format a number by adding leading zeros up to the defined amount of characters.

Parameters:

number - The number to format.

totalCharsCount - File path for the log.

Returns:

The formatted number with leading zeros.

addLeadingSymbols

public static java.lang.String addLeadingSymbols(java.lang.String originalValue,
                                                 int totalCharsCount,
                                                 char symbol)

Format a text by adding leading symbols up to the defined amount of characters.

Parameters:

originalValue - The value to format.

totalCharsCount - File path for the log.

symbol - The character to use for filling in leading spaces.

Returns:

The formatted text with leading symbols.