Index
All Classes and Interfaces|All Packages
A
- areInfoLogsEnabled() - Method in class com.github.eventmanager.EventManager
-
Checks if informational logs are enabled.
- areInfoLogsEnabled() - Method in class com.github.eventmanager.InternalEventManager
- args(String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the arguments of the log to the event log.
- args(String, KeyValueWrapper) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends a key-value pairs o the log to the event log.
- args(String, KeyValueWrapper...) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends a number of key-value pairs of the log to the event log.
C
- checkIfInternalLogFileExists() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Checks if the log file for internal events exists.
- checkIfLogFileExists() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Checks if the log file exists.
- checkIfLogFileNeedsRotation() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Checks if the log file needs rotation based on size and time.
- className() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the class name of the log to the event log.
- com.github.eventmanager - module com.github.eventmanager
-
This module defines the event manager application, which includes functionalities for logging events, handling file operations, and formatting events.
- com.github.eventmanager - package com.github.eventmanager
-
This package contains the main classes for managing and logging events.
- com.github.eventmanager.compressors - package com.github.eventmanager.compressors
-
This package contains classes and interfaces for handling compression operations.
- com.github.eventmanager.filehandlers - package com.github.eventmanager.filehandlers
-
This package contains classes responsible for handling file operations such as loading configurations and managing log files.
- com.github.eventmanager.filehandlers.config - package com.github.eventmanager.filehandlers.config
-
This package contains classes responsible for managing and configuring file handlers in the EventManager logging system.
- com.github.eventmanager.formatters - package com.github.eventmanager.formatters
-
This package contains classes for formatting events and key-value pairs.
- com.github.eventmanager.processors - package com.github.eventmanager.processors
-
This package contains classes that implement various event processing functionalities.
- compress(String) - Static method in class com.github.eventmanager.compressors.Gzip
-
Compresses the file at the specified file path using the GZIP format.
- compress(String) - Static method in class com.github.eventmanager.compressors.Zip
-
Compresses the file at the specified file path using the ZIP format.
- Config - Class in com.github.eventmanager.filehandlers.config
-
The Config class holds the configuration settings for the EventManager application.
- Config() - Constructor for class com.github.eventmanager.filehandlers.config.Config
- ConfigEvent - Class in com.github.eventmanager.filehandlers.config
-
The ConfigEvent class holds the configuration settings related to events for the EventManager application.
- ConfigEvent() - Constructor for class com.github.eventmanager.filehandlers.config.ConfigEvent
- ConfigInternalEvents - Class in com.github.eventmanager.filehandlers.config
-
This class contains the configuration settings for the internal events file handler.
- ConfigInternalEvents() - Constructor for class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
- ConfigLoader - Class in com.github.eventmanager.filehandlers
-
Deprecated.
- ConfigLoader(String) - Constructor for class com.github.eventmanager.filehandlers.ConfigLoader
-
Deprecated.
- ConfigLogFile - Class in com.github.eventmanager.filehandlers.config
-
The ConfigLogFile class holds the configuration settings related to log files for the EventManager application.
- ConfigLogFile() - Constructor for class com.github.eventmanager.filehandlers.config.ConfigLogFile
- ConfigLogRotate - Class in com.github.eventmanager.filehandlers.config
-
The ConfigLogRotate class holds the configuration settings related to log file rotation for the EventManager application.
- ConfigLogRotate() - Constructor for class com.github.eventmanager.filehandlers.config.ConfigLogRotate
- create() - Method in class com.github.eventmanager.formatters.EventCreator
-
Finalizes the event log and returns it as a string.
- createDefault() - Static method in class com.github.eventmanager.processors.DefaultProcessors
-
Creates a list of default processors.
- createInternalLogFile() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Creates a new log file for internal events.
- createLogFile() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Creates a new log file.
- CSV - Enum constant in enum class com.github.eventmanager.formatters.EventFormatter
-
The CSV formatter formats the event metadata and arguments in a CSV format.
D
- DEFAULT - Enum constant in enum class com.github.eventmanager.formatters.EventFormatter
-
The DEFAULT formatter formats the event metadata and arguments in a default format.
- DefaultProcessors - Class in com.github.eventmanager.processors
-
The DefaultProcessors class provides a method to create a list of default processors.
- DefaultProcessors() - Constructor for class com.github.eventmanager.processors.DefaultProcessors
E
- EnrichingProcessor - Class in com.github.eventmanager.processors
-
The EnrichingProcessor class is responsible for enriching event data with additional metadata.
- EnrichingProcessor() - Constructor for class com.github.eventmanager.processors.EnrichingProcessor
- EventCreator - Class in com.github.eventmanager.formatters
-
The EventCreator class is a builder class that creates event logs.
- EventCreator(String) - Constructor for class com.github.eventmanager.formatters.EventCreator
-
The constructor of the EventCreator class.
- EventFormatter - Enum Class in com.github.eventmanager.formatters
-
The EventFormatter enum provides different formatting strategies for event logs.
- EventManager - Class in com.github.eventmanager
-
The EventManager class is responsible for managing and logging events.
- EventManager(LogHandler) - Constructor for class com.github.eventmanager.EventManager
-
Constructs an EventManager with the specified LogHandler.
- EventManager(String) - Constructor for class com.github.eventmanager.EventManager
-
Constructs an EventManager with the specified configuration file path.
- eventQueue - Variable in class com.github.eventmanager.InternalEventManager
- eventThread - Variable in class com.github.eventmanager.InternalEventManager
- exception(String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the exception to the event.
F
- format(Map<String, String>, KeyValueWrapper...) - Method in enum class com.github.eventmanager.formatters.EventFormatter
-
Formats the event metadata and arguments.
- format(Map<String, String>, String) - Method in enum class com.github.eventmanager.formatters.EventFormatter
-
Formats the event metadata and message.
- formatArguments(String, KeyValueWrapper...) - Method in enum class com.github.eventmanager.formatters.EventFormatter
-
Formats the event arguments.
- formatElement(KeyValueWrapper) - Method in enum class com.github.eventmanager.formatters.EventFormatter
-
Formats the event element.
G
- getCompressionFormat() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Gets the compression format to use when rotating log files.
- getDebuggingMode() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets whether debugging mode is enabled.
- getEventFormat() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets the event format for logging events.
- getFileExtension() - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Gets the file extension for the internal events log.
- getFileExtension() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Gets the file extension for the log files.
- getFileName() - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Gets the file name for the internal events log.
- getFileName() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Gets the file name for the log files.
- getFilePath() - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Gets the file path where the internal events log will be stored.
- getFilePath() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Gets the file path for the log files.
- getInformationalMode() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets whether informational mode is enabled.
- getMaxSizeInKB() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Gets the maximum size of log files in kilobytes before rotation is triggered.
- getPrintAndSaveToFile() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets whether logs should be printed and saved to a file.
- getPrintToConsole() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets whether logs should be printed to the console.
- getRotationPeriodInSeconds() - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Gets the rotation period in seconds after which log files should be rotated.
- getTimeFormat() - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Gets the time format for logging events.
- Gzip - Class in com.github.eventmanager.compressors
-
The Gzip class provides methods for compressing files using the GZIP format.
- Gzip() - Constructor for class com.github.eventmanager.compressors.Gzip
H
- hostname() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the hostname to the event log.
I
- initiateEventThread() - Method in class com.github.eventmanager.InternalEventManager
- initiateThreads() - Method in class com.github.eventmanager.InternalEventManager
- initiatEventThread() - Method in class com.github.eventmanager.InternalEventManager
-
Deprecated.This method is deprecated and will be removed in a future release, as it was not intended to be used by external classes... there was also a typo. Use
ManagerBase.initiatEventThread()
instead. - InternalEventManager - Class in com.github.eventmanager
-
The InternalEventManager class is responsible for managing internal events of the EventManager library.
- InternalEventManager(LogHandler) - Constructor for class com.github.eventmanager.InternalEventManager
- ipAddress() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the IP address to the event log.
- isEnabled() - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Checks if the internal events file handler is enabled.
- isIpInCidr(String, String) - Static method in class com.github.eventmanager.processors.MaskIPV4Address
-
Checks if the given IP address is in the specified CIDR range.
- isValidTimeFormat(String) - Static method in class com.github.eventmanager.formatters.TimeStampFormatter
-
Checks if the provided time format is valid.
J
- JSON - Enum constant in enum class com.github.eventmanager.formatters.EventFormatter
-
The JSON formatter formats the event metadata and arguments in a JSON format.
K
- KEY_VALUE - Enum constant in enum class com.github.eventmanager.formatters.EventFormatter
-
The KEY_VALUE formatter formats the event metadata and arguments in a key-value format.
- KeyValueWrapper - Class in com.github.eventmanager.formatters
-
The KeyValueWrapper class is a simple data structure that holds a key-value pair.
- KeyValueWrapper(String, String) - Constructor for class com.github.eventmanager.formatters.KeyValueWrapper
-
Constructs a KeyValueWrapper with the specified key and value.
L
- level(String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the level of the log to the event log.
- lineNumber() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the line number of the log to the event log.
- logDebug(String) - Method in class com.github.eventmanager.InternalEventManager
-
Log a debug event to the log file.
- logDebugMessage(EventCreator) - Method in class com.github.eventmanager.EventManager
-
Logs a debug message with a EventCreator message.
- logDebugMessage(KeyValueWrapper...) - Method in class com.github.eventmanager.EventManager
-
Logs a debug message with key-value pairs.
- logDebugMessage(Object) - Method in class com.github.eventmanager.EventManager
-
Logs a debug message.
- logError(String) - Method in class com.github.eventmanager.InternalEventManager
-
Log an error event to the log file.
- logErrorMessage(EventCreator) - Method in class com.github.eventmanager.EventManager
-
Logs an error message with a EventCreator message.
- logErrorMessage(KeyValueWrapper...) - Method in class com.github.eventmanager.EventManager
-
Logs an error message with key-value pairs.
- logErrorMessage(Object) - Method in class com.github.eventmanager.EventManager
-
Logs an error message.
- logFatal(String) - Method in class com.github.eventmanager.InternalEventManager
-
Log a fatal events to the log file.
- logFatalMessage(EventCreator) - Method in class com.github.eventmanager.EventManager
-
Logs a fatal message with a EventCreator message.
- logFatalMessage(KeyValueWrapper...) - Method in class com.github.eventmanager.EventManager
-
Logs a fatal message with key-value pairs.
- logFatalMessage(Object) - Method in class com.github.eventmanager.EventManager
-
Logs a fatal message.
- logHandler - Variable in class com.github.eventmanager.InternalEventManager
- LogHandler - Class in com.github.eventmanager.filehandlers
-
The LogHandler class is responsible for managing log files for the EventManager application.
- LogHandler(String) - Constructor for class com.github.eventmanager.filehandlers.LogHandler
-
Constructs a LogHandler with the specified ConfigLoader.
- LogHandler(String, boolean) - Constructor for class com.github.eventmanager.filehandlers.LogHandler
-
Constructs a LogHandler with the specified ConfigLoader.
- logInfo(String) - Method in class com.github.eventmanager.InternalEventManager
-
Log an informational event to the log file.
- logInfoMessage(EventCreator) - Method in class com.github.eventmanager.EventManager
-
Logs an informational message with a EventCreator message.
- logInfoMessage(KeyValueWrapper...) - Method in class com.github.eventmanager.EventManager
-
Logs an informational message with key-value pairs.
- logInfoMessage(Object) - Method in class com.github.eventmanager.EventManager
-
Logs an informational message.
- logMessage(String, Object) - Method in class com.github.eventmanager.InternalEventManager
-
Logs a message to the destination file.
- logWarn(String) - Method in class com.github.eventmanager.InternalEventManager
-
Log a warning event to the log file.
- logWarningMessage(EventCreator) - Method in class com.github.eventmanager.EventManager
-
Logs a warning message with a EventCreator message.
- logWarningMessage(KeyValueWrapper...) - Method in class com.github.eventmanager.EventManager
-
Logs a warning message with key-value pairs.
- logWarningMessage(Object) - Method in class com.github.eventmanager.EventManager
-
Logs a warning message.
M
- MaskIPV4Address - Class in com.github.eventmanager.processors
-
The MaskIPV4Address class implements the Processor interface and provides methods to mask IPv4 addresses in different event formats (KV, JSON, XML).
- MaskIPV4Address(List<String>) - Constructor for class com.github.eventmanager.processors.MaskIPV4Address
- MaskPasswords - Class in com.github.eventmanager.processors
-
The MaskPasswords class is responsible for masking passwords in event data.
- MaskPasswords() - Constructor for class com.github.eventmanager.processors.MaskPasswords
- message(String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the message of the log to the event log.
- message(String, String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the message of the log to the event log.
- methodName() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the method name of the log to the event log.
P
- processEvent(String) - Method in class com.github.eventmanager.InternalEventManager
- processingQueue - Variable in class com.github.eventmanager.InternalEventManager
- processingThread - Variable in class com.github.eventmanager.InternalEventManager
- processJSON(String) - Method in class com.github.eventmanager.processors.EnrichingProcessor
- processJSON(String) - Method in class com.github.eventmanager.processors.MaskIPV4Address
-
Processes a JSON formatted event and masks any IPv4 addresses that match the CIDR ranges.
- processJSON(String) - Method in class com.github.eventmanager.processors.MaskPasswords
- processJSON(String) - Method in interface com.github.eventmanager.processors.Processor
-
Processes a JSON formatted event.
- processJSON(String) - Method in class com.github.eventmanager.processors.RegexProcessor
- processKV(String) - Method in class com.github.eventmanager.processors.EnrichingProcessor
- processKV(String) - Method in class com.github.eventmanager.processors.MaskIPV4Address
-
Processes a key-value formatted event and masks any IPv4 addresses that match the CIDR ranges.
- processKV(String) - Method in class com.github.eventmanager.processors.MaskPasswords
- processKV(String) - Method in interface com.github.eventmanager.processors.Processor
-
Processes a key-value formatted event.
- processKV(String) - Method in class com.github.eventmanager.processors.RegexProcessor
- Processor - Interface in com.github.eventmanager.processors
-
The Processor interface provides methods to process events in different formats (KV, JSON, XML).
- ProcessorEntry - Class in com.github.eventmanager.filehandlers.config
-
The ProcessorEntry class holds the configuration settings for the event processors.
- ProcessorEntry() - Constructor for class com.github.eventmanager.filehandlers.config.ProcessorEntry
- processors - Variable in class com.github.eventmanager.InternalEventManager
- processXML(String) - Method in class com.github.eventmanager.processors.EnrichingProcessor
- processXML(String) - Method in class com.github.eventmanager.processors.MaskIPV4Address
-
Processes an XML formatted event and masks any IPv4 addresses that match the CIDR ranges.
- processXML(String) - Method in class com.github.eventmanager.processors.MaskPasswords
- processXML(String) - Method in interface com.github.eventmanager.processors.Processor
-
Processes an XML formatted event.
- processXML(String) - Method in class com.github.eventmanager.processors.RegexProcessor
R
- readLogFile() - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Reads the log file and returns its content as a list of strings.
- RegexEntry - Class in com.github.eventmanager.filehandlers.config
- RegexEntry() - Constructor for class com.github.eventmanager.filehandlers.config.RegexEntry
- RegexProcessor - Class in com.github.eventmanager.processors
-
The RegexProcessor class is responsible for processing events using regular expressions.
- RegexProcessor() - Constructor for class com.github.eventmanager.processors.RegexProcessor
- rotateLogFile(File) - Method in class com.github.eventmanager.filehandlers.LogHandler
-
Rotates the log file using the specified compression format.
S
- setCompressionFormat(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Sets the compression format to use when rotating log files.
- setCorrectOSSeperator(String) - Static method in class com.github.eventmanager.EventManager
-
Sets the correct OS-specific file separator in the given path.
- setDebuggingMode(boolean) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets whether debugging mode is enabled.
- setEnabled(boolean) - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Enables or disables the internal events file handler.
- setEventFormat(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets the event format for logging events.
- setFileExtension(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Sets the file extension for the internal events log.
- setFileExtension(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Sets the file extension for the log files.
- setFileName(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Sets the file name for the internal events log.
- setFileName(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Sets the file name for the log files.
- setFilePath(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigInternalEvents
-
Sets the file path where the internal events log will be stored.
- setFilePath(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogFile
-
Sets the file path for the log files.
- setInformationalMode(boolean) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets whether informational mode is enabled.
- setMaxSizeInKB(int) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Sets the maximum size of log files in kilobytes before rotation is triggered.
- setMetaDataFields(String) - Method in class com.github.eventmanager.InternalEventManager
-
Sets the metadata fields for the event.
- setPrintAndSaveToFile(boolean) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets whether logs should be printed and saved to a file.
- setPrintToConsole(boolean) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets whether logs should be printed to the console.
- setRotationPeriodInSeconds(int) - Method in class com.github.eventmanager.filehandlers.config.ConfigLogRotate
-
Sets the rotation period in seconds after which log files should be rotated.
- setTimeFormat(String) - Method in class com.github.eventmanager.filehandlers.config.ConfigEvent
-
Sets the time format for logging events.
- stopEventThread() - Method in class com.github.eventmanager.EventManager
-
Stops the event thread by interrupting it and waiting for it to finish.
- stopEventThread() - Method in class com.github.eventmanager.InternalEventManager
T
- threadID() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the thread ID to the event.
- threadName() - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the thread name to the event.
- timestamp(String) - Method in class com.github.eventmanager.formatters.EventCreator
-
Appends the timestamp of the log to the event log.
- TimeStampFormatter - Class in com.github.eventmanager.formatters
-
The TimeStampFormatter class provides utility methods for validating time formats.
- TimeStampFormatter() - Constructor for class com.github.eventmanager.formatters.TimeStampFormatter
- toString() - Method in class com.github.eventmanager.formatters.KeyValueWrapper
-
Returns a string representation of the key-value pair in the format key="value".
V
- valueOf(String) - Static method in enum class com.github.eventmanager.formatters.EventFormatter
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.eventmanager.formatters.EventFormatter
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- writeEventToLogFile(String) - Method in class com.github.eventmanager.EventManager
- writeEventToLogFile(String) - Method in class com.github.eventmanager.InternalEventManager
-
Logs a message with the specified level and message to the log file.
- writeEventToProcessingQueue(String) - Method in class com.github.eventmanager.InternalEventManager
- writeEventToQueue(String) - Method in class com.github.eventmanager.InternalEventManager
-
Writes the given event to the event queue.
X
- XML - Enum constant in enum class com.github.eventmanager.formatters.EventFormatter
-
The XML formatter formats the event metadata and arguments in an XML format.
Z
- Zip - Class in com.github.eventmanager.compressors
-
The Zip class provides methods for compressing files using the ZIP format.
- Zip() - Constructor for class com.github.eventmanager.compressors.Zip
All Classes and Interfaces|All Packages
LogHandler
class from the com.github.eventmanager package instead.