Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterChainFactory

public final class FilterChainFactory
extends java.lang.Object

This class is used internally by the FilterConfigurationHelper to create or upgrade filter configuration. Creates or upgrades FilterChainConfiguration upon notifications. Uses DefaultFilterFactory to create filter or upgrade filter configuration.
It is possible to set custom filter factory:


 FilterChainFactory.setCustomFilterFactory("custom-filter", new CustomFilterFactory);
 
The setEnabledFilters puts available filter instances to the chain. Corresponding configuration string located in CME under "Application Parameters" of the client connection that was listed in application "Connections" tab, for example: "log-filter = name1,name2, nameN" ....

The applyFilterOptions creates or upgrades filter instances upon filter definition, specified in CME, in the application "Options" tab.


Nested Class Summary
static class FilterChainFactory.EntryConfiguration
          Represents entry from the list of filters, assigned to the protocol in the "Connection" tab of application configuration window.
 
Field Summary
static java.lang.String filter_key
           
static java.lang.String no_trace
           
 
Constructor Summary
FilterChainFactory()
           
 
Method Summary
static boolean applyFilterOptions(FilterChainConfiguration chain, KeyValueCollection addedOptions, KeyValueCollection changedOptions, KeyValueCollection removedOptions)
          Creates or upgrades filter instances upon filter definition, specified in CME, in the application "Options" tab.
static FilterChainConfiguration create(int appDbid, int targetAppDbid)
          Creates FilterChainConfiguration.
static java.util.List<FilterChainFactory.EntryConfiguration> parseFilterList(java.lang.String filterList)
          Parses string that defines what filters assigned to the protocol in the Connections tab: log-filter = filter_1, filter_2, !filter_3; Creates FilterChainFactory.EntryConfiguration for every name.
static FilterFactory resolve(BaseFilter filter)
          Resolves factory for a filter object.
static FilterFactory resolve(KeyValueCollection options)
          Resolves factory for a filter definition.
static void setCustomFilterFactory(java.lang.String name, FilterFactory factory)
          Registers custom filter factory.
static boolean setEnabledFilters(FilterChainConfiguration chain, java.lang.String filterList)
          Puts available filter instances to the chain.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filter_key

public static final java.lang.String filter_key
See Also:
Constant Field Values

no_trace

public static final java.lang.String no_trace
See Also:
Constant Field Values
Constructor Detail

FilterChainFactory

public FilterChainFactory()
Method Detail

create

public static FilterChainConfiguration create(int appDbid,
                                              int targetAppDbid)
Creates FilterChainConfiguration.

Parameters:
appDbid - The application dbid where filter definitions are stored ("Options" tab in CME).
targetAppDbid - Client connection id, for which filters are configured. Server dbid is used to identify the client connection. ("Connections" tab in CME)
Returns:
Configured filter chain.

applyFilterOptions

public static boolean applyFilterOptions(FilterChainConfiguration chain,
                                         KeyValueCollection addedOptions,
                                         KeyValueCollection changedOptions,
                                         KeyValueCollection removedOptions)
Creates or upgrades filter instances upon filter definition, specified in CME, in the application "Options" tab.

Parameters:
chain - Filter Chain configuration, where available filter instances are stored.
addedOptions - Added filter configuration options.
changedOptions - Changed filter configuration options.
removedOptions - Removed filter configuration options.
Returns:
true if configuration option was applied.

setEnabledFilters

public static boolean setEnabledFilters(FilterChainConfiguration chain,
                                        java.lang.String filterList)
Puts available filter instances to the chain. Corresponding configuration string located in CME under "Application Parameters" of the client connection that was listed in application "Connections" tab, for example: "log-filter = name1,name2, nameN" ....

Parameters:
chain - Chain configuration, where available filter instances are stored.
filterList - List of filters, that should be put to the chain
Returns:
true if filterList was parsed successfully

parseFilterList

public static java.util.List<FilterChainFactory.EntryConfiguration> parseFilterList(java.lang.String filterList)
Parses string that defines what filters assigned to the protocol in the Connections tab: log-filter = filter_1, filter_2, !filter_3; Creates FilterChainFactory.EntryConfiguration for every name. Used by setEnabledFilters

Parameters:
filterList -
Returns:

setCustomFilterFactory

public static void setCustomFilterFactory(java.lang.String name,
                                          FilterFactory factory)
Registers custom filter factory.

Parameters:
name - Name of the factory
factory - Factory instance

resolve

public static FilterFactory resolve(KeyValueCollection options)
Resolves factory for a filter definition.

Parameters:
options - Filter definition from CME

resolve

public static FilterFactory resolve(BaseFilter filter)
Resolves factory for a filter object.

Parameters:
filter - Filter object

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.