co.codewizards.cloudstore.core.repo.local

Interface LocalRepoManager

All Superinterfaces:

AutoCloseable

public interface LocalRepoManager
extends AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_ID_SIMPLE_ID
static String	CONFIG_KEY_CLOSE_DEFERRED_MILLIS
static long	DEFAULT_CLOSE_DEFERRED_MILLIS
static int	DEFAULT_KEY_SIZE
static String	META_DIR_NAME
static String	PERSISTENCE_PROPERTIES_FILE_NAME
static String	PROP_REPOSITORY_ALIASES Aliases separated by '/' (because '/' is an illegal character for an alias).
static String	PROP_REPOSITORY_ID
static String	PROP_VERSION
static String	REPO_TEMP_DIR_NAME Repository-wide global directory inside the meta-directory.
static String	REPOSITORY_LOCK_FILE_NAME
static String	REPOSITORY_PROPERTIES_FILE_NAME
static String	SYSTEM_PROPERTY_CLOSE_DEFERRED_MILLIS Deprecated. replaced by CONFIG_KEY_CLOSE_DEFERRED_MILLIS.
static String	SYSTEM_PROPERTY_KEY_SIZE
static String	TEMP_DIR_NAME Temporary directory potentially inside every directory.
static String	TEMP_NEW_FILE_PREFIX
static String	VAR_LOCAL_ROOT
static String	VAR_META_DIR
static String	VAR_REPOSITORY_ID

Method Summary

Modifier and Type	Method and Description
void	addLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)
LocalRepoTransaction	beginReadTransaction() Begin a JDO transaction for read operations only in the underlying database.
LocalRepoTransaction	beginWriteTransaction() Begin a JDO transaction for read and write operations in the underlying database.
void	close() Closes this LocalRepoManager.
void	deleteRemoteRepository(UUID repositoryId) Deletes a remote repository from the local database.
void	finalize() Deprecated. Do not invoke this method directly! It is declared in this interface to make sure the proxy's InvocationHandler is invoked when the garbage-collector collects the proxy.
String	getLocalPathPrefixOrFail(URL remoteRoot) Gets the local path-prefix (of the local repository managed by this LocalRepoManager) when syncing with the remote repository identified by the given remoteRoot.
String	getLocalPathPrefixOrFail(UUID repositoryId) Gets the local path-prefix (of the local repository managed by this LocalRepoManager) when syncing with the remote repository identified by the given remoteRoot.
LocalRepoMetaData	getLocalRepoMetaData()
File	getLocalRoot() Gets the repository's local root directory.
Lock	getLock()
byte[]	getPrivateKey() Gets the local repository's private key.
byte[]	getPublicKey() Gets the local repository's public key.
Map<UUID,URL>	getRemoteRepositoryId2RemoteRootMap()
UUID	getRemoteRepositoryIdOrFail(URL remoteRoot) Gets the unique ID of the remote repository identified by the given remoteRoot.
byte[]	getRemoteRepositoryPublicKeyOrFail(UUID repositoryId) Gets the remote repository's public key.
UUID	getRepositoryId() Gets the local repository's unique ID.
boolean	isOpen() Gets the open state.
void	localSync(ProgressMonitor monitor) Synchronises the local file system with the local database.
void	putRemoteRepository(UUID repositoryId, URL remoteRoot, byte[] publicKey, String localPathPrefix) Adds or relocates a remote repository.
void	putRepositoryAlias(String repositoryAlias)
void	removeLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)
void	removeRepositoryAlias(String repositoryAlias)

Field Detail

APP_ID_SIMPLE_ID

static final String APP_ID_SIMPLE_ID

SYSTEM_PROPERTY_KEY_SIZE

static final String SYSTEM_PROPERTY_KEY_SIZE

DEFAULT_KEY_SIZE

static final int DEFAULT_KEY_SIZE

See Also:

Constant Field Values

