Class FileDataStoreFactory

java.lang.Object

com.google.api.client.util.store.AbstractDataStoreFactory

com.google.api.client.util.store.FileDataStoreFactory

All Implemented Interfaces:

DataStoreFactory

public class FileDataStoreFactory
extends AbstractDataStoreFactory

Thread-safe file implementation of a credential store.

For security purposes, the file's permissions are set such that the file is only accessible by the file's owner.

Note: this class is not compatible with Android lower than API level 26 (Oreo). For an implementation compatible with Android invalid input: '<' 26, please use com.google.api.client.extensions.android.util.store.FileDataStoreFactory which is provided by com.google.http-client:google-http-client-android.

Since:

1.16

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	FileDataStoreFactory.FileDataStore<V extends Serializable>	File data store that inherits from the abstract memory data store because the key-value pairs are stored in a memory cache, and saved in the file (see FileDataStoreFactory.FileDataStore.save() when changing values.

Field Summary

Fields

Modifier and Type	Field	Description
private final File	dataDirectory	Directory to store data.
private static final boolean	IS_WINDOWS

Constructor Summary

Constructors

Constructor	Description
FileDataStoreFactory(File dataDirectory)

Method Summary

Modifier and Type	Method	Description
protected <V extends Serializable> DataStore<V>	createDataStore(String id)	Returns a new instance of a type-specific data store based on the given unique ID.
final File	getDataDirectory()	Returns the data directory.
private static void	setPermissionsToOwnerOnly(File file)	Attempts to set the given file's permissions such that it can only be read, written, and executed by the file's owner.
private static void	setPermissionsToOwnerOnlyWindows(File file)

Methods inherited from class AbstractDataStoreFactory

getDataStore

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

IS_WINDOWS

private static final boolean IS_WINDOWS

dataDirectory

private final File dataDirectory

Directory to store data.

Constructor Details

FileDataStoreFactory

public FileDataStoreFactory(File dataDirectory)
                     throws IOException

Parameters:

dataDirectory - data directory

Throws:

IOException

Method Details

getDataDirectory

public final File getDataDirectory()

Returns the data directory.

createDataStore

protected <V extends Serializable> DataStore<V> createDataStore(String id)
                                                         throws IOException

Description copied from class: AbstractDataStoreFactory

Returns a new instance of a type-specific data store based on the given unique ID.

The DataStore.getId() must match the id parameter from this method.

Specified by:

createDataStore in class AbstractDataStoreFactory

Type Parameters:

V - serializable type of the mapped value

Parameters:

id - unique ID to refer to typed data store

Throws:

IOException

setPermissionsToOwnerOnly

private static void setPermissionsToOwnerOnly(File file)
                                       throws IOException

Attempts to set the given file's permissions such that it can only be read, written, and executed by the file's owner.

Parameters:

file - the file's permissions to modify

Throws:

IOException - if the permissions can't be set

setPermissionsToOwnerOnlyWindows

private static void setPermissionsToOwnerOnlyWindows(File file)
                                              throws IOException

Throws:

IOException