java.lang.Object
- com.google.gerrit.server.securestore.SecureStore

Direct Known Subclasses:

DefaultSecureStore
```
public abstract class SecureStore
extends Object
```
Abstract class for providing new SecureStore implementation for Gerrit.
SecureStore is responsible for storing sensitive data like passwords in a secure manner.
It is implementator's responsibility to encrypt and store values.
To deploy new SecureStore one needs to provide a jar file with explicitly one class that extends SecureStore and put it in Gerrit server. Then run:
`java -jar gerrit.war SwitchSecureStore -d $gerrit_site --new-secure-store-lib $path_to_new_secure_store.jar`
on stopped Gerrit instance.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SecureStore.EntryKey
Describes SecureStore entry

Constructor Summary

Constructors
Constructor Description

SecureStore()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`get(String section, String subsection, String name)`	Extract decrypted value of stored property from SecureStore or `null` when property was not found.
`String`	`getForPlugin(String pluginName, String section, String subsection, String name)`	Extract decrypted value of stored plugin config property from SecureStore or `null` when property was not found.
`abstract String[]`	`getList(String section, String subsection, String name)`	Extract list of values from SecureStore and decrypt every value in that list or `null` when property was not found.
`abstract String[]`	`getListForPlugin(String pluginName, String section, String subsection, String name)`	Extract list of plugin config values from SecureStore and decrypt every value in that list, or `null` when property was not found.
`abstract boolean`	`isOutdated()`	Returns `true` if currently loaded values are outdated
`abstract Iterable<SecureStore.EntryKey>`	`list()`	Returns list of stored entries.
`abstract void`	`reload()`	Reload the values
`void`	`set(String section, String subsection, String name, String value)`	Store single value in SecureStore.
`abstract void`	`setList(String section, String subsection, String name, List<String> values)`	Store list of values in SecureStore.
`abstract void`	`unset(String section, String subsection, String name)`	Remove value for given `section`, `subsection` and `name` from SecureStore.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SecureStore
```
public SecureStore()
```

Method Detail

get

public final String get(String section,
                        String subsection,
                        String name)

Extract decrypted value of stored property from SecureStore or null when property was not found.

Returns:: decrypted String value or null if not found

getForPlugin

public final String getForPlugin(String pluginName,
                                 String section,
                                 String subsection,
                                 String name)

Extract decrypted value of stored plugin config property from SecureStore or null when property was not found.

Returns:: decrypted String value or null if not found

getListForPlugin

public abstract String[] getListForPlugin(String pluginName,
                                          String section,
                                          String subsection,
                                          String name)

Extract list of plugin config values from SecureStore and decrypt every value in that list, or null when property was not found.

Returns:: decrypted list of string values or null

getList

public abstract String[] getList(String section,
                                 String subsection,
                                 String name)

Extract list of values from SecureStore and decrypt every value in that list or null when property was not found.

Returns:: decrypted list of string values or null

set

public final void set(String section,
                      String subsection,
                      String name,
                      String value)

Store single value in SecureStore.

This method is responsible for encrypting value and storing it.

Parameters:: value - plain text value

setList

public abstract void setList(String section,
                             String subsection,
                             String name,
                             List<String> values)

Store list of values in SecureStore.

This method is responsible for encrypting all values in the list and storing them.

Parameters:: values - list of plain text values

unset

public abstract void unset(String section,
                           String subsection,
                           String name)

Remove value for given section, subsection and name from SecureStore.

list

public abstract Iterable<SecureStore.EntryKey> list()

Returns list of stored entries.

isOutdated
```
public abstract boolean isOutdated()
```
Returns true if currently loaded values are outdated

reload
```
public abstract void reload()
```
Reload the values

Class SecureStore

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecureStore