com.citrix.sharefile.api

Class SFApiClient

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.ISFEntities.Implementation

com.citrix.sharefile.api.SFApiClient

All Implemented Interfaces:

ISFEntities, IOAuthTokenChangeHandler, ISFApiClient

Direct Known Subclasses:

SFTokenLessApiClient

public class SFApiClient
extends ISFEntities.Implementation
implements ISFApiClient

Nested Class Summary

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

ISFEntities.Implementation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_INVALID_STATE_OAUTH_NULL

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFApiClient(SFOAuth2Token oAuthToken)
SFApiClient(SFOAuth2Token oauthToken, java.lang.String sfUserId, java.lang.String clientID, java.lang.String clientSecret, IOAuthTokenChangeHandler tokenChangeHandler, ISFReAuthHandler reAuthHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAllCookies()
SFApiClient	clone()
<T extends SFODataObject> T	executeQuery(ISFQuery<T> query)
java.io.InputStream	executeQueryEx(SFQueryStream query)
SFConfiguration	getConfig()
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> listener, ISFReAuthHandler reauthHandler)
SFOAuth2Token	getOAuthToken()
SFSession	getSession()
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()
boolean	isClientInitialised()
SFDownloadRunnable	prepareDownload(java.lang.String itemId, java.lang.String v3Url, int resumeFromByteIndex, java.io.OutputStream outpuStream, TransferRunnable.IProgress progressListener, java.lang.String connUserName, java.lang.String connPassword) Deprecated.
SFUploadRunnable	prepareUpload(java.lang.String destinationName, java.lang.String details, java.lang.String v3Url, boolean overwrite, int resumeFromByteIndex, long tolalBytes, java.io.InputStream inputStream, TransferRunnable.IProgress progressListener, java.lang.String connUserName, java.lang.String connPassword) Deprecated.
void	removeCookies(java.lang.String urlStr)
void	removeCookies(java.net.URI uri)
void	reset() Resets the token and nulls the internal callbacks.
void	setCookie(java.lang.String urlStr, java.lang.String cookieString)
void	setCookie(java.net.URI uri, java.lang.String cookieString)
void	setReAuthHandler(ISFReAuthHandler reAuthHandler)
void	setUserId(java.lang.String sfUserid) The SDK itself does not use the userid.
void	storeNewToken(ISFApiClient apiClient, SFOAuth2Token newAccessToken)
void	tokenRenewFailed(ISFApiClient apiClient, SFSDKException exception)

Methods inherited from class com.citrix.sharefile.api.entities.ISFEntities.Implementation

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

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

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

Field Detail

MSG_INVALID_STATE_OAUTH_NULL

public static final java.lang.String MSG_INVALID_STATE_OAUTH_NULL

See Also:

Constant Field Values

Constructor Detail

SFApiClient

public SFApiClient(SFOAuth2Token oAuthToken)
            throws SFInvalidStateException

Throws:

SFInvalidStateException

SFApiClient

public SFApiClient(SFOAuth2Token oauthToken,
           java.lang.String sfUserId,
           java.lang.String clientID,
           java.lang.String clientSecret,
           IOAuthTokenChangeHandler tokenChangeHandler,
           ISFReAuthHandler reAuthHandler)
            throws SFInvalidStateException

Throws:

SFInvalidStateException

Method Detail

isClientInitialised

public boolean isClientInitialised()

getOAuthToken

public SFOAuth2Token getOAuthToken()

clearAllCookies

public void clearAllCookies()

clone

public SFApiClient clone()

Specified by:

clone in interface ISFApiClient

Overrides:

clone in class java.lang.Object

getExecutor

public <T> ISFApiExecuteQuery getExecutor(ISFQuery<T> query,
                                 ISFApiResultCallback<T> listener,
                                 ISFReAuthHandler reauthHandler)
                               throws SFInvalidStateException

Specified by:

getExecutor in interface ISFApiClient

Throws:

SFInvalidStateException

