com.goldencode.p2j.util

Class LegacyLogWriteExecutor

java.lang.Object

com.goldencode.p2j.util.LegacyLogWriteExecutor

public class LegacyLogWriteExecutor
extends java.lang.Object

A single point of executing legacy LOG-MANAGER file write actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LegacyLogWriteExecutor.ExecutorsThreadFactory Private static class ExecutorsThreadFactory to provide meaningful names for threads used by the executors.
private static class	LegacyLogWriteExecutor.LegacyLogManagerQueueHolder Initialization on demand holder for LegacyLogManagerQueue singleton initialization.
private static class	LegacyLogWriteExecutor.WriteCallable Private static class WriteCallable that extends Callable.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG A temporary logger to just write messages to server's log.
private java.lang.Object	noRotationMutex Mutex for no rotation related actions.
private java.util.Map<java.lang.String,java.util.concurrent.ExecutorService>	noRotationPathToExecutorServicedMap Map with absolute log file path : executor service pairs for clients that don't need file rotation.
private java.util.Map<java.lang.String,java.util.Set<java.lang.Long>>	noRotationPathToPidMap Map with absolute log file path : client pids pairs for clients that don't need file rotation.
private java.lang.Object	rotationMutex Mutex for rotation related actions.
private java.util.Map<java.lang.String,java.util.concurrent.ExecutorService>	rotationPathToExecutorServicedMap Map with absolute log file path : executor service pairs for clients that need file rotation.
private java.util.Map<java.lang.String,java.lang.Long>	rotationPathToPidMap Map with absolute log file path : client pid pairs for clients that need file rotation.
private static java.util.concurrent.ThreadFactory	THREAD_FACTORY_NO_ROTATION Thread factory for the thread executor providing threads for writing to log files without rotation.
private static java.util.concurrent.ThreadFactory	THREAD_FACTORY_ROTATION Thread factory for the thread executor providing threads for writing to log files with rotation.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LegacyLogWriteExecutor() Private constructor for LegacyLogManagerQueue.

Method Summary

Modifier and Type	Method and Description
boolean	close(long pid, java.lang.String path, boolean isRotation) Closes the ExecutorService executing write tasks for the file path if no other pids are using it.
static LegacyLogWriteExecutor	get() Getter for LegacyLogManagerQueue singleton instance.
private java.util.concurrent.Future<java.lang.Boolean>	write(java.util.concurrent.ExecutorService es, java.io.FileWriter writer, java.lang.String msg) Creates a new WriteCallable and submits it to the ExecutorService.
java.util.Optional<java.util.concurrent.Future<java.lang.Boolean>>	write(long pid, java.lang.String path, boolean isRotation, java.io.FileWriter writer, java.lang.String msg) Each unique path has a dedicated thread and a queue (newSingleThreadExecutor).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

A temporary logger to just write messages to server's log.

THREAD_FACTORY_ROTATION

private static final java.util.concurrent.ThreadFactory THREAD_FACTORY_ROTATION

Thread factory for the thread executor providing threads for writing to log files with rotation.

THREAD_FACTORY_NO_ROTATION

private static final java.util.concurrent.ThreadFactory THREAD_FACTORY_NO_ROTATION

Thread factory for the thread executor providing threads for writing to log files without rotation.

rotationMutex

private final java.lang.Object rotationMutex

Mutex for rotation related actions.

rotationPathToPidMap

private final java.util.Map<java.lang.String,java.lang.Long> rotationPathToPidMap

Map with absolute log file path : client pid pairs for clients that need file rotation.

rotationPathToExecutorServicedMap

private final java.util.Map<java.lang.String,java.util.concurrent.ExecutorService> rotationPathToExecutorServicedMap

Map with absolute log file path : executor service pairs for clients that need file rotation.

noRotationMutex

private final java.lang.Object noRotationMutex

Mutex for no rotation related actions.

noRotationPathToPidMap

private final java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> noRotationPathToPidMap

Map with absolute log file path : client pids pairs for clients that don't need file rotation.

noRotationPathToExecutorServicedMap

private final java.util.Map<java.lang.String,java.util.concurrent.ExecutorService> noRotationPathToExecutorServicedMap

Map with absolute log file path : executor service pairs for clients that don't need file rotation.

Constructor Detail

LegacyLogWriteExecutor

private LegacyLogWriteExecutor()

Private constructor for LegacyLogManagerQueue.

Method Detail

get

public static LegacyLogWriteExecutor get()

Getter for LegacyLogManagerQueue singleton instance.

Returns:

instance of LegacyLogManagerQueue.

close

public boolean close(long pid,
                     java.lang.String path,
                     boolean isRotation)

Closes the ExecutorService executing write tasks for the file path if no other pids are using it.

Parameters:

pid - The process id of the client writing to the file.

path - Absolute path to the file to write to.

isRotation - Flag to indicate the file gets rotated.

Returns:

Always returns true.

write

public java.util.Optional<java.util.concurrent.Future<java.lang.Boolean>> write(long pid,
                                                                                java.lang.String path,
                                                                                boolean isRotation,
                                                                                java.io.FileWriter writer,
                                                                                java.lang.String msg)

Each unique path has a dedicated thread and a queue (newSingleThreadExecutor). In the case of rotation, only one client / pid will be able to add to the queue. In the case of no rotation, multiple clients / pids can write to the same path by adding tasks to the same queue.

Parameters:

pid - The process id of the client writing to the file.

path - Absolute path to the file to write to.

isRotation - Flag to indicate the file gets rotated.

writer - The prepared FileWriter for writing to the file.

msg - The log message.

Returns:

Empty Optional when the process is not allowed to write to the file (in case of rotation and another process already writing). Otherwise the Optional contains Future for the write task execution that returns a boolean.

write

private java.util.concurrent.Future<java.lang.Boolean> write(java.util.concurrent.ExecutorService es,
                                                             java.io.FileWriter writer,
                                                             java.lang.String msg)

Creates a new WriteCallable and submits it to the ExecutorService.

Parameters:

es - The executor service to execute the WriteCallable.

writer - The prepared FileWriter for writing to the file.

msg - The log message.

Returns:

Future for the write task execution that returns a boolean.