com.sap.aii.af.lib.mp.module

Interface ModuleContext

All Superinterfaces:

Serializable

public interface ModuleContext
extends Serializable

ModuleContext carries the context information which might be used by an XI AF module to access the current channel ID, module configuration data ot its namespaced. ModuleContext is created by the XI AF MP (producer) and read by the module (consumer) usually.

Method Summary

String	getChannelID() Returns the ID of the currently processed channel
String	getContextData(String name) Returns a value of a module configuration parameter
String	getContextData(String name, boolean fallback) Returns a value of a module configuration parameter and if fallback is true and the parameter cannot be found in the module configuration it is tried to read it from the channel configuration data.
Enumeration	getContextDataKeys() Get all configuration parameter keys (names) of this channel
Hashtable	resolveNamespace(String nameSpace) Get all configuration parameter keys (names) of this module in this channel

Method Detail

getChannelID

String getChannelID()

Returns the ID of the currently processed channel

Returns:

String Channel ID

getContextData

String getContextData(String name)

Returns a value of a module configuration parameter

Parameters:

name - of the module configuration parameter to read

Returns:

String configured value

getContextData

String getContextData(String name,
                      boolean fallback)

Returns a value of a module configuration parameter and if fallback is true and the parameter cannot be found in the module configuration it is tried to read it from the channel configuration data.

Parameters:

name - Name of the module configuration parameter to read

fallback - True, if value should be read from channel configuration if not found in the module configuration

Returns:

String Configuration value

getContextDataKeys

Enumeration getContextDataKeys()

Get all configuration parameter keys (names) of this channel

Returns:

Enumeration with all parameters keys as String

resolveNamespace

Hashtable resolveNamespace(String nameSpace)

Get all configuration parameter keys (names) of this module in this channel

Parameters:

nameSpace - Is the module key in the XI ID / PCK GUI that assigns the module configuration data to the module.

Returns:

Enumeration with all module parameters keys as String