gs.mclo.java

Class Log

java.lang.Object

gs.mclo.java.Log

public class Log
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	ALLOWED_FILE_NAME_PATTERN Only allow logs with the file extension `.log` or `.txt` (can be suffixed by both `.0` and `.gz` in that order)
protected java.lang.String	content log content
static java.util.regex.Pattern[]	IPV4_FILTER whitelist patterns for IPv4 addresses
static java.util.regex.Pattern	IPV4_PATTERN pattern for IPv4 addresses
static java.util.regex.Pattern[]	IPV6_FILTER whitelist patterns for IPv4 addresses
static java.util.regex.Pattern	IPV6_PATTERN pattern for IPv6 addresses
static int	MAX_LOG_LENGTH Maximum length of log files that can be uploaded in bytes

Constructor Summary

Constructors

Constructor and Description
Log(java.nio.file.Path logFile) Create a new Log
Log(java.lang.String content) Create a new Log
Log(java.lang.String dir, java.lang.String file) Deprecated. Use Log(Path) instead

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContent()

Methods inherited from class java.lang.Object

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

Field Detail

content

protected java.lang.String content

log content

IPV4_PATTERN

public static final java.util.regex.Pattern IPV4_PATTERN

pattern for IPv4 addresses

IPV4_FILTER

public static final java.util.regex.Pattern[] IPV4_FILTER

whitelist patterns for IPv4 addresses

IPV6_PATTERN

public static final java.util.regex.Pattern IPV6_PATTERN

pattern for IPv6 addresses

IPV6_FILTER

public static final java.util.regex.Pattern[] IPV6_FILTER

whitelist patterns for IPv4 addresses

ALLOWED_FILE_NAME_PATTERN

public static final java.util.regex.Pattern ALLOWED_FILE_NAME_PATTERN

Only allow logs with the file extension `.log` or `.txt` (can be suffixed by both `.0` and `.gz` in that order)

MAX_LOG_LENGTH

public static final int MAX_LOG_LENGTH

Maximum length of log files that can be uploaded in bytes

See Also:

Constant Field Values

Constructor Detail

Log

public Log(java.nio.file.Path logFile)
    throws java.io.IOException

Create a new Log

Parameters:

logFile - The log file, which must have a file extension of '.log' or '.txt'. The file extension may be suffixed by both `.0` and `.gz`

Throws:

java.io.IOException - If an exception occurs while reading the logFile

Log

public Log(java.lang.String content)

Create a new Log

Parameters:

content - The whole content of the log to share.

Log

@Deprecated
public Log(java.lang.String dir,
                       java.lang.String file)
                throws java.io.IOException

Deprecated. Use Log(Path) instead

Create a new Log

Parameters:

dir - The parent directory of the log file

file - The log file, which must have a file extension of '.log' or '.txt'. The file extension may be suffixed by both `.0` and `.gz`

Throws:

java.io.IOException - If an exception occurs while reading the logFile

Method Detail

getContent

public java.lang.String getContent()

Returns:

log content