Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.notifications

Class NtfyNotifier

java.lang.Object

page.codeberg.friedolyn.notifications.Notifier

page.codeberg.friedolyn.notifications.NtfyNotifier

All Implemented Interfaces:

Copyable<NtfyNotifier>, Redactable

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

A Notifier that sends push notifications via the Ntfy service. Requires the user to have the Ntfy app installed on their phone (e.g. Android or have opened the Progressive Web App. Moreover, it is necessary that the user has subscribed to a specific topic on a Ntfy server.

Nested Class Summary

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

Notifier.Mood

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull String	DEFAULT_HOST	The host that shall be used by default if no other host is specified.
static final @NonNull URL	DEFAULT_URL	The url that shall be used by default if no other URL is specified.
private @NonNull String	host	The domain name of the Ntfy server that shall relay the push notifications to the user's device.
private @NonNull ntfyJava.core.publish.PubClient	pubClient	The client that will be used to transmit the push notification to the Ntfy server.
private @NonNull String	topic	The (hopefully unique) topic that the user has subscribed to on the Ntfy server and where all push notifications shall be sent to.
private @NonNull URL	url	The URL of the Ntfy server that shall relay the push notifications to the user's device.

Constructor Summary

Constructors

Constructor	Description
NtfyNotifier(@NonNull String topic)	Creates a new NtfyNotifier with the specified topic.
NtfyNotifier(@NonNull String host, @NonNull URL url, @NonNull String topic)	Creates a new NtfyNotifier with the specified host, URL and topic.

Method Summary

Modifier and Type	Method	Description
@NonNull NtfyNotifier	copy()
void	sendNotification(@NonNull String subject, @NonNull String summary, @NonNull String message, @NonNull Notifier.Mood mood)	Sends a push notification to the user's device via the Ntfy service.
void	setHost(@NonNull String host)	Sets the host of the Ntfy server to use.
void	setPubClient(@NonNull ntfyJava.core.publish.PubClient pubClient)	Updates the pubClient that shall be used to send the push notifications.
void	setTopic(@NonNull String topic)	Updates the topic.
void	setUrl(@NonNull URL url)	Updates the url of the Ntfy server to use.
@NonNull String	toString()
@NonNull String	toStringRedacted()	Same as toString(), but redacts all fields if the debug level is set to DebugLevel.WARN or DebugLevel.ERROR.

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

sendNotification

Methods inherited from class java.lang.Object

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

Field Details

pubClient

@NonNull
private @NonNull ntfyJava.core.publish.PubClient pubClient

The client that will be used to transmit the push notification to the Ntfy server.

host

@NonNull
private @NonNull String host

The domain name of the Ntfy server that shall relay the push notifications to the user's device.

url

@NonNull
private @NonNull URL url

The URL of the Ntfy server that shall relay the push notifications to the user's device.

topic

@NonNull
private @NonNull String topic

The (hopefully unique) topic that the user has subscribed to on the Ntfy server and where all push notifications shall be sent to.

DEFAULT_HOST

@NonNull
public static final @NonNull String DEFAULT_HOST

The host that shall be used by default if no other host is specified.

See Also:

• Constant Field Values

DEFAULT_URL

@NonNull
public static final @NonNull URL DEFAULT_URL

The url that shall be used by default if no other URL is specified.

Constructor Details

NtfyNotifier

public NtfyNotifier(@NonNull
 @NonNull String topic)

Creates a new NtfyNotifier with the specified topic.

Parameters:

topic - Where to send the push notifications to.

NtfyNotifier

public NtfyNotifier(@NonNull
 @NonNull String host,
 @NonNull
 @NonNull URL url,
 @NonNull
 @NonNull String topic)

Creates a new NtfyNotifier with the specified host, URL and topic.

Parameters:

host - The host of the Ntfy server to use.

url - The url of the Ntfy server to use.

topic - The topic to send the push notifications to.

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 push notification to the user's device via the Ntfy service.

Specified by:

sendNotification in class Notifier

Parameters:

subject - What the notification is about.

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

message - The full message that should be sent to the user. Depending on the implementation, full messages might be too long to be displayed (in full) and might therefore be truncated or omitted entirely.

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 push notification could not be sent or if the subject, summary or message are blank.

See Also:

• Notifier.sendNotification(String, String, String)

setHost

public void setHost(@NonNull
 @NonNull String host)
             throws IllegalArgumentException

Sets the host of the Ntfy server to use.

Parameters:

host - The new domain name of the Ntfy server to use.

Throws:

IllegalArgumentException - If the host is blank.

setTopic

public void setTopic(@NonNull
 @NonNull String topic)
              throws IllegalArgumentException

Updates the topic.

Parameters:

topic - The new topic where the push notifications shall be sent to. Should be unique for each user, so that no one receives notifications that are meant for someone else. Must not be blank.

Throws:

IllegalArgumentException - If the topic is blank.

setUrl

public void setUrl(@NonNull
 @NonNull URL url)

Updates the url of the Ntfy server to use. The host will be implicitly updated accordingly to match the domain name of the new URL.

Parameters:

url - The new URL of the Ntfy server to use.

setPubClient

public void setPubClient(@NonNull
 @NonNull ntfyJava.core.publish.PubClient pubClient)

Updates the pubClient that shall be used to send the push notifications.

Parameters:

pubClient - The new PubClient to use.

copy

@NonNull
public @NonNull NtfyNotifier copy()

Specified by:

copy in interface Copyable<NtfyNotifier>

Returns:

A deep copy of the object, i.e. a clone that has the exact same values as the original object, but is a different instance (new reference).

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.

Implementation Note:

We don't really care about the pubClient, so we just call Object.toString() on it.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Same as toString(), but redacts all fields if the debug level is set to DebugLevel.WARN or DebugLevel.ERROR.

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.