Verified Owner
Top Fields Constructors Methods
org.jabref.logic.shared.prefs

public Class SharedDatabasePreferences

extends Object
Class Inheritance
Imports
java.io.UnsupportedEncodingException, java.security.GeneralSecurityException, java.util.Optional, java.util.prefs.BackingStoreException, .Preferences, org.jabref.logic.shared.DatabaseConnectionProperties, org.jabref.logic.shared.security.Password, org.jabref.logic.util.strings.StringUtil, com.github.javakeyring.Keyring, .PasswordAccessException, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private static final String
private final Preferences
private static final String
private final String
private static final Logger
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
SHARED_DATABASE_PASSWORD

Legacy key: the password used to be stored AES-encrypted in these preferences; it now lives in the system keyring

private static final String
private static final String
private static final String
private static final String
private static final String

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public void
public static void
public void
public boolean
public Optional<String>
public Optional<String>
public Optional<String>
public Optional<String>
private Optional<String>
public Optional<String>
getPassword()

Returns: the plain password from the system keyring; empty if none is stored or the keyring is unavailable

public Optional<String>
public boolean
public Optional<String>
public Optional<String>
public boolean
public boolean
private Optional<String>
public void
public void
setAutosave(boolean autosave)

public void
setExpertMode(boolean expertMode)

public void
setFolder(String folder)

public void
public void
setJdbcUrl(String jdbcUrl)

public void
public boolean

Returns:

whether the keyring operation succeeded
setPassword
(String password)

Stores the plain password in the system keyring; a blank password clears it.

public void
public void
setRememberPassword(boolean rememberPassword)

public void
public void
public void
setUseSSL(boolean useSSL)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_NODEback to summary
private static final String DEFAULT_NODE
internalPrefsback to summary
private final Preferences internalPrefs
KEYRING_SERVICEback to summary
private static final String KEYRING_SERVICE
keyringAccountback to summary
private final String keyringAccount
LOGGERback to summary
private static final Logger LOGGER
PREFERENCES_PATH_NAMEback to summary
private static final String PREFERENCES_PATH_NAME
SHARED_DATABASE_AUTOSAVEback to summary
private static final String SHARED_DATABASE_AUTOSAVE
SHARED_DATABASE_EXPERT_MODEback to summary
private static final String SHARED_DATABASE_EXPERT_MODE
SHARED_DATABASE_FOLDERback to summary
private static final String SHARED_DATABASE_FOLDER
SHARED_DATABASE_HOSTback to summary
private static final String SHARED_DATABASE_HOST
SHARED_DATABASE_JDBC_URLback to summary
private static final String SHARED_DATABASE_JDBC_URL
SHARED_DATABASE_NAMEback to summary
private static final String SHARED_DATABASE_NAME
SHARED_DATABASE_PASSWORDback to summary
private static final String SHARED_DATABASE_PASSWORD

Legacy key: the password used to be stored AES-encrypted in these preferences; it now lives in the system keyring

SHARED_DATABASE_PORTback to summary
private static final String SHARED_DATABASE_PORT
SHARED_DATABASE_REMEMBER_PASSWORDback to summary
private static final String SHARED_DATABASE_REMEMBER_PASSWORD
SHARED_DATABASE_TYPEback to summary
private static final String SHARED_DATABASE_TYPE
SHARED_DATABASE_USE_SSLback to summary
private static final String SHARED_DATABASE_USE_SSL
SHARED_DATABASE_USERback to summary
private static final String SHARED_DATABASE_USER

Constructor Detail

SharedDatabasePreferencesback to summary
public SharedDatabasePreferences()
SharedDatabasePreferencesback to summary
public SharedDatabasePreferences(String sharedDatabaseID)

Method Detail

clearback to summary
public void clear() throws BackingStoreException
clearAllback to summary
public static void clearAll() throws BackingStoreException
clearPasswordback to summary
public void clearPassword()
getAutosaveback to summary
public boolean getAutosave()
getFolderback to summary
public Optional<String> getFolder()
getHostback to summary
public Optional<String> getHost()
getJdbcUrlback to summary
public Optional<String> getJdbcUrl()
getNameback to summary
public Optional<String> getName()
getOptionalValueback to summary
private Optional<String> getOptionalValue(String key)
getPasswordback to summary
public Optional<String> getPassword()
Returns:Optional<String>

the plain password from the system keyring; empty if none is stored or the keyring is unavailable

getPortback to summary
public Optional<String> getPort()
getRememberPasswordback to summary
public boolean getRememberPassword()
getTypeback to summary
public Optional<String> getType()
getUserback to summary
public Optional<String> getUser()
isUseExpertModeback to summary
public boolean isUseExpertMode()
isUseSSLback to summary
public boolean isUseSSL()
migrateLegacyPasswordback to summary
private Optional<String> migrateLegacyPassword()
putAllDBMSConnectionPropertiesback to summary
public void putAllDBMSConnectionProperties(DatabaseConnectionProperties properties)
setAutosaveback to summary
public void setAutosave(boolean autosave)
setExpertModeback to summary
public void setExpertMode(boolean expertMode)
setFolderback to summary
public void setFolder(String folder)
setHostback to summary
public void setHost(String host)
setJdbcUrlback to summary
public void setJdbcUrl(String jdbcUrl)
setNameback to summary
public void setName(String name)
setPasswordback to summary
public boolean setPassword(String password)

Stores the plain password in the system keyring; a blank password clears it.

Returns:boolean

whether the keyring operation succeeded

setPortback to summary
public void setPort(String port)
setRememberPasswordback to summary
public void setRememberPassword(boolean rememberPassword)
setTypeback to summary
public void setType(String type)
setUserback to summary
public void setUser(String user)
setUseSSLback to summary
public void setUseSSL(boolean useSSL)