com.citrix.sharefile.api.interfaces

Interface ISFApiClient

All Superinterfaces:

IOAuthTokenChangeHandler, ISFEntities

All Known Implementing Classes:

SFApiClient, SFTokenLessApiClient

public interface ISFApiClient
extends IOAuthTokenChangeHandler, ISFEntities

Nested Class Summary

Nested classes/interfaces inherited from interface com.citrix.sharefile.api.entities.ISFEntities

ISFEntities.Implementation

Method Summary

Methods

Modifier and Type	Method and Description
ISFApiClient	clone()
<T extends SFODataObject> T	executeQuery(ISFQuery<T> query)
java.io.InputStream	executeQueryEx(SFQueryStream query)
java.net.URI	getDefaultUrl(java.lang.String folderID)
java.net.URI	getDeviceUrl(java.lang.String deviceId)
SFDownloadRunnable	getDownloader(SFFile file, java.io.OutputStream outputStream, TransferRunnable.IProgress progressListener)
<T> ISFApiExecuteQuery	getExecutor(ISFQuery<T> query, ISFApiResultCallback<T> apiResultCallback, ISFReAuthHandler reAuthHandler)
java.net.URI	getTopUrl()
SFUploadRunnable	getUploader(SFFolder parentFolder, java.lang.String destinationName, java.lang.String details, long fileSizeInBytes, java.io.InputStream inputStream, TransferRunnable.IProgress progressListener)
SFUploadRunnable	getUploader(SFUploadRequestParams uploadRequestParams, java.io.InputStream inputStream, TransferRunnable.IProgress progressListener)
java.lang.String	getUserId()
void	setReAuthHandler(ISFReAuthHandler reAuthHandler)

Methods inherited from interface com.citrix.sharefile.api.interfaces.IOAuthTokenChangeHandler

storeNewToken, tokenRenewFailed

Methods inherited from interface com.citrix.sharefile.api.entities.ISFEntities

accessControls, accounts, asyncOperations, capabilities, connectorGroups, favoriteFolders, folderTemplates, groups, items, metadata, remoteUploads, reports, sessions, shares, storageCenters, users, zones

Method Detail

executeQuery

<T extends SFODataObject> T executeQuery(ISFQuery<T> query)
                                     throws SFServerException,
                                            SFInvalidStateException,
                                            SFNotAuthorizedException,
                                            SFOAuthTokenRenewException,
                                            SFOtherException

Throws:

SFServerException

SFInvalidStateException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

executeQueryEx

java.io.InputStream executeQueryEx(SFQueryStream query)
                                   throws SFServerException,
                                          SFInvalidStateException,
                                          SFNotAuthorizedException,
                                          SFOAuthTokenRenewException,
                                          SFOtherException

Throws:

SFServerException

SFInvalidStateException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

getUserId

java.lang.String getUserId()

getExecutor

<T> ISFApiExecuteQuery getExecutor(ISFQuery<T> query,
                                 ISFApiResultCallback<T> apiResultCallback,
                                 ISFReAuthHandler reAuthHandler)
                               throws SFInvalidStateException

Throws:

SFInvalidStateException

getDownloader

SFDownloadRunnable getDownloader(SFFile file,
                               java.io.OutputStream outputStream,
                               TransferRunnable.IProgress progressListener)
                                 throws SFOtherException

Throws:

SFOtherException

getUploader

SFUploadRunnable getUploader(SFFolder parentFolder,
                           java.lang.String destinationName,
                           java.lang.String details,
                           long fileSizeInBytes,
                           java.io.InputStream inputStream,
                           TransferRunnable.IProgress progressListener)
                             throws SFInvalidStateException,
                                    SFServerException

Throws:

SFInvalidStateException

SFServerException

getUploader

SFUploadRunnable getUploader(SFUploadRequestParams uploadRequestParams,
                           java.io.InputStream inputStream,
                           TransferRunnable.IProgress progressListener)
                             throws SFInvalidStateException,
                                    SFServerException

Throws:

SFInvalidStateException

SFServerException

getDefaultUrl

java.net.URI getDefaultUrl(java.lang.String folderID)
                           throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

getTopUrl

java.net.URI getTopUrl()

getDeviceUrl

java.net.URI getDeviceUrl(java.lang.String deviceId)
                          throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

setReAuthHandler

void setReAuthHandler(ISFReAuthHandler reAuthHandler)

clone

ISFApiClient clone()