Package com.loop54

Class Loop54Client

java.lang.Object

com.loop54.Loop54Client

All Implemented Interfaces:

ILoop54Client, Closeable, AutoCloseable

public class Loop54Client
extends Object
implements ILoop54Client

Default implementation of the ILoop54Client interface.

When issuing a request the user data will be used in this order of priority:
1. The UserMetaData provided in RequestContainer in the method call.
2. The IRemoteClientInfo gotten from the IRemoteClientInfoProvider

Constructor Summary

Constructors

Constructor	Description
Loop54Client(IRequestManager requestManager, IRemoteClientInfoProvider remoteClientInfoProvider)

Method Summary

Modifier and Type	Method	Description
AutoCompleteResponse	autoComplete(AutoCompleteRequest request)
AutoCompleteResponse	autoComplete(RequestContainer<AutoCompleteRequest> request)
CompletableFuture<AutoCompleteResponse>	autoCompleteAsync(AutoCompleteRequest request)
CompletableFuture<AutoCompleteResponse>	autoCompleteAsync(RequestContainer<AutoCompleteRequest> request)
void	close()	Closes the underlying request manager and releases any system resources associated with it.
Response	createEvents(CreateEventsRequest request)
Response	createEvents(RequestContainer<CreateEventsRequest> request)
CompletableFuture<Response>	createEventsAsync(CreateEventsRequest request)
CompletableFuture<Response>	createEventsAsync(RequestContainer<CreateEventsRequest> request)
Response	customCall(String name, Request request)
Response	customCall(String name, RequestContainer<Request> request)
CompletableFuture<Response>	customCallAsync(String name, Request request)
CompletableFuture<Response>	customCallAsync(String name, RequestContainer<Request> request)
GetBasketRecommendationsResponse	getBasketRecommendations(GetBasketRecommendationsRequest request)
GetBasketRecommendationsResponse	getBasketRecommendations(RequestContainer<GetBasketRecommendationsRequest> request)
CompletableFuture<GetBasketRecommendationsResponse>	getBasketRecommendationsAsync(GetBasketRecommendationsRequest request)
CompletableFuture<GetBasketRecommendationsResponse>	getBasketRecommendationsAsync(RequestContainer<GetBasketRecommendationsRequest> request)
GetComplementaryEntitiesResponse	getComplementaryEntities(GetComplementaryEntitiesRequest request)
GetComplementaryEntitiesResponse	getComplementaryEntities(RequestContainer<GetComplementaryEntitiesRequest> request)
CompletableFuture<GetComplementaryEntitiesResponse>	getComplementaryEntitiesAsync(GetComplementaryEntitiesRequest request)
CompletableFuture<GetComplementaryEntitiesResponse>	getComplementaryEntitiesAsync(RequestContainer<GetComplementaryEntitiesRequest> request)
GetEntitiesResponse	getEntities(GetEntitiesRequest request)
GetEntitiesResponse	getEntities(RequestContainer<GetEntitiesRequest> request)
CompletableFuture<GetEntitiesResponse>	getEntitiesAsync(GetEntitiesRequest request)
CompletableFuture<GetEntitiesResponse>	getEntitiesAsync(RequestContainer<GetEntitiesRequest> request)
GetEntitiesByAttributeResponse	getEntitiesByAttribute(GetEntitiesByAttributeRequest request)
GetEntitiesByAttributeResponse	getEntitiesByAttribute(RequestContainer<GetEntitiesByAttributeRequest> request)
CompletableFuture<GetEntitiesByAttributeResponse>	getEntitiesByAttributeAsync(GetEntitiesByAttributeRequest request)
CompletableFuture<GetEntitiesByAttributeResponse>	getEntitiesByAttributeAsync(RequestContainer<GetEntitiesByAttributeRequest> request)
GetPopularEntitiesResponse	getPopularEntities(GetPopularEntitiesRequest request)
GetPopularEntitiesResponse	getPopularEntities(RequestContainer<GetPopularEntitiesRequest> request)
CompletableFuture<GetPopularEntitiesResponse>	getPopularEntitiesAsync(GetPopularEntitiesRequest request)
CompletableFuture<GetPopularEntitiesResponse>	getPopularEntitiesAsync(RequestContainer<GetPopularEntitiesRequest> request)
GetRecentEntitiesResponse	getRecentEntities(GetRecentEntitiesRequest request)
GetRecentEntitiesResponse	getRecentEntities(RequestContainer<GetRecentEntitiesRequest> request)
CompletableFuture<GetRecentEntitiesResponse>	getRecentEntitiesAsync(GetRecentEntitiesRequest request)
CompletableFuture<GetRecentEntitiesResponse>	getRecentEntitiesAsync(RequestContainer<GetRecentEntitiesRequest> request)
GetRecommendedEntitiesResponse	getRecommendedEntities(GetRecommendedEntitiesRequest request)
GetRecommendedEntitiesResponse	getRecommendedEntities(RequestContainer<GetRecommendedEntitiesRequest> request)
CompletableFuture<GetRecommendedEntitiesResponse>	getRecommendedEntitiesAsync(GetRecommendedEntitiesRequest request)
CompletableFuture<GetRecommendedEntitiesResponse>	getRecommendedEntitiesAsync(RequestContainer<GetRecommendedEntitiesRequest> request)
GetRelatedEntitiesResponse	getRelatedEntities(GetRelatedEntitiesRequest request)
GetRelatedEntitiesResponse	getRelatedEntities(RequestContainer<GetRelatedEntitiesRequest> request)
CompletableFuture<GetRelatedEntitiesResponse>	getRelatedEntitiesAsync(GetRelatedEntitiesRequest request)
CompletableFuture<GetRelatedEntitiesResponse>	getRelatedEntitiesAsync(RequestContainer<GetRelatedEntitiesRequest> request)
static <T extends Request> RequestContainer<T>	getRequestContainer(T requestData)
static <T extends Request> RequestContainer<T>	getRequestContainer(T requestData, UserMetaData metaDataOverrides)	Will wrap the request in a requestContainer to provide overriding options for the API call.
IRequestManager	getRequestManager()
SearchResponse	search(SearchRequest request)
SearchResponse	search(RequestContainer<SearchRequest> request)
CompletableFuture<SearchResponse>	searchAsync(SearchRequest request)
CompletableFuture<SearchResponse>	searchAsync(RequestContainer<SearchRequest> request)
Response	sync()
Response	sync(Request request)
Response	sync(RequestContainer<Request> request)
CompletableFuture<Response>	syncAsync()
CompletableFuture<Response>	syncAsync(Request request)
CompletableFuture<Response>	syncAsync(RequestContainer<Request> request)

