Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.notifications

Class UnifiedPushNotifier

java.lang.Object

page.codeberg.friedolyn.notifications.Notifier

page.codeberg.friedolyn.notifications.UnifiedPushNotifier

All Implemented Interfaces:

Copyable<UnifiedPushNotifier>, Redactable

public class UnifiedPushNotifier
extends Notifier
implements Redactable, Copyable<UnifiedPushNotifier>

A Notifier that sends notifications via the UnifiedPush protocol to a UP server that then forwards the notification to the user's device. This requires the user to have a client app like Ntfy or NextPush installed on their device and to have enabled listening on a certain URL for notifications.

Nested Class Summary

Nested classes/interfaces inherited from class page.codeberg.friedolyn.notifications.Notifier

Notifier.Mood

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration	Provides the client configuration containing the invalid reference user agent and invalid reference DNT / invalid reference GPC settings that will be used when sending the notification.
static final @NonNull URL	DEFAULT_URL	The URL that should be used if no other URL is specified.
private final @NonNull HttpClient	httpClient	The HttpClient that sends the notifications to the UnifiedPush server at the URL specified.
private @NonNull URL	url	The URL that the user's UnifiedPush client is listening on for notifications and where the notification should be sent to.

Constructor Summary

Constructors

Constructor	Description
UnifiedPushNotifier(@NonNull URL url)	Creates a new UnifiedPushNotifier with the given URL used to send notifications.
UnifiedPushNotifier(@NonNull URL url, @NonNull Configuration configuration)	Creates a new UnifiedPushNotifier with the given URL used to send notifications and the client configuration.

Method Summary

Modifier and Type	Method	Description
@NonNull UnifiedPushNotifier	copy()
boolean	equals(Object object)	Compares this UnifiedPushNotifier with the given Object.
void	sendNotification(@NonNull String subject, @NonNull String summary, @NonNull String message, @NonNull Notifier.Mood mood)	Sends a notification with the given subject, summary and message to the user.
void	setConfiguration(@NonNull Configuration configuration)	Updates the configuration with the new Configuration object reference.
@NonNull String	toString()
@NonNull String	toStringRedacted()

Methods inherited from class page.codeberg.friedolyn.notifications.Notifier

sendNotification

Methods inherited from class java.lang.Object

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

Field Details

url

@NonNull
private @NonNull URL url

The URL that the user's UnifiedPush client is listening on for notifications and where the notification should be sent to.

configuration

@Nullable
private Configuration configuration

Provides the client configuration containing the

invalid reference

user agent

and

invalid reference

DNT

/

invalid reference

GPC

settings that will be used when sending the notification.

Implementation Note:

We use Configuration instead of Client directly in order not to miss out on any future changes to the settings if the entire Client object is replaced. This may be quite a clumsy approach, and it might need to be refactored in the future.

DEFAULT_URL

@NonNull
public static final @NonNull URL DEFAULT_URL

The URL that should be used if no other URL is specified.

httpClient

@NonNull
private final @NonNull HttpClient httpClient

The HttpClient that sends the notifications to the UnifiedPush server at the URL specified.

Constructor Details

UnifiedPushNotifier

public UnifiedPushNotifier(@NonNull
 @NonNull URL url)

Creates a new UnifiedPushNotifier with the given URL used to send notifications.

Parameters:

url - Where the notification should be sent to.

UnifiedPushNotifier

public UnifiedPushNotifier(@NonNull
 @NonNull URL url,
 @NonNull
 @NonNull Configuration configuration)

Creates a new UnifiedPushNotifier with the given URL used to send notifications and the client configuration.

Parameters:

url - Where the notification should be sent to.

configuration - Its client configuration will be used when sending the notification to specify the

invalid reference

user agent

and the

invalid reference

DNT

/

invalid reference

GPC

settings.

Method Details

sendNotification

public void sendNotification(@NonNull
 @NonNull String subject,
 @NonNull
 @NonNull String summary,
 @NonNull
 @NonNull String message,
 @NonNull
 @NonNull Notifier.Mood mood)
                      throws RuntimeException

Sends a notification with the given subject, summary and message to the user.

Specified by:

sendNotification in class Notifier

Parameters:

subject - What the notification is about. Must not be blank.

summary - A short version of the message. Should be a one-liner that summarises the full message. Must not be blank.

message - Since the character count in Android notifications is limited, the full message is ignored.

mood - Whether the content of the message contains news that the user will likely perceive as positive, or negative (or neither – in which case the mood is neutral).

Throws:

RuntimeException - If the notification could not be sent or if the subject or summary is blank.

See Also:

• Notifier.sendNotification(String, String, String)

setConfiguration

public void setConfiguration(@NonNull
 @NonNull Configuration configuration)

Updates the configuration with the new Configuration object reference.

copy

@NonNull
public @NonNull UnifiedPushNotifier copy()

Specified by:

copy in interface Copyable<UnifiedPushNotifier>

Returns:

A new UnifiedPushNotifier with the same URL as this one. Does NOT copy the HttpClient.

See Also:

• Copyable.copy()

equals

public boolean equals(Object object)

Compares this UnifiedPushNotifier with the given Object. Does NOT compare the HttpClients. When comparing the configurations, only the client configurations are checked for equality, because these hold the values relevant for this notifier and because calling equals on the configuration might lead to recursive calls to this method (due to the Configuration.getNotifications() reference).

Overrides:

equals in class Object

Parameters:

object - The Object to compare this UnifiedPushNotifier with.

Returns:

• true if the given object is an UnifiedPushNotifier whose fields' values (deeply) match their equivalents in this UnifiedPushNotifier}, especially (but not exclusively) if the given UnifiedPushNotifier is the exact same reference as this UnifiedPushNotifier.
• false if the given object is not a UnifiedPushNotifier or if any of the fields' values differ from their equivalents in this UnifiedPushNotifier.

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Specified by:

toString in class Notifier

Returns:

A string representation of this object including all fields, even sensitive ones.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Description copied from class: Notifier

Specified by:

toStringRedacted in interface Redactable

Specified by:

toStringRedacted in class Notifier

Returns:

A string representation of this object including all fields. However, sensitive fields will be removed or replaced with a placeholder. The exact behaviour is implementation-specific and may depend on the debug level currently in effect.

See Also:

• Redactable.toStringRedacted()