co.codewizards.cloudstore.rest.client.transport

Class RestRepoTransport

java.lang.Object

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

co.codewizards.cloudstore.rest.client.transport.RestRepoTransport

All Implemented Interfaces:

RepoTransport, CredentialsProvider

public class RestRepoTransport
extends AbstractRepoTransport
implements CredentialsProvider

Constructor Summary

Constructors

Constructor and Description
RestRepoTransport()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginPutFile(String path) Begins a file transfer to this RepoTransport.
void	close()
void	copy(String fromPath, String toPath)
void	delete(String path) Deletes the file (or directory) specified by path.
protected URL	determineRemoteRootWithoutPathPrefix()
void	endPutFile(String path, Date lastModified, long length, String sha1)
void	endSyncFromRepository()
void	endSyncToRepository(long fromLocalRevision)
ChangeSetDTO	getChangeSetDTO(boolean localSync)
protected CloudStoreRESTClient	getClient()
protected DynamicX509TrustManagerCallback	getDynamicX509TrustManagerCallback()
byte[]	getFileData(String path, long offset, int length) Get the binary file data at the given offset and with the given length.
String	getPassword()
protected String	getPathAfterBaseURL()
byte[]	getPublicKey()
RepoFileDTO	getRepoFileDTO(String path)
RepositoryDTO	getRepositoryDTO()
UUID	getRepositoryId() Get the repository's unique ID.
protected String	getRepositoryName()
String	getUserName()
void	makeDirectory(String path, Date lastModified) Creates the specified directory (including all parent-directories).
void	makeSymlink(String path, String target, Date lastModified)
void	move(String fromPath, String toPath)
void	putFileData(String path, long offset, byte[] fileData) Write a block of binary data into the file.
void	requestRepoConnection(byte[] publicKey) Request to connect this repository with the remote repository identified by the given remoteRepositoryId.

Methods inherited from class co.codewizards.cloudstore.core.repo.transport.AbstractRepoTransport

finalize, getClientRepositoryId, getClientRepositoryIdOrFail, getPathPrefix, getRemoteRoot, getRemoteRootWithoutPathPrefix, getRepoTransportFactory, isPathUnderPathPrefix, prefixPath, setClientRepositoryId, setRemoteRoot, setRepoTransportFactory, unprefixPath

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRepoTransport

public RestRepoTransport()

Method Detail

getDynamicX509TrustManagerCallback

protected DynamicX509TrustManagerCallback getDynamicX509TrustManagerCallback()

getRepositoryId

public UUID getRepositoryId()

Description copied from interface: RepoTransport

Get the repository's unique ID.

Specified by:

getRepositoryId in interface RepoTransport

Returns:

the repository's unique ID.

getPublicKey

public byte[] getPublicKey()

Specified by:

getPublicKey in interface RepoTransport

getRepositoryDTO

public RepositoryDTO getRepositoryDTO()

Specified by:

getRepositoryDTO in interface RepoTransport

requestRepoConnection

public void requestRepoConnection(byte[] publicKey)

Description copied from interface: RepoTransport

Request to connect this repository with the remote repository identified by the given remoteRepositoryId.

Specified by:

requestRepoConnection in interface RepoTransport

Parameters:

publicKey - the public key of the client-repository which requests the connection.

close

public void close()

Specified by:

close in interface RepoTransport

Overrides:

close in class AbstractRepoTransport

getChangeSetDTO

public ChangeSetDTO getChangeSetDTO(boolean localSync)

Specified by:

getChangeSetDTO in interface RepoTransport

makeDirectory

public void makeDirectory(String path,
                 Date lastModified)

Description copied from interface: RepoTransport

Creates the specified directory (including all parent-directories).

If the directory already exists, this is a noop.

If there is any obstruction in the way of this path (e.g. a normal file), it is moved away (renamed or simply deleted depending on the conflict resolution strategy).

Specified by:

makeDirectory in interface RepoTransport

Parameters:

path - the path of the directory. Must not be null. No matter which operating system is used, the separation-character is always '/'. This path may start with a "/", but there is no difference, if it does: It is always relative to the repository's root directory.

lastModified - the last-modified-timestamp the newly created directory will be set to. May be null (in which case the lastModified property is not touched). This applies only to the actual directory and not to the parent-directories! The parent-directories' lastModified properties are never touched - even if the parent-directories are newly created.

