xmlBlaster 2.2.0 client API

org.xmlBlaster.util.dispatch.plugins.prio
Class DispatchAction

java.lang.Object
  extended by org.xmlBlaster.util.dispatch.plugins.prio.DispatchAction

public final class DispatchAction
extends java.lang.Object

This class holds all actions of one specific status.

The StatusConfiguration instance holds zero to n instances of this class.

Author:
xmlBlaster@marcelruff.info
See Also:
StatusConfiguration

Field Summary
static java.lang.String DESTROY
           
static java.lang.String NOTIFY_SENDER
           
static java.lang.String QUEUE
           
static java.lang.String SEND
           
 
Constructor Summary
DispatchAction(Global glob, java.lang.String action)
          Create an immutable instance.
 
Method Summary
 boolean defaultActionOnly()
          Check if only default action is wanted (for performance)
 boolean doDestroy()
           
 boolean doNotifySender()
           
 boolean doQueue()
           
 boolean doSend()
           
 boolean equals(DispatchAction other)
           
 java.lang.String getAction()
          Enforced by I_Plugin
 java.lang.String toString()
           
 java.lang.String toXml(java.lang.String extraOffset)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SEND

public static final java.lang.String SEND
See Also:
Constant Field Values

QUEUE

public static final java.lang.String QUEUE
See Also:
Constant Field Values

DESTROY

public static final java.lang.String DESTROY
See Also:
Constant Field Values

NOTIFY_SENDER

public static final java.lang.String NOTIFY_SENDER
See Also:
Constant Field Values
Constructor Detail

DispatchAction

public DispatchAction(Global glob,
                      java.lang.String action)
Create an immutable instance.

Parameters:
action - e.g. "send|queue"
Method Detail

getAction

public final java.lang.String getAction()
Enforced by I_Plugin

Returns:
The action string, e.g. "send|queue"

doSend

public boolean doSend()
Returns:
Shall message be sent?

doQueue

public boolean doQueue()
Returns:
Shall message be queued?

doDestroy

public boolean doDestroy()
Returns:
Shall message be destroyed?

doNotifySender

public boolean doNotifySender()
Returns:
Shall message be destroyed?

defaultActionOnly

public boolean defaultActionOnly()
Check if only default action is wanted (for performance)


equals

public boolean equals(DispatchAction other)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toXml

public java.lang.String toXml(java.lang.String extraOffset)

xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.