Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.configuration.client

Class Client

java.lang.Object

page.codeberg.friedolyn.configuration.client.Client

All Implemented Interfaces:

Copyable<Client>

public class Client
extends Object
implements Copyable<Client>

Stores various options for the HTTP client that will connect to the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Client.ClientKind	The kind of client to use for the HTTP requests.

Field Summary

Fields

Modifier and Type	Field	Description
private @NonNull Boolean	doNotTrack	The Do Not Track header indicates whether the user would prefer privacy rather than personalised content.
private @NonNull Boolean	globalPrivacyControl	The Global Privacy Control header indicates whether the user consents to a website or service selling or sharing their personal information with third parties.
private @NonNull Client.ClientKind	preferredClientKind	The kind of client to use for the HTTP requests.
private @NonNull String	userAgent	The user agent to use for the HTTP client.

Constructor Summary

Constructors

Modifier	Constructor	Description
	Client()
	Client(String userAgent)	Creates a new client with the given user agent by calling setUserAgent(String).
private	Client(String userAgent, Boolean doNotTrack, Boolean globalPrivacyControl, String preferredClientKind)	Creates a new client with the given user agent, Do Not Track and Global Privacy Control settings.
	Client(UserAgentManager.Client client, UserAgentManager.Platform platform)	Creates a new client with the given user agent.

Method Summary

Modifier and Type	Method	Description
@NonNull Client	copy()
boolean	equals(Object object)	Checks whether the fields of this client are equal to the fields of another client.
boolean	equalsDefault()	Checks whether the fields of this client are equal to the default values, i.e.
void	setDoNotTrack(Boolean doNotTrack)	Updates the doNotTrack field.
void	setGlobalPrivacyControl(Boolean globalPrivacyControl)	Updates the globalPrivacyControl field.
private void	setNullableUserAgent(String userAgent)	Deprecated. Only to be used by Jackson for deserialisation.
private void	setPreferredClientKind(String preferredClientKind)	Deprecated. Only to be used by Jackson for deserialisation.
void	setPreferredClientKind(Client.ClientKind preferredClientKind)	Updates the preferredClientKind field.
void	setUserAgent(@NonNull String userAgent)	Updates the userAgent field with the given one.
void	setUserAgent(UserAgentManager.Client client, UserAgentManager.Platform platform)	Updates the userAgent field with the given parameters.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Details

preferredClientKind

@NonNull
private @NonNull Client.ClientKind preferredClientKind

The kind of client to use for the HTTP requests. Defaults to Client.ClientKind.HTTP_CLIENT.

userAgent

@NonNull
private @NonNull String userAgent

The user agent to use for the HTTP client. Defaults to FRIEDOLYN without a platform specified.

doNotTrack

@NonNull
private @NonNull Boolean doNotTrack

The Do Not Track header indicates whether the user would prefer privacy rather than personalised content.

globalPrivacyControl

@NonNull
private @NonNull Boolean globalPrivacyControl

The Global Privacy Control header indicates whether the user consents to a website or service selling or sharing their personal information with third parties.

Constructor Details

Client

public Client()

Implementation Note:

For some reason, when using NoArgsConstructor, Builder complains that it needs "a proper constructor", so we need to define a no-argument constructor ourselves.

Client

public Client(UserAgentManager.Client client,
 UserAgentManager.Platform platform)

Creates a new client with the given user agent.

Parameters:

client - The name of the client that the user agent should indicate.

platform - The operating system or device that the user agent should indicate.

Client

public Client(String userAgent)

Creates a new client with the given user agent by calling setUserAgent(String).

Parameters:

userAgent - Same as in setUserAgent(String).

Client

private Client(String userAgent,
 Boolean doNotTrack,
 Boolean globalPrivacyControl,
 String preferredClientKind)
        throws IllegalArgumentException

Creates a new client with the given user agent, Do Not Track and Global Privacy Control settings.

Parameters:

userAgent - The user agent to use for the HTTP client. Will be stored in userAgent.

