com.gravityrd.recengclient.webshop

Class GravityClient

java.lang.Object

com.gravityrd.recengclient.webshop.GravityClient

public final class GravityClient
extends java.lang.Object

The com.gravityrd.recengclient.webshop.GravityClient class can be used to send events, item and user information to the recommendation engine and get recommendations.

Example usage:

                public com.gravityrd.recengclient.webshop.GravityClient createGravityClient() {
                        com.gravityrd.recengclient.webshop.GravityClient client = new com.gravityrd.recengclient.webshop.GravityClient();
                        client.setRemoteUrl("https://-.gravityrd-services.com/grrec--war/WebshopServlet");
                        client.setUserName("sampleUser");
                        client.setPassword("samplePasswd");
                        return client;
        }
                com.gravityrd.recengclient.webshop.GravityClient client = createGravityClient();
                GravityRecommendationContext context = new GravityRecommendationContext();
                context.numberLimit = 1;
                context.scenarioId = "ITEM_PAGE";
                client.getItemRecommendation("user1", context);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
GravityClient()

Method Summary

Modifier and Type	Method and Description
void	addEvents(com.gravityrd.receng.web.webshop.jsondto.GravityEvent[] events, boolean async) Adds events to the recommendation engine.
void	addItems(com.gravityrd.receng.web.webshop.jsondto.GravityItem[] items, boolean async) Adds items to the recommendation engine.
void	addUsers(com.gravityrd.receng.web.webshop.jsondto.GravityUser[] users, boolean async) Adds users to the recommendation engine.
com.gravityrd.receng.web.webshop.jsondto.GravityEvent[]	getEventsByCookieId(java.lang.String cookieId, int limit) Retrieves full event history associated with the cookieId from the recommendation engine.
com.gravityrd.receng.web.webshop.jsondto.GravityEvent[]	getEventsByUserId(java.lang.String userId, int limit) Retrieves full event history associated with the userId from the recommendation engine.
com.gravityrd.receng.web.webshop.jsondto.GravityItemRecommendation	getItemRecommendation(java.lang.String userId, java.lang.String cookieId, com.gravityrd.receng.web.webshop.jsondto.GravityRecommendationContext context) Returns a list of recommended items, based on the given context parameters.
com.gravityrd.receng.web.webshop.jsondto.GravityItemRecommendation[]	getItemRecommendationBulk(java.lang.String userId, java.lang.String cookieId, com.gravityrd.receng.web.webshop.jsondto.GravityRecommendationContext[] context) Given the userId and the cookieId, we can request recommendations for multiple scenarios (described by the context).
java.lang.String	getPassword()
int	getReadTimeout()
java.lang.String	getRemoteUrl()
com.gravityrd.receng.web.webshop.jsondto.GravityScenario[]	getScenarioInformation() Query the list of available recommendation scenarios for the backend
com.gravityrd.receng.web.webshop.jsondto.GravityUser	getUserByCookieId(java.lang.String cookieId) Retrieves user metadata from the recommendation engine if a user can be recognized from the specified cookieId.
com.gravityrd.receng.web.webshop.jsondto.GravityUser	getUserByUserId(java.lang.String userId) Retrieves user metadata from the recommendation engine.
java.lang.String	getUserName()
void	optOutCookie(java.lang.String cookieId) Deletes full event history assigned with the given cookieId from the recommendation engine.
void	optOutUser(java.lang.String userId) Deletes full event history and metadata assigned with the given userId from the recommendation engine.
void	setPassword(java.lang.String password) Set the password for the http authenticated connection.
void	setReadTimeout(int readTimeout) Set the timeout for the operations in millisecs.
void	setRemoteUrl(java.lang.String remoteUrl) Set the URL of the server side interface.
void	setUserName(java.lang.String userName) Set the user name for the http authenticated connection.
java.lang.String	test(java.lang.String name) Simple test function to test without side effects whether the service is alive.
void	testException() Simple test function to test throwing an exception.

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

GravityClient

public GravityClient()

Method Detail

getScenarioInformation

public com.gravityrd.receng.web.webshop.jsondto.GravityScenario[] getScenarioInformation()
                                                                                  throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                                         java.io.IOException

Query the list of available recommendation scenarios for the backend

Returns:

array of scenarios

Throws:

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - cannot process answer

java.io.IOException - cannot connect to server

getRemoteUrl

public java.lang.String getRemoteUrl()

setRemoteUrl

public void setRemoteUrl(java.lang.String remoteUrl)

Set the URL of the server side interface. It has no default value, must be specified.

Parameters:

remoteUrl - the server url provided by Gravity integration team

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String userName)

Set the user name for the http authenticated connection. Leave it blank in case of connection without authentication.

Parameters:

userName - user authentication name provided by Gravity

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

Set the password for the http authenticated connection. Leave it blank in case of connection without authentication.

Parameters:

password - user authentication password provided by Gravity

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

Set the timeout for the operations in millisecs. The default value is 3000 millisecs.

Parameters:

readTimeout - wait up to this millisecond for the request answers

addEvents

public void addEvents(com.gravityrd.receng.web.webshop.jsondto.GravityEvent[] events,
                      boolean async)
               throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                      java.io.IOException

