|
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.FilterChainConfiguration
public class FilterChainConfiguration
This class keeps filter chain FilterChain
and it's settings that can be modified at
runtime.
Constructor Summary | |
---|---|
FilterChainConfiguration(int appDBID,
int targetAppDBID)
Creates FilterChainConfiguration object. |
|
FilterChainConfiguration(int appDBID,
int targetAppDBID,
FilterContext context)
Creates FilterChainConfiguration object. |
Method Summary | |
---|---|
void |
applyFilterList(java.util.List<BaseFilter> filters)
Registers new available filter objects for this chain. |
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. |
void |
clear()
Removes all filter instances. |
int |
getApplicationDBID()
Returns DBID of the application, where filters are declared. |
java.util.List<BaseFilter> |
getFilterList()
Returns the shallow copy of available filter instances list. |
int |
getTargetApplicationDBID()
Returns DBID of the application, to which client protocol connected. |
boolean |
isMessageAccepted(Message message)
This method uses internal FilterChain object with pre-configured
Log Filters to evaluate if message can be logged. |
void |
resetContext()
Clears filter context. |
void |
save()
Applies changes, made in filter list or in filter definition, to the filter chain object. |
void |
setCanTrace(boolean value)
Enables or disables tracing log entries like "New message# " and so on. |
boolean |
setEnabledFilters(java.util.List<FilterChainFactory.EntryConfiguration> entryList)
Filter entry that should be used in this filter chain. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FilterChainConfiguration(int appDBID, int targetAppDBID)
appDBID
and
targetAppDBID
can be used to identify application
configuration updates sent by Configuration Server.
appDBID
- The application DBID where filters are declared.targetAppDBID
- The DBID of application to which DuplecChannel
with
assigned FilterChainConfiguration is connected.public FilterChainConfiguration(int appDBID, int targetAppDBID, FilterContext context)
appDBID
and
targetAppDBID
should be used to identify application
configuration updates sent by Configuration Server.
appDBID
- The application DBID where filters are declared.targetAppDBID
- The DBID of application to which DuplecChannel
with
assigned FilterChainConfiguration is connected.context
- Filter context where filter variables or other data is stored.Method Detail |
---|
public int getApplicationDBID()
public int getTargetApplicationDBID()
public java.util.List<BaseFilter> getFilterList()
public void applyFilterList(java.util.List<BaseFilter> filters)
key
- filter namefilter
- filter objectpublic boolean setEnabledFilters(java.util.List<FilterChainFactory.EntryConfiguration> entryList)
entry
- List of filter entries, assigned to the protocol
public void save()
public void clear()
public void resetContext()
public boolean isMessageAccepted(Message message)
FilterChain
object with pre-configured
Log Filters to evaluate if message can be logged.
isMessageAccepted
in interface MessageFilter
message
- for filtering
public void setCanTrace(boolean value)
value
- public boolean canTrace()
MessageFilter
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.
canTrace
in interface MessageFilter
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |