Package com.adobe.cq.mcm.campaign

Interface CampaignProxy

public interface CampaignProxy

Provides means to proxy requests to Adobe Campaign.

Should be used by servlet implementations that simply forward requests to Adobe Campaign and transfer the result of the request back to the client.

Method Summary

Modifier and Type	Method	Description
void	get(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> params, CampaignCredentials credentials, HttpServletResponse response)	Proxies a GET request to the specified Campaign method.
void	get(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> params, Configuration config, HttpServletResponse response)	Proxies a GET request to the specified Campaign method.
void	get(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> params, Resource resource, HttpServletResponse response)	Proxies a GET request to the specified Campaign method.
void	getWithBasicAuth(java.lang.String url, CampaignCredentials credentials, HttpServletResponse response)	Proxies a GET request with Basic authentication to the specified Campaign method.
void	getWithBasicAuth(java.lang.String url, Configuration config, HttpServletResponse response)	Proxies a GET request with Basic authentication to the specified Campaign method.
void	getWithBasicAuth(java.lang.String url, Resource resource, HttpServletResponse response)	Proxies a GET request with Basic authentication to the specified Campaign method.
void	post(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> postData, CampaignCredentials credentials, HttpServletResponse response)	Proxies a POST request to the specified Campaign method.
void	post(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> postData, Configuration config, HttpServletResponse response)	Proxies a POST request to the specified Campaign method.
void	post(java.lang.String remoteFunction, java.util.Map<java.lang.String,java.lang.String> postData, Resource resource, HttpServletResponse response)	Proxies a POST request to the specified Campaign method.

Method Detail

get

void get(java.lang.String remoteFunction,
         java.util.Map<java.lang.String,java.lang.String> params,
         CampaignCredentials credentials,
         HttpServletResponse response)
  throws CampaignException

Proxies a GET request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

params - The URL parameters

credentials - The credentials for accessing the Campaign instance

response - The response

Throws:

CampaignException - if the request could not be proxied

get

void get(java.lang.String remoteFunction,
         java.util.Map<java.lang.String,java.lang.String> params,
         Resource resource,
         HttpServletResponse response)
  throws CampaignException

Proxies a GET request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

params - The URL parameters

resource - The resource the request is addressing (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied

get

void get(java.lang.String remoteFunction,
         java.util.Map<java.lang.String,java.lang.String> params,
         Configuration config,
         HttpServletResponse response)
  throws CampaignException

Proxies a GET request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

params - The URL parameters

config - The cloud service configuration to be used (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied

post

void post(java.lang.String remoteFunction,
          java.util.Map<java.lang.String,java.lang.String> postData,
          CampaignCredentials credentials,
          HttpServletResponse response)
   throws CampaignException

Proxies a POST request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

postData - Post data

credentials - The credentials for accessing the Campaign instance

response - The response

Throws:

CampaignException - if the request could not be proxied

post

void post(java.lang.String remoteFunction,
          java.util.Map<java.lang.String,java.lang.String> postData,
          Resource resource,
          HttpServletResponse response)
   throws CampaignException

Proxies a POST request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

postData - Post data

resource - The resource the request is addressing (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied

post

void post(java.lang.String remoteFunction,
          java.util.Map<java.lang.String,java.lang.String> postData,
          Configuration config,
          HttpServletResponse response)
   throws CampaignException

Proxies a POST request to the specified Campaign method.

Parameters:

remoteFunction - The remote function (including AC namespace + extension)

postData - Post data

config - The cloud service configuration to be used (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied

getWithBasicAuth

void getWithBasicAuth(java.lang.String url,
                      CampaignCredentials credentials,
                      HttpServletResponse response)
               throws CampaignException

Proxies a GET request with Basic authentication to the specified Campaign method.

This is required for the query API in ".next style".

Parameters:

url - The remote function (including AC namespace + extension)

credentials - The credentials for accessing the Campaign instance

response - The response

Throws:

CampaignException - if the request could not be proxied

getWithBasicAuth

void getWithBasicAuth(java.lang.String url,
                      Resource resource,
                      HttpServletResponse response)
               throws CampaignException

Proxies a GET request with Basic authentication to the specified Campaign method.

This is required for the query API in ".next style".

Parameters:

url - The remote function (including AC namespace + extension)

resource - The resource the request is addressing (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied

getWithBasicAuth

void getWithBasicAuth(java.lang.String url,
                      Configuration config,
                      HttpServletResponse response)
               throws CampaignException

Proxies a GET request with Basic authentication to the specified Campaign method.

This is required for the query API in ".next style".

Parameters:

url - The remote function (including AC namespace + extension)

config - The cloud service configuration to be used (for retrieving credentials for accessing the Campaign instance)

response - The response

Throws:

CampaignException - if the request could not be proxied