Top Description Fields Constructors Methods

org.jabref.logic.shared.notifications

public Class Notifier

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.shared.notifications.Notifier

Annotations

@NullMarked

Imports

java.nio.charset.StandardCharsets, java.sql.Connection, .PreparedStatement, .SQLException, java.util.Optional, org.jabref.model.entry.BibEntry, org.jabref.model.entry.event.FieldChangedEvent, com.google.gson.Gson, .GsonBuilder, org.jspecify.annotations.NullMarked, org.slf4j.Logger, .LoggerFactory

Notifies the other clients connected to the same database about changes.

Field Summary

Modifier and Type	Field and Description
public static final String	CHANNEL Used as string argument to `pg_notify`, which - unlike the `LISTEN` command - does not case-fold its channel argument.
private final Connection	connection
private final Gson	gson
private static final Logger	LOGGER
private static final int	MAX_PAYLOAD_BYTES
public static final String	METADATA_CHANNEL Channel on which the database-side `upsert_metadata` function announces changed metadata values
private final String	processorId

Constructor Summary

Access	Constructor and Description
public	Notifier(Connection connection, String processorId)

Method Summary

Modifier and Type	Method and Description
private FieldChange	createPayload(FieldChangedEvent event)
public void	notifyAboutChangedField(FieldChangedEvent event)
public void	notifyClientsToPull() Asks all other clients to pull.
private void	send(FieldChange payload)
private FieldChange	withoutContent() A payload without content makes receivers pull the changes from the database instead

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHANNEL	back to summary
public static final String CHANNEL Used as string argument to `pg_notify`, which - unlike the `LISTEN` command - does not case-fold its channel argument. Both sides therefore use this constant verbatim (the listener quotes it in `LISTEN`).

connection	back to summary
private final Connection connection

gson	back to summary
private final Gson gson

LOGGER	back to summary
private static final Logger LOGGER

MAX_PAYLOAD_BYTES	back to summary
private static final int MAX_PAYLOAD_BYTES

METADATA_CHANNEL	back to summary
public static final String METADATA_CHANNEL Channel on which the database-side `upsert_metadata` function announces changed metadata values

processorId	back to summary
private final String processorId

Constructor Detail

Notifier	back to summary
public Notifier(Connection connection, String processorId)

Method Detail

createPayload	back to summary
private FieldChange createPayload(FieldChangedEvent event)

notifyAboutChangedField	back to summary
public void notifyAboutChangedField(FieldChangedEvent event)

notifyClientsToPull	back to summary
public void notifyClientsToPull() Asks all other clients to pull. Used when changes reached the database without a single field-change event describing them - e.g. flushed micro-edits, which are written as a whole entry.

send	back to summary
private void send(FieldChange payload)

withoutContent	back to summary
private FieldChange withoutContent() A payload without content makes receivers pull the changes from the database instead