co.codewizards.cloudstore.rest.client

Class CloudStoreRESTClient

java.lang.Object

co.codewizards.cloudstore.rest.client.CloudStoreRESTClient

public class CloudStoreRESTClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_KEY_SOCKET_CONNECT_TIMEOUT The key for the connection timeout used with Config.getPropertyAsInt(String, int).
static String	CONFIG_KEY_SOCKET_READ_TIMEOUT The key for the read timeout used with Config.getPropertyAsInt(String, int).

Constructor Summary

Constructors

Constructor and Description
CloudStoreRESTClient(String url) Create a new client.
CloudStoreRESTClient(URL url) Create a new client.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginPutFile(String repositoryName, String path)
void	copy(String repositoryName, String fromPath, String toPath)
void	delete(String repositoryName, String path)
void	endPutFile(String repositoryName, String path, DateTime lastModified, long length, String sha1)
void	endSyncFromRepository(String repositoryName)
void	endSyncToRepository(String repositoryName, long fromLocalRevision)
String	getBaseURL() Get the server's base-URL.
ChangeSetDTO	getChangeSet(String repositoryName, boolean localSync)
CredentialsProvider	getCredentialsProvider()
EncryptedSignedAuthToken	getEncryptedSignedAuthToken(String repositoryName, UUID clientRepositoryId)
byte[]	getFileData(String repositoryName, String path, long offset, int length)
HostnameVerifier	getHostnameVerifier()
RepoFileDTO	getRepoFileDTO(String repositoryName, String path)
RepositoryDTO	getRepositoryDTO(String repositoryName)
Integer	getSocketConnectTimeout()
Integer	getSocketReadTimeout()
SSLContext	getSslContext()
void	makeDirectory(String repositoryName, String path, Date lastModified)
void	makeSymlink(String repositoryName, String path, String target, Date lastModified)
void	move(String repositoryName, String fromPath, String toPath)
void	putFileData(String repositoryName, String path, long offset, byte[] fileData)
void	requestRepoConnection(String repositoryName, String pathPrefix, RepositoryDTO clientRepositoryDTO)
void	setCredentialsProvider(CredentialsProvider credentialsProvider)
void	setHostnameVerifier(HostnameVerifier hostnameVerifier)
void	setSocketConnectTimeout(Integer socketConnectTimeout)
void	setSocketReadTimeout(Integer socketReadTimeout)
void	setSslContext(SSLContext sslContext)
void	testException()
void	testSuccess()

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_SOCKET_CONNECT_TIMEOUT

public static final String CONFIG_KEY_SOCKET_CONNECT_TIMEOUT

The key for the connection timeout used with Config.getPropertyAsInt(String, int).

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

CONFIG_KEY_SOCKET_READ_TIMEOUT

public static final String CONFIG_KEY_SOCKET_READ_TIMEOUT

The key for the read timeout used with Config.getPropertyAsInt(String, int).

The configuration can be overridden by a system property - see Config.SYSTEM_PROPERTY_PREFIX.

See Also:

Constant Field Values

Constructor Detail

CloudStoreRESTClient

public CloudStoreRESTClient(URL url)

Create a new client.

Parameters:

url - any URL to the server. Must not be null. May be the base-URL, any repository's remote-root-URL or any URL within a remote-root-URL. The base-URL is automatically determined by cutting sub-paths, step by step.

CloudStoreRESTClient

public CloudStoreRESTClient(String url)

Create a new client.

Parameters:

url - any URL to the server. Must not be null. May be the base-URL, any repository's remote-root-URL or any URL within a remote-root-URL. The base-URL is automatically determined by cutting sub-paths, step by step.

Method Detail

getSocketConnectTimeout

public Integer getSocketConnectTimeout()

setSocketConnectTimeout

public void setSocketConnectTimeout(Integer socketConnectTimeout)

getSocketReadTimeout

public Integer getSocketReadTimeout()

setSocketReadTimeout

public void setSocketReadTimeout(Integer socketReadTimeout)

getBaseURL

public String getBaseURL()

Get the server's base-URL.

This base-URL is the base of the CloudStoreREST application. Hence all URLs beneath this base-URL are processed by the CloudStoreREST application.

In other words: All repository-names are located directly beneath this base-URL. The special services, too, are located directly beneath this base-URL.

For example, if the server's base-URL is "https://host.domain:8443/", then the test-service is available via "https://host.domain:8443/_test" and the repository with the alias "myrepo" is "https://host.domain:8443/myrepo".

Returns:

the base-URL. This URL always ends with "/".

testSuccess

public void testSuccess()

testException

public void testException()

getRepositoryDTO

public RepositoryDTO getRepositoryDTO(String repositoryName)

getChangeSet

public ChangeSetDTO getChangeSet(String repositoryName,
                        boolean localSync)

requestRepoConnection

public void requestRepoConnection(String repositoryName,
                         String pathPrefix,
                         RepositoryDTO clientRepositoryDTO)

getEncryptedSignedAuthToken

public EncryptedSignedAuthToken getEncryptedSignedAuthToken(String repositoryName,
                                                   UUID clientRepositoryId)

getRepoFileDTO

public RepoFileDTO getRepoFileDTO(String repositoryName,
                         String path)

beginPutFile

public void beginPutFile(String repositoryName,
                String path)

endSyncFromRepository

public void endSyncFromRepository(String repositoryName)

endSyncToRepository

public void endSyncToRepository(String repositoryName,
                       long fromLocalRevision)

endPutFile

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

getFileData

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

putFileData

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

delete

public void delete(String repositoryName,
          String path)

copy

public void copy(String repositoryName,
        String fromPath,
        String toPath)

move

public void move(String repositoryName,
        String fromPath,
        String toPath)

makeDirectory

public void makeDirectory(String repositoryName,
                 String path,
                 Date lastModified)

makeSymlink

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

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier hostnameVerifier)

getSslContext

public SSLContext getSslContext()

setSslContext

public void setSslContext(SSLContext sslContext)

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

setCredentialsProvider

public void setCredentialsProvider(CredentialsProvider credentialsProvider)