org.mule.modules.zuora

Class ZuoraConnector

java.lang.Object

org.mule.modules.zuora.ZuoraConnector

@Connector(name="zuora",
           friendlyName="Zuora",
           minMuleVersion="3.7")
@RequiresEnterpriseLicense(allowEval=true)
public class ZuoraConnector
extends Object

Zuora is the leader in online recurring billing and payment solutions for SaaS and subscription businesses.

This connector provides access to the Z-Commerce platform API.

Author:

MuleSoft, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZuoraConnector.ZuoraOperatorVisitor
static class	ZuoraConnector.ZuoraQueryVisitor

Constructor Summary

Constructors

Constructor and Description
ZuoraConnector()

Method Summary

Methods

Modifier and Type	Method and Description
Job	aquaDeleteJob(String jobId, String entityId, String entityName) Deletes the current job, only if the job is not complete.
org.mule.api.callback.StopSourceCallback	aquaGetBatchResults(String storeName, org.mule.api.callback.SourceCallback callback, String entityId, String entityName) Periodically polls for the status of the jobs retrieved from the object store and returns the results of the completed jobs
Job	aquaGetJobMetadata(Object jobResponse) Converts an Object returned by the source into an instance of a Job
Job	aquaGetJobResults(String jobId, String entityId, String entityName) Retrieves an aggregate query using the Job ID.
Job	aquaGetLastCompletedJob(GetLastJobRequest request, String entityId, String entityName) This operation returns the details of the last completed job.
PostQueryResponse	aquaPostQuery(PostQueryRequest request, boolean saveJobToObjectStore, String storeName, String entityId, String entityName) Submits an aggregated list of ZOQL and Export ZOQL queries.
ImportResponse	checkImportStatus(String importUrl, String entityId, String entityName) Checks the status of the import made with the Post Usage operation.
ZuoraClient	getClient()
ZuoraBasicAuthConfig	getConfig()
String	getExportFileContent(String exportId, String entityId, String entityName) Retrieve an exported file from Zuora, and return its content as a String
InputStream	getExportFileStream(String exportId, String entityId, String entityName) Retrieve an exported file from Zuora and return an InputStream to it
XMLStreamReader	invokeSoapService(String soapMetadataKey, XMLStreamReader input, org.mule.api.MuleEvent event) Calls SOAP based operations from THE Zuora WSDL.
PostUsageResponse	postUsage(String fileLocation, String entityId, String entityName) Post or imports usage data for one or more accounts in the CSV format.
org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,ZuoraConnector>	query(String query, org.mule.streaming.PagingConfiguration pagingConfiguration) Lazily retrieves ZObjects that match a given query, written in Zuora native query language.
void	setConfig(ZuoraBasicAuthConfig config)
String	toNativeQuery(org.mule.common.query.DsqlQuery query)

Methods inherited from class java.lang.Object

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

Constructor Detail

ZuoraConnector

public ZuoraConnector()

Method Detail

invokeSoapService

@Processor(friendlyName="Invoke SOAP Service")
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
@Mime(value="application/xml")
@MetaDataScope(value=ZuoraMetadataCategory.class)
public XMLStreamReader invokeSoapService(@MetaDataKeyParam(labels={"Service","Operation Name","Entity"},affects=BOTH)@FriendlyName(value="Apex Class Method Name")
                                                                                                                                                                    String soapMetadataKey,
                                                                                                                                                                    @Default(value="#[payload]")@Nullable
                                                                                                                                                                    XMLStreamReader input,
                                                                                                                                                                    org.mule.api.MuleEvent event)
                                  throws ZuoraException

Calls SOAP based operations from THE Zuora WSDL.

Parameters:

soapMetadataKey - the metadata Key that is used to extract useful information for executing the operation request

input - XMLStreamReader that represents the input of the operation

event - MuleEvent

Returns:

XMLStreamReader that represents the result of the operation

Throws:

ZuoraException - this exception will he thrown in case that something went wrong.

getExportFileStream

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
@MetaDataScope(value=ZuoraMetadataCategory.class)
public InputStream getExportFileStream(@Default(value="#[payload]")
                                                                                                                                                             String exportId,
                                                                                                                                                             @Optional
                                                                                                                                                             String entityId,
                                                                                                                                                             @Optional
                                                                                                                                                             String entityName)
                                throws IOException,
                                       ZuoraException,
                                       org.mule.api.transformer.TransformerException

Retrieve an exported file from Zuora and return an InputStream to it

Parameters:

exportId - id of the Zuora exported file to retrieve

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

an InputStream to read from the exported file

Throws:

IOException - if can't access the exported file or the exported file doesn't exist

ZuoraException - if an error ocurred during the call

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

getExportFileContent

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
@MetaDataScope(value=ZuoraMetadataCategory.class)
public String getExportFileContent(@Default(value="#[payload]")
                                                                                                                                                         String exportId,
                                                                                                                                                         @Optional
                                                                                                                                                         String entityId,
                                                                                                                                                         @Optional
                                                                                                                                                         String entityName)
                            throws IOException,
                                   org.mule.api.transformer.TransformerException,
                                   ZuoraException

Retrieve an exported file from Zuora, and return its content as a String

Parameters:

exportId - id of the Zuora exported file to retrieve

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

the file's content as a String

Throws:

IOException - if can't access the exported file or the exported file doesn't exist

ZuoraException - When the message cannot be succesfully extracted from the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

query