Methods inherited from class java.lang.Object

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

Constructor Details

Loop54Client

public Loop54Client(IRequestManager requestManager,
 IRemoteClientInfoProvider remoteClientInfoProvider)

Parameters:

requestManager - The IRequestManager to use when making calls to the api. Must not be null.

remoteClientInfoProvider - The IRemoteClientInfoProvider.

Method Details

getRequestManager

public IRequestManager getRequestManager()

Returns:

IRequestManager used by this client.

search

public SearchResponse search(SearchRequest request)
                      throws Loop54Exception

Specified by:

search in interface ILoop54Client

Throws:

Loop54Exception

search

public SearchResponse search(RequestContainer<SearchRequest> request)
                      throws Loop54Exception

Specified by:

search in interface ILoop54Client

Throws:

Loop54Exception

searchAsync

public CompletableFuture<SearchResponse> searchAsync(SearchRequest request)

Specified by:

searchAsync in interface ILoop54Client

searchAsync

public CompletableFuture<SearchResponse> searchAsync(RequestContainer<SearchRequest> request)

Specified by:

searchAsync in interface ILoop54Client

getEntities

public GetEntitiesResponse getEntities(GetEntitiesRequest request)
                                throws Loop54Exception

Specified by:

getEntities in interface ILoop54Client

Throws:

Loop54Exception

getEntities

public GetEntitiesResponse getEntities(RequestContainer<GetEntitiesRequest> request)
                                throws Loop54Exception

Specified by:

getEntities in interface ILoop54Client

Throws:

Loop54Exception

getEntitiesAsync

public CompletableFuture<GetEntitiesResponse> getEntitiesAsync(GetEntitiesRequest request)

Specified by:

getEntitiesAsync in interface ILoop54Client

getEntitiesAsync

public CompletableFuture<GetEntitiesResponse> getEntitiesAsync(RequestContainer<GetEntitiesRequest> request)

Specified by:

getEntitiesAsync in interface ILoop54Client

getEntitiesByAttribute

public GetEntitiesByAttributeResponse getEntitiesByAttribute(GetEntitiesByAttributeRequest request)
                                                      throws Loop54Exception

Specified by:

getEntitiesByAttribute in interface ILoop54Client

Throws:

Loop54Exception

getEntitiesByAttribute

public GetEntitiesByAttributeResponse getEntitiesByAttribute(RequestContainer<GetEntitiesByAttributeRequest> request)
                                                      throws Loop54Exception

Specified by:

getEntitiesByAttribute in interface ILoop54Client

Throws:

Loop54Exception

getEntitiesByAttributeAsync

public CompletableFuture<GetEntitiesByAttributeResponse> getEntitiesByAttributeAsync(GetEntitiesByAttributeRequest request)

Specified by:

getEntitiesByAttributeAsync in interface ILoop54Client

getEntitiesByAttributeAsync

public CompletableFuture<GetEntitiesByAttributeResponse> getEntitiesByAttributeAsync(RequestContainer<GetEntitiesByAttributeRequest> request)

Specified by:

getEntitiesByAttributeAsync in interface ILoop54Client

autoComplete

public AutoCompleteResponse autoComplete(AutoCompleteRequest request)
                                  throws Loop54Exception

Specified by:

autoComplete in interface ILoop54Client

Throws:

Loop54Exception

autoComplete

public AutoCompleteResponse autoComplete(RequestContainer<AutoCompleteRequest> request)
                                  throws Loop54Exception

Specified by:

autoComplete in interface ILoop54Client

Throws:

Loop54Exception

autoCompleteAsync

public CompletableFuture<AutoCompleteResponse> autoCompleteAsync(AutoCompleteRequest request)

Specified by:

autoCompleteAsync in interface ILoop54Client

autoCompleteAsync

public CompletableFuture<AutoCompleteResponse> autoCompleteAsync(RequestContainer<AutoCompleteRequest> request)

Specified by:

autoCompleteAsync in interface ILoop54Client

getRelatedEntities

public GetRelatedEntitiesResponse getRelatedEntities(GetRelatedEntitiesRequest request)
                                              throws Loop54Exception

Specified by:

getRelatedEntities in interface ILoop54Client

Throws:

Loop54Exception

getRelatedEntities

public GetRelatedEntitiesResponse getRelatedEntities(RequestContainer<GetRelatedEntitiesRequest> request)
                                              throws Loop54Exception

Specified by:

getRelatedEntities in interface ILoop54Client

Throws:

Loop54Exception

getRelatedEntitiesAsync

public CompletableFuture<GetRelatedEntitiesResponse> getRelatedEntitiesAsync(GetRelatedEntitiesRequest request)

Specified by:

getRelatedEntitiesAsync in interface ILoop54Client

getRelatedEntitiesAsync

public CompletableFuture<GetRelatedEntitiesResponse> getRelatedEntitiesAsync(RequestContainer<GetRelatedEntitiesRequest> request)

Specified by:

getRelatedEntitiesAsync in interface ILoop54Client

getComplementaryEntities

public GetComplementaryEntitiesResponse getComplementaryEntities(GetComplementaryEntitiesRequest request)
                                                          throws Loop54Exception

Specified by:

getComplementaryEntities in interface ILoop54Client

Throws:

Loop54Exception

getComplementaryEntities

public GetComplementaryEntitiesResponse getComplementaryEntities(RequestContainer<GetComplementaryEntitiesRequest> request)
                                                          throws Loop54Exception

Specified by:

getComplementaryEntities in interface ILoop54Client

Throws:

Loop54Exception

getComplementaryEntitiesAsync

public CompletableFuture<GetComplementaryEntitiesResponse> getComplementaryEntitiesAsync(GetComplementaryEntitiesRequest request)

Specified by:

getComplementaryEntitiesAsync in interface ILoop54Client

getComplementaryEntitiesAsync

public CompletableFuture<GetComplementaryEntitiesResponse> getComplementaryEntitiesAsync(RequestContainer<GetComplementaryEntitiesRequest> request)

Specified by:

getComplementaryEntitiesAsync in interface ILoop54Client

getBasketRecommendations

public GetBasketRecommendationsResponse getBasketRecommendations(GetBasketRecommendationsRequest request)
                                                          throws Loop54Exception

Specified by:

getBasketRecommendations in interface ILoop54Client

Throws:

Loop54Exception

getBasketRecommendations

public GetBasketRecommendationsResponse getBasketRecommendations(RequestContainer<GetBasketRecommendationsRequest> request)
                                                          throws Loop54Exception

Specified by:

getBasketRecommendations in interface ILoop54Client

Throws:

Loop54Exception

getBasketRecommendationsAsync

public CompletableFuture<GetBasketRecommendationsResponse> getBasketRecommendationsAsync(GetBasketRecommendationsRequest request)

Specified by:

getBasketRecommendationsAsync in interface ILoop54Client

getBasketRecommendationsAsync

public CompletableFuture<GetBasketRecommendationsResponse> getBasketRecommendationsAsync(RequestContainer<GetBasketRecommendationsRequest> request)

Specified by:

getBasketRecommendationsAsync in interface ILoop54Client

getRecommendedEntities

public GetRecommendedEntitiesResponse getRecommendedEntities(GetRecommendedEntitiesRequest request)
                                                      throws Loop54Exception

Specified by:

getRecommendedEntities in interface ILoop54Client

Throws:

Loop54Exception

getRecommendedEntities

public GetRecommendedEntitiesResponse getRecommendedEntities(RequestContainer<GetRecommendedEntitiesRequest> request)
                                                      throws Loop54Exception

Specified by:

getRecommendedEntities in interface ILoop54Client

Throws:

Loop54Exception

getRecommendedEntitiesAsync

public CompletableFuture<GetRecommendedEntitiesResponse> getRecommendedEntitiesAsync(GetRecommendedEntitiesRequest request)

Specified by:

getRecommendedEntitiesAsync in interface ILoop54Client

getRecommendedEntitiesAsync

public CompletableFuture<GetRecommendedEntitiesResponse> getRecommendedEntitiesAsync(RequestContainer<GetRecommendedEntitiesRequest> request)

Specified by:

getRecommendedEntitiesAsync in interface ILoop54Client

getPopularEntities

public GetPopularEntitiesResponse getPopularEntities(GetPopularEntitiesRequest request)
                                              throws Loop54Exception

Specified by:

getPopularEntities in interface ILoop54Client

Throws:

Loop54Exception

getPopularEntities

public GetPopularEntitiesResponse getPopularEntities(RequestContainer<GetPopularEntitiesRequest> request)
                                              throws Loop54Exception

Specified by:

getPopularEntities in interface ILoop54Client

Throws:

Loop54Exception

getPopularEntitiesAsync

public CompletableFuture<GetPopularEntitiesResponse> getPopularEntitiesAsync(GetPopularEntitiesRequest request)

Specified by:

getPopularEntitiesAsync in interface ILoop54Client

getPopularEntitiesAsync

public CompletableFuture<GetPopularEntitiesResponse> getPopularEntitiesAsync(RequestContainer<GetPopularEntitiesRequest> request)

Specified by:

getPopularEntitiesAsync in interface ILoop54Client

getRecentEntities

public GetRecentEntitiesResponse getRecentEntities(GetRecentEntitiesRequest request)
                                            throws Loop54Exception

Specified by:

getRecentEntities in interface ILoop54Client

Throws:

Loop54Exception

getRecentEntities

public GetRecentEntitiesResponse getRecentEntities(RequestContainer<GetRecentEntitiesRequest> request)
                                            throws Loop54Exception

Specified by:

getRecentEntities in interface ILoop54Client

Throws:

Loop54Exception

getRecentEntitiesAsync

public CompletableFuture<GetRecentEntitiesResponse> getRecentEntitiesAsync(GetRecentEntitiesRequest request)

Specified by:

getRecentEntitiesAsync in interface ILoop54Client

getRecentEntitiesAsync

public CompletableFuture<GetRecentEntitiesResponse> getRecentEntitiesAsync(RequestContainer<GetRecentEntitiesRequest> request)

Specified by:

getRecentEntitiesAsync in interface ILoop54Client

sync

public Response sync()
              throws Loop54Exception

Specified by:

sync in interface ILoop54Client

Throws:

Loop54Exception

sync

public Response sync(Request request)
              throws Loop54Exception

Specified by:

sync in interface ILoop54Client

Throws:

Loop54Exception

sync

public Response sync(RequestContainer<Request> request)
              throws Loop54Exception

Specified by:

sync in interface ILoop54Client

Throws:

Loop54Exception

syncAsync

public CompletableFuture<Response> syncAsync()

Specified by:

syncAsync in interface ILoop54Client

syncAsync

public CompletableFuture<Response> syncAsync(Request request)

Specified by:

syncAsync in interface ILoop54Client

syncAsync

public CompletableFuture<Response> syncAsync(RequestContainer<Request> request)

Specified by:

syncAsync in interface ILoop54Client

createEvents

public Response createEvents(CreateEventsRequest request)
                      throws Loop54Exception

Specified by:

createEvents in interface ILoop54Client

Throws:

Loop54Exception

createEvents

public Response createEvents(RequestContainer<CreateEventsRequest> request)
                      throws Loop54Exception

Specified by:

createEvents in interface ILoop54Client

Throws:

Loop54Exception

createEventsAsync

public CompletableFuture<Response> createEventsAsync(CreateEventsRequest request)

Specified by:

createEventsAsync in interface ILoop54Client

createEventsAsync

public CompletableFuture<Response> createEventsAsync(RequestContainer<CreateEventsRequest> request)

Specified by:

createEventsAsync in interface ILoop54Client

customCall

public Response customCall(String name,
 Request request)
                    throws Loop54Exception

Specified by:

customCall in interface ILoop54Client

Throws:

Loop54Exception

customCall

public Response customCall(String name,
 RequestContainer<Request> request)
                    throws Loop54Exception

Specified by:

customCall in interface ILoop54Client

Throws:

Loop54Exception

customCallAsync

public CompletableFuture<Response> customCallAsync(String name,
 Request request)

Specified by:

customCallAsync in interface ILoop54Client

customCallAsync

public CompletableFuture<Response> customCallAsync(String name,
 RequestContainer<Request> request)

Specified by:

customCallAsync in interface ILoop54Client

getRequestContainer

public static <T extends Request>
RequestContainer<T> getRequestContainer(T requestData,
 UserMetaData metaDataOverrides)

Will wrap the request in a requestContainer to provide overriding options for the API call.

Type Parameters:

T - The type of the request data to add overrides to.

Parameters:

requestData - The request data to wrap in a container. For instance a SearchRequest.

metaDataOverrides - Use these overrides to force certain values to take effect in the api call. For instance if you set the UserMetaData.userId it will trump any data from a IRemoteClientInfo! This could be useful if you want to use an internal customer id of a logged in user.

Returns:

A RequestContainer wrapping the Request.

getRequestContainer

public static <T extends Request>
RequestContainer<T> getRequestContainer(T requestData)

close

public void close()
           throws IOException

Closes the underlying request manager and releases any system resources associated with it. After calling this method, the client should no longer be used.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs while closing the request manager