|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.engine.mime.demo.ContentLenFilter
public class ContentLenFilter
This demo plugin filters away all messages having a content longer than the given filter length.
Message which are longer then the max length are used to filter subscribed messages, they are not send via updated() to the subscriber. The same filter may be used for the synchronous get() access. Please register this plugin in xmlBlaster.properties:MimeAccessPlugin[ContentLenFilter][1.0]=org.xmlBlaster.engine.mime.demo.ContentLenFilterPlugins must implement the I_Plugin interface to be loadable by the PluginManager and must implement the I_AccessFilter interface to be usable as a filter.
Field Summary | |
---|---|
private long |
DEFAULT_MAX_LEN
Limits max message size to 1 MB as a default |
private ServerScope |
glob
|
private static java.util.logging.Logger |
log
|
private java.lang.String |
ME
|
private int |
THROW_EXCEPTION_FOR_LEN
For testsuite TestAccess.java only to force an XmlBlasterException |
Constructor Summary | |
---|---|
ContentLenFilter()
|
Method Summary | |
---|---|
java.lang.String[] |
getMimeExtended()
Get the content MIME version number for which this plugin applies |
java.lang.String[] |
getMimeTypes()
Get the content MIME type for which this plugin applies |
java.lang.String |
getName()
Get a human readable name of this filter implementation |
java.lang.String |
getType()
Return plugin type for Plugin loader |
java.lang.String |
getVersion()
Return plugin version for Plugin loader |
void |
init(Global glob,
PluginInfo pluginInfo)
This method is called by the PluginManager. |
void |
initialize(ServerScope glob)
This is called after instantiation of the plugin |
boolean |
match(SessionInfo receiver,
MsgUnit msgUnit,
Query query)
Check if the filter rule matches for this message. |
void |
shutdown()
Cleans up the resource. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final java.lang.String ME
private ServerScope glob
private static java.util.logging.Logger log
private long DEFAULT_MAX_LEN
private int THROW_EXCEPTION_FOR_LEN
Constructor Detail |
---|
public ContentLenFilter()
Method Detail |
---|
public void initialize(ServerScope glob)
initialize
in interface I_AccessFilter
glob
- The Global handle of this xmlBlaster server instance.public void init(Global glob, PluginInfo pluginInfo) throws XmlBlasterException
init
in interface I_Plugin
XmlBlasterException
org.xmlBlaster.util.plugin.I_Plugin#init(ServerScope,PluginInfo)
public java.lang.String getType()
getType
in interface I_Plugin
public java.lang.String getVersion()
getVersion
in interface I_Plugin
public java.lang.String getName()
getName
in interface I_AccessFilter
public java.lang.String[] getMimeTypes()
getMimeTypes
in interface I_AccessFilter
public java.lang.String[] getMimeExtended()
getMimeExtended
in interface I_AccessFilter
public boolean match(SessionInfo receiver, MsgUnit msgUnit, Query query) throws XmlBlasterException
match
in interface I_AccessFilter
msgUnit
- The message to checkquery
- The max. message length as given by the subscriber/getter.receiver
- The session object describing the receiver, is never null.
see
- I_AccessFilter#match()
XmlBlasterException
- Is thrown on problems, for example if the MIME type
does not fit to message content.I_AccessFilter#match(SessionInfo, SessionInfo, MsgUnit, Query)
public void shutdown()
I_Plugin
shutdown
in interface I_AccessFilter
shutdown
in interface I_Plugin
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |