com.day.cq.mcm.campaign

Interface GenericCampaignConnector

All Superinterfaces:

CampaignConnector

public interface GenericCampaignConnector
extends CampaignConnector

A service that is used to access a remote Adobe Campaign instance.

Method Summary

Modifier and Type	Method and Description
CallResults	callGeneric(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> fctParams, CampaignCredentials credentials) Calls a remote JSSP on the campaign instance.
CallResults	callGenericWithBasicAuth(java.lang.String path, java.lang.String queryString, CampaignCredentials credentials) Gets data from a given URL with the credentials passed as Basic Authentication headers.
CallResults	postGeneric(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> data, CampaignCredentials credentials) Posts data to a remote function on the campaign instance.

Methods inherited from interface com.day.cq.mcm.campaign.CampaignConnector

callFunction, getWebserviceConfig, postFunction, retrieveCredentials

Method Detail

callGeneric

CallResults callGeneric(java.lang.String name,
                        java.util.Map<java.lang.String,java.lang.String> fctParams,
                        CampaignCredentials credentials)
                 throws ACConnectorException

Calls a remote JSSP on the campaign instance.

Note that the caller is required to use CallResults.destroy() after processing the result of the remote function call.

This method supports generic namespaces, hence the namespace must be included in the name of the function (parameter name).

Parameters:

name - The name of the function to be called (including the namespace)

fctParams - The parameters of the function call (name/value parameters)

credentials - The credentials to be used for the call

Returns:

The result of the function call

Throws:

ACConnectorException - If the remote function could not be called or returned an unexpected status

postGeneric

CallResults postGeneric(java.lang.String name,
                        java.util.Map<java.lang.String,java.lang.String> data,
                        CampaignCredentials credentials)
                 throws ACConnectorException

Posts data to a remote function on the campaign instance.

Note that the caller is required to use CallResults.destroy() after processing the result of the remote function call.

This method supports generic namespaces, hence the namespace must be included in the name of the function (parameter name).

Parameters:

name - The name of the function to be called

data - The data to post (name/value)

credentials - The credentials to be used for the call

Returns:

The result of the function call

Throws:

ACConnectorException - If the remote function could not be called or returned an unexpected status

callGenericWithBasicAuth

CallResults callGenericWithBasicAuth(java.lang.String path,
                                     java.lang.String queryString,
                                     CampaignCredentials credentials)
                              throws ACConnectorException

Gets data from a given URL with the credentials passed as Basic Authentication headers.

Note that the caller is required to use CallResults.destroy() after processing the result of the remote function call.

This is (for example) the counterpart for Campaign .next's query retrieval.

Parameters:

path - The (absolute) path to call

queryString - The query string (without leading '?')

credentials - The credentials

Returns:

The result of the function call

Throws:

ACConnectorException - If the remote function could not be called or returned an unexpected status