com.citrix.sharefile.api.authentication

Class SFOAuthService

java.lang.Object

com.citrix.sharefile.api.authentication.SFOAuthService

All Implemented Interfaces:

ISFOAuthService

public class SFOAuthService
extends java.lang.Object
implements ISFOAuthService

Constructor Summary

Constructors

Constructor and Description
SFOAuthService()

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)
protected SFOAuth2Token	authenticate(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String clientId, java.lang.String clientSecret, java.lang.String samlAssertion) Authenticate via samlAssertion
protected SFOAuth2Token	authenticate(java.lang.String subDomain, java.lang.String apiControlPlane, java.lang.String clientId, java.lang.String clientSecret, java.lang.String username, java.lang.String password) Authenticate via username/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) This function converts the SFWebAuthCode obtained from the webpop and returns the OAuthToken from the server for that code.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

SFOAuthService

public SFOAuthService()

Method Detail

authenticate

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

Authenticate via username/password

Parameters:

subDomain - - hostname like "yourcompanyname"

apiControlPlane - - hostname like "sharefile.com"

clientId - - your apiClient id

clientSecret - - your apiClient secret

username - - my@user.name

password - - mypassword

Returns:

an OAuth2Token instance

Throws:

SFJsonException

SFNotAuthorizedException

authenticate

protected SFOAuth2Token authenticate(java.lang.String subDomain,
                         java.lang.String apiControlPlane,
                         java.lang.String clientId,
                         java.lang.String clientSecret,
                         java.lang.String samlAssertion)
                              throws SFNotAuthorizedException,
                                     SFJsonException

Authenticate via samlAssertion

Parameters:

subDomain - - hostname like "yourcompanyname"

apiControlPlane - - hostname like "sharefile.com"

samlAssertion - - Base64 URL encoded SAML assertion.

Returns:

an OAuth2Token instance

Throws:

SFJsonException

SFNotAuthorizedException

refreshOAuthToken

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

Specified by:

refreshOAuthToken in interface ISFOAuthService

Throws:

SFOAuthTokenRenewException

authenticate

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

Specified by:

authenticate in interface ISFOAuthService

Throws:

SFNotAuthorizedException

SFJsonException

SFInvalidStateException

authenticate

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

Specified by:

authenticate in interface ISFOAuthService

Throws:

SFNotAuthorizedException

SFJsonException

SFInvalidStateException

refreshOAuthToken

public SFOAuth2Token refreshOAuthToken(SFOAuth2Token oldToken)
                                throws SFOAuthTokenRenewException,
                                       SFInvalidStateException

Specified by:

refreshOAuthToken in interface ISFOAuthService

Throws:

SFOAuthTokenRenewException

SFInvalidStateException

authenticateAsync

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

Specified by:

authenticateAsync in interface ISFOAuthService

authenticateAsync

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

Specified by:

authenticateAsync in interface ISFOAuthService

authenticateAsync

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

Specified by:

authenticateAsync in interface ISFOAuthService

refreshOAuthTokenAsync

public void refreshOAuthTokenAsync(SFOAuth2Token oldToken,
                          IOAuthTokenCallback callback)

Specified by:

refreshOAuthTokenAsync in interface ISFOAuthService

refreshOAuthTokenAsync

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

Specified by:

refreshOAuthTokenAsync in interface ISFOAuthService

getOAuthToken

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

This function converts the SFWebAuthCode obtained from the webpop and returns the OAuthToken from the server for that code. The clientIDSecret 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()

Specified by:

getOAuthToken in interface ISFOAuthService

Throws:

SFServerException

SFOtherException