Index

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

actions() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Action buttons as a raw ntfy Actions header value (short format, e.g.

actions(List<NtfyAction>) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets action buttons from typed NtfyActions, serialized to the ntfy Actions header via NtfyActionSerializer. ntfy caps a notification at three actions; extra entries and null elements are dropped.

actionsHeader(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets action buttons from a raw, pre-formatted ntfy Actions header value (the short "simple" format, e.g.

AlertEngine - Class in io.github.pimak.ntfy.core

Framework-pure alert engine: the extracted heart of the original Logback NtfyAlertAppender, decoupled from any logging framework.

AlertEngine(NtfyConfig, Diagnostics) - Constructor for class io.github.pimak.ntfy.core.AlertEngine

AlertEngine(NtfyConfig, Diagnostics, PipelineCounters) - Constructor for class io.github.pimak.ntfy.core.AlertEngine

Constructs an engine sharing an externally-owned PipelineCounters.

AlertEvent - Record Class in io.github.pimak.ntfy.core

Framework-neutral snapshot of a single log event, handed to AlertEngine.submit(io.github.pimak.ntfy.core.AlertEvent).

AlertEvent(String, String, long, List<AlertEvent.Cause>, List<String>, Set<String>) - Constructor for record class io.github.pimak.ntfy.core.AlertEvent

The pre-mdcValues canonical signature, kept as an explicit constructor for compatibility: AlertEvent is public API, and preserving the original (String, String, long, List, List, Set) descriptor keeps adapters compiled against an earlier release both source- AND binary-compatible — they keep linking without recompilation.

AlertEvent(String, String, long, List<AlertEvent.Cause>, List<String>, Set<String>, Map<String, String>) - Constructor for record class io.github.pimak.ntfy.core.AlertEvent

The pre-level signature, kept as an explicit constructor for compatibility, exactly like the pre-mdcValues one below: preserving the (String, String, long, List, List, Set, Map) descriptor keeps adapters compiled against an earlier release both source- AND binary-compatible.

AlertEvent(String, String, long, List<AlertEvent.Cause>, List<String>, Set<String>, Map<String, String>, AlertLevel) - Constructor for record class io.github.pimak.ntfy.core.AlertEvent

Validates the mandatory fields and normalizes the optional collections so every construction path — direct new, the AlertEvent.of(java.lang.String, java.lang.String, long) factory, or an adapter — yields a null-free, defensively copied event.

AlertEvent.Cause - Record Class in io.github.pimak.ntfy.core

One link of an exception chain: the throwable's class name and its message (either may be null in degenerate cases, mirroring the source throwable).

AlertLevel - Enum Class in io.github.pimak.ntfy.core

The severity of an AlertEvent, as far as the alerting engine is concerned — the value AlertEngine routes on.

allowClasspathEndpoint(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Explicit opt-in for activating from a classpath-only endpoint URL; see NtfyConfig.isAllowClasspathEndpoint().

append(ILoggingEvent) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Gates on level, then maps the event and hands it to the engine, which owns all further gating and publishing.

append(LogEvent) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

Gates on level, maps the event eagerly, and hands it to the engine, which owns all further gating and publishing.

APPENDER_NAME - Static variable in class io.github.pimak.ntfy.micronaut.NtfyLogbackInstaller

Name of the appender this module manages on the root logger.

appName() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Application name, used as the title base when NtfyRuntimeConfig.title() is unset.

appName(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

async() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Asynchronous (offloaded) delivery: individual error alerts are handed to the engine's bounded work queue and published by a daemon worker, so a slow/unreachable ntfy server never blocks the logging thread.

asyncEnabled(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Toggles asynchronous (offloaded) delivery of individual error alerts.

asyncQueueCapacity() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Bounded async delivery queue capacity; only consulted when NtfyRuntimeConfig.async() is true.

asyncQueueCapacity(int) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the bounded async delivery queue capacity (see NtfyConfig.getAsyncQueueCapacity()).

attachLevel() - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

The log4j2 level this appender should be ATTACHED at — WARN once the engine activated a warn route, ERROR otherwise.

AuthMode - Class in io.github.pimak.ntfy.core

Auth strategy for an outbound ntfy publish request, modeled as a sealed hierarchy so each mode carries only the fields it needs and knows how to build its own Authorization header.

AuthMode() - Constructor for class io.github.pimak.ntfy.core.AuthMode

AuthMode.BasicAuth - Class in io.github.pimak.ntfy.core

Sends Authorization: Basic <base64(username:password)>.

AuthMode.BearerToken - Class in io.github.pimak.ntfy.core

Sends Authorization: Bearer <token>.

AuthMode.None - Class in io.github.pimak.ntfy.core

Sends no Authorization header at all — a valid anonymous publish.

B

basic(String, String) - Static method in class io.github.pimak.ntfy.core.AuthMode

Creates a AuthMode.BasicAuth auth mode carrying the given username/password pair.

bearer(String) - Static method in class io.github.pimak.ntfy.core.AuthMode

Creates a AuthMode.BearerToken auth mode carrying the given token.

bindTo(MeterRegistry) - Method in class io.github.pimak.ntfy.quarkus.runtime.NtfyMeterBinder

body() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the body record component.

broadcast(String, NtfyAction.BroadcastExtra...) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

A broadcast action sending ntfy's default intent, with optional extras.

broadcast(String, String, boolean, NtfyAction.BroadcastExtra...) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

A broadcast action sending intent (blank uses ntfy's default) with an explicit clear flag dismissing the notification on tap, plus optional extras.

broadcast(String, String, NtfyAction.BroadcastExtra...) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

A broadcast action sending intent (blank uses ntfy's default), with extras.

Broadcast(String, String, List<NtfyAction.BroadcastExtra>, boolean) - Constructor for record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Creates an instance of a Broadcast record class.

BroadcastExtra(String, String) - Constructor for record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Creates an instance of a BroadcastExtra record class.

build() - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

build() - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Instantiates the appender.

builder() - Static method in class io.github.pimak.ntfy.core.NtfyConfig

Returns a fresh NtfyConfig.Builder pre-loaded with every default.

Builder() - Constructor for class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

buildHeader() - Method in class io.github.pimak.ntfy.core.AuthMode.BasicAuth

buildHeader() - Method in class io.github.pimak.ntfy.core.AuthMode.BearerToken

buildHeader() - Method in class io.github.pimak.ntfy.core.AuthMode

Builds the Authorization header value for this auth mode, if any.

buildHeader() - Method in class io.github.pimak.ntfy.core.AuthMode.None

C

cache() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

false asks the server not to store the message (Cache: no).

cache(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

false asks the server not to store the message (Cache: no), at the cost of every subscriber who is not connected at that moment.

cache(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets cache from a raw configuration string, the spelling every flat surface hands over — an XML attribute, an environment variable, a properties entry.

Cause(String, String) - Constructor for record class io.github.pimak.ntfy.core.AlertEvent.Cause

Creates an instance of a Cause record class.

causeChain() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the causeChain record component.

className() - Method in record class io.github.pimak.ntfy.core.AlertEvent.Cause

Returns the value of the className record component.

clear() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns the value of the clear record component.

clear() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the clear record component.

clear() - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Returns the value of the clear record component.

clickUrl() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

URL opened when a notification is tapped (ntfy Click header).

clickUrl(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

URL opened when a notification is tapped (ntfy Click header); null to omit.

close() - Method in class io.github.pimak.ntfy.core.NtfyClient

Releases the underlying HttpClient (Java 21+ deterministic shutdown).

close() - Method in class io.github.pimak.ntfy.jul.NtfyJulAutoHandler

close() - Method in class io.github.pimak.ntfy.jul.NtfyJulHandler

closeNtfyClient(NtfyClient) - Method in class io.github.pimak.ntfy.quarkus.runtime.NtfyClientProducer

Releases the client's underlying HTTP resources when the application shuts down.

ConfigLoader - Class in io.github.pimak.ntfy.core

Resolves an NtfyConfig from the ambient environment.

configure(LoggerContext) - Method in class io.github.pimak.ntfy.logback.NtfyLogbackConfigurator

connectTimeout() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

HTTP connect timeout (ntfy duration spelling, e.g.

connectTimeout(Duration) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

counters() - Method in class io.github.pimak.ntfy.core.AlertEngine

Read-only pipeline observability counters (published / suppressed / failed).

counters() - Method in class io.github.pimak.ntfy.jul.NtfyJulHandler

The alert pipeline's observability counters for this handler's engine — the JUL counterpart of the Logback/Log4j2 appenders' getCounters().

create() - Method in class io.github.pimak.ntfy.quarkus.runtime.NtfyRecorder

Builds the ntfy JUL handler from the run-time config.

D

destroy() - Method in class io.github.pimak.ntfy.spring.NtfyAutoConfiguration

Diagnostics - Interface in io.github.pimak.ntfy.core

Self-diagnostic sink for AlertEngine.

digestPriority() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy priority header for the periodic storm digest.

digestPriority(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

digestTags() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy tags header for the periodic storm digest.

digestTags(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

DurationParser - Class in io.github.pimak.ntfy.core

Parses the several duration spellings the ntfy configuration surface accepts into a Duration.

E

enabled() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Master switch; when false the handler is never installed.

enabled(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

endpointFromClasspathFile(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

See NtfyConfig.isEndpointFromClasspathFile(); set by ConfigLoader only.

equals(Object) - Method in record class io.github.pimak.ntfy.core.AlertEvent.Cause

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.AlertEvent

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class io.github.pimak.ntfy.core.PublishResult

Indicates whether some other object is "equal to" this one.

error(String, Throwable) - Method in interface io.github.pimak.ntfy.core.Diagnostics

Records an error together with the throwable that triggered it.

ERROR - Enum constant in enum class io.github.pimak.ntfy.core.AlertLevel

Error-level and above (Log4j2 FATAL, JUL SEVERE, and any custom level above them).

errorPriority() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy priority header for individual error alerts.

errorPriority(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

errorTags() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy tags header for individual error alerts.

errorTags(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

excludedExceptionTypes() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Comma-separated fully qualified exception class names.

excludedExceptionTypes(List<String>) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the excluded exception types from an explicit list of fully qualified class names (defensively copied, null-safe, blanks dropped).

excludedExceptionTypesCsv(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience: sets the excluded exception types from a single comma-separated string of fully qualified class names, trimming each entry and dropping blanks.

excludedLoggerPrefixes(List<String>) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the excluded logger prefixes from an explicit list (defensively copied, null-safe).

excludedLoggers() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Comma-separated logger-name prefixes excluded from alerting.

excludedLoggers(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience: sets the excluded logger prefixes from a single comma-separated string, trimming each entry and dropping blanks.

extras() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns the value of the extras record component.

F

failed() - Method in class io.github.pimak.ntfy.core.PipelineCounters

Failed publish attempts (individual publish failure/exception + digest publish failure).

failed() - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Returns the value of the failed record component.

failure(int, String) - Static method in record class io.github.pimak.ntfy.core.PublishResult

failure(String) - Static method in record class io.github.pimak.ntfy.core.PublishResult

firebase() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

false asks the server not to forward the message to Firebase ( Firebase: no).

firebase(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

false asks the server not to forward the message to Firebase (Firebase: no), at the cost of push latency on the Google Play Android client.

firebase(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

firebase from a raw configuration string.

flush() - Method in class io.github.pimak.ntfy.jul.NtfyJulAutoHandler

flush() - Method in class io.github.pimak.ntfy.jul.NtfyJulHandler

forConfig(NtfyConfig) - Static method in class io.github.pimak.ntfy.jul.NtfyJulHandler

Builds a handler around a fresh, started AlertEngine for config, with engine self-diagnostics routed to System.err (never back through the logging pipeline — see JulDiagnostics).

formattedMessage() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the formattedMessage record component.

fromCredentials(String, String, String) - Static method in class io.github.pimak.ntfy.core.AuthMode

Derives the applicable AuthMode from raw configured credentials, encoding the same precedence as the engine's configuration surface: a non-blank token always wins, even if username/password are also set; otherwise a non-blank username AND password together select AuthMode.BasicAuth; otherwise AuthMode.None.

fromValue(String) - Static method in enum class io.github.pimak.ntfy.core.StartupPingMode

Parses a configured value case-insensitively, returning null — never throwing — when the value matches no constant.

G

getActions() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The pre-serialized ntfy Actions header value (action buttons) sent with both individual error alerts and the storm digest, or null/blank to send no Actions header.

getActions() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Action buttons as a raw ntfy Actions header value (short format, e.g.

getActions() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getAppName() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getAppName() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Application name shown in notification bodies to distinguish services sharing a topic.

getAppName() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getAsyncQueueCapacity() - Method in class io.github.pimak.ntfy.core.NtfyConfig

Maximum number of pending error alerts the asynchronous delivery queue holds before overflow kicks in (see AlertEngine).

getAsyncQueueCapacity() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Bounded async delivery queue capacity; only consulted when NtfyConfiguration.isAsync() is true.

getAsyncQueueCapacity() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getClickUrl() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The URL ntfy opens when a notification is tapped (sent as the Click header), or null/blank to send no Click header.

getClickUrl() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

URL opened when a notification is tapped (ntfy Click header).

getClickUrl() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getConnectTimeout() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getConnectTimeout() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

HTTP connect timeout for publishing.

getConnectTimeout() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getCounters() - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

Read-only pipeline observability counters (published / suppressed / failed) for this appender.

getCounters() - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Read-only pipeline observability counters (published / suppressed / failed) for this appender.

getDigestPriority() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getDigestPriority() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

ntfy priority of digest notifications.

getDigestPriority() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getDigestTags() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getDigestTags() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Comma-separated ntfy tags attached to digest notifications.

getDigestTags() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getErrorPriority() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getErrorPriority() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

ntfy priority of individual error notifications.

getErrorPriority() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getErrorTags() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getErrorTags() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Comma-separated ntfy tags attached to individual error notifications.

getErrorTags() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getExcludedExceptionTypes() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The unmodifiable list of fully qualified exception class names whose presence ANYWHERE in an event's cause chain gates the event out.

getExcludedExceptionTypes() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Comma-separated fully qualified exception class names.

getExcludedExceptionTypes() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getExcludedLoggerPrefixes() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The unmodifiable list of logger-name prefixes excluded from alerting.

getExcludedLoggers() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Comma-separated logger-name prefixes excluded from alerting.

getExcludedLoggers() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getIcon() - Method in class io.github.pimak.ntfy.core.NtfyConfig

URL of the icon shown beside the notification (ntfy Icon header), or null when unset.

getIcon() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

URL of the icon shown beside the notification (ntfy Icon header).

getIcon() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getIconsByLogger() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Per-logger icon overrides as prefix=url pairs separated by commas.

getIconsByLogger() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getIconsByLoggerPrefix() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The unmodifiable logger-prefix → icon-URL table that overrides NtfyConfig.getIcon() for alerts, in configured order.

getIncludeMdcKeys() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The unmodifiable, EXPLICIT allow-list of MDC keys whose values are rendered into alert bodies (one key: value line each), in configured order — that order is the rendering order.

getIncludeMdcKeys() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Comma-separated allow-list of MDC keys whose values are rendered into alert bodies, one key: value line each.

getIncludeMdcKeys() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

Comma-separated allow-list of MDC keys whose values are rendered into alert bodies, one key: value line each, in the order given here.

getLocale() - Method in class io.github.pimak.ntfy.core.NtfyConfig

Language of the notification bodies and self-diagnostic messages the engine produces.

getLocale() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Language of notification bodies and diagnostics as a BCP 47 tag (e.g.

getLocale() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

Language of notification bodies and diagnostics as a BCP 47 tag (e.g.

getMaxAlertsPerWindow() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getMaxAlertsPerWindow() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Individual alerts published per suppression window before the engine switches to digesting.

getMaxAlertsPerWindow() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getMaxStackFrames() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getMaxStackFrames() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Number of stack frames included in a notification body.

getMaxStackFrames() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getPassword() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getPassword() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Password for basic authentication.

getPassword() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getRequestTimeout() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getRequestTimeout() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

HTTP request timeout for publishing.

getRequestTimeout() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getStartupPing() - Method in class io.github.pimak.ntfy.core.NtfyConfig

What the opt-in startup self-test does once the engine has finished activating — see StartupPingMode.

getStartupPing() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Opt-in startup self-test verifying at boot that the configured endpoint, credentials and topic actually work — instead of finding out when the first real error alert fails to deliver.

getStartupPing() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getStartupPingWarn() - Method in class io.github.pimak.ntfy.core.NtfyConfig

What the startup self-test does for the optional WARN route — see StartupPingMode.

getStartupPingWarn() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Startup self-test for the optional WARN route, independent of NtfyConfiguration.getStartupPing().

getStartupPingWarn() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getSuppressionWindow() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getSuppressionWindow() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Length of the storm-suppression window.

getSuppressionWindow() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getTitle() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getTitle() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Fixed notification title; when unset the engine derives one from the event.

getTitle() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getToken() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getToken() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Bearer access token used instead of username/password authentication.

getToken() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getTopic() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getTopic() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Topic notifications are published to.

getTopic() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getUrl() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getUrl() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Base URL of the ntfy server, e.g.

getUrl() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getUsername() - Method in class io.github.pimak.ntfy.core.NtfyConfig

getUsername() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Username for basic authentication.

getUsername() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

getWarnPriority() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The ntfy Priority header for WARN alerts (default default).

getWarnPriority() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

ntfy priority header for WARN alerts and the WARN digest.

getWarnPriority() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

ntfy Priority header for WARN alerts and the WARN digest.

getWarnTags() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The ntfy Tags header for WARN alerts and the WARN digest (default warning).

getWarnTags() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

ntfy tags header for WARN alerts and the WARN digest.

getWarnTags() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

ntfy Tags header for WARN alerts and the WARN digest.

getWarnTopic() - Method in class io.github.pimak.ntfy.core.NtfyConfig

The ntfy topic WARN-level events are published to, or null/blank when WARN alerting is off (the default).

getWarnTopic() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

The ntfy topic WARN-level events are published to.

getWarnTopic() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

The topic WARN-level events are published to.

H

hashCode() - Method in record class io.github.pimak.ntfy.core.AlertEvent.Cause

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Returns a hash code value for this object.

hashCode() - Method in record class io.github.pimak.ntfy.core.PublishResult

Returns a hash code value for this object.

headers() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the headers record component.

http(String, String) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

An http action sending a GET to url when tapped.

http(String, String, String, String) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

An http action sending method (with optional body) to url.

http(String, String, String, String, boolean, NtfyAction.HttpHeader...) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

An http action as NtfyAction.http(String, String, String, String, HttpHeader...) but with an explicit clear flag dismissing the notification on tap.

http(String, String, String, String, NtfyAction.HttpHeader...) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

An http action sending method (with optional body) to url, carrying the given request headers (e.g.

Http(String, String, String, String, boolean, List<NtfyAction.HttpHeader>) - Constructor for record class io.github.pimak.ntfy.core.NtfyAction.Http

Creates an instance of a Http record class.

HttpHeader(String, String) - Constructor for record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Creates an instance of a HttpHeader record class.

httpStatus() - Method in record class io.github.pimak.ntfy.core.PublishResult

Returns the value of the httpStatus record component.

I

icon() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

URL of the icon shown beside the notification (ntfy Icon header).

icon(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the notification icon URL (ntfy Icon header).

iconsByLogger() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Per-logger icon overrides as prefix=url pairs separated by commas.

iconsByLoggerPrefix(Map<String, String>) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the logger-prefix → icon-URL table (defensively copied, null-safe).

iconsByLoggerPrefixCsv(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience: the same table as a single string, prefix=url pairs separated by commas — the spelling every adapter's flat configuration surface uses.

includeMdcKeys() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Comma-separated allow-list of MDC keys whose values are rendered into alert bodies, one key: value line each, in the order given here.

includeMdcKeys(List<String>) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the MDC-key allow-list from an explicit list (defensively copied, null-safe); a null list clears it.

includeMdcKeysCsv(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience: sets the MDC-key allow-list from a single comma-separated string, trimming each entry and dropping blanks.

info(String) - Method in interface io.github.pimak.ntfy.core.Diagnostics

Records an informational lifecycle message (engine active, exclusions configured, ...).

install() - Static method in class io.github.pimak.ntfy.jul.NtfyJulInstaller

Installs on the root logger.

install() - Static method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Installer

Installs on the current LoggerContext (LoggerContext.getContext(false) — the caller's context, without forcing initialization of a new one).

install(Logger) - Static method in class io.github.pimak.ntfy.jul.NtfyJulInstaller

Resolves the ambient config and, when active and vetted, attaches a started NtfyJulHandler to logger.

install(LoggerContext) - Static method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Installer

Resolves the ambient config and, when active and vetted, attaches a started NtfyLog4j2Appender to context's root logger at Level.ERROR.

intent() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns the value of the intent record component.

io.github.pimak.ntfy.core - package io.github.pimak.ntfy.core

io.github.pimak.ntfy.jul - package io.github.pimak.ntfy.jul

io.github.pimak.ntfy.log4j2 - package io.github.pimak.ntfy.log4j2

io.github.pimak.ntfy.logback - package io.github.pimak.ntfy.logback

io.github.pimak.ntfy.micronaut - package io.github.pimak.ntfy.micronaut

io.github.pimak.ntfy.quarkus.runtime - package io.github.pimak.ntfy.quarkus.runtime

io.github.pimak.ntfy.spring - package io.github.pimak.ntfy.spring

isActive() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when this config should actually deliver alerts: it is NtfyConfig.enabled, and both NtfyConfig.getUrl() and NtfyConfig.getTopic() are non-blank.

isAllowClasspathEndpoint() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when the operator has explicitly opted in to activating alert delivery from an endpoint URL supplied only by a classpath ntfy.properties (see NtfyConfig.isEndpointFromClasspathFile()).

isAsync() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Asynchronous (offloaded) delivery, so a slow or unreachable ntfy server never blocks the logging thread.

isAsync() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isAsyncEnabled() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when delivery of individual error alerts should be offloaded to the engine's bounded asynchronous work queue instead of running inline on the calling (logging) thread.

isCache() - Method in class io.github.pimak.ntfy.core.NtfyConfig

Whether the ntfy server may cache published messages (true by default, matching ntfy's own default of storing them for 12 hours).

isCache() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

false asks the server not to store the message (Cache: no).

isCache() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isDeliveryPolicyValueRejected() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when a cache or firebase value was supplied but could not be read as a boolean, so the default was kept.

isEnabled() - Method in class io.github.pimak.ntfy.core.NtfyConfig

isEnabled() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Master switch for the integration.

isEnabled() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isEndpointFromClasspathFile() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when the endpoint URL was supplied ONLY by a classpath ntfy.properties (no system property or environment variable set it).

isFirebase() - Method in class io.github.pimak.ntfy.core.NtfyConfig

Whether the ntfy server may forward published messages to Firebase Cloud Messaging ( true by default).

isFirebase() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

false asks the server not to forward the message to Firebase ( Firebase: no).

isFirebase() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isIconsByLoggerValueRejected() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when an icons-by-logger entry could not be read as a prefix=url pair, so it was discarded.

isRequireHttpsForCredentials() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when the engine must REFUSE activation (rather than merely warn) if credentials — a configured token, a username/password pair, or userinfo embedded in the URL itself — would be sent over a cleartext http:// endpoint.

isRequireHttpsForCredentials() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Strict transport mode: refuse engine activation (rather than only warn) when credentials would be sent over a cleartext http:// endpoint.

isRequireHttpsForCredentials() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isStarted() - Method in class io.github.pimak.ntfy.core.AlertEngine

True once AlertEngine.start() has activated the engine, until AlertEngine.stop() tears it down.

isStartupPingFailFast() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when a failed startup self-test must abort application startup (by throwing NtfyStartupSelfTestException out of AlertEngine.start()) rather than merely warn.

isStartupPingFailFast() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Whether a failed startup self-test aborts application startup instead of only warning.

isStartupPingFailFast() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isStartupPingNotifyFailures() - Method in class io.github.pimak.ntfy.core.NtfyConfig

Whether a failed self-test should be announced as an ntfy notification on a route that PASSED.

isStartupPingNotifyFailures() - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Whether a failed self-test is announced on a route that passed.

isStartupPingNotifyFailures() - Method in class io.github.pimak.ntfy.spring.NtfyProperties

isStartupPingValueRejected() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when a startup-ping value was supplied but matched no known mode, so the default was kept.

isStartupPingWarnValueRejected() - Method in class io.github.pimak.ntfy.core.NtfyConfig

As NtfyConfig.isStartupPingValueRejected(), for startup-ping-warn.

isWarnRoutingActive() - Method in class io.github.pimak.ntfy.core.AlertEngine

True when this started engine actually activated a WARN route, i.e.

isWarnRoutingEnabled() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when a non-blank NtfyConfig.getWarnTopic() is configured, i.e.

isWarnTopicFromClasspathFile() - Method in class io.github.pimak.ntfy.core.NtfyConfig

True when NtfyConfig.getWarnTopic() was supplied ONLY by a classpath ntfy.properties — no ntfy.warn-topic system property and no NTFY_WARN_TOPIC environment variable.

L

label() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns the value of the label record component.

label() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the label record component.

label() - Method in interface io.github.pimak.ntfy.core.NtfyAction

The button label shown in the notification.

label() - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Returns the value of the label record component.

level() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the level record component.

load() - Static method in class io.github.pimak.ntfy.core.ConfigLoader

Loads configuration from live system properties, environment variables, and a classpath ntfy.properties (if present), applying the precedence documented on this class.

locale() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Language of notification bodies and diagnostics as a BCP 47 tag (e.g.

locale(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience overload that parses a BCP 47 language tag (e.g.

locale(Locale) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Sets the language of notification bodies and diagnostics (see NtfyConfig.getLocale()).

LogbackAlertAppender - Class in io.github.pimak.ntfy.logback

A thin Logback UnsynchronizedAppenderBase<ILoggingEvent> shell over the framework-neutral AlertEngine.

LogbackAlertAppender() - Constructor for class io.github.pimak.ntfy.logback.LogbackAlertAppender

loggerName() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the loggerName record component.

M

markerNames() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the markerNames record component.

maxAlertsPerWindow() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Maximum individually-published alerts per suppression window before digesting kicks in.

maxAlertsPerWindow(int) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

maxStackFrames() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Maximum root-cause stack frames rendered into an alert body.

maxStackFrames(int) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

MdcProjector - Class in io.github.pimak.ntfy.core

Projects a logging framework's diagnostic context (MDC) onto the small, bounded, sanitized map of key -> value pairs an alert body may carry — the include-mdc-keys feature.

mdcValues() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the mdcValues record component.

message() - Method in record class io.github.pimak.ntfy.core.AlertEvent.Cause

Returns the value of the message record component.

message() - Method in record class io.github.pimak.ntfy.core.PublishResult

Returns the value of the message record component.

method() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the method record component.

N

name() - Method in record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Returns the value of the name record component.

name() - Method in record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Returns the value of the name record component.

newBuilder() - Static method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

The plugin builder log4j2 instantiates for an <Ntfy .../> element.

NO_ALERT_MARKER_NAME - Static variable in class io.github.pimak.ntfy.core.AlertEngine

Marker name an adapter surfaces in AlertEvent.markerNames() to opt a single event out of alerting entirely.

NO_ALERT_MARKER_NAME - Static variable in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

Marker name a caller attaches to a single log call to opt it out of alerting entirely (logger.error(MarkerManager.getMarker(NtfyLog4j2Appender.NO_ALERT_MARKER_NAME), ...)).

NO_ALERT_MARKER_NAME - Static variable in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Marker name a caller attaches to a single log call to opt it out of alerting entirely.

none() - Static method in class io.github.pimak.ntfy.core.AuthMode

Returns the shared AuthMode.None instance (no Authorization header is sent).

notify(String, String) - Method in class io.github.pimak.ntfy.core.NtfyClient

Publishes title/message to the configured topic with no Priority/ Tags headers.

notify(String, String, String, String) - Method in class io.github.pimak.ntfy.core.NtfyClient

Publishes title/message to the configured topic, forwarding priority and tags as ntfy's Priority and Tags headers (blank/null values send no corresponding header).

notify(String, String, String, String, String) - Method in class io.github.pimak.ntfy.core.NtfyClient

Publishes title/message to the configured topic, forwarding priority, tags and click as ntfy's Priority, Tags and Click headers (blank/null values send no corresponding header).

notify(String, String, List<NtfyAction>) - Method in class io.github.pimak.ntfy.core.NtfyClient

Publishes title/message to the configured topic with the given action buttons, serialized to ntfy's Actions header (ntfy caps a notification at three actions; extras and null elements are dropped).

NtfyAction - Interface in io.github.pimak.ntfy.core

A single ntfy notification action button, modeled as a sealed hierarchy so each action type carries only the fields it needs (mirroring the AuthMode pattern).

NtfyAction.Broadcast - Record Class in io.github.pimak.ntfy.core

Sends an Android broadcast intent when tapped (only actioned by ntfy's Android app).

NtfyAction.BroadcastExtra - Record Class in io.github.pimak.ntfy.core

A single intent extra (name/value) carried by a NtfyAction.Broadcast action.

NtfyAction.Http - Record Class in io.github.pimak.ntfy.core

Sends an HTTP request to url when tapped.

NtfyAction.HttpHeader - Record Class in io.github.pimak.ntfy.core

A single request header (name/value) carried by an NtfyAction.Http action.

NtfyAction.View - Record Class in io.github.pimak.ntfy.core

Opens url in the browser/app when the action button is tapped.

NtfyAutoConfiguration - Class in io.github.pimak.ntfy.spring

Auto-configuration that turns ntfy.* properties into a live ntfy integration for a Spring Boot application.

NtfyAutoConfiguration() - Constructor for class io.github.pimak.ntfy.spring.NtfyAutoConfiguration

ntfyClient(NtfyConfiguration) - Method in class io.github.pimak.ntfy.micronaut.NtfyClientFactory

Builds the singleton NtfyClient.

ntfyClient(NtfyRuntimeConfig) - Method in class io.github.pimak.ntfy.quarkus.runtime.NtfyClientProducer

Produces the singleton NtfyClient built from the run-time ntfy config.

NtfyClient - Class in io.github.pimak.ntfy.core

Generic, standalone ntfy notification client — the "send an arbitrary notification" surface, independent of AlertEngine's log-alert lifecycle.

NtfyClient(NtfyConfig) - Constructor for class io.github.pimak.ntfy.core.NtfyClient

NtfyClientFactory - Class in io.github.pimak.ntfy.micronaut

Exposes the injectable NtfyClient bean, built from the bound NtfyConfiguration.

NtfyClientFactory() - Constructor for class io.github.pimak.ntfy.micronaut.NtfyClientFactory

NtfyClientProducer - Class in io.github.pimak.ntfy.quarkus.runtime

Exposes a generic, application-scoped NtfyClient for CDI injection, so Quarkus apps can @Inject NtfyClient to send arbitrary notifications independent of the log-alert path.

NtfyClientProducer() - Constructor for class io.github.pimak.ntfy.quarkus.runtime.NtfyClientProducer

NtfyConfig - Class in io.github.pimak.ntfy.core

Immutable, framework-neutral configuration for the ntfy engine and client.

NtfyConfig.Builder - Class in io.github.pimak.ntfy.core

Fluent builder for NtfyConfig; every setter returns this.

NtfyConfiguration - Class in io.github.pimak.ntfy.micronaut

Binds all ntfy.* application configuration for a Micronaut application.

NtfyConfiguration() - Constructor for class io.github.pimak.ntfy.micronaut.NtfyConfiguration

NtfyJulAutoHandler - Class in io.github.pimak.ntfy.jul

Declarative zero-code entry point: name this class in a JUL logging.properties —

NtfyJulAutoHandler() - Constructor for class io.github.pimak.ntfy.jul.NtfyJulAutoHandler

Invoked reflectively by LogManager; also usable directly.

NtfyJulHandler - Class in io.github.pimak.ntfy.jul

A Handler that forwards SEVERE-and-above (and, when a warn route is configured, WARNING) LogRecords to the ntfy AlertEngine.

NtfyJulHandler(AlertEngine) - Constructor for class io.github.pimak.ntfy.jul.NtfyJulHandler

Equivalent to NtfyJulHandler(AlertEngine, List) with an empty MDC allow-list, i.e. no MDC values in the alert body.

NtfyJulHandler(AlertEngine, List<String>) - Constructor for class io.github.pimak.ntfy.jul.NtfyJulHandler

NtfyJulInstaller - Class in io.github.pimak.ntfy.jul

Programmatic one-liner install of the ntfy JUL handler from the ambient environment: NtfyJulInstaller.install() early in main attaches a NtfyJulHandler to the root logger when the environment configures ntfy (NTFY_URL/NTFY_TOPIC, -Dntfy.*, or a trusted classpath ntfy.properties — see JulAmbientConfig for the classpath-endpoint opt-in guard), and does nothing otherwise.

NtfyLog4j2Appender - Class in io.github.pimak.ntfy.log4j2

A thin log4j2 AbstractAppender shell over the framework-neutral AlertEngine, exposed to log4j2.xml as the <Ntfy .../> element.

NtfyLog4j2Appender.Builder - Class in io.github.pimak.ntfy.log4j2

Plugin builder for the <Ntfy .../> element.

NtfyLog4j2Installer - Class in io.github.pimak.ntfy.log4j2

Programmatic one-liner install of the ntfy log4j2 appender from the ambient environment: NtfyLog4j2Installer.install() early in main attaches a started NtfyLog4j2Appender to the root logger at Level.ERROR when the environment configures ntfy (NTFY_URL/NTFY_TOPIC, -Dntfy.*, or a trusted classpath ntfy.properties — see Log4j2AmbientConfig for the classpath-endpoint opt-in guard), and does nothing otherwise.

NtfyLogbackConfigurator - Class in io.github.pimak.ntfy.logback

A Logback Configurator SPI implementation that auto-installs the ntfy appender on the root logger with zero XML — activated only when the ambient environment actually configures ntfy.

NtfyLogbackConfigurator() - Constructor for class io.github.pimak.ntfy.logback.NtfyLogbackConfigurator

NtfyLogbackInstaller - Class in io.github.pimak.ntfy.micronaut

Installs the ntfy appender named "ntfy-auto" on the root Logback logger once the Micronaut context has started, and detaches it again on shutdown.

NtfyLogbackInstaller(NtfyConfiguration) - Constructor for class io.github.pimak.ntfy.micronaut.NtfyLogbackInstaller

Creates the installer.

NtfyMeterBinder - Class in io.github.pimak.ntfy.quarkus.runtime

Binds the ntfy pipeline observability counters to Micrometer as three FunctionCounters: ntfy.pipeline.published, ntfy.pipeline.suppressed, and ntfy.pipeline.failed — the same three meters, with the same names and meanings, that the Spring Boot starter exports.

NtfyMeterBinder() - Constructor for class io.github.pimak.ntfy.quarkus.runtime.NtfyMeterBinder

NtfyProperties - Class in io.github.pimak.ntfy.spring

Binds all ntfy.* application properties.

NtfyProperties() - Constructor for class io.github.pimak.ntfy.spring.NtfyProperties

NtfyPublisher - Class in io.github.pimak.ntfy.core

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

NtfyPublisher(HttpClient) - Constructor for class io.github.pimak.ntfy.core.NtfyPublisher

NtfyPublisher(HttpClient, Duration) - Constructor for class io.github.pimak.ntfy.core.NtfyPublisher

NtfyRecorder - Class in io.github.pimak.ntfy.quarkus.runtime

Records the creation of the ntfy log Handler at RUNTIME_INIT.

NtfyRecorder(RuntimeValue<NtfyRuntimeConfig>) - Constructor for class io.github.pimak.ntfy.quarkus.runtime.NtfyRecorder

The run-time config is injected through the recorder constructor.

NtfyRuntimeConfig - Interface in io.github.pimak.ntfy.quarkus.runtime

Run-time configuration surface for the ntfy Quarkus extension, mapped from the quarkus.ntfy.* config namespace.

NtfyStartupSelfTestException - Exception Class in io.github.pimak.ntfy.core

Thrown out of AlertEngine.start() when the startup self-test fails and startup-ping-fail-fast is enabled — the deliberate opt-in that turns a broken alerting configuration into a failed deployment rather than a silent one.

NtfyStartupSelfTestException(String) - Constructor for exception class io.github.pimak.ntfy.core.NtfyStartupSelfTestException

O

of(String, String, long) - Static method in record class io.github.pimak.ntfy.core.AlertEvent

Convenience factory for the "no throwable, no markers" case: causeChain, rootCauseFrames, markerNames and mdcValues default to empty collections, and the event is an AlertLevel.ERROR one.

OFF - Enum constant in enum class io.github.pimak.ntfy.core.StartupPingMode

No self-test.

onApplicationEvent(StartupEvent) - Method in class io.github.pimak.ntfy.micronaut.NtfyLogbackInstaller

Installs the appender once the application context has started.

P

parse(String) - Static method in class io.github.pimak.ntfy.core.DurationParser

Parses value into a Duration.

password() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Basic-auth password.

password(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

PipelineCounters - Class in io.github.pimak.ntfy.core

Read-only, monotonic observability counters for the alert pipeline, letting operators "alert on the alerter" (e.g. a spike in PipelineCounters.failed() signalling a revoked token or a topic ACL change).

PipelineCounters() - Constructor for class io.github.pimak.ntfy.core.PipelineCounters

PipelineCounters.Snapshot - Record Class in io.github.pimak.ntfy.core

An immutable, point-in-time triple of the three counters.

PROBE - Enum constant in enum class io.github.pimak.ntfy.core.StartupPingMode

Read-only reachability check — GET {url}/{topic}/json?poll=1&since=none.

project(List<String>, Function<String, String>) - Static method in class io.github.pimak.ntfy.core.MdcProjector

Reads the allow-listed keys out of a logging context and returns the sanitized, bounded, configured-order map to render into an alert body.

publish(String, String, String, AuthMode, String) - Method in class io.github.pimak.ntfy.core.NtfyPublisher

Deprecated.

publish(String, String, String, AuthMode, String, String, String) - Method in class io.github.pimak.ntfy.core.NtfyPublisher

Deprecated.

publish(String, String, String, AuthMode, String, String, String, String) - Method in class io.github.pimak.ntfy.core.NtfyPublisher

Deprecated.

publish(String, String, String, AuthMode, String, String, String, String, String) - Method in class io.github.pimak.ntfy.core.NtfyPublisher

Deprecated.

publish(LogRecord) - Method in class io.github.pimak.ntfy.jul.NtfyJulAutoHandler

publish(LogRecord) - Method in class io.github.pimak.ntfy.jul.NtfyJulHandler

PUBLISH - Enum constant in enum class io.github.pimak.ntfy.core.StartupPingMode

Posts a real low-priority test notification through the production publish path, so the exact code, headers and credentials that carry real alerts are exercised.

published() - Method in class io.github.pimak.ntfy.core.PipelineCounters

Notifications actually accepted by ntfy (individual + digest publishes).

published() - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Returns the value of the published record component.

PublishResult - Record Class in io.github.pimak.ntfy.core

Outcome of a single NtfyPublisher.publish(java.lang.String, java.lang.String, java.lang.String, io.github.pimak.ntfy.core.AuthMode, java.lang.String) call.

PublishResult(boolean, Integer, String) - Constructor for record class io.github.pimak.ntfy.core.PublishResult

Creates an instance of a PublishResult record class.

R

requestTimeout() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

HTTP request timeout (ntfy duration spelling, e.g.

requestTimeout(Duration) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

requireHttpsForCredentials() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Strict mode: refuse engine activation (rather than only warn) when credentials would be sent over a cleartext http:// endpoint.

requireHttpsForCredentials(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Toggles refusing activation when credentials would traverse a cleartext http:// endpoint.

rootCauseFrames() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the rootCauseFrames record component.

S

setActions(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Action buttons as a raw ntfy Actions header value (short format, e.g.

setActions(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Action buttons as a raw ntfy Actions header value (short format, e.g.

setActions(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the raw ntfy Actions header value.

setActions(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setAppName(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Application name used as the title prefix when no explicit title is set.

setAppName(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setAppName(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the application name.

setAppName(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setAsync(boolean) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Asynchronous (offloaded) delivery: individual error alerts are handed to the engine's bounded work queue and published by a daemon worker, so a slow/unreachable ntfy server never blocks the logging thread.

setAsync(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Turns asynchronous delivery on or off.

setAsync(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setAsync(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Opt into asynchronous (offloaded) delivery: individual error alerts are handed to the engine's bounded work queue and published by a daemon worker, so a slow/unreachable ntfy server never blocks the logging thread.

setAsyncQueueCapacity(int) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Bounded async delivery queue capacity; only consulted when async is true.

setAsyncQueueCapacity(int) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the bounded async delivery queue capacity.

setAsyncQueueCapacity(int) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setAsyncQueueCapacity(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Bounded async delivery queue capacity; only consulted when async is "true".

setCache(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets whether the server may cache published messages.

setCache(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setCache(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

false asks the server not to store the message (Cache: no).

setCache(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

false asks the server not to store the message (Cache: no).

setClickUrl(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

URL opened when a notification is tapped (ntfy Click header).

setClickUrl(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

URL opened when a notification is tapped (ntfy Click header).

setClickUrl(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the click-through URL.

setClickUrl(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setConnectTimeout(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

HTTP connect timeout as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setConnectTimeout(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Accepts a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setConnectTimeout(Duration) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the HTTP connect timeout.

setConnectTimeout(Duration) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setDigestPriority(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Priority header for the aggregated digest.

setDigestPriority(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setDigestPriority(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the priority of digest notifications.

setDigestPriority(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setDigestTags(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Tags header for the aggregated digest.

setDigestTags(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setDigestTags(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the tags attached to digest notifications.

setDigestTags(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setEnabled(boolean) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setEnabled(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Enables or disables the integration.

setEnabled(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setEnabled(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Master switch; "false" keeps the appender inert even with a complete configuration.

setErrorPriority(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Priority header for individual error alerts.

setErrorPriority(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setErrorPriority(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the priority of individual error notifications.

setErrorPriority(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setErrorTags(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Tags header for individual error alerts.

setErrorTags(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setErrorTags(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the tags attached to individual error notifications.

setErrorTags(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setExcludedExceptionTypes(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

A single comma-separated value of fully qualified exception class names.

setExcludedExceptionTypes(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Comma-separated fully qualified exception class names.

setExcludedExceptionTypes(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the comma-separated fully qualified exception class names excluded from alerting.

setExcludedExceptionTypes(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setExcludedLoggers(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

A single comma-separated value of logger-name prefixes to exclude from alerting.

setExcludedLoggers(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

A single comma-separated value of logger-name prefixes to exclude from alerting.

setExcludedLoggers(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the comma-separated logger-name prefixes excluded from alerting.

setExcludedLoggers(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setFirebase(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets whether the server may forward published messages to FCM.

setFirebase(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setFirebase(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

false asks the server not to forward the message to Firebase (Firebase: no).

setFirebase(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

false asks the server not to forward the message to Firebase (Firebase: no).

setIcon(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

URL of the icon shown beside the notification (ntfy Icon header).

setIcon(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

URL of the icon shown beside the notification (ntfy Icon header).

setIcon(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the notification icon URL.

setIcon(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setIconsByLogger(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Per-logger icon overrides as prefix=url pairs separated by commas.

setIconsByLogger(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Per-logger icon overrides as prefix=url pairs separated by commas.

setIconsByLogger(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the per-logger icon overrides.

setIconsByLogger(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setIncludeMdcKeys(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

A single comma-separated allow-list of MDC keys whose values are rendered into alert bodies, one key: value line each.

setIncludeMdcKeys(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

A comma-separated allow-list of MDC keys rendered into alert bodies, one key: value line each, in the order given here.

setIncludeMdcKeys(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the comma-separated allow-list of MDC keys rendered into alert bodies.

setIncludeMdcKeys(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setLocale(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Language of notification bodies and diagnostics as a BCP 47 tag (e.g.

setLocale(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Language of notification bodies and diagnostics as a BCP 47 tag (e.g.

setLocale(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the notification language as a BCP 47 tag.

setLocale(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setMaxAlertsPerWindow(int) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setMaxAlertsPerWindow(int) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the per-window alert budget.

setMaxAlertsPerWindow(int) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setMaxAlertsPerWindow(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Individual alerts allowed per suppression window before digesting kicks in (integer).

setMaxStackFrames(int) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setMaxStackFrames(int) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the number of stack frames included in a notification body.

setMaxStackFrames(int) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setMaxStackFrames(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Maximum root-cause stack frames included in the notification body (integer).

setPassword(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Basic-authentication password.

setPassword(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setPassword(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the basic-authentication password.

setPassword(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setRequestTimeout(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

HTTP request timeout as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setRequestTimeout(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Accepts a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setRequestTimeout(Duration) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the HTTP request timeout.

setRequestTimeout(Duration) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setRequireHttpsForCredentials(boolean) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Strict mode: refuse engine activation (rather than only warn) when credentials would be sent over a cleartext http:// endpoint.

setRequireHttpsForCredentials(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Turns the strict credentials-over-HTTPS requirement on or off.

setRequireHttpsForCredentials(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setRequireHttpsForCredentials(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Strict mode: refuse engine activation (rather than only warn) when credentials would be sent over a cleartext http:// endpoint.

setStartupPing(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Opt-in startup self-test verifying at boot that the configured endpoint, credentials and topic actually work — instead of finding out when the first real error alert fails to deliver.

setStartupPing(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Opt-in startup self-test: off (default), probe (read-only reachability check, publishes nothing) or publish (a real low-priority test notification).

setStartupPing(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Selects the startup self-test mode.

setStartupPing(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

Bound as a String rather than the StartupPingMode enum on purpose: Spring's relaxed binder throws on an unconvertible enum value, which would turn one typo in application.yml into a failed context refresh.

setStartupPingFailFast(boolean) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

When true, a failed startup self-test aborts application startup instead of only warning.

setStartupPingFailFast(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Turns fail-fast on a failed startup self-test on or off.

setStartupPingFailFast(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setStartupPingFailFast(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Whether a failed startup self-test aborts application startup instead of only warning.

setStartupPingNotifyFailures(boolean) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Whether a failed self-test is announced as a notification on a route that PASSED.

setStartupPingNotifyFailures(boolean) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Turns the failure notification on or off.

setStartupPingNotifyFailures(boolean) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setStartupPingNotifyFailures(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Whether a failed self-test is announced on a route that passed.

setStartupPingWarn(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Startup self-test for the optional WARN route, independent of startupPing.

setStartupPingWarn(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Startup self-test for the optional WARN route: off (default), probe or publish.

setStartupPingWarn(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Selects the WARN-route self-test mode; bound as a String for the same reason as NtfyConfiguration.setStartupPing(String).

setStartupPingWarn(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

Bound as a String for the same reason as NtfyProperties.setStartupPing(String).

setSuppressionWindow(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Length of the rate-limiting/digest window as a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setSuppressionWindow(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Accepts a duration string (bare int = ms, Nms/Ns/Nm/Nh/Nd, or ISO-8601).

setSuppressionWindow(Duration) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the storm-suppression window.

setSuppressionWindow(Duration) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setTitle(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Fixed notification title; overrides the derived appName - RootCause title.

setTitle(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setTitle(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the fixed notification title.

setTitle(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setToken(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Bearer token authentication (takes precedence over username/password).

setToken(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setToken(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the bearer access token.

setToken(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setTopic(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Topic alerts are published to.

setTopic(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setTopic(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the ntfy topic.

setTopic(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setUrl(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Base URL of the ntfy server, e.g.

setUrl(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setUrl(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the ntfy server base URL.

setUrl(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setUsername(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

Basic-authentication user name.

setUsername(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

setUsername(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

Sets the basic-authentication username.

setUsername(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setWarnPriority(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Priority header for WARN alerts and the WARN digest; default default.

setWarnPriority(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

ntfy Priority header for WARN alerts and the WARN digest; default default.

setWarnPriority(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

setWarnPriority(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setWarnTags(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

ntfy Tags header for WARN alerts and the WARN digest; default warning.

setWarnTags(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

ntfy Tags header for WARN alerts and the WARN digest; default warning.

setWarnTags(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

setWarnTags(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

setWarnTopic(String) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender.Builder

The topic WARN-level events are published to.

setWarnTopic(String) - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

The topic WARN-level events are published to.

setWarnTopic(String) - Method in class io.github.pimak.ntfy.micronaut.NtfyConfiguration

setWarnTopic(String) - Method in class io.github.pimak.ntfy.spring.NtfyProperties

snapshot() - Method in class io.github.pimak.ntfy.core.PipelineCounters

A single read of all three counters.

Snapshot(long, long, long) - Constructor for record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Creates an instance of a Snapshot record class.

start() - Method in class io.github.pimak.ntfy.core.AlertEngine

url+topic both blank (or engine disabled) -> silently inactive (info, isStarted()==false).

start() - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

Builds an AlertEngine from the injected config (if present) or from the plugin attributes, starts it, and marks this appender started ONLY if the engine actually activated.

start() - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Builds an AlertEngine from the injected config (if present) or from the JavaBean setters, starts it, and marks this appender started ONLY if the engine actually activated.

startupPing() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Opt-in startup self-test: off (default), probe (read-only reachability check that publishes nothing) or publish (a real low-priority test notification).

startupPing(StartupPingMode) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Selects the opt-in startup self-test mode (see NtfyConfig.getStartupPing()).

startupPing(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Convenience overload parsing a configured string (off/probe/publish, case-insensitive) so the XML and properties surfaces bind without carrying their own parser.

startupPingFailFast() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Whether a failed startup self-test aborts application startup instead of only warning.

startupPingFailFast(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Toggles aborting application startup when the self-test fails; see NtfyConfig.isStartupPingFailFast().

StartupPingMode - Enum Class in io.github.pimak.ntfy.core

What the opt-in startup self-test does when AlertEngine.start() finishes activating.

startupPingNotifyFailures() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Whether a failed self-test is announced as a notification on a route that PASSED.

startupPingNotifyFailures(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Toggles announcing a failed self-test on a route that passed; see NtfyConfig.isStartupPingNotifyFailures().

startupPingWarn() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Startup self-test for the optional WARN route: off (default), probe or publish.

startupPingWarn(StartupPingMode) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Selects the startup self-test mode for the WARN route (see NtfyConfig.getStartupPingWarn()).

startupPingWarn(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

Lenient string overload for startup-ping-warn; see NtfyConfig.Builder.startupPing(String).

stop() - Method in class io.github.pimak.ntfy.core.AlertEngine

Releases every resource AlertEngine.start() acquired.

stop() - Method in class io.github.pimak.ntfy.logback.LogbackAlertAppender

Tears the engine down (flushing any pending digest) and marks this appender stopped.

stop(long, TimeUnit) - Method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Appender

Tears the engine down — which flushes any pending digest and drains the async queue — and then delegates to super.stop for the normal appender/filter shutdown.

submit(AlertEvent) - Method in class io.github.pimak.ntfy.core.AlertEngine

Assembles the alert payload, delegates to NtfyPublisher.publish(java.lang.String, java.lang.String, java.lang.String, io.github.pimak.ntfy.core.AuthMode, java.lang.String), and reports any failure exclusively through the injected Diagnostics — never an SLF4J logger, never the token.

success() - Method in record class io.github.pimak.ntfy.core.PublishResult

Returns the value of the success record component.

success(int) - Static method in record class io.github.pimak.ntfy.core.PublishResult

suppressed() - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Returns the value of the suppressed record component.

suppressed() - Method in class io.github.pimak.ntfy.core.PipelineCounters

Events rejected by the rate-limiter gate (over the per-window allowance).

suppressionWindow() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Storm-suppression window (ntfy duration spelling, e.g.

suppressionWindow(Duration) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

T

timestampMillis() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns the value of the timestampMillis record component.

title() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Fixed notification title; falls back to NtfyRuntimeConfig.appName() when unset.

title(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

token() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Bearer/access token (ntfy tk_...); takes precedence over username/password.

token(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

topic() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Topic to publish to.

topic(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

toString() - Method in record class io.github.pimak.ntfy.core.AlertEvent.Cause

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Broadcast

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.PipelineCounters.Snapshot

Returns a string representation of this record class.

toString() - Method in record class io.github.pimak.ntfy.core.PublishResult

Returns a string representation of this record class.

U

uninstall() - Method in class io.github.pimak.ntfy.micronaut.NtfyLogbackInstaller

Stops the installed appender and detaches it from the root logger on context shutdown.

uninstall(Logger, NtfyJulHandler) - Static method in class io.github.pimak.ntfy.jul.NtfyJulInstaller

Detaches handler from logger and stops its engine.

uninstall(LoggerContext, NtfyLog4j2Appender) - Static method in class io.github.pimak.ntfy.log4j2.NtfyLog4j2Installer

Reverses NtfyLog4j2Installer.install(LoggerContext): deregisters the reconfiguration listener, detaches the appender from the root logger by name, refreshes the loggers and stops the appender (which flushes any pending digest and drains the async queue).

url() - Method in record class io.github.pimak.ntfy.core.NtfyAction.Http

Returns the value of the url record component.

url() - Method in record class io.github.pimak.ntfy.core.NtfyAction.View

Returns the value of the url record component.

url() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Base URL of the ntfy server, e.g.

url(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

username() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

Basic-auth username (used with NtfyRuntimeConfig.password() when no NtfyRuntimeConfig.token() is set).

username(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

V

value() - Method in record class io.github.pimak.ntfy.core.NtfyAction.BroadcastExtra

Returns the value of the value record component.

value() - Method in record class io.github.pimak.ntfy.core.NtfyAction.HttpHeader

Returns the value of the value record component.

valueOf(String) - Static method in enum class io.github.pimak.ntfy.core.AlertLevel

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class io.github.pimak.ntfy.core.StartupPingMode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.pimak.ntfy.core.AlertLevel

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class io.github.pimak.ntfy.core.StartupPingMode

Returns an array containing the constants of this enum class, in the order they are declared.

view(String, String) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

A view action opening url when tapped.

view(String, String, boolean) - Static method in interface io.github.pimak.ntfy.core.NtfyAction

A view action opening url; clear dismisses the notification on tap.

View(String, String, boolean) - Constructor for record class io.github.pimak.ntfy.core.NtfyAction.View

Creates an instance of a View record class.

W

warn(String) - Method in interface io.github.pimak.ntfy.core.Diagnostics

Records a warning (partial config, a publish failure, an invalid window fallback, ...).

WARN - Enum constant in enum class io.github.pimak.ntfy.core.AlertLevel

Warning-level.

warnPriority() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy priority header for WARN alerts and the WARN digest.

warnPriority(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

ntfy Priority header for WARN alerts and the WARN digest; default default.

warnTags() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

ntfy tags header for WARN alerts and the WARN digest.

warnTags(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

ntfy Tags header for WARN alerts and the WARN digest; default warning.

warnTopic() - Method in interface io.github.pimak.ntfy.quarkus.runtime.NtfyRuntimeConfig

The ntfy topic WARN-level events are published to.

warnTopic(String) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

The topic WARN-level events are published to.

warnTopicFromClasspathFile(boolean) - Method in class io.github.pimak.ntfy.core.NtfyConfig.Builder

See NtfyConfig.isWarnTopicFromClasspathFile(); set by ConfigLoader only.

withLevel(AlertLevel) - Method in record class io.github.pimak.ntfy.core.AlertEvent

Returns a copy of this event on level, leaving every other component untouched.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form