xmlBlaster 2.2.0 client API

org.xmlBlaster.util.checkpoint
Interface I_Checkpoint

All Superinterfaces:
CheckpointMBean, I_AdminPlugin, I_AdminService, I_AdminUsage, I_Plugin
All Known Implementing Classes:
Checkpoint

public interface I_Checkpoint
extends I_Plugin, CheckpointMBean

Interface for plugins to handle messages passing checkpoints.

Author:
Marcel Ruff
See Also:
The admin.checkpoint requirement

Field Summary
static int CP_CONNECTION_PUBLISH_ACK
          On client side (or client of a cluster setup) after the message is acknowledged by the remote server.
static int CP_CONNECTION_PUBLISH_ENTER
          On cluster - client side before sending or putting to connection queue (if offline)
static java.lang.String[] CP_NAMES
           
static int CP_PUBLISH_ACK
          A published messages is successfully processed by the core (publish or publishOneway) For none oneway the ACK is now returned to the publisher.
static int CP_PUBLISH_ENTER
          A published messages is entering xmlBlaster via protocol plugin.
static int CP_UPDATE_ACK
          A message was delivered to a client (update or updateOneway).
static int CP_UPDATE_QUEUE_ADD
          A messages is put to a clients callback queue
 
Method Summary
 void passingBy(int checkpoint, MsgUnit msgUnit, SessionName destination, java.lang.String[] context)
          A message is passing a checkpoint.
 
Methods inherited from interface org.xmlBlaster.util.plugin.I_Plugin
getType, getVersion, init, shutdown
 
Methods inherited from interface org.xmlBlaster.util.checkpoint.CheckpointMBean
getCheckpointList, getFilter, isShowAllClientProperties, isShowAllMessages, isXmlStyle, setFilter, setShowAllClientProperties, setShowAllMessages, setXmlStyle
 
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminService
activate, deActivate, isActive
 
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminPlugin
getType, getVersion, isShutdown, shutdown
 
Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage
getUsageUrl, setUsageUrl, usage
 

Field Detail

CP_PUBLISH_ENTER

static final int CP_PUBLISH_ENTER
A published messages is entering xmlBlaster via protocol plugin. Note: Internal and administrative messages are not reported

See Also:
Constant Field Values

CP_PUBLISH_ACK

static final int CP_PUBLISH_ACK
A published messages is successfully processed by the core (publish or publishOneway) For none oneway the ACK is now returned to the publisher. Note: Internal and administrative messages are not reported

See Also:
Constant Field Values

CP_UPDATE_QUEUE_ADD

static final int CP_UPDATE_QUEUE_ADD
A messages is put to a clients callback queue

See Also:
Constant Field Values

CP_UPDATE_ACK

static final int CP_UPDATE_ACK
A message was delivered to a client (update or updateOneway). For none oneway messages after the client has returned its ACK.

See Also:
Constant Field Values

CP_CONNECTION_PUBLISH_ENTER

static final int CP_CONNECTION_PUBLISH_ENTER
On cluster - client side before sending or putting to connection queue (if offline)

See Also:
Constant Field Values

CP_CONNECTION_PUBLISH_ACK

static final int CP_CONNECTION_PUBLISH_ACK
On client side (or client of a cluster setup) after the message is acknowledged by the remote server.

See Also:
Constant Field Values

CP_NAMES

static final java.lang.String[] CP_NAMES
Method Detail

passingBy

void passingBy(int checkpoint,
               MsgUnit msgUnit,
               SessionName destination,
               java.lang.String[] context)
A message is passing a checkpoint. Note: This method may never throw any exceptions

Parameters:
checkpoint - The checkpoint, e.g. CP_PUBLISH_ACK
destination - Can be null
msgUnit - The message processed
context - Additional key values like { "subscriptionId", "__suvbId:2349", "comment", "blabla" }

xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.