Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl.configuration
Class FilterChainNotificationHandler

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterChainNotificationHandler
All Implemented Interfaces:
Action<ConfEvent>, ChannelListener, Listener, MessageFilter

public class FilterChainNotificationHandler
extends java.lang.Object
implements MessageFilter, Action<ConfEvent>, ChannelListener

Implements MessageFilter to decide whether message should be logged or not upon internal message filter chain. Instance of this class should be assigned to the protocol object using FilterConfigurationHelper.bind() helper.
Implements Action to receive notifications from Configuration Server. Creates, deletes or reconfigures message filters in a filter chain upon received notifications.
Implements ChannelListener. Handles channel closed event to discard filter context (clears variables, etc.)


Constructor Summary
FilterChainNotificationHandler(FilterChainConfiguration chain)
          Creates object that can handle configuration notifications and apply them to FilterChainConfiguration object.
 
Method Summary
 boolean canTrace()
          In addition to MessageFilter.isMessageAccepted(Message) which controls message content log, this option can enable or disable additional log entries like "New message#", "Complete message handling" and so on.
 FilterChainConfiguration getChainConfiguration()
           
 void handle(ConfEvent obj)
          Handles notifications from Configuration server.
 boolean isMessageAccepted(Message message)
          Delegates message evaluation to internal Filter Chain witch is configured upon application settings, defined in CME.
 void onChannelClosed(ChannelClosedEvent event)
          Handles channel close event to clear filter context.
 void onChannelError(ChannelErrorEvent event)
          onChannelError is called when some not critical channel error occurs.
 void onChannelOpened(java.util.EventObject event)
          onChannelOpened is called when the channel opening will be completed successfully.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterChainNotificationHandler

public FilterChainNotificationHandler(FilterChainConfiguration chain)
Creates object that can handle configuration notifications and apply them to FilterChainConfiguration object.

Parameters:
chain -
Method Detail

getChainConfiguration

public FilterChainConfiguration getChainConfiguration()
Returns:
FilterChainConfiguration object

onChannelOpened

public void onChannelOpened(java.util.EventObject event)
Description copied from interface: ChannelListener
onChannelOpened is called when the channel opening will be completed successfully.

Specified by:
onChannelOpened in interface ChannelListener
Parameters:
event - details.

onChannelClosed

public void onChannelClosed(ChannelClosedEvent event)
Handles channel close event to clear filter context.

Specified by:
onChannelClosed in interface ChannelListener
Parameters:
event - details. See event.getCause() to analize the source reason.

onChannelError

public void onChannelError(ChannelErrorEvent event)
Description copied from interface: ChannelListener
onChannelError is called when some not critical channel error occurs. (like unknown attribute in message occurs)

Specified by:
onChannelError in interface ChannelListener
Parameters:
event - details. See event.getCause() to analize the problem source.

handle

public void handle(ConfEvent obj)
Handles notifications from Configuration server.

Specified by:
handle in interface Action<ConfEvent>

isMessageAccepted

public boolean isMessageAccepted(Message message)
Delegates message evaluation to internal Filter Chain witch is configured upon application settings, defined in CME.

Specified by:
isMessageAccepted in interface MessageFilter
Parameters:
message - for filtering
Returns:
true if message is accepted by filter else return false.

canTrace

public boolean canTrace()
Description copied from interface: MessageFilter
In addition to MessageFilter.isMessageAccepted(Message) which controls message content log, this option can enable or disable additional log entries like "New message#", "Complete message handling" and so on.

Specified by:
canTrace in interface MessageFilter
Returns:
boolean value to disable or enable trace log entries.

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.