Class IpListClient

java.lang.Object

de.gustavblass.nginx.ipguard4j.IpListClient

All Implemented Interfaces:

IpListFetcher

public class IpListClient
extends Object
implements IpListFetcher

Downloads lists of IP addresses from given URIs.

See Also:

• fetchList(URI)

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull okhttp3.OkHttpClient	httpClient	The HTTP client that will be used to make the actual requests to the given URIs.
private static final @NonNull org.apache.logging.log4j.Logger	LOG
private static @Nullable String	USER_AGENT	The user agent string that the application will send with each HTTP request.
private static final @NonNull ReentrantReadWriteLock	USER_AGENT_LOCK	Ensures mutual exclusion when accessing the USER_AGENT.

Constructor Summary

Constructors

Constructor	Description
IpListClient()	Creates a new IpListClient with a default OkHttpClient.
IpListClient(@NonNull okhttp3.OkHttpClient httpClient)	Creates a new IpListClient with the given OkHttpClient.

Method Summary

Modifier and Type	Method	Description
@NonNull Stream<String>	fetchList(@NonNull URI sourceUri)	Downloads the IP-address list from the given URI.
private static @NonNull String	getUserAgent()	Computes the USER_AGENT based on the Main.NAME and version.

Methods inherited from class Object

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

Field Details

LOG

@NonNull
private static final @NonNull org.apache.logging.log4j.Logger LOG

USER_AGENT

@Nullable
private static @Nullable String USER_AGENT

The user agent string that the application will send with each HTTP request.

Access only through getUserAgent()!

USER_AGENT_LOCK

@NonNull
private static final @NonNull ReentrantReadWriteLock USER_AGENT_LOCK

Ensures mutual exclusion when accessing the USER_AGENT.

httpClient

@NonNull
private final @NonNull okhttp3.OkHttpClient httpClient

The HTTP client that will be used to make the actual requests to the given URIs.

Constructor Details

IpListClient

public IpListClient()

Creates a new IpListClient with a default OkHttpClient.

IpListClient

public IpListClient(@NonNull
 @NonNull okhttp3.OkHttpClient httpClient)

Creates a new IpListClient with the given OkHttpClient.

Parameters:

httpClient - The httpClient.

Method Details

fetchList

@Contract(mutates="io")
@NonNull
public @NonNull Stream<String> fetchList(@NonNull
 @NonNull URI sourceUri)
                                  throws IOException,
UncheckedIOException

Downloads the IP-address list from the given URI.

Specified by:

fetchList in interface IpListFetcher

Parameters:

sourceUri - The address from which to download the IP address list.

Returns:

A Stream of the individual lines that the list consists of.

Throws:

IOException - If an error occurs while downloading the list.

UncheckedIOException - If the BufferedReader or the HTTP Response cannot be closed after the Stream is closed.

getUserAgent

@NonNull
private static @NonNull String getUserAgent()

Computes the USER_AGENT based on the Main.NAME and version.

Returns:

The USER_AGENT string.

Implementation Note:

Acquires the USER_AGENT_LOCK's read lock first, and if the USER_AGENT has not yet been computed, acquires the write lock to compute it.