com.edustructures.sifworks
Interface UndeliverableMessageHandler

public interface UndeliverableMessageHandler

Called when the ADK cannot dispatch an inbound message to a message handler.

The ADK does not require that you implement this interface. However, if you want to customize the default error handling, you can implement this interface and register your handler with a Zone or the Agent object. This is done by calling the Zone.setErrorHandler or Agent.setErrorHandler methods. The class framework attempts to call the zone handler first followed by the agent handler.

UndeliverableMessageHandler is called in the following situations:

• Dispatching Errors
  
  If a SIF_Event, SIF_Request, or SIF_Response message is received but the ADK cannot determine the Subscriber, Publisher, or QueryResults message handler to dispatch the message to, the onDispatchError method is invoked. This condition may arise if you are using topic classes but have not established a Topic for the SIF data object type associated with the incoming message.
  
  Default Behavior: If there is no UndeliverableMessageHandler registered with the Zone or Agent object, the ADK returns an error SIF_Ack to the ZIS indicating the specified SIF data object type is not supported by the agent:
  
  <SIF_Ack>
<SIF_Error>
<SIF_Category>0</SIF_Category>
<SIF_Code>0</SIF_Code>
<SIF_Desc>The agent does not support this object type</SIF_Desc>
<SIF_ExtendedDesc>BusInfo</SIF_ExtendedDesc>
</SIF_Error>
</SIF_Ack>

  
  

Method Summary

boolean

onDispatchError(SIFMessagePayload message, Zone zone, MessageInfo info) Called when the ADK cannot dispatch a SIF_Event, SIF_Request, or SIF_Response message

Method Detail

onDispatchError

boolean onDispatchError(SIFMessagePayload message,
                        Zone zone,
                        MessageInfo info)
                        throws SIFException

Called when the ADK cannot dispatch a SIF_Event, SIF_Request, or SIF_Response message

Parameters:

message - The message that failed to dispatch

zone - The zone the message was received on

info - Additional information about the message (e.g. its header fields)

Returns:

true if this method has handled the error, or false if the ADK should apply its default error handling

Throws:

SIFException - If a SIFException is thrown, the ADK returns a SIF_Ack message to the Zone Integration Server using the error category, error code, description and extended description provided by the exception. Otherwise, a success SIF_Ack is returned.