SYSTEM_PROPERTY_CLOSE_DEFERRED_MILLIS

@Deprecated
static final String SYSTEM_PROPERTY_CLOSE_DEFERRED_MILLIS

Deprecated. replaced by CONFIG_KEY_CLOSE_DEFERRED_MILLIS.

CONFIG_KEY_CLOSE_DEFERRED_MILLIS

static final String CONFIG_KEY_CLOSE_DEFERRED_MILLIS

See Also:

Constant Field Values

DEFAULT_CLOSE_DEFERRED_MILLIS

static final long DEFAULT_CLOSE_DEFERRED_MILLIS

See Also:

Constant Field Values

META_DIR_NAME

static final String META_DIR_NAME

TEMP_DIR_NAME

static final String TEMP_DIR_NAME

Temporary directory potentially inside every directory.

For example: ${repo}/Accounting/2019/.cloudstore-tmp/

TEMP_NEW_FILE_PREFIX

static final String TEMP_NEW_FILE_PREFIX

REPO_TEMP_DIR_NAME

static final String REPO_TEMP_DIR_NAME

Repository-wide global directory inside the meta-directory.

For example: ${repo}/.cloudstore-repo/tmp/

See Also:

Constant Field Values

REPOSITORY_LOCK_FILE_NAME

static final String REPOSITORY_LOCK_FILE_NAME

REPOSITORY_PROPERTIES_FILE_NAME

static final String REPOSITORY_PROPERTIES_FILE_NAME

PROP_REPOSITORY_ID

static final String PROP_REPOSITORY_ID

See Also:

Constant Field Values

PROP_VERSION

static final String PROP_VERSION

See Also:

Constant Field Values

PROP_REPOSITORY_ALIASES

static final String PROP_REPOSITORY_ALIASES

Aliases separated by '/' (because '/' is an illegal character for an alias).

To make scripting easier (e.g. using grep), the aliases start and end with a '/'. For example: "/alias1/alias2/alias3/"

See Also:

Constant Field Values

PERSISTENCE_PROPERTIES_FILE_NAME

static final String PERSISTENCE_PROPERTIES_FILE_NAME

VAR_REPOSITORY_ID

static final String VAR_REPOSITORY_ID

See Also:

Constant Field Values

VAR_LOCAL_ROOT

static final String VAR_LOCAL_ROOT

See Also:

Constant Field Values

VAR_META_DIR

static final String VAR_META_DIR

See Also:

Constant Field Values

Method Detail

getLocalRoot

File getLocalRoot()

Gets the repository's local root directory.

This file is canonical (absolute and symbolic links resolved).

Returns:

the repository's local root directory. Never null.

getRepositoryId

UUID getRepositoryId()

Gets the local repository's unique ID.

This is LocalRepository.entityID in the local repository database.

Returns:

the local repository's unique ID. Never null.

getPrivateKey

byte[] getPrivateKey()

Gets the local repository's private key.

This is always an RSA key - other key types are not (yet) supported.

Returns:

the local repository's private key. Never null.

getPublicKey

byte[] getPublicKey()

Gets the local repository's public key.

This is always an RSA key - other key types are not (yet) supported.

Returns:

the local repository's public key. Never null.

getRemoteRepositoryPublicKeyOrFail

byte[] getRemoteRepositoryPublicKeyOrFail(UUID repositoryId)

Gets the remote repository's public key.

This is always an RSA key - other key types are not (yet) supported.

Parameters:

repositoryId - the remote repository's unique ID. Must not be null.

Returns:

the remote repository's public key. Never null.

Throws:

IllegalArgumentException - if there is no remote-repository with the given repositoryId.

addLocalRepoManagerCloseListener

void addLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)

removeLocalRepoManagerCloseListener

void removeLocalRepoManagerCloseListener(LocalRepoManagerCloseListener listener)

isOpen

boolean isOpen()

Gets the open state.