Adds events to the recommendation engine.

Parameters:

events - The events to add.

async - true if the call is asynchronous. An asynchronous call returns immediately after an input data checking, a synchronous call returns only after the data is saved to database.

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

addUsers

public void addUsers(com.gravityrd.receng.web.webshop.jsondto.GravityUser[] users,
                     boolean async)
              throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                     java.io.IOException

Adds users to the recommendation engine. The existing users will be updated. If a user already exists with the specified userId, the entire user will be replaced with the new user specified here.

Parameters:

users - The user to add.

async - true if the call is asynchronous. An asynchronous call returns immediately after an input data checking, a synchronous call returns only after the data is saved to database.

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

getUserByUserId

public com.gravityrd.receng.web.webshop.jsondto.GravityUser getUserByUserId(java.lang.String userId)
                                                                     throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                            java.io.IOException

Retrieves user metadata from the recommendation engine.

Parameters:

userId - GravityUser.userId

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

getUserByCookieId

public com.gravityrd.receng.web.webshop.jsondto.GravityUser getUserByCookieId(java.lang.String cookieId)
                                                                       throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                              java.io.IOException

Retrieves user metadata from the recommendation engine if a user can be recognized from the specified cookieId.

Parameters:

cookieId - GravityEvent.cookieId

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

getEventsByUserId

public com.gravityrd.receng.web.webshop.jsondto.GravityEvent[] getEventsByUserId(java.lang.String userId,
                                                                                 int limit)
                                                                          throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                                 java.io.IOException

Retrieves full event history associated with the userId from the recommendation engine.

Parameters:

userId - GravityEvent.userId

limit - upper limit for returned events. If 0 or negative a default limit will be used

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

getEventsByCookieId

public com.gravityrd.receng.web.webshop.jsondto.GravityEvent[] getEventsByCookieId(java.lang.String cookieId,
                                                                                   int limit)
                                                                            throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                                   java.io.IOException

Retrieves full event history associated with the cookieId from the recommendation engine.

Parameters:

cookieId - GravityEvent.cookieId

limit - upper limit for returned events. If 0 or negative a default limit will be used

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

optOutUser

public void optOutUser(java.lang.String userId)
                throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                       java.io.IOException

Deletes full event history and metadata assigned with the given userId from the recommendation engine.

Parameters:

userId - GravityEvent.userId

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if the userId is invalid

optOutCookie

public void optOutCookie(java.lang.String cookieId)
                  throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                         java.io.IOException

Deletes full event history assigned with the given cookieId from the recommendation engine.

Parameters:

cookieId - GravityEvent.cookieId

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if the cookieId is invalid

addItems

public void addItems(com.gravityrd.receng.web.webshop.jsondto.GravityItem[] items,
                     boolean async)
              throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                     java.io.IOException

Adds items to the recommendation engine. If an item already exists with the specified itemId, the entire item along with its NameValue pairs will be replaced to the new item specified here.

Parameters:

items - The items to add

async - true if the call is asynchronous. An asynchronous call returns immediately after an input data checking, a synchronous call returns only after the data is saved to

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer filesdatabase.

getItemRecommendation

public com.gravityrd.receng.web.webshop.jsondto.GravityItemRecommendation getItemRecommendation(java.lang.String userId,
                                                                                                java.lang.String cookieId,
                                                                                                com.gravityrd.receng.web.webshop.jsondto.GravityRecommendationContext context)
                                                                                         throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                                                java.io.IOException

Returns a list of recommended items, based on the given context parameters.

Parameters:

userId - The identifier of the logged in user. If no user is logged in, null should be specified.

cookieId - It should be a permanent identifier for the end users computer, preserving its value across browser sessions. It should be always specified.

context - Additional information which describes the actual scenario.

Returns:

An object containing the recommended items and other information about the recommendation.

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

getItemRecommendationBulk

public com.gravityrd.receng.web.webshop.jsondto.GravityItemRecommendation[] getItemRecommendationBulk(java.lang.String userId,
                                                                                                      java.lang.String cookieId,
                                                                                                      com.gravityrd.receng.web.webshop.jsondto.GravityRecommendationContext[] context)
                                                                                               throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                                                                                                      java.io.IOException

Given the userId and the cookieId, we can request recommendations for multiple scenarios (described by the context). This function returns lists of recommended items for each of the given scenarios in an array.

Parameters:

userId - The identifier of the logged in user. If no user is logged in, null should be specified.

cookieId - It should be a permanent identifier for the end users computer, preserving its value across browser sessions. It should be always specified.

context - Additional Array of information which describes the actual scenarios.

Returns:

An Array containing the recommended items for each scenario with other information about the recommendation.

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

test

public java.lang.String test(java.lang.String name)
                      throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                             java.io.IOException

Simple test function to test without side effects whether the service is alive.

Parameters:

name - a test string

Returns:

"Hello " + name* @throws IOException if cannot connect

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files

testException

public void testException()
                   throws com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException,
                          java.io.IOException

Simple test function to test throwing an exception.

Throws:

java.io.IOException - if cannot connect

com.gravityrd.receng.web.webshop.jsondto.GravityRecEngException - if cannot process the answer files