com.uploadcare.api

Class Client

java.lang.Object

com.uploadcare.api.Client

public class Client
extends java.lang.Object

Uploadcare API client. Provides simple access to File and Project resources.

See Also:

File, Project

Constructor Summary

Constructors

Constructor and Description
Client(java.lang.String publicKey, java.lang.String privateKey) Initializes a client with custom access keys and simple authentication.
Client(java.lang.String publicKey, java.lang.String privateKey, boolean simpleAuth, RequestHelperProvider requestHelperProvider) Initializes a client with custom access keys.

Method Summary

Modifier and Type	Method and Description
void	close() Closes client.
CopyFileData	copyFile(java.lang.String fileId, java.lang.String storage)
void	deleteFile(java.lang.String fileId) Marks a file as deleted.
static Client	demoClient() Creates a client with demo credentials.
File	getFile(java.lang.String fileId) Requests file data.
FilesQueryBuilder	getFiles() Begins to build a request for uploaded files for the current account.
java.lang.String	getPrivateKey() Returns the private key.
Project	getProject() Requests project info from the API.
java.lang.String	getPublicKey() Returns the public key.
RequestHelper	getRequestHelper()
boolean	isSimpleAuth() Returns true, if simple authentication is used.
void	saveFile(java.lang.String fileId) Marks a file as saved.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(java.lang.String publicKey,
              java.lang.String privateKey)

Initializes a client with custom access keys and simple authentication.

Parameters:

publicKey - Public key

privateKey - Private key

Client

public Client(java.lang.String publicKey,
              java.lang.String privateKey,
              boolean simpleAuth,
              RequestHelperProvider requestHelperProvider)

Initializes a client with custom access keys. Can use simple or secure authentication.

Parameters:

publicKey - Public key

privateKey - Private key

simpleAuth - If false, HMAC-based authentication is used

requestHelperProvider - Should be null to use DefaultRequestHelperProvider

Method Detail

demoClient

public static Client demoClient()

Creates a client with demo credentials. Useful for tests and anonymous access. Warning! Do not use in production. All demo account files are eventually purged.

Returns:

A demo client

getPublicKey

public java.lang.String getPublicKey()

Returns the public key.

Returns:

Public key

getPrivateKey

public java.lang.String getPrivateKey()

Returns the private key.

Returns:

Private key

isSimpleAuth

public boolean isSimpleAuth()

Returns true, if simple authentication is used.

Returns:

true, if simple authentication is used, false otherwise

getRequestHelper

public RequestHelper getRequestHelper()

getProject

public Project getProject()

Requests project info from the API.

Returns:

Project resource

getFile

public File getFile(java.lang.String fileId)

Requests file data.

Parameters:

fileId - Resource UUID

Returns:

File resource

getFiles

public FilesQueryBuilder getFiles()

Begins to build a request for uploaded files for the current account.

Returns:

File resource request builder

deleteFile

public void deleteFile(java.lang.String fileId)

Marks a file as deleted.

Parameters:

fileId - Resource UUID

saveFile

public void saveFile(java.lang.String fileId)

Marks a file as saved. This has to be done for all files you want to keep. Unsaved files are eventually purged.

Parameters:

fileId - Resource UUID

close

public void close()

Closes client. Ensures that all connections kept alive by the manager get closed and system resources allocated by those connections are released.

copyFile

public CopyFileData copyFile(java.lang.String fileId,
                             java.lang.String storage)

Parameters:

fileId - Resource UUID

storage - Target storage name

Returns:

An object containing the results of the copy request