If this is false, the LocalRepoManager instance cannot be used anymore. Due to the proxy-mechanism, this does, however, not mean that the backend is really shut down.

Returns:

the open state.

close

void close()

Closes this LocalRepoManager.

Important: The LocalRepoManagerFactory always returns a proxy. It never returns the real backend-instance. Calling close() closes the proxy and thus renders it unusable. It decrements the real backend-instance's reference counter. As soon as this reaches 0, the backend is really closed - which may happen delayed (for performance reasons).

Specified by:

close in interface AutoCloseable

beginReadTransaction

LocalRepoTransaction beginReadTransaction()

Begin a JDO transaction for read operations only in the underlying database.

Returns:

the transaction handle. Never null.

beginWriteTransaction

LocalRepoTransaction beginWriteTransaction()

Begin a JDO transaction for read and write operations in the underlying database.

Returns:

the transaction handle. Never null.

localSync

void localSync(ProgressMonitor monitor)

Synchronises the local file system with the local database.

Registers every directory and file in the repository's local root and its sub-directories.

putRemoteRepository

void putRemoteRepository(UUID repositoryId,
                         URL remoteRoot,
                         byte[] publicKey,
                         String localPathPrefix)

Adds or relocates a remote repository.

Parameters:

repositoryId - the remote repository's unique ID. Must not be null. This is LocalRepository.entityID in the remote database and will become RemoteRepository.entityID in the local database.

remoteRoot - the URL of the remote repository. May be null (in the server, a RemoteRepository never has a remoteRoot).

localPathPrefix - TODO

deleteRemoteRepository

void deleteRemoteRepository(UUID repositoryId)

Deletes a remote repository from the local database.

Does nothing, if the specified repository does not exist.

Parameters:

repositoryId - the remote repository's unique ID. Must not be null.

getRemoteRepositoryId2RemoteRootMap

Map<UUID,URL> getRemoteRepositoryId2RemoteRootMap()

getLocalPathPrefixOrFail

String getLocalPathPrefixOrFail(URL remoteRoot)

Gets the local path-prefix (of the local repository managed by this LocalRepoManager) when syncing with the remote repository identified by the given remoteRoot.

Parameters:

remoteRoot - the remote repository's root-URL (not necessarily its real root, but the root URL connected to the local repository). Must not be null.

Returns:

the local path-prefix. Never null, but maybe empty.

Throws:

IllegalArgumentException - if there is no remote-repository with the given remoteRoot.

getLocalPathPrefixOrFail

String getLocalPathPrefixOrFail(UUID repositoryId)

Gets the local path-prefix (of the local repository managed by this LocalRepoManager) when syncing with the remote repository identified by the given remoteRoot.

Parameters:

repositoryId - the remote repository's unique ID. Must not be null.

Returns:

the local path-prefix. Never null, but maybe empty.

Throws:

IllegalArgumentException - if there is no remote-repository with the given remoteRoot.

getRemoteRepositoryIdOrFail

UUID getRemoteRepositoryIdOrFail(URL remoteRoot)

Gets the unique ID of the remote repository identified by the given remoteRoot.

Parameters:

remoteRoot - the remote repository's root-URL (not necessarily its real root, but the root URL connected to the local repository). Must not be null.

Returns:

the remote repository's unique ID. Never null.

Throws:

IllegalArgumentException - if there is no remote-repository with the given remoteRoot.

getLock

Lock getLock()

finalize

@Deprecated
void finalize()
                   throws Throwable

Deprecated. Do not invoke this method directly! It is declared in this interface to make sure the proxy's InvocationHandler is invoked when the garbage-collector collects the proxy.

Throws:

Throwable

putRepositoryAlias

void putRepositoryAlias(String repositoryAlias)

removeRepositoryAlias

void removeRepositoryAlias(String repositoryAlias)

getLocalRepoMetaData

LocalRepoMetaData getLocalRepoMetaData()