Package com.smartfoxserver.controllers.filter

Class SysControllerFilter

java.lang.Object

com.smartfoxserver.controllers.filter.SysControllerFilter

All Implemented Interfaces:

ISystemFilter

Direct Known Subclasses:

ReadOnlyUserVariablesFilter

public abstract class SysControllerFilter
extends Object
implements ISystemFilter

A filter can be used to intercept any API client request (not Extension requests) and interact with the parameter, adding extra validation, custom logic etc...

A complete description of the process is found in this tutorial.

Since:

version 2.3.0

See Also:

• SysControllerFilterChain
• Zone.setFilterChain(com.smartfoxserver.controllers.SystemRequest, ISystemFilterChain)

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
SysControllerFilter()

Method Summary

Modifier and Type	Method	Description
String	getName()
void	setName(String name)
protected void	trace(ExtensionLogLevel level, Object... args)	Trace a message to the console and log files using the specified logging level
protected void	trace(Object... args)	Traces a message to the console and log files using the Logger INFO level

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.smartfoxserver.controllers.filter.ISystemFilter

handleClientRequest

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

SysControllerFilter

public SysControllerFilter()

Method Details

getName

public String getName()

setName

public void setName(String name)

trace

protected void trace(Object... args)

Traces a message to the console and log files using the Logger INFO level

Parameters:

args - any number of strings/object to trace

trace

protected void trace(ExtensionLogLevel level,
 Object... args)

Trace a message to the console and log files using the specified logging level

Parameters:

level - the logging level

args - any number of object to trace