com.sap.aii.af.lib.mp.processor

Interface ModuleProcessor

public interface ModuleProcessor

The XI AF module processor controls the process flow among the XI AF modules. For XI AF adapters it represents the entry point of messages in case of sender/inbound channels. Internally it is used to call the MP for the receiver/outbound direction.

Method Summary

ModuleData

process(String objectKey, ModuleData inputModuleData) Analogous to the process() method of the module itself the module processor offers a process() method to inject new messages into the XI AF MP processing.

Method Detail

process

ModuleData process(String objectKey,
                   ModuleData inputModuleData)
                   throws ModuleException

Analogous to the process() method of the module itself the module processor offers a process() method to inject new messages into the XI AF MP processing. The objectKey must be set to the channel ID that identfies the XI channel which processes this message. The following supplemenatl data may be placed in the inputmoduleData.

• audit.key
  To enable automatic auditting and performance statics collection, a supplemental parameter object with key audit.key must be set to the MessageKey object representing the current message.
• mp.skip
  When this supplemental parameter is set to Boolean.TRUE, some modules aware of this key may skip the processing. Others may reset this parameter so that the subsequent modules will process the object.

Parameters:

objectKey - Channel ID of the XI channel

inputModuleData - ModuleData container that wraps the (request) message and supplemental data

Returns:

outputModuleData ModuleData container that wraps the (response) message (if available) and supplemental data

Throws:

ModuleException - An exception that was thrown by one of the included modules in the module chain

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] SAP_XIAF	[sap.com] com.sap.aii.af.lib.facade	api	BC-XI