com.loop54.user

Class UserMetaData

java.lang.Object

com.loop54.user.UserMetaData

public class UserMetaData
extends java.lang.Object

Represents data about the end-user. Used by the search engine to personalize the shopping experience. Use this class to override the default behaviour of the library. For instance if you want a custom UserId based on a logged in user.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	ipAddress Ip address of the end-user.
static java.lang.String	PROXY_IP_HEADER_NAME
java.lang.String	referer The Referer(sic) header from the end-user.
static java.lang.String	USER_ID_COOKIE_KEY
java.lang.String	userAgent User-Agent header from the end-user.
java.lang.String	userId An unique identifier of the end-user.

Constructor Summary

Constructors

Constructor and Description
UserMetaData()
UserMetaData(java.lang.String userId) The unique id of the user.

Method Summary

Modifier and Type	Method and Description
void	setFromClientInfo(IRemoteClientInfo clientInfo)

Methods inherited from class java.lang.Object

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

Field Detail

userId

public java.lang.String userId

An unique identifier of the end-user. DO NOT set this to a placeholder string. If it's not set it'll be automatically set to a random GUID when making the request and a cookie will be stored to the IRemoteClientInfo provided in the request so that we may identify the user later.

ipAddress

public java.lang.String ipAddress

Ip address of the end-user. If not set it will later be set to the IP address provided by the IRemoteClientInfo.

userAgent

public java.lang.String userAgent

User-Agent header from the end-user. If not set it will later be set to the User-Agent provided by the IRemoteClientInfo.

referer

public java.lang.String referer

The Referer(sic) header from the end-user. If not set it will later be set to the Referer provided by the IRemoteClientInfo.

USER_ID_COOKIE_KEY

public static final java.lang.String USER_ID_COOKIE_KEY

See Also:

Constant Field Values

PROXY_IP_HEADER_NAME

public static final java.lang.String PROXY_IP_HEADER_NAME

See Also:

Constant Field Values

Constructor Detail

UserMetaData

public UserMetaData()

UserMetaData

public UserMetaData(java.lang.String userId)

The unique id of the user. Could be used for overriding the default, random, cookie-stored identifier.

Parameters:

userId - unique identifier of the current end-user. Used to connect behaviour.

Method Detail

setFromClientInfo

public void setFromClientInfo(IRemoteClientInfo clientInfo)