public final class FilterChainFactory
extends java.lang.Object
FilterConfigurationHelper
to create or upgrade filter configuration.
Creates or upgrades FilterChainConfiguration
upon notifications. Uses
DefaultFilterFactory
to create filter or upgrade filter
configuration.
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" .... applyFilterOptions
creates or upgrades filter instances upon filter
definition, specified in CME, in the application "Options" tab.Modifier and Type | Class | Description |
---|---|---|
static class |
FilterChainFactory.EntryConfiguration |
Represents entry from the list of filters,
assigned to the protocol in the "Connection" tab of application configuration window.
|
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
filter_key |
|
static java.lang.String |
no_trace |
Constructor | Description |
---|---|
FilterChainFactory() |
Modifier and Type | Method | Description |
---|---|---|
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.Used by setEnabledFilters(FilterChainConfiguration, String) . |
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.
|
public static final java.lang.String filter_key
public static final java.lang.String no_trace
public static FilterChainConfiguration create(int appDbid, int targetAppDbid)
FilterChainConfiguration
.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)public static boolean applyFilterOptions(FilterChainConfiguration chain, KeyValueCollection addedOptions, KeyValueCollection changedOptions, KeyValueCollection removedOptions)
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.public static boolean setEnabledFilters(FilterChainConfiguration chain, java.lang.String filterList)
chain
- Chain configuration, where available filter instances are
stored.filterList
- List of filters, that should be put to the chainpublic static java.util.List<FilterChainFactory.EntryConfiguration> parseFilterList(java.lang.String filterList)
FilterChainFactory.EntryConfiguration
for every name.setEnabledFilters(FilterChainConfiguration, String)
.filterList
- the filters list.public static void setCustomFilterFactory(java.lang.String name, FilterFactory factory)
name
- Name of the factoryfactory
- Factory instancepublic static FilterFactory resolve(KeyValueCollection options)
options
- Filter definition from CMEpublic static FilterFactory resolve(BaseFilter filter)
filter
- Filter objectSend comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.