makeSymlink

public void makeSymlink(String path,
               String target,
               Date lastModified)

Specified by:

makeSymlink in interface RepoTransport

copy

public void copy(String fromPath,
        String toPath)

Specified by:

copy in interface RepoTransport

move

public void move(String fromPath,
        String toPath)

Specified by:

move in interface RepoTransport

delete

public void delete(String path)

Description copied from interface: RepoTransport

Deletes the file (or directory) specified by path.

If there is no such file (or directory), this method is a noop.

If path denotes a directory, all its children (if there are) are deleted recursively.

Specified by:

delete in interface RepoTransport

Parameters:

path - the path of the file (or directory) to be deleted. Must not be null. No matter which operating system is used, the separation-character is always '/'. This path may start with a "/", but there is no difference, if it does: It is always relative to the repository's root directory.

getRepoFileDTO

public RepoFileDTO getRepoFileDTO(String path)

Specified by:

getRepoFileDTO in interface RepoTransport

getFileData

public byte[] getFileData(String path,
                 long offset,
                 int length)

Description copied from interface: RepoTransport

Get the binary file data at the given offset and with the given length.

If the file was modified/deleted, this method should not fail, but simply return null or a result being shorter than the length specified.

Specified by:

getFileData in interface RepoTransport

Parameters:

path - the path of the file. Must not be null. No matter which operating system is used, the separation-character is always '/'. This path may start with a "/", but there is no difference, if it does: It is always relative to the repository's root directory.

offset - the offset of the first byte to be read (0-based).

length - the length of the data to be read. -1 to read from offset to the end of the file.

beginPutFile

public void beginPutFile(String path)

Description copied from interface: RepoTransport

Begins a file transfer to this RepoTransport.

Usually, this method creates the specified file in the file system (if necessary with parent-directories) and in the database. But this operation may be deferred until RepoTransport.endPutFile(String, Date, long, String).

If the file is immediately created, it should not be synchronised to any other repository, yet! It should be ignored, until RepoTransport.endPutFile(String, Date, long, String) was called for it.

In normal operation, zero or more invocations of RepoTransport.putFileData(String, long, byte[]) and finally one invocation of RepoTransport.endPutFile(String, Date, long, String) follow this method. However, this is not guaranteed and the file transfer may be interrupted. If it is resumed, later this method is called again, without RepoTransport.endPutFile(String, Date, long, String) ever having been called inbetween.

Specified by:

beginPutFile in interface RepoTransport

Parameters:

path - the path of the file. Must not be null. No matter which operating system is used, the separation-character is always '/'. This path may start with a "/", but there is no difference, if it does: It is always relative to the repository's root directory.

See Also:

RepoTransport.putFileData(String, long, byte[]), RepoTransport.endPutFile(String, Date, long, String)

putFileData

public void putFileData(String path,
               long offset,
               byte[] fileData)

Description copied from interface: RepoTransport

Write a block of binary data into the file.

This method may only be called after RepoTransport.beginPutFile(String) and before RepoTransport.endPutFile(String, Date, long, String).

Specified by:

putFileData in interface RepoTransport

offset - the 0-based position in the file at which the block should be written.

See Also:

RepoTransport.beginPutFile(String), RepoTransport.endPutFile(String, Date, long, String)

endPutFile

public void endPutFile(String path,
              Date lastModified,
              long length,
              String sha1)

Specified by:

endPutFile in interface RepoTransport

endSyncFromRepository

public void endSyncFromRepository()

Specified by:

endSyncFromRepository in interface RepoTransport

endSyncToRepository

public void endSyncToRepository(long fromLocalRevision)

Specified by:

endSyncToRepository in interface RepoTransport

getUserName

public String getUserName()

Specified by:

getUserName in interface CredentialsProvider

getPassword

public String getPassword()

Specified by:

getPassword in interface CredentialsProvider

getClient

protected CloudStoreRESTClient getClient()

determineRemoteRootWithoutPathPrefix

protected URL determineRemoteRootWithoutPathPrefix()

Specified by:

determineRemoteRootWithoutPathPrefix in class AbstractRepoTransport

getRepositoryName

protected String getRepositoryName()

getPathAfterBaseURL

protected String getPathAfterBaseURL()