Examples of org.xmlBlaster.engine.mime.I_PublishFilter

org.xmlBlaster.engine.mime.I_PublishFilter

This interface hides the real implementation used to intercept published messages.

The interface may be used to filter/check/manipulate messages arriving with publish(). Only messages where the intercept() method returns "OK" or "" are accepted and passed to the xmlBlaster core for processing.

Note that you can manipulate the content of a message with your plugin but changing the XmlKey or QoS is not allowed.

The plugin with your filter rules must implement this interface.

Steps to add a new plugin:

Code the plugin.
Code a plugin which inherits from this interface. In the intercept() method code your specific filter rule. You get passed the MsgUnit object, which contains the content of a message. You look into the content and decide if you accept or reject a message. You may manipulate accepted messages.
Register the plugin.
Register the plugin in xmlBlaster.properties file, for example
MimePublishPlugin[PublishLenChecker][1.0]=org.xmlBlaster.engine.mime.demo.PublishLenChecker,DEFAULT_MAX_LEN=80000,VERBOSE=false

@version $Revision: 1.4 $ @author xmlBlaster@marcelruff.info

         if (getPublishPluginManager().hasPlugins() && !publishQos.isClusterUpdate()) {
            Map mimePlugins = getPublishPluginManager().findMimePlugins(msgKeyData.getContentMime(),msgKeyData.getContentMimeExtended());
            if (mimePlugins != null) {
               Iterator iterator = mimePlugins.values().iterator();
               while (iterator.hasNext()) {
                  I_PublishFilter plugin = (I_PublishFilter)iterator.next();
                  if (log.isLoggable(Level.FINE)) log.fine("Message " + msgKeyData.getOid() + " is forwarded to publish plugin");
                  String ret = plugin.intercept(sessionInfo.getSubjectInfo(), msgUnit);
                  if (ret == null || ret.length() == 0 || ret.equals(Constants.STATE_OK))
                     continue;
                  else {
                     if (log.isLoggable(Level.FINE)) log.fine("Message " + msgKeyData.getOid() + " is rejected by PublishPlugin");
                     return "<qos><state id='" + ret + "'/></qos>";  // Message is rejected by PublishPlugin

Examples of org.xmlBlaster.engine.mime.I_PublishFilter

Related Classes of org.xmlBlaster.engine.mime.I_PublishFilter