com.bazaarvoice.bvandroidsdk

Class BVHostedAuthenticationProvider

java.lang.Object

com.bazaarvoice.bvandroidsdk.BVHostedAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public class BVHostedAuthenticationProvider
extends java.lang.Object
implements AuthenticationProvider

Authentication that clients configured for Hosted Authentication should use. You can check which authentication configuration you have by following these steps.

Constructor Summary

Constructors

Constructor and Description
BVHostedAuthenticationProvider(java.lang.String uas) Use this constructor if you managed to retrieve the UAS for the user.
BVHostedAuthenticationProvider(java.lang.String userEmailAddress, java.lang.String callbackUrl) When to use

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCallbackUrl()
java.lang.String	getUas()
java.lang.String	getUserEmailAddress()

Methods inherited from class java.lang.Object

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

Constructor Detail

BVHostedAuthenticationProvider

public BVHostedAuthenticationProvider(java.lang.String userEmailAddress,
                                      java.lang.String callbackUrl)

When to use

Use this constructor if you have not managed to retrieve the User Authentication String (UAS) for the user. This method will send the user an email to confirm the ConversationsSubmissionRequest that this was attached to. The email will contain a link for them to tap to confirm, and it will be composed of,

1. The callbackUrl you provided here
2. A bv_authtoken query parameter generated by Bazaarvoice. You will use this to fetch a UAS.

e.g. http://www.example.com/your/authentication-service?bv_authtoken=a7a4278ff33887d352fcdef30edd143f487dc881

How to retrieve a bv_authtoken

You have multiple options for retrieving this bv_authtoken,

1. You may intercept the URL when it is tapped by the user on their phone by registering an IntentFilter in your AndroidManifest.xml. This will not work if the user taps/clicks on the link on a different device.
2. You may setup your backend to retrieve the callback when the user opens the link in a browser, and then send a push notification to your app for this specific user, with the bv_authtoken.

How to retrieve a UAS

Once you have the bv_authtoken from the previous step, you can send off a UserAuthenticationStringRequest, which will return a UserAuthenticationStringResponse. You can then obtain the UAS by calling, UserAuthenticationStringResponse.getUas(). You should store this for the logged in user to make all future requests with the BVHostedAuthenticationProvider(String) constructor.

What if I do not send a UAS?

All content will still be submitted and moderated, and will show up in the display requests.

The consequences for not retrieving the UAS, and using the other constructor, is that the user will continue to be sent an email to confirm for each submission.

The consequences for a user not confirming their submission is that their user profile will not be merged with the content they submitted. If at any point in the future, your app is able to send a UAS then all of those cumulative profiles will be merged.

Parameters:

userEmailAddress - The users email address which Bazaarvoice will send an email to, asking them to verify the submission. This may need to be whitelisted by Bazaarvoice.

callbackUrl - The link that will be posted in the email, that a user taps to confirm their submission. This must be whitelisted by Bazaarvoice.

BVHostedAuthenticationProvider

public BVHostedAuthenticationProvider(java.lang.String uas)

Use this constructor if you managed to retrieve the UAS for the user.

Parameters:

uas - The User Authentication String from the UserAuthenticationStringResponse

Method Detail

getUserEmailAddress

public java.lang.String getUserEmailAddress()

getCallbackUrl

public java.lang.String getCallbackUrl()

getUas

public java.lang.String getUas()