com.feedhenry.sdk.api

Class FHAuthRequest

java.lang.Object

com.feedhenry.sdk.FHRemote

com.feedhenry.sdk.api.FHAuthRequest

All Implemented Interfaces:

FHAct

public class FHAuthRequest
extends FHRemote

The request for calling the authentication function. Example:

 FHAuthRequest authRequest = FH.buildAuthRequest();
  // This is an oAuth auth policy. Setting a presenting activity will allow the library to
 automatically handle the interaction between the user and the oAuth provider.
  // You also need to add the following code to your application's AndroidManifest.xml file
 (inside the <application> element):
  // <activity android:name="com.feedhenry.sdk.oauth.FHOAuthIntent" />;
  authRequest.setPresentingActivity(this);
  authRequest.setAuthPolicyId("MyGooglePolicy");
  authRequest.executeAsync(new FHActCallback() {
    public void success(FHResponse resp) {
      Log.d("FHAuthActivity", "user sessionToken = "+ resp.getJson().getString("sessionToken"));
    }

    public void fail(FHResponse resp) {
      Log.d("FHAuthActivity", resp.getErrorMessage());
   }
  });
 
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LOG_TAG

Fields inherited from class com.feedhenry.sdk.FHRemote

mCallback, mContext, PATH_PREFIX

Constructor Summary

Constructors

Constructor and Description
FHAuthRequest(android.content.Context context) Deprecated. please use FHActRequest(Context, FHAuthSession) instead
FHAuthRequest(android.content.Context context, FHAuthSession pAuthSession)

Method Summary

Methods

Modifier and Type	Method and Description
protected cz.msebera.android.httpclient.Header[]	buildHeaders(cz.msebera.android.httpclient.Header[] pHeaders)
void	execute(FHActCallback pCallback) Executes the request synchronously.
void	executeAsync(FHActCallback pCallback) Executes the request asynchronously.
protected String	getPath()
protected JSONObject	getRequestArgs()
void	setAuthPolicyId(String pPolicyId) Sets the policy ID for this auth request.
void	setAuthUser(String pPolicyId, String pUserName, String pPassword) Sets the user name for the auth request.
void	setPresentingActivity(android.content.Context pActivity) If the auth policy type is OAuth, user need to enter their username and password for the OAuth provider.

Methods inherited from class com.feedhenry.sdk.FHRemote

executeAsync, getApiURl, setCallback

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static String LOG_TAG

Constructor Detail

FHAuthRequest

@Deprecated
public FHAuthRequest(android.content.Context context)

Deprecated. please use FHActRequest(Context, FHAuthSession) instead

Parameters:

context - The Android application context

FHAuthRequest

public FHAuthRequest(android.content.Context context,
             FHAuthSession pAuthSession)

Parameters:

context - The Android application context

pAuthSession - an FHAuthSession to store and verify tokens

Method Detail

setAuthPolicyId

public void setAuthPolicyId(String pPolicyId)

Sets the policy ID for this auth request.

Parameters:

pPolicyId - the auth policy id. It is required for all the auth requests

setAuthUser

public void setAuthUser(String pPolicyId,
               String pUserName,
               String pPassword)

Sets the user name for the auth request. Only required if the auth policy type is FeedHenry or LDAP.

Parameters:

pPolicyId - the auth policy id

pUserName - the user name

pPassword - the password

getPath

protected String getPath()

Specified by:

getPath in class FHRemote

getRequestArgs

protected JSONObject getRequestArgs()

Specified by:

getRequestArgs in class FHRemote

setPresentingActivity

public void setPresentingActivity(android.content.Context pActivity)

If the auth policy type is OAuth, user need to enter their username and password for the OAuth provider. If an Activity instance is provided, the SDK will automatically handle this (By presenting the OAuth login page in a WebView and back to the application once the authentication process is finished). If it's not provided, the application will need to handle the OAuth process itself.

Parameters:

pActivity - the parent Activity instance to invoke the WebView

executeAsync

public void executeAsync(FHActCallback pCallback)

Description copied from interface: FHAct

Executes the request asynchronously. Executes the pCallback function when it finishes.

Specified by:

executeAsync in interface FHAct

Overrides:

executeAsync in class FHRemote

Parameters:

pCallback - the callback function

execute

public void execute(FHActCallback pCallback)

Description copied from interface: FHAct

Executes the request synchronously.

Specified by:

execute in interface FHAct

Overrides:

execute in class FHRemote

Parameters:

pCallback - the callback function

buildHeaders

protected cz.msebera.android.httpclient.Header[] buildHeaders(cz.msebera.android.httpclient.Header[] pHeaders)

Specified by:

buildHeaders in class FHRemote