API_Dispatcher
Class · Group: Web Services
global inherited sharing class API_DispatcherFactory class for orchestrating the execution of web service handlers. Manages the lifecycle of API calls, including handler initiation, error handling, and change commitment. Supports both single and batch processing of web service requests.
Example
// Process an inbound REST service
API_Dispatcher.processInboundService(API_UpdateInvoice.class.getName());
// Execute an outbound API call
ApiCall__c apiCall = TST_Factory.newOutboundApiCall('API_SendEmail', recordId, parameters);
API_Base handler = API_Dispatcher.execute(apiCall);Methods
| Method | Description |
|---|---|
| global static API_Base execute(ApiCall__c apiCall) | Executes a single API callout for the provided API call record. |
| global static List<API_Base> execute(List<ApiCall__c> apiCalls) | Processes a list of API callout requests by executing multiple web service handlers. |
| global static API_Base processInboundService(String serviceName) | Processes a single inbound web service request by executing the specified handler. |
execute
global static API_Base execute(ApiCall__c apiCall)Executes a single API callout for the provided API call record.
Parameters
| Parameter | Type | Description |
|---|---|---|
apiCall | ApiCall__c | A ApiCall__c record containing details of the API call to execute. |
Returns API_Base — The API_Base handler that processed the request, or null if no handler was executed.
Example
ApiCall__c apiCall = TST_Factory.newInboundApiCall('MyServiceHandler');
API_Base handler = API_Dispatcher.execute(apiCall);global static List<API_Base> execute(List<ApiCall__c> apiCalls)Processes a list of API callout requests by executing multiple web service handlers. Manages batch processing, commits successful transactions, and logs failures for retries.
Parameters
| Parameter | Type | Description |
|---|---|---|
apiCalls | List | A list of ApiCall__c records representing API calls to process. |
Returns API_Base — A list of API_Base handlers that successfully processed the requests.
Example
List<ApiCall__c> apiCalls = [SELECT Id, Service__c FROM ApiCall__c WHERE Status__c = 'Pending'];
List<API_Base> handlers = API_Dispatcher.execute(apiCalls);processInboundService
global static API_Base processInboundService(String serviceName)Processes a single inbound web service request by executing the specified handler.
Parameters
| Parameter | Type | Description |
|---|---|---|
serviceName | String | The name of the web service handler class to execute. |
Returns API_Base — The API_Base handler that processed the request, or null if no handler was executed.
Example
API_Base handler = API_Dispatcher.processInboundService('MyServiceHandler');