com.day.cq.analytics.sitecatalyst

Interface SitecatalystHttpClient

public interface SitecatalystHttpClient

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(java.lang.String method, java.lang.String data, Configuration configuration) Executes a SiteCatalyst API method via HTTP POST request.
java.lang.String	execute(java.lang.String method, java.lang.String data, java.lang.String company, java.lang.String username, java.lang.String secret) Executes a SiteCatalyst API method via HTTP POST request.
java.lang.String	execute(java.lang.String url, java.lang.String method, java.lang.String data, java.lang.String company, java.lang.String username, java.lang.String secret) Executes a SiteCatalyst API method via HTTP POST request.
java.lang.String	execute(java.net.URI uri, java.lang.String data, Configuration configuration) Deprecated.
java.lang.String	executeProxyUser(java.lang.String method, java.lang.String data) Executes a SiteCatalyst API method via HTTP POST request.

Method Detail

execute

java.lang.String execute(java.lang.String url,
                         java.lang.String method,
                         java.lang.String data,
                         java.lang.String company,
                         java.lang.String username,
                         java.lang.String secret)
                  throws SitecatalystException

Executes a SiteCatalyst API method via HTTP POST request. Authorization headers are automatically generated and added to the request.

Parameters:

url - API base URL

method - API method name

data - JSON data, will be submitted with MIME-Type 'application/json' and encoding 'UTF-8'.

company - Company name

username - User name

secret - Webservice API secret

Returns:

A JSON result String

Throws:

SitecatalystException - SitecatalystException

execute

java.lang.String execute(java.lang.String method,
                         java.lang.String data,
                         java.lang.String company,
                         java.lang.String username,
                         java.lang.String secret)
                  throws SitecatalystException

Executes a SiteCatalyst API method via HTTP POST request. Authorization headers are automatically generated and added to the request.

Parameters:

method - API method name

data - JSON data, will be submitted with MIME-Type 'application/json' and encoding 'UTF-8'.

company - Company name

username - User name

secret - Webservice API secret

Returns:

A JSON result String

Throws:

SitecatalystException - SitecatalystException

execute

java.lang.String execute(java.lang.String method,
                         java.lang.String data,
                         Configuration configuration)
                  throws SitecatalystException

Executes a SiteCatalyst API method via HTTP POST request. Authorization headers are automatically generated and added to the request. The corresponding end point URL is evaluated according to the provided configuration.

Parameters:

method - API method name

data - JSON data, will be submitted with MIME-Type 'application/json' and encoding 'UTF-8'.

configuration - Service configuration

Returns:

A JSON result String

Throws:

SitecatalystException - SitecatalystException

execute

@Deprecated
java.lang.String execute(java.net.URI uri,
                                     java.lang.String data,
                                     Configuration configuration)
                              throws SitecatalystException

Deprecated.

Sends data to SiteCatalyst Data Insertion API via HTTP POST request. Authorization headers are automatically generated and added to the request.

Parameters:

uri - WebService end point URI

data - String data, will be submitted with MIME-Type 'application/xml' and encoding 'UTF-8'.

configuration - Service configuration

Returns:

An XML result String

Throws:

SitecatalystException - SitecatalystException

executeProxyUser

java.lang.String executeProxyUser(java.lang.String method,
                                  java.lang.String data)
                           throws SitecatalystException

Executes a SiteCatalyst API method via HTTP POST request. Authorization headers for the SiteCatalyst proxy user are automatically generated and added to the request.

Parameters:

method - API method name

data - JSON data, will be submitted with MIME-Type 'application/json' and encoding 'UTF-8'.

Returns:

A JSON result String

Throws:

SitecatalystException - SitecatalystException