co.codewizards.cloudstore.core.repo.transport

Class AbstractRepoTransport

java.lang.Object

co.codewizards.cloudstore.core.repo.transport.AbstractRepoTransport

All Implemented Interfaces:

RepoTransport, AutoCloseable

Direct Known Subclasses:

FileRepoTransport, RestRepoTransport

public abstract class AbstractRepoTransport
extends Object
implements RepoTransport

Constructor Summary

Constructors

Constructor and Description
AbstractRepoTransport()

Method Summary

Modifier and Type	Method and Description
void	close()
protected String	determinePathPrefix()
protected abstract URL	determineRemoteRootWithoutPathPrefix()
protected void	finalize()
UUID	getClientRepositoryId() Gets the client repository's unique identifier.
UUID	getClientRepositoryIdOrFail()
String	getPathPrefix() Prefix for every path (as used in RepoTransport.delete(String) for example).
URL	getRemoteRoot() Gets the remote repository's root URL, maybe including a path-prefix.
URL	getRemoteRootWithoutPathPrefix() Gets the remote repository's root URL without the path-prefix.
RepoTransportFactory	getRepoTransportFactory() Gets the factory which created this instance.
protected boolean	isPathUnderPathPrefix(String path)
String	prefixPath(String path) Prepend the pathPrefix to the given path.
void	setClientRepositoryId(UUID clientRepositoryId) Sets the client's repository identifier.
void	setRemoteRoot(URL remoteRoot) Sets the remote repository's root URL.
void	setRepoTransportFactory(RepoTransportFactory repoTransportFactory) Sets the factory which created this instance.
String	unprefixPath(String path) Cut the pathPrefix from the given path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.codewizards.cloudstore.core.repo.transport.RepoTransport

beginPutFile, copy, delete, endPutFile, endSyncFromRepository, endSyncToRepository, getChangeSetDto, getClientRepositoryDto, getFileData, getPublicKey, getRepoFileDto, getRepositoryDto, getRepositoryId, getVersionInfoDto, makeDirectory, makeSymlink, move, prepareForChangeSetDto, putFileData, putParentConfigPropSetDto, requestRepoConnection

Constructor Detail

AbstractRepoTransport

public AbstractRepoTransport()

Method Detail

getRepoTransportFactory

public RepoTransportFactory getRepoTransportFactory()

Description copied from interface: RepoTransport

Gets the factory which created this instance.

Specified by:

getRepoTransportFactory in interface RepoTransport

Returns:

the factory which created this instance. Should never be null, if properly initialised.

See Also:

RepoTransport.setRepoTransportFactory(RepoTransportFactory)

setRepoTransportFactory

public void setRepoTransportFactory(RepoTransportFactory repoTransportFactory)

Description copied from interface: RepoTransport

Sets the factory which created this instance.

Specified by:

setRepoTransportFactory in interface RepoTransport

Parameters:

repoTransportFactory - the factory which created this instance. Must not be null.

See Also:

RepoTransport.getRepoTransportFactory()

getRemoteRoot

public URL getRemoteRoot()

Description copied from interface: RepoTransport

Gets the remote repository's root URL, maybe including a path-prefix.

This is thus the remote repository's root URL as used to synchronise a certain local repository. The word "remote" should not be misunderstood as actually on another computer. It just means behind this transport abstraction.

In contrast to the remoteRootWithoutPathPrefix, this is the connection point for the synchronisation, which might be a sub-directory, i.e. not the native root of the connected repository.

Specified by:

getRemoteRoot in interface RepoTransport

Returns:

the remote repository's root URL, maybe including a path-prefix. Never null, if properly initialised.

See Also:

RepoTransport.setRemoteRoot(URL)

setRemoteRoot

public void setRemoteRoot(URL remoteRoot)

Description copied from interface: RepoTransport

Sets the remote repository's root URL.

This URL is the point where the client-repository is connected to the repository managed by this RepoTransport.

You should never directly invoke this method! It is automatically called when creating a RepoTransport instance via the RepoTransportFactory.

Invoking this method twice with different remoteRoot values is not allowed. The remoteRoot cannot be changed after it was once set.

Specified by:

setRemoteRoot in interface RepoTransport

Parameters:

remoteRoot - the remote repository's root URL. It may be null, but this RepoTransport is only usable, after this method was invoked with a non-null value.

See Also:

RepoTransport.getRemoteRoot()

getClientRepositoryIdOrFail

public UUID getClientRepositoryIdOrFail()

getClientRepositoryId

public UUID getClientRepositoryId()

Description copied from interface: RepoTransport

Gets the client repository's unique identifier.

The word "client" does not necessarily mean a remote JVM. It merely means the API client accessing this RepoTransport API.

This property might be null. If it is not set, only operations which do not require repo-to-repo-authentication can be used.

Specified by:

getClientRepositoryId in interface RepoTransport

Returns:

the client repository's identifier. Might be null.

See Also:

RepoTransport.setClientRepositoryId(UUID)

setClientRepositoryId

public void setClientRepositoryId(UUID clientRepositoryId)

Description copied from interface: RepoTransport

Sets the client's repository identifier.

Specified by:

setClientRepositoryId in interface RepoTransport

Parameters:

clientRepositoryId - the client's repository identifier. May be null.

See Also:

RepoTransport.getClientRepositoryId()

getRemoteRootWithoutPathPrefix

public URL getRemoteRootWithoutPathPrefix()

Description copied from interface: RepoTransport

Gets the remote repository's root URL without the path-prefix.

In other words, this is the repository's native root, even if the connection is established to a sub-directory.

Specified by:

getRemoteRootWithoutPathPrefix in interface RepoTransport

Returns:

the remote repository's root URL without the path-prefix. Never null, if properly initialised.

determineRemoteRootWithoutPathPrefix

protected abstract URL determineRemoteRootWithoutPathPrefix()

getPathPrefix

public String getPathPrefix()

Description copied from interface: RepoTransport

Prefix for every path (as used in RepoTransport.delete(String) for example).

It is possible to connect to a repository at a sub-directory, i.e. not the repo's root. If this RepoTransport is connected to the repo's root, this pathPrefix is an empty string. But if this RepoTransport is connected to a sub-directory, this sub-directory will be the pathPrefix.

For example, if the remoteRoot is "https://some.host/some/repo/Private+pictures/Wedding+%26+honeymoon" and the remoteRootWithoutPathPrefix is "https://some.host/some/repo", then this pathPrefix will be "/Private pictures/Wedding & honeymoon".

As shown in this example, the pathPrefix is - just like every other path - not encoded in any way! The separator for the path-segments inside this prefix is "/" on all operating systems.

The RepoTransport implementations use this prefix to calculate back and forth between the path relative to the connected remoteRoot and the complete path used in the repository.

Specified by:

getPathPrefix in interface RepoTransport

determinePathPrefix

protected String determinePathPrefix()

prefixPath

public String prefixPath(String path)

Description copied from interface: RepoTransport

Prepend the pathPrefix to the given path.

Specified by:

prefixPath in interface RepoTransport

Parameters:

path - the path to be prepended. Must not be null.

Returns:

the complete path composed of the pathPrefix and the given path. Never null.

See Also:

RepoTransport.unprefixPath(String), RepoTransport.getPathPrefix()

unprefixPath

public String unprefixPath(String path)

Description copied from interface: RepoTransport

Cut the pathPrefix from the given path.

Specified by:

unprefixPath in interface RepoTransport

Parameters:

path - the path to be shortened. Must not be null. Of course, this path must start with pathPrefix.

Returns:

the new shortened path without the pathPrefix. Never null.

See Also:

RepoTransport.prefixPath(String), RepoTransport.getPathPrefix()

isPathUnderPathPrefix

protected boolean isPathUnderPathPrefix(String path)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()

Specified by:

close in interface RepoTransport

Specified by:

close in interface AutoCloseable