Index (ipguard4j 0.1.0-alpha API)

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values

A

addAndFetchListSource(IpListParser, URI, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URI as a (additional) source for an IP-address list in the IpListAggregator that is being built, whereby that list is expected to be formatted such that the given IpListParser can parse it.
addAndFetchListSource(URI, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URI as a (additional) source for an IP-address list in the IpListAggregator that is being built, whereby that list is expected to be formatted in plain-text format.
addAndFetchListSources(IpListParser, HashSet, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted such that the given IpListParser can parse them.
addAndFetchListSources(IpListParser, HashSet, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted such that the given IpListParser can parse them.
addAndFetchListSources(HashSet, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted such that the given IpListParser can parse them.
addCommentSymbol(char) - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.FinalBuilder: Inserts the given character into the PlainIpListParser.FinalBuilder.commentCharacters of the PlainIpListParser that is being built.
addListSource(IpListParser, URI) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URI as a (additional) source for an IP-address list in the IpListAggregator that is being built, whereby that list is expected to be formatted such that the given IpListParser can parse it.
addListSource(URI) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URI as a (additional) source for an IP-address list in the IpListAggregator that is being built, whereby that list is expected to be formatted in plain-text format.
addListSources(IpListParser, HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted such that the given IpListParser can parse them.
addListSources(IpListParser, HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted such that the given IpListParser can parse them.
addListSources(HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Sets up the given URIs as (additional) sources for IP-address lists in the IpListAggregator that is being built, whereby those lists are expected to be formatted in plain-text format.
addOption(IpListAggregator.FinalBuilder.Option) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder: Enables the given IpListAggregator.FinalBuilder.Option for the IpListAggregator that is being built.
addSourceUris(IpListParser, HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Inserts the given IP-list URIs into the IpListAggregator.sourceUris map for the given IpListParser.
addSourceUris(IpListParser, HashSet, boolean, ProgressListener, Supplier, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Inserts the given IP-list URIs into the IpListAggregator.sourceUris map for the given IpListParser.
addTargetFile(IpAddressFormatter, File) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given File as an (additional) target file for the IpListAggregator that is being built, whereby that new file shall be written in the given IpAddressFormatter format by IpListAggregator.writeToFiles() when called in the future.
addTargetFile(File) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given File as an (additional) target file for the IpListAggregator that is being built, whereby that new file shall be written in the plain format by IpListAggregator.writeToFiles() when called in the future.
addTargetFiles(IpAddressFormatter, HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given Files as (additional) target files for the IpListAggregator that is being built, whereby each of those new files shall be written in the given IpAddressFormatter format by IpListAggregator.writeToFiles() when called in the future.
addTargetFiles(IpAddressFormatter, HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder: Sets up the given Files as (additional) target files for the IpListAggregator that is being built, whereby each of those new files shall be written in the given IpAddressFormatter format by IpListAggregator.writeToFiles() when called in the future.
addTargetFiles(HashSet) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: Sets up the given Files as (additional) target files for the IpListAggregator that is being built, whereby each of those new files shall be written in plain format by IpListAggregator.writeToFiles() when called in the future.
aggregate() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Downloads the IP lists, parses all IPAddresses contained in them, removes any duplicates in the process and then writes all IP addresses to the IpListAggregator.targetFiles in the corresponding formats.
aggregator - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls: The IpListAggregator that is being built by this IpListAggregator.BuilderWithSourceUrls.
aggregator - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder: The IpListAggregator that has been built so far.

B

build() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder
build() - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.FinalBuilder
builder() - Static method in class de.gustavblass.nginx.ipguard4j.IpListAggregator
builder() - Static method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser
BuilderWithSourceUrls() - Constructor for class de.gustavblass.nginx.ipguard4j.IpListAggregator.BuilderWithSourceUrls

C

call() - Method in class de.gustavblass.nginx.ipguard4j.cli.IpGuard: Depending on the IpGuard.mode, does the following:
code - Variable in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode
COMMAND - Static variable in class de.gustavblass.nginx.ipguard4j.Main: The name of the terminal command used to invoke the program when it has been installed on a Linux system via a package manager.
commentCharacters - Variable in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser: Symbols that mark the beginning of a comment in a plain IP-list entry.
commentCharacters - Variable in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.FinalBuilder: The selected PlainIpListParser.FinalBuilder.commentCharacters for the PlainIpListParser that is being built.
Configuration - Class in de.gustavblass.nginx.ipguard4j.configuration: Specifies the behaviour of IPguard4j.
Configuration() - Constructor for class de.gustavblass.nginx.ipguard4j.configuration.Configuration
CONFIGURATION_FILE_DOES_NOT_EXIST - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given configuration file does not exist at the specified path.
CONFIGURATION_FILE_DOES_NOT_MATCH_EXPECTED_FORMAT - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given Configuration does not match the expected format.
CONFIGURATION_FILE_IS_NOT_A_FILE - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given configuration file is not a regular file (e.g. it is a directory).
configurationFile - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.ConfigurationMode
configurationMode - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode: Runs IpGuard with the given configuration file.
ConfigurationMode() - Constructor for class de.gustavblass.nginx.ipguard4j.cli.IpGuard.ConfigurationMode
CustomIpAddressFormatter - Class in de.gustavblass.nginx.ipguard4j: IpAddressFormatter that uses a custom CustomIpAddressFormatter.format to convert an IPAddress to some string representation.
CustomIpAddressFormatter(String) - Constructor for class de.gustavblass.nginx.ipguard4j.CustomIpAddressFormatter: Creates a new CustomIpAddressFormatter that turns IPAddresss into the string representation defined by given CustomIpAddressFormatter.format.

D

de.gustavblass.nginx.ipguard4j - module de.gustavblass.nginx.ipguard4j: Module for the IPguard4j application.
de.gustavblass.nginx.ipguard4j - package de.gustavblass.nginx.ipguard4j
de.gustavblass.nginx.ipguard4j.cli - package de.gustavblass.nginx.ipguard4j.cli
de.gustavblass.nginx.ipguard4j.configuration - package de.gustavblass.nginx.ipguard4j.configuration
de.gustavblass.nginx.ipguard4j.parser - package de.gustavblass.nginx.ipguard4j.parser
DEBUG - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
DEFAULT_COMMENT_CHARACTERS - Static variable in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser: Pre-defined symbols that mark the beginning of a comment in a plain IP-list entry.
DEFAULT_IP_ADDRESS_FORMATTERS - Static variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: The pre-defined IP-address formatters available for use:
disableProgressBars - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.ConfigurationMode
downloadUri(URI, IpListParser, Supplier, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Fetches a single list of IPAddresses and processes each of them.

E

equals(Object) - Method in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
EXAMPLE_YAML_CONFIGURATION_PATH - Static variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: The path to the example YAML configuration file, relative to the application's resources folder (with the package name as folder structure inside).
ExitCode - Enum Class in de.gustavblass.nginx.ipguard4j.cli: The exit status indicated by the program when it terminates.
ExitCode(int) - Constructor for enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode

F

FATAL - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
fetch() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Downloads all IP lists in parallel, each in its own virtual thread, and processes all contained IP addresses.
fetch(ProgressListener) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Downloads all IP lists in parallel, each in its own virtual thread, and processes all contained IP addresses.
fetcher - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Used to download the IpListAggregator.sourceUris.
fetcherLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.fetcher.
fetchList(URI) - Method in class de.gustavblass.nginx.ipguard4j.IpListClient: Downloads the IP-address list from the given URI.
fetchList(URI) - Method in interface de.gustavblass.nginx.ipguard4j.IpListFetcher: Downloads the list of IP addresses from the given URI.
fetchLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for fetching.
FinalBuilder() - Constructor for class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.FinalBuilder
FinalBuilder(IpListAggregator) - Constructor for class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder: Creates a new IpListAggregator.FinalBuilder with the pre-built given IpListAggregator.
format - Variable in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration: The format of the IP-address lists.
format - Variable in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration: The format for each IP address (each in a separate line) in the output files.
format - Variable in class de.gustavblass.nginx.ipguard4j.CustomIpAddressFormatter: In the order defined by the List, executing the Functions converts an IPAddress to the desired string representation.
format(IPAddress) - Method in class de.gustavblass.nginx.ipguard4j.CustomIpAddressFormatter: Converts the given IPAddress to a string representation according to the CustomIpAddressFormatter.format previously defined.
format(IPAddress) - Method in interface de.gustavblass.nginx.ipguard4j.IpAddressFormatter: Converts the given IPAddress into a string representation in some format.

G

getConfigurationMode() - Method in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode
getFetcher() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Retrieves the IpListAggregator.fetcher.
getFormat() - Method in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration
getFormat() - Method in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration
getIpLists() - Method in class de.gustavblass.nginx.ipguard4j.configuration.Configuration
getListUris() - Method in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration
getLockableSuccess(URI) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Retrieves the IpListAggregator.LockableSuccess for the given IP-list URI from the IpListAggregator.sourceUrisLocks map.
getNumberOfSourceUris() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator
getNumberOfTargetFiles() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator
getTargetFiles() - Method in class de.gustavblass.nginx.ipguard4j.configuration.Configuration
getTargetFiles() - Method in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration
getUserAgent() - Static method in class de.gustavblass.nginx.ipguard4j.IpListClient: Computes the IpListClient.USER_AGENT based on the Main.NAME and version.
getVersion() - Method in class de.gustavblass.nginx.ipguard4j.cli.VersionProvider
getVersion() - Static method in class de.gustavblass.nginx.ipguard4j.Main

H

handleLoggingArguments() - Method in class de.gustavblass.nginx.ipguard4j.cli.IpGuard: Enables or disables logging based on the command-line parameters passed to the program.
hashCode() - Method in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Returns a hash code value for this object.
hashCode() - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser
httpClient - Variable in class de.gustavblass.nginx.ipguard4j.IpListClient: The HTTP client that will be used to make the actual requests to the given URIs.

I

INFO - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
initialiseLockableSuccesses(Collection) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Creates a new IpListAggregator.LockableSuccess for each URI in the given sourceUris collection and stores each one in the IpListAggregator.sourceUrisLocks map (if no corresponding entry already exists).
INSTALLATION_TYPE - Static variable in class de.gustavblass.nginx.ipguard4j.Main: The way the program was actually installed on the system running it.
InstallationType(String) - Constructor for enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType
INTERNAL_ERROR - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An unexpected error occurred that does not fall into any of the other categories.
INTERRUPTED - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An InterruptedException occurred.
INVALID_COMMAND_LINE_ARGUMENTS - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given command-line parameters were invalid.
INVALID_CONFIGURATION - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given Configuration file was invalid.
INVALID_LOGGING_LEVEL - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The given logging Level was invalid.
IO_ERROR - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An input/output error occurred.
IO_ERROR_WHILE_FETCHING_IP_LISTS - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An input/output error occurred while downloading the IP list(s).
IO_ERROR_WHILE_READING_CONFIGURATION_FILE - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An input/output error occurred while reading the configuration file.
IO_ERROR_WHILE_READING_RESOURCE_FILE - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An input/output error occurred while reading a File in the application's resources folder.
IO_ERROR_WHILE_WRITING_IP_LISTS - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: An input/output error occurred while writing the IP list(s) to the target file(s).
IP_ADDRESS_CAPTURE_GROUP_NAME - Static variable in class de.gustavblass.nginx.ipguard4j.parser.PatternBasedIpListParser: The name of the capture group in the regular expression that contains the IP address.
IpAddressFormatter - Interface in de.gustavblass.nginx.ipguard4j: Converts any given IPAddress into a string representation in some format.
IpGuard - Class in de.gustavblass.nginx.ipguard4j.cli: The main class of the application.
IpGuard() - Constructor for class de.gustavblass.nginx.ipguard4j.cli.IpGuard
IpGuard.ConfigurationMode - Class in de.gustavblass.nginx.ipguard4j.cli: Groups the options that are only meaningful in combination with IpGuard.ConfigurationMode.configurationFile.
IpGuard.Mode - Class in de.gustavblass.nginx.ipguard4j.cli: Contains the different quasi-subcommands that are available to users.
IpListAggregator - Class in de.gustavblass.nginx.ipguard4j: Downloads lists of IP addresses, compiles them into a deduplicated collection and writes it to oen or more target files in custom formats.
IpListAggregator() - Constructor for class de.gustavblass.nginx.ipguard4j.IpListAggregator
IpListAggregator.BuilderWithSourceUrls - Class in de.gustavblass.nginx.ipguard4j: In order to finally build the IpListAggregator, at least one target file must be added.
IpListAggregator.FinalBuilder - Class in de.gustavblass.nginx.ipguard4j: As many list sources, target files and options as desired as well as a custom client can be added to the IpListAggregator before finally building it.
IpListAggregator.FinalBuilder.Option - Enum Class in de.gustavblass.nginx.ipguard4j: Settings to influence the behaviour of the IpListAggregator that is being built.
IpListAggregator.LockableSuccess - Record Class in de.gustavblass.nginx.ipguard4j: Cache entry for an entry from the IP lists.
IpListAggregator.StartBuilder - Class in de.gustavblass.nginx.ipguard4j: Before the IpListAggregator can finally be built, either
IpListClient - Class in de.gustavblass.nginx.ipguard4j: Downloads lists of IP addresses from given URIs.
IpListClient() - Constructor for class de.gustavblass.nginx.ipguard4j.IpListClient: Creates a new IpListClient with a default OkHttpClient.
IpListClient(OkHttpClient) - Constructor for class de.gustavblass.nginx.ipguard4j.IpListClient: Creates a new IpListClient with the given OkHttpClient.
IpListConfiguration - Class in de.gustavblass.nginx.ipguard4j.configuration: Represents a collection of IP-address lists sharing a common format.
IpListConfiguration() - Constructor for class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration
IpListFetcher - Interface in de.gustavblass.nginx.ipguard4j: A client that downloads a list of IP addresses from a given URI.
IpListParser - Interface in de.gustavblass.nginx.ipguard4j.parser: Converts a single entry of an IP-address list into an IPAddress object.
ipLists - Variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: The input lists from which the IP addresses will be parsed.
ipv4Collection - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Contains all IPv4 addresses from all IP lists.
ipv4CollectionLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.ipv4Collection.
ipv6Collection - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Contains all IPv6 addresses from all IP lists.
ipv6CollectionLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.ipv6Collection.

J

JAR - Enum constant in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType: The program is just a JAR file which can be executed with java -jar <JAR_NAME>.
JAR_NAME - Static variable in class de.gustavblass.nginx.ipguard4j.Main: The file name of the JAR which contains the compiled program currently running.
JSON_SCHEMA_PATH - Static variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: The path to the JSON schema for Configuration files, relative to the application's resources folder (with the package name as folder structure inside).

L

label - Variable in enum class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder.Option
label - Variable in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType
listUris - Variable in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration: The actual URIs pointing to the IP-address lists.
lock - Variable in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: The field for the lock record component.
lock() - Method in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Returns the value of the lock record component.
LockableSuccess(ReentrantReadWriteLock, boolean) - Constructor for record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Creates an instance of a LockableSuccess record class.
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.cli.ResourceFilePrinter
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.IpListClient
LOG - Static variable in class de.gustavblass.nginx.ipguard4j.Main
logFile - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard
logLevel - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard
LogLevel - Enum Class in de.gustavblass.nginx.ipguard4j.cli: Represents the log Levels supported by Log4j.
LogLevel(String) - Constructor for enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel

M

main(String[]) - Static method in class de.gustavblass.nginx.ipguard4j.Main: Parses the Configuration passed to the program via the command-line parameters, downloads the IP lists specified, deduplicates the IP-address entries and saves the resulting collection to the configured target files.
Main - Class in de.gustavblass.nginx.ipguard4j
Main() - Constructor for class de.gustavblass.nginx.ipguard4j.Main
Main.InstallationType - Enum Class in de.gustavblass.nginx.ipguard4j: Indicates how the program has been deployed on a system.
mode - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard: Exactly one of the quasi-subcommands defined by IpGuard.Mode must be specified.
Mode() - Constructor for class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode

N

name - Variable in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
NAME - Static variable in class de.gustavblass.nginx.ipguard4j.Main: Human-readable title of the application, as used in the name of the JAR file.
NATIVE - Enum constant in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType: The program has been installed as a native executable/command on the system (e.g. via a package manager).
numberOfTargetFiles - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: The number of IpListAggregator.targetFiles.
numberOfUris - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: The number of IP lists to be downloaded and parsed.

O

ofConfiguration(Configuration) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Processes the given Configuration and returns a IpListAggregator.FinalBuilder which can be used to build the IpListAggregator.
ofConfiguration(Configuration, boolean, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Processes the given Configuration and returns a IpListAggregator.FinalBuilder which can be used to build the IpListAggregator.
ofConfigurationAndFetch(Configuration, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Processes the given Configuration and returns a IpListAggregator.FinalBuilder which can be used to build the IpListAggregator.
ofConfigurationParallel(Configuration, boolean, ProgressListener, Consumer) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Processes the given Configuration in parallelised manner, whereby adding the IP lists and adding the target files is done simultaneously in separate virtual threads.
ofConfigurationSequential(Configuration, boolean, ProgressListener) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder: Processes the given Configuration without parallelisation.
OFF - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
ofLabel(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType: Converts the given label to the matching enum value.
ofName(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel: Converts the given label to the matching enum value.
onProgress(int, int) - Method in interface de.gustavblass.nginx.ipguard4j.ProgressListener: Invoked after further items have been processed, i.e.
Option(String) - Constructor for enum class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder.Option
OVERWRITE_EXISTING_TARGET_FILES - Enum constant in enum class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder.Option: If set, IpListAggregator.writeToFiles() will overwrite specified target files if they already exist at the specified location on the filesystem.
overwriteExistingTargetFiles - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.ConfigurationMode
overwriteExistingTargetFiles - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Whether the IpListAggregator.targetFiles should be overwritten if they already exist.

P

PARALLEL_LIST_PARSING_WINDOW_SIZE - Static variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator

Determines how many IP addresses should be parsed in each thread.

PARALLELISM_THRESHOLD_IP_LISTS - Static variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder

The threshold for the number of IP lists above which the processing shall be done in parallel.

PARALLELISM_THRESHOLD_TARGET_FILES - Static variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder

The threshold for the number of target files above which the processing shall be done in parallel.

parse(String) - Static method in class de.gustavblass.nginx.ipguard4j.CustomIpAddressFormatter

Converts the given string format to list of Functions that can be used to format an IPAddress according to the given format, when executed in the correct order.

parse(String) - Method in interface de.gustavblass.nginx.ipguard4j.parser.IpListParser

Converts the given plain-text entry (in some format) of an IP-address list into an IPAddress object.

parse(String) - Method in class de.gustavblass.nginx.ipguard4j.parser.PatternBasedIpListParser

Converts the given plain-text entry (in the format defined by the regular expression) of an IP-address list into an IPAddress object.

parse(String) - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser

Converts the given plain-text entry of an IP-address list into an IPAddress object.

parseConfiguration() - Method in class de.gustavblass.nginx.ipguard4j.cli.IpGuard

Creates a Configuration object from the YAML configuration file.

parseYAML(File) - Static method in class de.gustavblass.nginx.ipguard4j.configuration.Configuration

Converts the given YAML-formatted configuration File to a new Configuration.

pattern - Variable in class de.gustavblass.nginx.ipguard4j.parser.PatternBasedIpListParser

The regular expression that is used to extract the IP address from the list entry.

PatternBasedIpListParser - Class in de.gustavblass.nginx.ipguard4j.parser

A parser for IP-address list entries that uses a regular expression to extract the IP address.

PatternBasedIpListParser(Pattern) - Constructor for class de.gustavblass.nginx.ipguard4j.parser.PatternBasedIpListParser

Creates a new PatternBasedIpListParser that uses the given regular expression to extract IPAddresses from entries of an IP list.

PlainIpListParser - Class in de.gustavblass.nginx.ipguard4j.parser

A parser that extracts IPAddresses from plain IP-list entries, without special formatting (other than comments).

PlainIpListParser() - Constructor for class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser

PlainIpListParser.FinalBuilder - Class in de.gustavblass.nginx.ipguard4j.parser

FinalBuilder ::= '#addCommentSymbol'* build PlainIpListParser

PlainIpListParser.StartBuilder - Class in de.gustavblass.nginx.ipguard4j.parser

StartBuilder ::= ( '#withDefaultCommentSymbols' | '#withoutDefaultCommentSymbols' )
                 FinalBuilder

printExampleConfiguration - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode

printJsonSchema - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode

printResourceFile(String) - Static method in class de.gustavblass.nginx.ipguard4j.cli.ResourceFilePrinter

Reads the given resource File and prints its content to the console.

printYamlSchema - Variable in class de.gustavblass.nginx.ipguard4j.cli.IpGuard.Mode

processListEntry(String, IpListParser) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator

Uses the given IpListParser to parse the given listEntry as an IPAddress.

ProgressListener - Interface in de.gustavblass.nginx.ipguard4j

Callback that is invoked to inform the callee about the progress status of some operation.

R

ResourceFilePrinter - Class in de.gustavblass.nginx.ipguard4j.cli
ResourceFilePrinter() - Constructor for class de.gustavblass.nginx.ipguard4j.cli.ResourceFilePrinter

S

setFiles(Collection) - Method in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration: Updates the TargetConfiguration.targetFiles.
setFormat(String) - Method in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration: Updates the IpListConfiguration.format.
setFormat(String) - Method in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration: Updates the TargetConfiguration.format.
setIpLists(Collection) - Method in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: Updates the Configuration.ipLists with the given new ones.
setListUris(Collection) - Method in class de.gustavblass.nginx.ipguard4j.configuration.IpListConfiguration: Updates the IpListConfiguration.listUris.
setLoggingLevel(Level, File, boolean) - Static method in class de.gustavblass.nginx.ipguard4j.Main: Configures Log4J to log to the console and to the file specified by logFilePath.
setTargetFiles(Collection) - Method in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: Updates the Configuration.targetFiles with the given new ones.
SHUTDOWN_HOOK - Static variable in class de.gustavblass.nginx.ipguard4j.Main: Prints a farewell message to the console.
sourceUris - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: The lists of IPAddresses to be downloaded, grouped by IpListParsers for common formats.
sourceUrisLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.sourceUris and IpListAggregator.numberOfUris.
sourceUrisLocks - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Cache for the IpListAggregator.sourceUris, indicating whether each IP list has already been successfully downloaded and parsed.
sourceUrisLocksLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.sourceUrisLocks.
StartBuilder() - Constructor for class de.gustavblass.nginx.ipguard4j.IpListAggregator.StartBuilder
StartBuilder() - Constructor for class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.StartBuilder
success - Variable in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: The field for the success record component.
success() - Method in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Returns the value of the success record component.
SUCCESS - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: The program terminated successfully.

T

TargetConfiguration - Class in de.gustavblass.nginx.ipguard4j.configuration: Represents a collection of output files to which the IP addresses shall be written in the same format.
TargetConfiguration() - Constructor for class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration
targetFileCache - Variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: Tracks efficiently all target files that have already been configured in Configuration.targetFiles.
targetFiles - Variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: The destination files to which the parsed IP addresses will be written.
targetFiles - Variable in class de.gustavblass.nginx.ipguard4j.configuration.TargetConfiguration: The output files to which the IP addresses shall be written.
targetFiles - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: The output files which the IPAddresses from the IP lists shall be written to, grouped by IpAddressFormatters for common formats.
targetFilesLock - Variable in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Facilitates mutual exclusion for the IpListAggregator.targetFiles, IpListAggregator.numberOfTargetFiles and IpListAggregator.overwriteExistingTargetFiles.
toString() - Method in record class de.gustavblass.nginx.ipguard4j.IpListAggregator.LockableSuccess: Returns a string representation of this record class.
TRACE - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel

U

USER_AGENT - Static variable in class de.gustavblass.nginx.ipguard4j.IpListClient: The user agent string that the application will send with each HTTP request.
USER_AGENT_LOCK - Static variable in class de.gustavblass.nginx.ipguard4j.IpListClient: Ensures mutual exclusion when accessing the IpListClient.USER_AGENT.

V

valueOf(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder.Option: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class de.gustavblass.nginx.ipguard4j.cli.ExitCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder.Option: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class de.gustavblass.nginx.ipguard4j.Main.InstallationType: Returns an array containing the constants of this enum class, in the order they are declared.
VERSION - Static variable in class de.gustavblass.nginx.ipguard4j.Main: The current version of the application.
VERSION_FILE_PATH - Static variable in class de.gustavblass.nginx.ipguard4j.Main: The path to / name of the Properties file which contains the version of the program, relative to the Main class' resource folder.
VERSION_LOCK - Static variable in class de.gustavblass.nginx.ipguard4j.Main: Ensures mutual exclusion when accessing the Main.VERSION.
VersionProvider - Class in de.gustavblass.nginx.ipguard4j.cli: Tells the CommandLine library how the Main.VERSION.
VersionProvider() - Constructor for class de.gustavblass.nginx.ipguard4j.cli.VersionProvider

W

WARN - Enum constant in enum class de.gustavblass.nginx.ipguard4j.cli.LogLevel
withClient(IpListFetcher) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator.FinalBuilder: Sets the given IpListFetcher as the client that will be used to fetch the IP lists in the future.
withDefaultCommentSymbols() - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.StartBuilder: Uses the PlainIpListParser.DEFAULT_COMMENT_CHARACTERS for the PlainIpListParser.commentCharacters of the PlainIpListParser to be built.
withoutDefaultCommentSymbols() - Method in class de.gustavblass.nginx.ipguard4j.parser.PlainIpListParser.StartBuilder: Omits the PlainIpListParser.DEFAULT_COMMENT_CHARACTERS from the PlainIpListParser.commentCharacters of the PlainIpListParser to be built.
writeToFiles() - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Saves all IPAddresses from the IpListAggregator.ipv4Collection and IpListAggregator.ipv6Collection to each of the IpListAggregator.targetFiles in the corresponding formats.
writeToFiles(ProgressListener) - Method in class de.gustavblass.nginx.ipguard4j.IpListAggregator: Saves all IPAddresses from the IpListAggregator.ipv4Collection and IpListAggregator.ipv6Collection to each of the IpListAggregator.targetFiles in the corresponding formats.

Y

YAML_SCHEMA_PATH - Static variable in class de.gustavblass.nginx.ipguard4j.configuration.Configuration: The path to the YAML schema for Configuration files, relative to the application's resources folder (with the package name as folder structure inside).

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values