Package org.filestack

Class Client

java.lang.Object

org.filestack.Client

All Implemented Interfaces:

Serializable

public class Client
extends Object
implements Serializable

Uploads new files.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Config	config

Constructor Summary

Constructors

Constructor	Description
Client(Config config)	Basic constructor for Client class.

Method Summary

Modifier and Type	Method	Description
FileLink	fileLink(String handle)	Acquires a reference to a FileLink based on an unique handle.
AppInfo	getAppInfo()	Gets basic account info for this fsClient's API key.
io.reactivex.Single<AppInfo>	getAppInfoAsync()	Asynchronously get basic account info for this fsClient's API key.
CloudResponse	getCloudItems(String providerName, String path)	Gets contents of a user's cloud "drive".
CloudResponse	getCloudItems(String providerName, String path, String next)	Gets contents of a user's cloud "drive".
io.reactivex.Single<CloudResponse>	getCloudItemsAsync(String providerName, String path)	Asynchronously gets contents of a user's cloud "drive".
io.reactivex.Single<CloudResponse>	getCloudItemsAsync(String providerName, String path, String next)	Asynchronously gets contents of a user's cloud "drive".
Config	getConfig()
String	getSessionToken()
protected static String	guessContentType(String path)
ImageTransform	imageTransform(String url)	Creates an ImageTransform object for this file.
void	logoutCloud(String providerName)	Logs out from specified cloud.
io.reactivex.Completable	logoutCloudAsync(String providerName)	Asynchronously logs out from specified cloud.
void	setSessionToken(String sessionToken)
FileLink	storeCloudItem(String providerName, String path)	Transfers file from a user's cloud "drive" to Filestack.
FileLink	storeCloudItem(String providerName, String path, StorageOptions options)	Transfers file from a user's cloud "drive" to Filestack.
io.reactivex.Single<FileLink>	storeCloudItemAsync(String providerName, String path)	Asynchronously transfers file from a user's cloud "drive" to Filestack.
io.reactivex.Single<FileLink>	storeCloudItemAsync(String providerName, String path, StorageOptions options)	Asynchronously transfers file from a user's cloud "drive" to Filestack.
FileLink	upload(InputStream input, int size, boolean intel)	Synchronously uploads an InputStream using default storage options.
FileLink	upload(InputStream input, int size, boolean intel, StorageOptions opts)	Synchronously uploads an InputStream.
FileLink	upload(String path, boolean intel)	Synchronously uploads a file system path using default storage options.
FileLink	upload(String path, boolean intel, StorageOptions opts)	Synchronously uploads a file system path.
io.reactivex.Flowable<Progress<FileLink>>	uploadAsync(InputStream input, int size, boolean intel)	Asynchronously uploads an InputStream using default storage options.
io.reactivex.Flowable<Progress<FileLink>>	uploadAsync(InputStream input, int size, boolean intel, StorageOptions opts)	Asynchronously uploads an InputStream.
io.reactivex.Flowable<Progress<FileLink>>	uploadAsync(String path, boolean intelligent)	Asynchronously uploads a file system path using default storage options.
io.reactivex.Flowable<Progress<FileLink>>	uploadAsync(String path, boolean intel, StorageOptions opts)	Asynchronously uploads a file system path.

Methods inherited from class java.lang.Object

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

Field Details

config

protected final Config config

Constructor Details

Client

public Client(Config config)

Basic constructor for Client class.

Parameters:

config - - configuration for this Client's instance

Method Details

upload

public FileLink upload(String path,
 boolean intel)
                throws IOException

Synchronously uploads a file system path using default storage options. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

Throws:

IOException

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

upload

public FileLink upload(String path,
 boolean intel,
 @Nullable
 StorageOptions opts)
                throws IOException

Synchronously uploads a file system path. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

Throws:

IOException

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

upload

public FileLink upload(InputStream input,
 int size,
 boolean intel)
                throws IOException

Synchronously uploads an InputStream using default storage options. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

Throws:

IOException

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

upload

public FileLink upload(InputStream input,
 int size,
 boolean intel,
 @Nullable
 StorageOptions opts)
                throws IOException

Synchronously uploads an InputStream. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

Throws:

IOException

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

fileLink

public FileLink fileLink(String handle)

Acquires a reference to a FileLink based on an unique handle.

Parameters:

handle - - a unique reference to a file uploaded through our API

getAppInfo

public AppInfo getAppInfo()
                   throws IOException

Gets basic account info for this fsClient's API key.

Throws:

HttpException - on error response from backend

IOException - on network failure

getCloudItems

public CloudResponse getCloudItems(String providerName,
 String path)
                            throws IOException

Gets contents of a user's cloud "drive".

