Verified Owner
Top Description Inners Fields Constructors Methods
org.jabref.logic.shared

public Class SharedDatabaseSessionService

extends Object
Class Inheritance
Annotations
@NullMarked
Imports
java.util.List, .Map, java.util.function.Function, org.jabref.logic.preferences.LastFilesOpenedPreferences, org.jabref.logic.shared.prefs.SharedDatabasePreferences, org.jabref.model.database.BibDatabaseContext, org.jspecify.annotations.NullMarked
Manages the persisted state of shared databases between application sessions.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static record
SharedDatabaseSessionService.Reconnection

Field Summary

Modifier and TypeField and Description
private final Function<String, DBMSConnectionProperties>
connectionPropertiesFactory

Constructor Summary

AccessConstructor and Description
public
SharedDatabaseSessionService()

pack-priv
SharedDatabaseSessionService(Function<String, DBMSConnectionProperties> connectionPropertiesFactory)

Method Summary

Modifier and TypeMethod and Description
public List<SharedDatabaseSessionService.Reconnection>
getDatabasesToReconnect(LastFilesOpenedPreferences lastFilesOpenedPreferences)

Returns all shared databases remembered for reconnection, including databases with an empty password.

public void
persistConnections(Map<String, DatabaseConnectionProperties> sharedDatabases)

Persists the connection settings of the shared databases that remain open until quit is confirmed.

public void
restoreSharedDatabaseId(BibDatabaseContext databaseContext, String sharedDatabaseId)

Restores the identifier used to find a shared database's stored connection settings.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

connectionPropertiesFactoryback to summary
private final Function<String, DBMSConnectionProperties> connectionPropertiesFactory

Constructor Detail

SharedDatabaseSessionServiceback to summary
public SharedDatabaseSessionService()
SharedDatabaseSessionServiceback to summary
pack-priv SharedDatabaseSessionService(Function<String, DBMSConnectionProperties> connectionPropertiesFactory)

Method Detail

getDatabasesToReconnectback to summary
public List<SharedDatabaseSessionService.Reconnection> getDatabasesToReconnect(LastFilesOpenedPreferences lastFilesOpenedPreferences)

Returns all shared databases remembered for reconnection, including databases with an empty password.

persistConnectionsback to summary
public void persistConnections(Map<String, DatabaseConnectionProperties> sharedDatabases)

Persists the connection settings of the shared databases that remain open until quit is confirmed.

restoreSharedDatabaseIdback to summary
public void restoreSharedDatabaseId(BibDatabaseContext databaseContext, String sharedDatabaseId)

Restores the identifier used to find a shared database's stored connection settings.

org.jabref.logic.shared back to summary

public final Record SharedDatabaseSessionService.Reconnection

extends Record
Class Inheritance
Record Components
sharedDatabaseId:String 
connectionProperties:DBMSConnectionProperties 

Field Summary

Modifier and TypeField and Description
private final DBMSConnectionProperties
connectionProperties

Record Component accessed by connectionProperties().

private final String
sharedDatabaseId

Record Component accessed by sharedDatabaseId().

Constructor Summary

AccessConstructor and Description
public
Reconnection(String sharedDatabaseId, DBMSConnectionProperties connectionProperties)

Method Summary

Modifier and TypeMethod and Description
public DBMSConnectionProperties
connectionProperties()

Record Component getter of connectionProperties.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public String
sharedDatabaseId()

Record Component getter of sharedDatabaseId.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

connectionPropertiesback to summary
private final DBMSConnectionProperties connectionProperties

Record Component accessed by connectionProperties().

sharedDatabaseIdback to summary
private final String sharedDatabaseId

Record Component accessed by sharedDatabaseId().

Constructor Detail

Reconnectionback to summary
public Reconnection(String sharedDatabaseId, DBMSConnectionProperties connectionProperties)

Method Detail

connectionPropertiesback to summary
public DBMSConnectionProperties connectionProperties()

Record Component getter of connectionProperties.

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

sharedDatabaseIdback to summary
public String sharedDatabaseId()

Record Component getter of sharedDatabaseId.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.