Package com.apptus.esales.connector

Class CustomerKeyAuthentication

java.lang.Object

com.apptus.esales.connector.CustomerKeyAuthentication

public class CustomerKeyAuthentication
extends Object

A class that should be used for creating personal customer keys when using eSales Web-API.

Constructor Summary

Constructors

Constructor	Description
CustomerKeyAuthentication(String privateKey, String user)	Creates a new instance that contains a personal customer key and a token, that can be used for cross-device client-side notifications in eSales Web API.

Method Summary

Modifier and Type	Method	Description
String	getCustomerKey()
String	getToken()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerKeyAuthentication

public CustomerKeyAuthentication(String privateKey,
                                 String user)

Creates a new instance that contains a personal customer key and a token, that can be used for cross-device client-side notifications in eSales Web API. This object should be created when the user has successfully logged in, and the respective values should be set in cookies. See getCustomerKey() and getToken().

Parameters:

privateKey - A private key that is unique for this site. This key is provided by Apptus.

user - The user name, or other user-unique value, of the customer that logged in.

Throws:

IllegalArgumentException - If privateKey or user is null or empty.

Method Detail

getCustomerKey

public String getCustomerKey()

Returns:

A hash based on a user specific value, such as user name. This value should be stored in a cookie named "apptus.customerKey".

getToken

public String getToken()

Returns:

The signature of this customerKey. This value should be stored in a cookie named "apptus.token".