Interface Listener
An Interface Listener allows a developer to execute tasks during the life cycle of inbound and outbound message processing.
You can define listeners on inbound and outbound interfaces in studio, or you can also define listeners in the database using the INTERFACE_LISTENER table. InterfaceListener is a regular model and you can load data to InterfaceListener just like any other model using LoadData.xml
The following table outlines all fields for InterfaceListener:
Table 16.14. InterfaceListener Fields
|
Field |
Description |
|
ValueChainId |
Value Chain which owns the InterfaceListener. (KEY field) |
|
OwningQueueName |
When non-null, only messages in this queue will have this listener applied. (optional KEY field) |
|
OwningQueueEnterpriseName |
Identifies the queue's owning enterprise. (optional KEY field) |
|
InboundInterface |
When non-null, only messages with this Inbound Interface will have this listener applied. (optional KEY field) |
|
InboundInterfaceVersion |
When non-null, only messages with this Inbound Interface version will have this listener applied. (optional KEY field) |
|
OutboundInterface |
When non-null, only messages with this Outbound Interface will have this listener applied. (optional KEY field) |
|
OutboundInterfaceVersion |
When non-null, only messages with this Outbound Interface version will have this listener applied. (optional KEY field) |
|
Precedence |
Determines the order in which the listener gets executed. All matching listeners will be sorted by precedence ascending and then executed. |
|
ListenerClass |
Listener class extending com.onenetwork.platform.integ.msg.BaseInboundProcessingListener for inbound messages and com.onenetwork.platform.integ.msg.BaseOutboundProcessingListener for outbound messages. |