|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterChainFactory
public final class FilterChainFactory
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" .... 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 |
---|
public static final java.lang.String filter_key
public static final java.lang.String no_trace
Constructor Detail |
---|
public FilterChainFactory()
Method Detail |
---|
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 chain
public static java.util.List<FilterChainFactory.EntryConfiguration> parseFilterList(java.lang.String filterList)
FilterChainFactory.EntryConfiguration
for every name.
Used by setEnabledFilters
filterList
-
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 object
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |