com.day.cq.searchpromote

Interface SearchPromoteService

public interface SearchPromoteService

Method Summary

Modifier and Type	Method and Description
java.lang.String	callRemoteIndex(java.lang.String accountNumber, java.lang.String remotePassword, boolean fullIndex) Calls the remote indexer
java.lang.String	getBannerAreaList(java.lang.String memberid, java.lang.String accountnumber) Returns a JSON string representation of available BannerAreas.
int	getConnectionTimeout() Returns the configured timeout in milliseconds until a connection is established.
java.lang.String	getFacetList(java.lang.String memberid, java.lang.String accountnumber) Returns a JSON string representation of available Facets.
java.lang.String	getSearchForm(java.lang.String memberid, java.lang.String accountnumber) Returns an XML string representation for search form from the stage environment of Search&Promote.
java.lang.String	getSearchForm(java.lang.String memberId, java.lang.String accountNumber, SearchPromoteEnvironment environment) Returns an XML string representation for search form.
java.net.URI	getServerURI() Returns configured Search&Promote server where configurations are fetched from.
int	getSocketTimeout() Returns the configured timeout in milliseconds, which is the timeout for waiting for data or a maximum period of inactivity between two consecutive data packets.

Method Detail

getServerURI

java.net.URI getServerURI()

Returns configured Search&Promote server where configurations are fetched from.

Returns:

URI for Search&Promote server

getSearchForm

java.lang.String getSearchForm(java.lang.String memberid,
                               java.lang.String accountnumber)
                        throws SearchPromoteException

Returns an XML string representation for search form from the stage environment of Search&Promote.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

String representation of the search form XML

Throws:

SearchPromoteException - SearchPromoteException if XML could not be fetched or response is invalid.

getSearchForm

java.lang.String getSearchForm(java.lang.String memberId,
                               java.lang.String accountNumber,
                               SearchPromoteEnvironment environment)
                        throws SearchPromoteException

Returns an XML string representation for search form. The search form is retrieved from the specified environment

Parameters:

memberId - Member ID

accountNumber - Account number

environment - The Search&Promote environment (stage / live)

Returns:

String representation of the search form XML

Throws:

SearchPromoteException - SearchPromoteException

getFacetList

java.lang.String getFacetList(java.lang.String memberid,
                              java.lang.String accountnumber)
                       throws SearchPromoteException

Returns a JSON string representation of available Facets.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

JSON string representation of the available Facets

Throws:

SearchPromoteException - SearchPromoteException if JSON could not be feteched or response is invalid.

getBannerAreaList

java.lang.String getBannerAreaList(java.lang.String memberid,
                                   java.lang.String accountnumber)
                            throws SearchPromoteException

Returns a JSON string representation of available BannerAreas.

Parameters:

memberid - Member ID

accountnumber - Account number

Returns:

JSON string representation of the available BannerAreas

Throws:

SearchPromoteException - SearchPromoteException if JSON could not be feteched or response is invalid.

callRemoteIndex

java.lang.String callRemoteIndex(java.lang.String accountNumber,
                                 java.lang.String remotePassword,
                                 boolean fullIndex)
                          throws SearchPromoteException

Calls the remote indexer

Parameters:

accountNumber - Account number

remotePassword - The remote indexer password

fullIndex - signals that a full feed index is requested

Returns:

a String representing the request's outcome. Possible values are OK if the request was sent successfully, Error otherwise.

Throws:

SearchPromoteException - SearchPromoteException

getConnectionTimeout

int getConnectionTimeout()

Returns the configured timeout in milliseconds until a connection is established. A timeout value of 0 is interpreted as an infinite timeout.

Returns:

Timeout in milliseconds. If value is not configured SearchPromoteConstants.DEFAULT_CONNECTION_TIMEOUT is returned.

getSocketTimeout

int getSocketTimeout()

Returns the configured timeout in milliseconds, which is the timeout for waiting for data or a maximum period of inactivity between two consecutive data packets. A timeout value of 0 is interpreted as an infinite timeout.

Returns:

Timeout in milliseconds. If value is not configured SearchPromoteConstants.DEFAULT_SOCKET_TIMEOUT is returned.