getSession

public SFSession getSession()

reset

public void reset()

Resets the token and nulls the internal callbacks. Call this when you no longer want to use this object.

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface ISFApiClient

setCookie

public void setCookie(java.lang.String urlStr,
             java.lang.String cookieString)

setCookie

public void setCookie(java.net.URI uri,
             java.lang.String cookieString)

removeCookies

public void removeCookies(java.lang.String urlStr)

removeCookies

public void removeCookies(java.net.URI uri)

setUserId

public void setUserId(java.lang.String sfUserid)

The SDK itself does not use the userid. This id is simply sent back to the app with the reauth-context so that the app can detect the user for which the re-auth was requested.

getConfig

public SFConfiguration getConfig()

executeQuery

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

Specified by:

executeQuery in interface ISFApiClient

Throws:

SFServerException

SFInvalidStateException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

executeQueryEx

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

Specified by:

executeQueryEx in interface ISFApiClient

Throws:

SFServerException

SFInvalidStateException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

prepareDownload

@Deprecated
public SFDownloadRunnable prepareDownload(java.lang.String itemId,
                                            java.lang.String v3Url,
                                            int resumeFromByteIndex,
                                            java.io.OutputStream outpuStream,
                                            TransferRunnable.IProgress progressListener,
                                            java.lang.String connUserName,
                                            java.lang.String connPassword)
                                   throws SFInvalidStateException

Deprecated.

create a runnable to handle downloading the file it is up to the developer to decide how to run this asynchronously (AsyncTask, Thread, ...)

Parameters:

itemId -

v3Url -

resumeFromByteIndex -

outpuStream -

progressListener -

connUserName -

connPassword -

Returns:

Throws:

SFInvalidStateException

getDownloader

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

Specified by:

getDownloader in interface ISFApiClient

Throws:

SFOtherException

getUploader

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

Specified by:

getUploader in interface ISFApiClient

Throws:

SFInvalidStateException

SFServerException

getUploader

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

Specified by:

getUploader in interface ISFApiClient

Throws:

SFInvalidStateException

SFServerException

prepareUpload

@Deprecated
public SFUploadRunnable prepareUpload(java.lang.String destinationName,
                                        java.lang.String details,
                                        java.lang.String v3Url,
                                        boolean overwrite,
                                        int resumeFromByteIndex,
                                        long tolalBytes,
                                        java.io.InputStream inputStream,
                                        TransferRunnable.IProgress progressListener,
                                        java.lang.String connUserName,
                                        java.lang.String connPassword)
                               throws SFInvalidStateException,
                                      SFServerException

Deprecated.

prepare runnable to be used to upload a file TODO_ADD_V3: needs to be moved to SFUploadRunnable. create a different version that can handle prompting the users for connector credentials

Parameters:

destinationName -

details -

v3Url -

overwrite -

resumeFromByteIndex -

tolalBytes -

inputStream -

progressListener -

connUserName -

connPassword -

Returns:

Throws:

SFInvalidStateException

SFServerException

getDefaultUrl

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

Specified by:

getDefaultUrl in interface ISFApiClient

Throws:

java.net.URISyntaxException

getTopUrl

public java.net.URI getTopUrl()

Specified by:

getTopUrl in interface ISFApiClient

getDeviceUrl

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

Specified by:

getDeviceUrl in interface ISFApiClient

Throws:

java.net.URISyntaxException

storeNewToken

public void storeNewToken(ISFApiClient apiClient,
                 SFOAuth2Token newAccessToken)

Specified by:

storeNewToken in interface IOAuthTokenChangeHandler

tokenRenewFailed

public void tokenRenewFailed(ISFApiClient apiClient,
                    SFSDKException exception)

Specified by:

tokenRenewFailed in interface IOAuthTokenChangeHandler

setReAuthHandler

public void setReAuthHandler(ISFReAuthHandler reAuthHandler)

Specified by:

setReAuthHandler in interface ISFApiClient