@Paged
@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
@MetaDataScope(value=ZuoraQueryMetadataCategory.class)
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,ZuoraConnector> query(@Query
                                                                                                                                                                                                                                String query,
                                                                                                                                                                                                                                org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                        throws Exception

Lazily retrieves ZObjects that match a given query, written in Zuora native query language. If you expect more than 2000 results to be returned, remember that you have to enable queryMore for your zuora account (as documented: http://knowledgecenter.zuora.com/D_Using_the_Zuora_API/C_API_Reference/E_API_Calls/queryMore())

Parameters:

query - the query, using the SQL-Like Zuora Query Language

pagingConfiguration - the paging configuration

Returns:

An array of Zobjects

Throws:

Exception - if the request fails

toNativeQuery

@QueryTranslator
public String toNativeQuery(org.mule.common.query.DsqlQuery query)

aquaPostQuery

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public PostQueryResponse aquaPostQuery(@Default(value="#[payload]")@RefOnly
                                                                                                                    PostQueryRequest request,
                                                                                                                    @Default(value="false")@Optional@Placement(order=4)
                                                                                                                    boolean saveJobToObjectStore,
                                                                                                                    @Optional@Placement(order=5)
                                                                                                                    String storeName,
                                                                                                                    @Optional
                                                                                                                    String entityId,
                                                                                                                    @Optional
                                                                                                                    String entityName)
                                throws ZuoraException,
                                       IOException,
                                       org.mule.api.transformer.TransformerException

Submits an aggregated list of ZOQL and Export ZOQL queries. see postQuery()

Parameters:

request - the PostQuery request object

saveJobToObjectStore - flag that determines if the result should be saved in the object store

storeName - name for a PartitionedPersistentObjectStore

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

PostQueryResponse the response of the PostQuery call.

Throws:

ZuoraException - when an exception occurs preparing or executing the request

IOException - when it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

postUsage

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public PostUsageResponse postUsage(@Default(value="#[payload]")@RefOnly
                                                                                                                String fileLocation,
                                                                                                                @Optional
                                                                                                                String entityId,
                                                                                                                @Optional
                                                                                                                String entityName)
                            throws ZuoraException,
                                   IOException,
                                   org.mule.api.transformer.TransformerException

Post or imports usage data for one or more accounts in the CSV format. see postUsage()

Parameters:

fileLocation - the location of the csv file to import

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

PostUsageResponse the response of the PostUsage call. In order to check if the import is completed succesfully, the URL from checkImportStatus field must be called.

Throws:

ZuoraException - when an exception occurs preparing or executing the request

IOException - when it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

checkImportStatus

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public ImportResponse checkImportStatus(@Default(value="#[payload]")
                                                                                                                     String importUrl,
                                                                                                                     @Optional
                                                                                                                     String entityId,
                                                                                                                     @Optional
                                                                                                                     String entityName)
                                 throws ZuoraException,
                                        IOException,
                                        org.mule.api.transformer.TransformerException

Checks the status of the import made with the Post Usage operation. see postUsage()

Parameters:

importUrl - the url returned by the postUsage operation. When called, it returns the current status of the import.

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

ImportStatus the response of the check import call.

Throws:

ZuoraException - when an exception occurs preparing or executing the request

IOException - when it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

aquaGetJobResults

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public Job aquaGetJobResults(@Default(value="#[payload]")
                                                                                                          String jobId,
                                                                                                          @Optional
                                                                                                          String entityId,
                                                                                                          @Optional
                                                                                                          String entityName)
                      throws ZuoraException,
                             IOException,
                             org.mule.api.transformer.TransformerException

Retrieves an aggregate query using the Job ID. see aquaGetJobResults()

Parameters:

jobId - the job ID

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

GetJobIdResponse object response.

Throws:

ZuoraException - when an exception occurs preparing or executing the request

IOException - when it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

aquaGetLastCompletedJob

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public Job aquaGetLastCompletedJob(@Default(value="#[payload]")@RefOnly
                                                                                                                GetLastJobRequest request,
                                                                                                                @Optional
                                                                                                                String entityId,
                                                                                                                @Optional
                                                                                                                String entityName)
                            throws ZuoraException,
                                   IOException,
                                   org.mule.api.transformer.TransformerException

This operation returns the details of the last completed job. see aquaGetLastCompletedJob()

Parameters:

request - containing the partner field and projectId The partner field indicates the unique ID of a data integration partner. It must be used together with "projectId" parameter to uniquely identify a data integration target. The projectId is the unique ID of a data integration project for a particular partner. This parameter must be used together with partnerId field to uniquely identify a data integration target. This parameter is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, projectId can be null.

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

Job object response.

Throws:

ZuoraException - When an exception occurs preparing or executing the request

IOException - When it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

aquaDeleteJob

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public Job aquaDeleteJob(String jobId,
                                                                                                      @Optional
                                                                                                      String entityId,
                                                                                                      @Optional
                                                                                                      String entityName)
                  throws ZuoraException,
                         IOException,
                         org.mule.api.transformer.TransformerException

Deletes the current job, only if the job is not complete. If the job is complete, an error is thrown. see aquaDeleteJob()

Parameters:

jobId - the job ID

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

Job response that represents a job.

Throws:

ZuoraException - when an exception occurs preparing or executing the request

IOException - when it cannot properly construct the POJO that represents the response

org.mule.api.transformer.TransformerException - When the header cannot be properly constructed

aquaGetJobMetadata

@Processor
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public Job aquaGetJobMetadata(@Default(value="#[payload]")@RefOnly
                                                                                                           Object jobResponse)
                       throws ZuoraException

Converts an Object returned by the source into an instance of a Job

Parameters:

jobResponse - the jobResponse viewed as an Object

Returns:

GetJobIdResponse the jobResponse as an instance of a GetJobIdResponse

Throws:

ZuoraException - when the input object is not an instance of a GetJobIdResponse

aquaGetBatchResults

@Source(threadingModel=SINGLE_THREAD,
        sourceStrategy=POLLING,
        pollingPeriod=1000L)
@ReconnectOn(exceptions={ZuoraSessionExpiredException.class,ZuoraConnectionException.class})
public org.mule.api.callback.StopSourceCallback aquaGetBatchResults(@Optional
                                                                                                                                              String storeName,
                                                                                                                                              org.mule.api.callback.SourceCallback callback,
                                                                                                                                              @Optional
                                                                                                                                              String entityId,
                                                                                                                                              @Optional
                                                                                                                                              String entityName)
                                                             throws Exception

Periodically polls for the status of the jobs retrieved from the object store and returns the results of the completed jobs

Parameters:

storeName - the name of the objectStore that holds the PostQuery results

callback - The callback to call when a job is completed

entityId - optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

entityName - optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

Returns:

Object representing the jobResponse

Throws:

Exception - when an exception occurs preparing or executing the request

getClient

public ZuoraClient getClient()

getConfig

public ZuoraBasicAuthConfig getConfig()

setConfig

public void setConfig(ZuoraBasicAuthConfig config)