doNotTrack - true means that the user prefers privacy rather than personalised content. false means the opposite. Will be stored in doNotTrack.

globalPrivacyControl - true means that the user consents to a website or service selling or sharing their personal information with third parties. false means the opposite. Will be stored in globalPrivacyControl.

preferredClientKind - The kind of client to use for the HTTP requests. Will be stored in preferredClientKind.

Throws:

IllegalArgumentException - If the user agent is blank.

Implementation Note:

This constructor must NOT be replaced by Lombok's @AllArgsConstructor annotation, because then the default values would be ignored, i.e. if optional fields were missing, they would be set to null instead of the default values.

Method Details

setUserAgent

public void setUserAgent(@NonNull
 UserAgentManager.Client client,
 @NonNull
 UserAgentManager.Platform platform)

Updates the userAgent field with the given parameters.

Parameters:

client - The name of the client that the user agent should indicate.

platform - The operating system or device that the user agent should indicate.

Throws:

IllegalStateException - If the client was not found in the user-agent collection.

IllegalArgumentException - If the client is not available on the platform specified.

See Also:

• setUserAgent(String)

setUserAgent

public void setUserAgent(@NonNull
 @NonNull String userAgent)
                  throws IllegalArgumentException

Updates the userAgent field with the given one.

Parameters:

userAgent - The user agent to use for the HTTP client; will be stored in userAgent. If it contains a dot, the method will try to cast the substring before the dot to a Client and the substring after the dot to a Platform. If there is no dot or if the cast fails, the given user agent will be used verbatim (as is).

Throws:

IllegalArgumentException - If the user agent is blank.

See Also:

• setUserAgent(UserAgentManager.Client, UserAgentManager.Platform)

setNullableUserAgent

@Deprecated
private void setNullableUserAgent(@Nullable
 String userAgent)
                           throws IllegalArgumentException

Deprecated.

Only to be used by Jackson for deserialisation. Use setUserAgent(String) instead.

Parameters:

userAgent - The user agent to use for the HTTP client; will be stored in userAgent.

Throws:

IllegalArgumentException - See setUserAgent(String).

setDoNotTrack

public void setDoNotTrack(@Nullable
 Boolean doNotTrack)

Updates the doNotTrack field.

Parameters:

doNotTrack - true means that the user prefers privacy rather than personalized content. false means the opposite. If it is null, the field will not be updated.

setGlobalPrivacyControl

public void setGlobalPrivacyControl(@Nullable
 Boolean globalPrivacyControl)

Updates the globalPrivacyControl field.

Parameters:

globalPrivacyControl - true means that the user consents to a website or service selling or sharing their personal information with third parties. false means the opposite. If it is null, the field will not be updated.

setPreferredClientKind

public void setPreferredClientKind(@Nullable
 Client.ClientKind preferredClientKind)

Updates the preferredClientKind field.

Parameters:

preferredClientKind - The kind of client to use for the HTTP requests. If it is null, the field will not be updated.

setPreferredClientKind

@Deprecated
private void setPreferredClientKind(@Nullable
 String preferredClientKind)

Deprecated.

Only to be used by Jackson for deserialisation. Use setPreferredClientKind(ClientKind) instead. Updates the preferredClientKind field.

Parameters:

preferredClientKind - The kind of client to use for the HTTP requests. If it is null or does not match any member of the Client.ClientKind enum, the field will not be updated.

copy

@NonNull
public @NonNull Client copy()

Specified by:

copy in interface Copyable<Client>

Returns:

A deep copy of this client, i.e. a new instance with the same properties but different references.

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

Returns:

A string representation of this client with all its properties.

equals

public boolean equals(Object object)

Checks whether the fields of this client are equal to the fields of another client.

Overrides:

equals in class Object

Parameters:

object - The object to compare this client to.

Returns:

true if the objects are equal, false otherwise.

equalsDefault

public boolean equalsDefault()

Checks whether the fields of this client are equal to the default values, i.e. whether this client resembles a newly created one.

Returns:

true if the fields are equal to the default values, false otherwise.