com.citrix.sharefile.api.interfaces

Interface ISFOAuthService

All Known Implementing Classes:

SFOAuthService

public interface ISFOAuthService

Method Summary

Methods

Modifier and Type	Method and Description
SFOAuth2Token	authenticate(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String samlAssertion)
SFOAuth2Token	authenticate(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String username, java.lang.String password)
void	authenticateAsync(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String samlAssertion, IOAuthTokenCallback callback)
void	authenticateAsync(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String username, java.lang.String password, IOAuthTokenCallback callback)
void	authenticateAsync(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String clientId, java.lang.String clientSecret, java.lang.String samlAssertion, IOAuthTokenCallback callback)
SFOAuth2Token	getOAuthToken(SFWebAuthCode webAuthCode, java.lang.String... clientIdSecret) The clientID Secret is optional.
SFOAuth2Token	refreshOAuthToken(SFOAuth2Token oldToken)
SFOAuth2Token	refreshOAuthToken(SFOAuth2Token oldToken, java.lang.String clientId, java.lang.String clientSecret)
void	refreshOAuthTokenAsync(SFOAuth2Token oldToken, IOAuthTokenCallback callback)
void	refreshOAuthTokenAsync(SFOAuth2Token oldToken, java.lang.String clientId, java.lang.String clientSecret, IOAuthTokenCallback callback)

Method Detail

authenticate

SFOAuth2Token authenticate(java.lang.String subDomain,
                         java.lang.String apiControlPlane,
                         java.lang.String username,
                         java.lang.String password)
                           throws SFNotAuthorizedException,
                                  SFJsonException,
                                  SFInvalidStateException

Throws:

SFNotAuthorizedException

SFJsonException

SFInvalidStateException

authenticate

SFOAuth2Token authenticate(java.lang.String subDomain,
                         java.lang.String apiControlPlane,
                         java.lang.String samlAssertion)
                           throws SFNotAuthorizedException,
                                  SFJsonException,
                                  SFInvalidStateException

Throws:

SFNotAuthorizedException

SFJsonException

SFInvalidStateException

refreshOAuthToken

SFOAuth2Token refreshOAuthToken(SFOAuth2Token oldToken)
                                throws java.io.IOException,
                                       SFOAuthTokenRenewException,
                                       SFInvalidStateException

Throws:

java.io.IOException

SFOAuthTokenRenewException

SFInvalidStateException

authenticateAsync

void authenticateAsync(java.lang.String subDomain,
                     java.lang.String apiControlPlane,
                     java.lang.String username,
                     java.lang.String password,
                     IOAuthTokenCallback callback)

authenticateAsync

void authenticateAsync(java.lang.String subDomain,
                     java.lang.String apiControlPlane,
                     java.lang.String samlAssertion,
                     IOAuthTokenCallback callback)

authenticateAsync

void authenticateAsync(java.lang.String subDomain,
                     java.lang.String apiControlPlane,
                     java.lang.String clientId,
                     java.lang.String clientSecret,
                     java.lang.String samlAssertion,
                     IOAuthTokenCallback callback)

refreshOAuthTokenAsync

void refreshOAuthTokenAsync(SFOAuth2Token oldToken,
                          IOAuthTokenCallback callback)

refreshOAuthTokenAsync

void refreshOAuthTokenAsync(SFOAuth2Token oldToken,
                          java.lang.String clientId,
                          java.lang.String clientSecret,
                          IOAuthTokenCallback callback)

getOAuthToken

SFOAuth2Token getOAuthToken(SFWebAuthCode webAuthCode,
                          java.lang.String... clientIdSecret)
                            throws SFServerException,
                                   SFOtherException

The clientID Secret is optional. Yf you don't pass these, the function will try to pick it up from those which you set during the SFSdk.init()

Throws:

SFServerException

SFOtherException

refreshOAuthToken

SFOAuth2Token refreshOAuthToken(SFOAuth2Token oldToken,
                              java.lang.String clientId,
                              java.lang.String clientSecret)
                                throws SFOAuthTokenRenewException

Throws:

SFOAuthTokenRenewException