Throws:

IOException

See Also:

• getCloudItems(String, String, String)

getCloudItems

public CloudResponse getCloudItems(String providerName,
 @Nullable
 String path,
 @Nullable
 String next)
                            throws IOException

Gets contents of a user's cloud "drive". If the user has not authorized for the provider, the response will contain an OAuth URL that should be opened in a browser.

Parameters:

providerName - one of the static CLOUD constants in this class

next - pagination token returned in previous response

Throws:

HttpException - on error response from backend

IOException - on network failure

storeCloudItem

public FileLink storeCloudItem(String providerName,
 String path)
                        throws IOException

Transfers file from a user's cloud "drive" to Filestack. Uses default storage options.

Throws:

IOException

See Also:

• storeCloudItem(String, String, StorageOptions)

storeCloudItem

public FileLink storeCloudItem(String providerName,
 String path,
 @Nullable
 StorageOptions options)
                        throws IOException

Transfers file from a user's cloud "drive" to Filestack.

Parameters:

providerName - one of the static CLOUD constants in this class

options - storage options for how to save the file in Filestack

Returns:

new filelink

Throws:

HttpException - on error response from backend

IOException - on network failure

logoutCloud

public void logoutCloud(String providerName)
                 throws IOException

Logs out from specified cloud.

Parameters:

providerName - one of the static CLOUD constants in this class

Throws:

HttpException - on error response from backend

IOException - on network failure

uploadAsync

public io.reactivex.Flowable<Progress<FileLink>> uploadAsync(String path,
 boolean intelligent)

Asynchronously uploads a file system path using default storage options. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

uploadAsync

public io.reactivex.Flowable<Progress<FileLink>> uploadAsync(String path,
 boolean intel,
 @Nullable
 StorageOptions opts)

Asynchronously uploads a file system path. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

uploadAsync

public io.reactivex.Flowable<Progress<FileLink>> uploadAsync(InputStream input,
 int size,
 boolean intel)

Asynchronously uploads an InputStream using default storage options. Wraps uploadAsync(InputStream, int, boolean, StorageOptions).

See Also:

• uploadAsync(InputStream, int, boolean, StorageOptions)

uploadAsync

public io.reactivex.Flowable<Progress<FileLink>> uploadAsync(InputStream input,
 int size,
 boolean intel,
 @Nullable
 StorageOptions opts)

Asynchronously uploads an InputStream. The returned Flowable emits a stream of Progress objects. The final Progress object will return a new FileLink from the Progress.getData() method. The upload is not done until Progress.getData() returns non-null. All exceptions, including issues opening a file, are returned through the observable.

An HttpException is thrown on error response from backend. An IOException is thrown on error reading file or network failure.

Parameters:

intel - enable intelligent ingestion, setting to true to will decrease failures in very poor network conditions at the expense of upload speed

opts - storage options, https://www.filestack.com/docs/rest-api/store

getAppInfoAsync

public io.reactivex.Single<AppInfo> getAppInfoAsync()

Asynchronously get basic account info for this fsClient's API key.

See Also:

• getAppInfo()

getCloudItemsAsync

public io.reactivex.Single<CloudResponse> getCloudItemsAsync(String providerName,
 String path)

Asynchronously gets contents of a user's cloud "drive".

See Also:

• getCloudItems(String, String, String)

getCloudItemsAsync

public io.reactivex.Single<CloudResponse> getCloudItemsAsync(String providerName,
 String path,
 @Nullable
 String next)

Asynchronously gets contents of a user's cloud "drive".

See Also:

• getCloudItems(String, String, String)

storeCloudItemAsync

public io.reactivex.Single<FileLink> storeCloudItemAsync(String providerName,
 String path)

Asynchronously transfers file from a user's cloud "drive" to Filestack. Uses default storage options.

See Also:

• storeCloudItem(String, String, StorageOptions)

storeCloudItemAsync

public io.reactivex.Single<FileLink> storeCloudItemAsync(String providerName,
 String path,
 @Nullable
 StorageOptions options)

Asynchronously transfers file from a user's cloud "drive" to Filestack.

See Also:

• storeCloudItem(String, String, StorageOptions)

logoutCloudAsync

public io.reactivex.Completable logoutCloudAsync(String providerName)

Asynchronously logs out from specified cloud.

See Also:

• logoutCloud(String)

imageTransform

public ImageTransform imageTransform(String url)

Creates an ImageTransform object for this file. A transformation call isn't made directly by this method.

Returns:

ImageTransform instance configured for this file

guessContentType

protected static String guessContentType(String path)

getConfig

public Config getConfig()

getSessionToken

public String getSessionToken()

setSessionToken

public void setSessionToken(String sessionToken)