com.citrix.sharefile.api.interfaces

Interface ISFQuery<T>

All Known Implementing Classes:

SFApiQuery, SFQueryStream

public interface ISFQuery<T>

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<T>	addActionIds(java.lang.Integer id)
ISFQuery<T>	addActionIds(java.lang.String id)
ISFQuery<T>	addIds(java.net.URI url)
ISFQuery<T>	addQueryString(java.lang.String string, java.util.ArrayList<java.lang.String> ids)
ISFQuery<T>	addQueryString(java.lang.String string, java.lang.Object type)
ISFQuery<T>	addSubAction(java.lang.String string)
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)
boolean	canReNewTokenInternally()
boolean	constructDownloadSpec()
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 name)
ISFQuery<T>	setAction(java.lang.String string)
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/cifs/v3/
ISFQuery<T>	setBody(java.util.ArrayList<?> sfoDataObjectsFeed)
ISFQuery<T>	setBody(java.lang.Object object)
ISFQuery<T>	setBody(SFODataObject sfoDataObject)
ISFQuery<T>	setCredentials(java.lang.String userName, java.lang.String password)
ISFQuery<T>	setFrom(java.lang.String string)
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.
ISFQuery<T>	setHttpMethod(java.lang.String string)
ISFQuery<T>	setLink(java.lang.String string)
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 uri) This will append the query paremeters from previuos query to the new link.
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)

Method Detail

setApiClient

ISFQuery<T> setApiClient(ISFApiClient apiClient)

setFrom

ISFQuery<T> setFrom(java.lang.String string)

setHttpMethod

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

addIds

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

setAction

ISFQuery<T> setAction(java.lang.String string)

setBody

ISFQuery<T> setBody(SFODataObject sfoDataObject)

setBody

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

setBody

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

addQueryString

ISFQuery<T> addQueryString(java.lang.String string,
                         java.lang.Object type)

addActionIds

ISFQuery<T> addActionIds(java.lang.String id)

addActionIds

ISFQuery<T> addActionIds(java.lang.Integer id)

addQueryString

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

addSubAction

ISFQuery<T> addSubAction(java.lang.String string)

addSubAction

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

getLink

java.net.URI getLink()

getUserName

java.lang.String getUserName()

getPassword

java.lang.String getPassword()

getHttpMethod

java.lang.String getHttpMethod()

getBody

java.lang.String getBody()

constructDownloadSpec

boolean constructDownloadSpec()

buildQueryUrlString

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

Throws:

java.io.UnsupportedEncodingException

setLink

ISFQuery<T> setLink(java.lang.String string)
                    throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

setLink

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.

setFullyParametrizedLink

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. Generally we get such URI from Redirection object.

canReNewTokenInternally

boolean canReNewTokenInternally()

setCredentials

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

allowRedirection

ISFQuery<T> allowRedirection(boolean value)

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..

reDirectionAllowed

boolean reDirectionAllowed()

expect

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

setLinkAndAppendPreviousParameters

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

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

Throws:

java.net.URISyntaxException

java.io.UnsupportedEncodingException

setLinkAndAppendPreviousParameters

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

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

Throws:

java.net.URISyntaxException

java.io.UnsupportedEncodingException

expand

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

simplifies the adding of expansion parameters to the query.

top

ISFQuery<T> top(int topItems)

skip

ISFQuery<T> skip(int skipItems)

filter

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

is

ISFQuery<T> is(SFV3ElementType type)

select

ISFQuery<T> select(java.lang.String name)

setBaseLink

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/cifs/v3/

Throws:

java.net.URISyntaxException

execute

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

Throws:

SFInvalidStateException

SFServerException

SFNotAuthorizedException

SFOAuthTokenRenewException

SFOtherException

executeAsync

void executeAsync(ISFApiResultCallback<T> callback)

setTag

void setTag(java.lang.Object tag)

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

getTag

java.lang.Object getTag()

Get tag set by the setTag function.

getStringResponse

java.lang.String getStringResponse()

setStringResponse

void setStringResponse(java.lang.String response)