Package io.github.pimak.ntfy.core

Class NtfyPublisher

java.lang.Object

io.github.pimak.ntfy.core.NtfyPublisher

public class NtfyPublisher
extends Object

Stateless, never-throws HTTP publisher for the ntfy wire format.

Zero framework dependencies — this class is plain-constructed by AlertEngine/ NtfyClient, not managed by any DI container. It never calls an SLF4J logger and never posts to a Logback StatusManager; the caller owns all diagnostics and only consumes the returned PublishResult.

Internal transport. This class is public only because AlertEngine, NtfyClient and StartupSelfTest needed it before there was anywhere better to put it — not because it was designed as an entry point. It is NOT covered by this library's binary-compatibility guarantee, its shape is free to change within 2.x, and it is scheduled to stop being public in 3.0. Publish through NtfyClient instead, which is the supported surface for sending a notification of your own.

No SSRF guard is included here — that concern is out of scope for a plain HTTP publisher and is the consumer's responsibility if the target URL is derived from untrusted input. The topic, however, IS validated (ntfy's own [-_A-Za-z0-9]{1,64} rule): it is concatenated into the request path, and a topic containing /, ?, #, or .. would otherwise rewrite the request target (cross-topic publishing with the configured credential).

Constructor Summary

Constructors

Constructor	Description
NtfyPublisher(HttpClient httpClient)
NtfyPublisher(HttpClient httpClient, Duration requestTimeout)

Method Summary

Modifier and Type	Method	Description
PublishResult	publish(String url, String topic, String title, AuthMode auth, String body)	Deprecated.
PublishResult	publish(String url, String topic, String title, AuthMode auth, String body, String priority, String tags)	Deprecated.
PublishResult	publish(String url, String topic, String title, AuthMode auth, String body, String priority, String tags, String click)	Deprecated.
PublishResult	publish(String url, String topic, String title, AuthMode auth, String body, String priority, String tags, String click, String actions)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

NtfyPublisher

public NtfyPublisher(HttpClient httpClient)

NtfyPublisher

public NtfyPublisher(HttpClient httpClient,
 Duration requestTimeout)

Method Details

publish

@Deprecated(since="2.1.0")
public PublishResult publish(String url,
 String topic,
 String title,
 AuthMode auth,
 String body)

Deprecated.

Publishes title/body to {url}/{topic} with no Priority/ Tags/Click headers. Delegates to publish(String, String, String, AuthMode, String, String, String, String) with priority/tags/click all null.

Returns:

a PublishResult describing the outcome; never throws

publish

@Deprecated(since="2.1.0")
public PublishResult publish(String url,
 String topic,
 String title,
 AuthMode auth,
 String body,
 String priority,
 String tags)

Deprecated.

Priority/tags overload with no Click header. Delegates to publish(String, String, String, AuthMode, String, String, String, String) with click null.

Returns:

a PublishResult describing the outcome; never throws

publish

@Deprecated(since="2.1.0")
public PublishResult publish(String url,
 String topic,
 String title,
 AuthMode auth,
 String body,
 String priority,
 String tags,
 String click)

Deprecated.

Priority/tags/click overload with no Actions header. Delegates to publish(String, String, String, AuthMode, String, String, String, String, String) with actions null.

Returns:

a PublishResult describing the outcome; never throws

publish

@Deprecated(since="2.1.0")
public PublishResult publish(String url,
 String topic,
 String title,
 AuthMode auth,
 String body,
 String priority,
 String tags,
 String click,
 String actions)

Deprecated.

Publishes title/body to {url}/{topic}, additionally forwarding priority, tags, click and actions as ntfy's Priority, Tags, Click and Actions HTTP headers. click is the URL ntfy opens when the notification is tapped; actions is a pre-serialized ntfy Actions header value (see NtfyActionSerializer).

A blank/null value for any of priority/tags/click/actions sends no corresponding header. Values containing non-printable-ASCII characters are omitted rather than forwarded: the CRLF-injection guard must not depend solely on the JDK client's header validation, and a single invalid configured value must not abort every publish at the header-build boundary.

The Authorization header (if any) comes entirely from the supplied AuthMode: auth.buildHeader() returns the header value to send, or Optional.empty() to send no Authorization header at all (a valid anonymous publish).

Returns:

a PublishResult describing the outcome; never throws