com.citrix.sharefile.api

Class SFApiQuery<T extends SFODataObject>

java.lang.Object

com.citrix.sharefile.api.SFApiQuery<T>

All Implemented Interfaces:

ISFQuery<T>

public class SFApiQuery<T extends SFODataObject>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ISFApiClient	apiClient

Constructor Summary

Constructors

Constructor and Description
SFApiQuery(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<T>	addActionIds(java.lang.Integer actionid)
ISFQuery<T>	addActionIds(SFSafeEnum actionId)
ISFQuery<T>	addActionIds(java.lang.String actionid)
void	addIds(java.lang.String key, java.lang.String value) setId() and addIds() are mutually exclusive.
ISFQuery<T>	addIds(java.net.URI url)
ISFQuery<T>	addQueryString(java.lang.String key, java.util.ArrayList<java.lang.String> ids)
ISFQuery<T>	addQueryString(java.lang.String key, java.lang.Object object)
void	addQueryString(java.lang.String key, SFApiQuery<SFSearchResults> query) Deprecated.
ISFQuery<T>	addSubAction(java.lang.String subaction)
ISFQuery<T>	addSubAction(java.lang.String subaction, SFSafeEnum extras)
ISFQuery<T>	allowRedirection(boolean value) For certain calls like create symbolic link we want to disable readahead done by the SDK.
java.lang.String	buildQueryUrlString(java.lang.String server) https://server/provider/version/entity(id)
boolean	canReNewTokenInternally() we can renew token for Sharefile providers.
boolean	constructDownloadSpec() Currently the server is not returning a DownloadSpecification for download requests, its directly returning the download link.
void	copyQuery(com.citrix.sharefile.api.AbstractSFApiQuery<T> sourceQuery) When whenever you want to re-execute a previous query with slightly different parameters always use this function to copy feilds from the source query and then modify the necessry feilds.
T	execute()
void	executeAsync(ISFApiResultCallback<T> callback)
ISFQuery<T>	expand(java.lang.String expansionParameter) simplifies the adding of expansion parameters to the query.
<V> ISFQuery<V>	expect(java.lang.Class<V> clazz)
ISFQuery<T>	filter(java.lang.String filterValue)
java.lang.String	getBody()
java.lang.String	getHttpMethod()
java.net.URI	getLink()
java.lang.String	getPassword()
java.lang.String	getStringResponse()
java.lang.Object	getTag() Get tag set by the setTag function.
java.lang.String	getUserName()
ISFQuery<T>	is(SFV3ElementType type)
boolean	reDirectionAllowed()
ISFQuery<T>	select(java.lang.String selectParam)
ISFQuery<T>	setAction(java.lang.String action)
ISFQuery<T>	setApiClient(ISFApiClient apiClient)
ISFQuery<T>	setBaseLink(java.net.URI uri) This function takes any uri and stores only its base part along with the provider example if you pass: https://szqatest2.sharefiletest.com/cifs/v3/Capabilities This function will store baseLink as : https://szqatest2.sharefiletest.com
ISFQuery<T>	setBody(java.util.ArrayList<?> sfoDataObjectsFeed)
ISFQuery<T>	setBody(java.lang.Object object)
ISFQuery<T>	setBody(SFODataObject body)
ISFQuery<T>	setBody(java.lang.String str)
ISFQuery<T>	setCredentials(java.lang.String userName, java.lang.String password)
ISFQuery<T>	setFrom(java.lang.String setFrom)
ISFQuery<T>	setFullyParametrizedLink(java.net.URI uri) This implies that the query parameters are included in the URI and no more parameters more needs to be added before executing the query.
void	setHttpMethod(SFHttpMethod httpMethod)
ISFQuery<T>	setHttpMethod(java.lang.String string)
void	setId(java.lang.String id) setId() and addIds() are mutually exclusive.
ISFQuery<T>	setLink(java.lang.String link) This function takes any uri and store it entirely.
ISFQuery<T>	setLink(java.net.URI uri) This implies that the query parameters need to be appended by the buildQuery function before executing the query.
ISFQuery<T>	setLinkAndAppendPreviousParameters(java.lang.String string) This will append the query paremeters from previuos query to the new link.
ISFQuery<T>	setLinkAndAppendPreviousParameters(java.net.URI newuri) This will append the query paremeters from previuos query to the new link.
void	setProvider(java.lang.String provider)
void	setStringResponse(java.lang.String response)
void	setTag(java.lang.Object tag) This will allow the consumer apps to preserve identification information related to queries.
ISFQuery<T>	skip(int skipItems)
ISFQuery<T>	top(int topItems)

Methods inherited from class java.lang.Object

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

Field Detail

apiClient

protected ISFApiClient apiClient

Constructor Detail

SFApiQuery

public SFApiQuery(ISFApiClient client)

Method Detail

execute

public T execute()
                                throws SFInvalidStateException,
                                       SFServerException,
                                       SFNotAuthorizedException,
                                       SFOAuthTokenRenewException,
                                       SFOtherException

Throws:

SFInvalidStateException

SFServerException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

setApiClient

public ISFQuery<T> setApiClient(ISFApiClient apiClient)

Specified by:

setApiClient in interface ISFQuery<T>

constructDownloadSpec

public boolean constructDownloadSpec()

Currently the server is not returning a DownloadSpecification for download requests, its directly returning the download link. For the sake of completeness, implement the local response filler for such requests.

Specified by:

constructDownloadSpec in interface ISFQuery<T>

copyQuery

public void copyQuery(com.citrix.sharefile.api.AbstractSFApiQuery<T> sourceQuery)

When whenever you want to re-execute a previous query with slightly different parameters always use this function to copy feilds from the source query and then modify the necessry feilds.

expect

public <V> ISFQuery<V> expect(java.lang.Class<V> clazz)

Specified by:

expect in interface ISFQuery<T>

setCredentials

public ISFQuery<T> setCredentials(java.lang.String userName,
                         java.lang.String password)

Specified by:

setCredentials in interface ISFQuery<T>

getUserName

public final java.lang.String getUserName()

Specified by:

getUserName in interface ISFQuery<T>

getPassword

public final java.lang.String getPassword()

Specified by:

getPassword in interface ISFQuery<T>

setFrom

public final ISFQuery<T> setFrom(java.lang.String setFrom)

Specified by:

setFrom in interface ISFQuery<T>

setLink

public final ISFQuery<T> setLink(java.lang.String link)
                          throws java.net.URISyntaxException

This function takes any uri and store it entirely. example if you pass: https://szqatest2.sharefiletest.com/cifs/v3/Items(randdomid) This function will store it as: https://szqatest2.sharefiletest.com/cifs/v3/Items(randdomid) if the query needs additional params, the call to buildQueryUrlString() will add those to this one. In case you want to avoid that, call setFullyParametrizedLink() instead.

Specified by:

setLink in interface ISFQuery<T>

Throws:

java.net.URISyntaxException

getLink

public final java.net.URI getLink()

Specified by:

getLink in interface ISFQuery<T>

setProvider

public final void setProvider(java.lang.String provider)

setAction

public final ISFQuery<T> setAction(java.lang.String action)

Specified by:

setAction in interface ISFQuery<T>

setHttpMethod

public final void setHttpMethod(SFHttpMethod httpMethod)

setId

public final void setId(java.lang.String id)

setId() and addIds() are mutually exclusive. We will throw and exception if both are called on the same QueryObject That's since we want to be able to build queries like:

Items(id) or

Items(principalid=pid, itemid=itemid)

addIds

public final void addIds(java.lang.String key,
          java.lang.String value)

setId() and addIds() are mutually exclusive. We will throw and exception if both are called on the same QueryObject That's since we want to be able to build queries like:

Items(id) or

Items(principalid=pid, itemid=itemid)

addActionIds

public final ISFQuery<T> addActionIds(java.lang.String actionid)

Specified by:

addActionIds in interface ISFQuery<T>

addActionIds

public final ISFQuery<T> addActionIds(java.lang.Integer actionid)

Specified by:

addActionIds in interface ISFQuery<T>

addActionIds

public final ISFQuery<T> addActionIds(SFSafeEnum actionId)

addSubAction

public final ISFQuery<T> addSubAction(java.lang.String subaction)

Specified by:

addSubAction in interface ISFQuery<T>

addSubAction

public final ISFQuery<T> addSubAction(java.lang.String subaction,
                       SFSafeEnum extras)

Specified by:

addSubAction in interface ISFQuery<T>

setBody

public final ISFQuery<T> setBody(SFODataObject body)

Specified by:

setBody in interface ISFQuery<T>

setBody

public final ISFQuery<T> setBody(java.lang.String str)

getBody

public final java.lang.String getBody()

Specified by:

getBody in interface ISFQuery<T>

addQueryString

public final ISFQuery<T> addQueryString(java.lang.String key,
                         java.lang.Object object)

Specified by:

addQueryString in interface ISFQuery<T>

addQueryString

public ISFQuery<T> addQueryString(java.lang.String key,
                         java.util.ArrayList<java.lang.String> ids)

Specified by:

addQueryString in interface ISFQuery<T>

addQueryString

@Deprecated
public void addQueryString(java.lang.String key,
                             SFApiQuery<SFSearchResults> query)

Deprecated.

buildQueryUrlString

public final java.lang.String buildQueryUrlString(java.lang.String server)
                                           throws java.io.UnsupportedEncodingException

https://server/provider/version/entity(id)

https://myaccount.sf-api.com/sf/v3/Items(id)

https://server/provider/version/entity(principalid=pid,itemid=id)

https://server/provider/version/entity(id)?$expand=Children

https://server/provider/version/entity?$expand=Children

https://server/provider/version/entity?$expand=Children&$select=FileCount,Id,Name,Children/Id,Children/Name,Children/CreationDate

https://account.sf-api.com/sf/v3/Items(parentid)/Folder?overwrite=false&passthrough=false

Specified by:

buildQueryUrlString in interface ISFQuery<T>

Throws:

java.io.UnsupportedEncodingException

getHttpMethod

public final java.lang.String getHttpMethod()

Specified by:

getHttpMethod in interface ISFQuery<T>

canReNewTokenInternally

public boolean canReNewTokenInternally()

we can renew token for Sharefile providers.

Specified by:

canReNewTokenInternally in interface ISFQuery<T>

setHttpMethod

public ISFQuery<T> setHttpMethod(java.lang.String string)

Specified by:

setHttpMethod in interface ISFQuery<T>

addIds

public ISFQuery<T> addIds(java.net.URI url)

Specified by:

addIds in interface ISFQuery<T>

setBody

public ISFQuery<T> setBody(java.util.ArrayList<?> sfoDataObjectsFeed)

Specified by:

setBody in interface ISFQuery<T>

setBody

public ISFQuery<T> setBody(java.lang.Object object)

Specified by:

setBody in interface ISFQuery<T>

setLink

public ISFQuery<T> setLink(java.net.URI uri)

Description copied from interface: ISFQuery

This implies that the query parameters need to be appended by the buildQuery function before executing the query.

Specified by:

setLink in interface ISFQuery<T>

setFullyParametrizedLink

public ISFQuery<T> setFullyParametrizedLink(java.net.URI uri)

Description copied from interface: ISFQuery

This implies that the query parameters are included in the URI and no more parameters more needs to be added before executing the query. Generally we get such URI from Redirection object.

Specified by:

setFullyParametrizedLink in interface ISFQuery<T>

allowRedirection

public ISFQuery<T> allowRedirection(boolean value)

Description copied from interface: ISFQuery

For certain calls like create symbolic link we want to disable readahead done by the SDK. This function allows to set the flag to explicity false if required..

Specified by:

allowRedirection in interface ISFQuery<T>

reDirectionAllowed

public boolean reDirectionAllowed()

Specified by:

reDirectionAllowed in interface ISFQuery<T>

setLinkAndAppendPreviousParameters

public ISFQuery<T> setLinkAndAppendPreviousParameters(java.net.URI newuri)
                                               throws java.net.URISyntaxException,
                                                      java.io.UnsupportedEncodingException

Description copied from interface: ISFQuery

This will append the query paremeters from previuos query to the new link. use this only when re-executing the query for a redirected object. Also , this will ignore the previous params if new query already has some params

Specified by:

setLinkAndAppendPreviousParameters in interface ISFQuery<T>

Throws:

java.net.URISyntaxException

java.io.UnsupportedEncodingException

setLinkAndAppendPreviousParameters

public ISFQuery<T> setLinkAndAppendPreviousParameters(java.lang.String string)
                                               throws java.net.URISyntaxException,
                                                      java.io.UnsupportedEncodingException

Description copied from interface: ISFQuery

This will append the query paremeters from previuos query to the new link. use this only when re-executing the query for a redirected object. Also , this will ignore the previous params if new query already has some params

Specified by:

setLinkAndAppendPreviousParameters in interface ISFQuery<T>

Throws:

java.net.URISyntaxException

java.io.UnsupportedEncodingException

expand

public ISFQuery<T> expand(java.lang.String expansionParameter)

Description copied from interface: ISFQuery

simplifies the adding of expansion parameters to the query.

Specified by:

expand in interface ISFQuery<T>

top

public ISFQuery<T> top(int topItems)

Specified by:

top in interface ISFQuery<T>

skip

public ISFQuery<T> skip(int skipItems)

Specified by:

skip in interface ISFQuery<T>

filter

public ISFQuery<T> filter(java.lang.String filterValue)

Specified by:

filter in interface ISFQuery<T>

is

public ISFQuery<T> is(SFV3ElementType type)

Specified by:

is in interface ISFQuery<T>

select

public ISFQuery<T> select(java.lang.String selectParam)

Specified by:

select in interface ISFQuery<T>

setBaseLink

public ISFQuery<T> setBaseLink(java.net.URI uri)
                        throws java.net.URISyntaxException

This function takes any uri and stores only its base part along with the provider example if you pass: https://szqatest2.sharefiletest.com/cifs/v3/Capabilities This function will store baseLink as : https://szqatest2.sharefiletest.com

Specified by:

setBaseLink in interface ISFQuery<T>

Throws:

java.net.URISyntaxException

executeAsync

public void executeAsync(ISFApiResultCallback<T> callback)

Specified by:

executeAsync in interface ISFQuery<T>

setTag

public void setTag(java.lang.Object tag)

Description copied from interface: ISFQuery

This will allow the consumer apps to preserve identification information related to queries. The SDK itself never uses this.

Specified by:

setTag in interface ISFQuery<T>

getTag

public java.lang.Object getTag()

Description copied from interface: ISFQuery

Get tag set by the setTag function.

Specified by:

getTag in interface ISFQuery<T>

getStringResponse

public java.lang.String getStringResponse()

Specified by:

getStringResponse in interface ISFQuery<T>

setStringResponse

public void setStringResponse(java.lang.String response)

Specified by:

setStringResponse in interface ISFQuery<T>