org.xmlBlaster.util.qos.address
Class AddressBase

java.lang.Object
  org.xmlBlaster.util.qos.address.AddressBase

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Address, AddressServer, CallbackAddress

public abstract class AddressBase
extends java.lang.Object
implements java.lang.Cloneable

Abstract helper class holding connect address and callback address string and protocol string.

See examples in the implementing classes

See Also:

Address, CallbackAddress, AddressBaseTest

Field Summary

private PropString	bootstrapHostname
private PropInt	bootstrapPort
protected PropLong	burstModeMaxBytes
protected PropInt	burstModeMaxEntries
private java.lang.Object	callbackDriver
protected java.lang.String	className
protected PropLong	collectTime
protected PropString	compressType
protected java.lang.String	context
static int	DEFAULT_bootstrapPort
static long	DEFAULT_burstModeMaxBytes
static int	DEFAULT_burstModeMaxEntries
static long	DEFAULT_collectTime BurstMode: The time to collect messages for publish/update
static java.lang.String	DEFAULT_compressType Compress messages if set to "gzip" or "zip"
static boolean	DEFAULT_dispatcherActive
java.lang.String	DEFAULT_dispatchPlugin Does client whish a dispatcher plugin.
static long	DEFAULT_minSize Messages bigger this size in bytes are compressed
static boolean	DEFAULT_oneway Shall the update() or publish() messages be send oneway (no application level ACK).
static boolean	DEFAULT_ptpAllowed PtP messages wanted? Defaults to true, false prevents spamming
static java.lang.String	DEFAULT_sessionId The identifier sent to the callback client, the client can decide if he trusts this invocation
boolean	DEFAULT_stallOnPingTimeout Setting this property will not throw an exception on pings when a ping response timeout is detected.
static java.lang.String	DEFAULT_type The unique protocol type, defaults to SOCKET
static boolean	DEFAULT_useForSubjectQueue Shall this session callback be used for subjectQueue messages as well? For <callback> only
static java.lang.String	DEFAULT_version The protocol version, e.g.
protected PropLong	delay
protected PropBoolean	dispatcherActive Control if the dispatcher is activated on login, i.e.
protected PropString	dispatchPlugin
protected java.lang.String	envPrefix For example "plugin/socket/"
protected boolean	fromPersistenceRecovery Marker if message comes from persistent store and is recovered after a server restart.
protected Global	glob
protected java.lang.String	instanceName
private static java.util.logging.Logger	log
protected PropLong	minSize
protected java.lang.String	nodeId The node id to which we want to connect
protected PropBoolean	oneway
protected PropLong	pingInterval
private ClientPropertiesInfo	pluginAttributes
private java.util.Properties	pluginInfoParameters
protected PropBoolean	ptpAllowed
private PropString	rawAddress The unique address, e.g.
protected PropInt	retries
protected java.lang.String	rootTag The root xml element: <callback> or <address>, is set from the derived class
protected PropString	sessionId
protected SessionName	sessionName
protected PropBoolean	stallOnPingTimeout
protected PropString	type
protected PropBoolean	useForSubjectQueue
protected PropString	version

Constructor Summary

AddressBase(Global glob, java.lang.String rootTag)

Method Summary

void	addClientProperty(ClientProperty clientProperty)
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character) Handle SAX parsed end element
java.lang.String	getBootstrapHostname()
int	getBootstrapPort()
java.lang.String	getBootstrapUrl() Returns a URL markup of the bootstrap server, currently it looks like xmlBlaster://myServer.com:3412 but will probably change in a future release.
long	getBurstModeMaxBytes() How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
int	getBurstModeMaxEntries() How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.
java.lang.Object	getCallbackDriver()
AddressBase	getClone()
long	getCollectTime() BurstMode: The time span to collect messages before sending.
java.lang.String	getCompressType() Get the compression method.
abstract long	getDefaultDelay() Delay between connection retries in milliseconds
abstract long	getDefaultPingInterval() Ping interval: pinging every given milliseconds
abstract int	getDefaultRetries() How often to retry if connection fails
long	getDelay() Delay between callback retries in milliseconds, defaults to one minute
java.lang.String	getDispatchPlugin()
PropBoolean	getEnv(java.lang.String key, boolean defaultValue) Plugins may query their properties here
PropInt	getEnv(java.lang.String key, int defaultValue) Plugins may query their properties here
PropLong	getEnv(java.lang.String key, long defaultValue) Plugins may query their properties here
PropString	getEnv(java.lang.String key, java.lang.String defaultValue) Plugins may query their properties here
java.lang.String	getEnvLookupKey(java.lang.String key) Returns the completed key which was found and chosen.
java.lang.String	getEnvPrefix()
java.lang.String	getLogId()
long	getMinSize() Messages bigger this size in bytes are compressed.
java.lang.String	getName() A nice human readable name for this address (used for logging)
java.lang.String	getOnExhaust() What to do if max retries is exhausted.
boolean	getOnExhaustKillSession() Kill login session if max callback retries is exhausted?
long	getPingInterval() How long to wait between pings to the callback server.
java.lang.String	getRawAddress() Returns the rawAddress which is specific for each protocol.
int	getRetries() How often shall we retry callback attempt on callback failure
java.lang.String	getSecretSessionId() The identifier sent to the callback client, the client can decide if he trusts this invocation
SessionName	getSessionName()
java.lang.String	getSettings() Show some important settings for logging
java.lang.String	getType() Returns the protocol type.
java.lang.String	getVersion() Returns the protocol version.
boolean	hasAttributeEnv(java.lang.String key)
boolean	hasBootstrapHostname() Check if a bootstrapHostname is set already
protected void	initialize() Configure property settings.
boolean	isDispatcherActive()
boolean	isFromPersistenceRecovery()
boolean	isPtpAllowed()
boolean	isSameAddress(AddressBase other) Check if supplied address would connect to the address of this instance
boolean	isStallOnPingTimeout()
boolean	oneway() Shall the publish() or callback update() message be oneway.
void	setBootstrapHostname(java.lang.String host) Updates the internal address as well.
void	setBootstrapPort(int bootstrapPort) Set the bootstrapping port.
void	setBurstModeMaxBytes(long burstModeMaxBytes)
void	setBurstModeMaxEntries(int burstModeMaxEntries)
void	setCallbackDriver(java.lang.Object callbackDriver)
void	setCollectTime(long collectTime) BurstMode: The time to collect messages for sending in a bulk.
void	setCompressType(java.lang.String compressType)
void	setDefaultBootstrapHostname(java.lang.String host)
void	setDefaultBootstrapPort(int defaultBootstrapPort) The creation default will be overwritten by the given defaultPort.
void	setDelay(long delay) Delay between callback retries in milliseconds, defaults to one minute
void	setDispatcherActive(boolean dispatcherActive) Inhibits/activates the delivery of asynchronous dispatches of messages.
void	setDispatchPlugin(java.lang.String dispatchPlugin) Specify your dispatcher plugin configuration.
void	setFromPersistenceRecovery(boolean fromPersistenceRecovery)
void	setMinSize(long minSize) Messages bigger this size in bytes are compressed.
void	setOneway(boolean oneway) Shall the publish() or callback update() message be oneway.
void	setPingInterval(long pingInterval) How long to wait between pings to the callback server.
void	setPluginInfoParameters(java.util.Properties parameters) Set the PluginInfo parameters (derived from xmlBlasterPlugins.xml or xmlBlaster.properties).
void	setPluginProperty(java.lang.String key, java.lang.String value) Set a protocol specific property.
void	setPtpAllowed(boolean ptpAllowed)
void	setRawAddress(java.lang.String rawAddress) Set the callback address, it should fit to the protocol-type.
void	setRetries(int retries) How often shall we retry callback attempt on callback failure
private void	setRootTag(java.lang.String rootTag) Sets the root xml tag, <callback> or <address>
void	setSecretSessionId(java.lang.String sessionId) The identifier sent to the callback client, the client can decide if he trusts this invocation
void	setSessionName(SessionName sessionName)
void	setStallOnPingTimeout(boolean stallOnPingTimeout)
void	setType(java.lang.String type) NOTE: This setting has precedence over all environment or command line settings
void	setVersion(java.lang.String version)
void	shutdown()
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String name, java.lang.StringBuffer character, org.xml.sax.Attributes attrs) Called for SAX callback start tag
java.lang.String	toXml() Dump state of this object into a XML ASCII string.
java.lang.String	toXml(java.lang.String extraOffset) Dump state of this object into a XML ASCII string.
java.lang.String	usage() Get a usage string for the connection parameters.

Methods inherited from class java.lang.Object

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

Field Detail

glob

protected final Global glob

log

private static java.util.logging.Logger log

pluginAttributes

private ClientPropertiesInfo pluginAttributes

pluginInfoParameters

private java.util.Properties pluginInfoParameters

rootTag

protected java.lang.String rootTag

The root xml element: <callback> or <address>, is set from the derived class

instanceName

protected java.lang.String instanceName

className

protected final java.lang.String className

See Also:

Constant Field Values

context

protected final java.lang.String context

envPrefix

protected java.lang.String envPrefix

For example "plugin/socket/"

rawAddress

private PropString rawAddress

The unique address, e.g. the CORBA IOR string

bootstrapHostname

private PropString bootstrapHostname

DEFAULT_bootstrapPort

public static final int DEFAULT_bootstrapPort

See Also:

Constant Field Values

bootstrapPort

private PropInt bootstrapPort

DEFAULT_type

public static final java.lang.String DEFAULT_type

The unique protocol type, defaults to SOCKET

See Also:

Constant Field Values

type

protected PropString type

DEFAULT_version

public static final java.lang.String DEFAULT_version

The protocol version, e.g. "1.0"

See Also:

Constant Field Values

version

protected PropString version

DEFAULT_collectTime

public static final long DEFAULT_collectTime

BurstMode: The time to collect messages for publish/update

See Also:

Constant Field Values

collectTime

protected PropLong collectTime

pingInterval

protected PropLong pingInterval

retries

protected PropInt retries

delay

protected PropLong delay

DEFAULT_oneway

public static final boolean DEFAULT_oneway

Shall the update() or publish() messages be send oneway (no application level ACK).

For more info read the CORBA spec. Only CORBA and our native SOCKET protocol support oneway. Defaults to false (the update() or publish() has a return value and can throw an exception).

See Also:

Constant Field Values

oneway

protected PropBoolean oneway

DEFAULT_dispatcherActive

public static final boolean DEFAULT_dispatcherActive

See Also:

Constant Field Values

dispatcherActive

protected PropBoolean dispatcherActive

Control if the dispatcher is activated on login, i.e. if it is able to deliver asynchronous messages from the callback queue. defaults to true

DEFAULT_compressType

public static final java.lang.String DEFAULT_compressType

Compress messages if set to "gzip" or "zip"

See Also:

Constant Field Values

compressType

protected PropString compressType

DEFAULT_minSize

public static final long DEFAULT_minSize

Messages bigger this size in bytes are compressed

See Also:

Constant Field Values

minSize

protected PropLong minSize

DEFAULT_burstModeMaxEntries

public static final int DEFAULT_burstModeMaxEntries

See Also:

Constant Field Values

burstModeMaxEntries

protected PropInt burstModeMaxEntries

DEFAULT_burstModeMaxBytes

public static final long DEFAULT_burstModeMaxBytes

See Also:

Constant Field Values

burstModeMaxBytes

protected PropLong burstModeMaxBytes

DEFAULT_ptpAllowed

public static final boolean DEFAULT_ptpAllowed

PtP messages wanted? Defaults to true, false prevents spamming

See Also:

Constant Field Values

ptpAllowed

protected PropBoolean ptpAllowed

DEFAULT_sessionId

public static final java.lang.String DEFAULT_sessionId

The identifier sent to the callback client, the client can decide if he trusts this invocation

See Also:

Constant Field Values

sessionId

protected PropString sessionId

DEFAULT_useForSubjectQueue

public static final boolean DEFAULT_useForSubjectQueue

Shall this session callback be used for subjectQueue messages as well? For <callback> only

See Also:

Constant Field Values

useForSubjectQueue

protected PropBoolean useForSubjectQueue

sessionName

protected SessionName sessionName

DEFAULT_dispatchPlugin

public java.lang.String DEFAULT_dispatchPlugin

Does client whish a dispatcher plugin.

Set to "undef" forces to switch off, or e.g. "Priority,1.0" to access the PriorizedDispatchPlugin

Setting it to 'null' (which is the default) lets the server choose the plugin

See Also:

The dispatch.control.plugin requirement

dispatchPlugin

protected PropString dispatchPlugin

DEFAULT_stallOnPingTimeout

public boolean DEFAULT_stallOnPingTimeout

Setting this property will not throw an exception on pings when a ping response timeout is detected. Instead it will just set the 'stalled' flag in the dispatch statistics.

stallOnPingTimeout

protected PropBoolean stallOnPingTimeout

nodeId

protected java.lang.String nodeId

The node id to which we want to connect

fromPersistenceRecovery

protected transient boolean fromPersistenceRecovery

Marker if message comes from persistent store and is recovered after a server restart. NOTE: This information is for server side usage only and is NOT dumped to XML!

callbackDriver

private java.lang.Object callbackDriver

Constructor Detail

AddressBase

public AddressBase(Global glob,
                   java.lang.String rootTag)

Method Detail

getDefaultPingInterval

public abstract long getDefaultPingInterval()

Ping interval: pinging every given milliseconds

getDefaultRetries

public abstract int getDefaultRetries()

How often to retry if connection fails

getDefaultDelay

public abstract long getDefaultDelay()

Delay between connection retries in milliseconds

getClone

public AddressBase getClone()

initialize

protected void initialize()

Configure property settings. "-/node/heron/dispatch/connection/delay 20" has precedence over "-delay 10"

setPluginProperty

public void setPluginProperty(java.lang.String key,
                              java.lang.String value)

Set a protocol specific property.

Setting a property here forces the setting in the plugin, it has precedence over any environment, xmlBlaster.properties or command line setting.
You typically use this method in your client code to overwrite settings,. please check the protocol specific documentation about the supported settings.

Parameters:

key - The property, e.g. "SOLingerTimeout" (WITHOUT any prefix like "plugin/socket/") The searched property is depending on the type (here "socket") and instance (here "connection") e.g. "plugin/socket/SOLingerTimeout" and with higher precedence "dispatch/connection/plugin/socket/SOLingerTimeout"

value - The value, e.g. "10000"

addClientProperty

public void addClientProperty(ClientProperty clientProperty)

setPluginInfoParameters

public void setPluginInfoParameters(java.util.Properties parameters)

Set the PluginInfo parameters (derived from xmlBlasterPlugins.xml or xmlBlaster.properties).
As a protocol plugin developer you should call this method if you have a PluginInfo instance to use the default paramaters of the plugin.
Example from xmlBlasterPlugins.xml:
<plugin id='SOCKET_UDP' className='org.xmlBlaster.protocol.socket.SocketDriver'> ... <attribute id='useUdpForOneway'>true </plugin>

These settings are used as default settings for the plugin with lowest priority

Calls initialize() to reinitialize compression.

getEnvPrefix

public java.lang.String getEnvPrefix()

hasAttributeEnv

public boolean hasAttributeEnv(java.lang.String key)

getEnv

public PropString getEnv(java.lang.String key,
                         java.lang.String defaultValue)

Plugins may query their properties here

Parameters:

key - The property, e.g. "SOLingerTimeout" (WITHOUT any prefix like "plugin/socket/")

Returns:

never null

getEnv

public PropInt getEnv(java.lang.String key,
                      int defaultValue)

Plugins may query their properties here

Parameters:

key - The property, e.g. "SOLingerTimeout" (WITHOUT any prefix like "plugin/socket/")

Returns:

never null

getEnv

public PropLong getEnv(java.lang.String key,
                       long defaultValue)

Plugins may query their properties here

Parameters:

key - The property, e.g. "SOLingerTimeout" (WITHOUT any prefix like "plugin/socket/")

Returns:

never null

getEnv

public PropBoolean getEnv(java.lang.String key,
                          boolean defaultValue)

Plugins may query their properties here

Parameters:

key - The property, e.g. "SOLingerTimeout" (WITHOUT any prefix like "plugin/socket/")

Returns:

never null

getEnvLookupKey

public java.lang.String getEnvLookupKey(java.lang.String key)

Returns the completed key which was found and chosen.

Returns:

For "responseTimeout" it could be "dispatch/connection/plugin/socket/responseTimeout"

getName

public final java.lang.String getName()

A nice human readable name for this address (used for logging)

isSameAddress

public final boolean isSameAddress(AddressBase other)

Check if supplied address would connect to the address of this instance

setRootTag

private final void setRootTag(java.lang.String rootTag)

Sets the root xml tag, <callback> or <address>

getSettings

public java.lang.String getSettings()

Show some important settings for logging

setType

public final void setType(java.lang.String type)

NOTE: This setting has precedence over all environment or command line settings

Parameters:

type - The protocol type, e.g. "IOR", "EMAIL", "XMLRPC" If you pass null the value is reset to its default setting

setVersion

public final void setVersion(java.lang.String version)

Parameters:

version - The protocol version, e.g. "1.0"

getLogId

public java.lang.String getLogId()

Returns:

A human readable address for logging only

setBootstrapHostname

public final void setBootstrapHostname(java.lang.String host)

Updates the internal address as well.

NOTE:

This bootstrapping bootstrapPort is currently only used by the CORBA plugin.

To set other protocols try e.g.:

  String[] args = { "-protocol", "SOCKET",
                    "-dispatch/connection/plugin/socket/hostname", "myHost",
                    "-dispatch/connection/plugin/socket/port", "7666",
                    "-dispatch/connection/plugin/socket/localHostname", "myHost",   // optional
                    "-dispatch/connection/plugin/socket/localPort", "8888" };       // optional
  glob.init(args);
 

Parameters:

host - An IP or DNS

setDefaultBootstrapHostname

public final void setDefaultBootstrapHostname(java.lang.String host)

hasBootstrapHostname

public boolean hasBootstrapHostname()

Check if a bootstrapHostname is set already

getBootstrapHostname

public final java.lang.String getBootstrapHostname()

Returns:

The Hostname, IP or "" if not known

getBootstrapUrl

public final java.lang.String getBootstrapUrl()

Returns a URL markup of the bootstrap server, currently it looks like xmlBlaster://myServer.com:3412 but will probably change in a future release.

setBootstrapPort

public final void setBootstrapPort(int bootstrapPort)

Set the bootstrapping port. Updates the internal address as well.

NOTE:

This bootstrapping bootstrapPort is currently only used by the CORBA plugin.

To set other protocols try e.g.:

  String[] args = { "-protocol", "SOCKET",
                    "-dispatch/connection/plugin/socket/hostname", "myHost",
                    "-dispatch/connection/plugin/socket/port", "7666",
                    "-dispatch/connection/plugin/socket/localHostname", "myHost",   // optional
                    "-dispatch/connection/plugin/socket/localPort", "8888" };       // optional
  glob.init(args);
 

getBootstrapPort

public final int getBootstrapPort()

setDefaultBootstrapPort

public final void setDefaultBootstrapPort(int defaultBootstrapPort)

The creation default will be overwritten by the given defaultPort.

If the bootstrapPort was changed by environment setting, this setting has precedence over the given defaultPort and nothing happens.

This is used by the protocol plugins which all have different defaults

setRawAddress

public final void setRawAddress(java.lang.String rawAddress)

Set the callback address, it should fit to the protocol-type.

If you set an address here you need to set it compatible to the protocol from getType().
For XmlRpc it looks typically like http://myServer:8080 for CORBA like IOR:00005395.... and for SOCKET like socket://128.56.44.12:7608

Setting the address here has precedence over any environment settings like -dispatch/connection/plugin/socket/port 7666 on command line or

  String[] args = { "-protocol", "SOCKET",
                    "-dispatch/connection/plugin/socket/hostname", "myHost",
                    "-dispatch/connection/plugin/socket/port", "7666",
                    "-dispatch/connection/plugin/socket/localHostname", "myHost",   // optional
                    "-dispatch/connection/plugin/socket/localPort", "8888" };       // optional
  glob.init(args);
 

Parameters:

rawAddress - The address specific for the protocol, e.g. "et@mars.univers" for EMAIL

getRawAddress

public final java.lang.String getRawAddress()

Returns the rawAddress which is specific for each protocol.

Returns:

e.g. "IOR:00001100022...." or "et@universe.com" or "" (never null)

setCallbackDriver

public final void setCallbackDriver(java.lang.Object callbackDriver)

getCallbackDriver

public final java.lang.Object getCallbackDriver()

getType

public final java.lang.String getType()

Returns the protocol type.

Returns:

e.g. "EMAIL" or "IOR" (never null).

getVersion

public final java.lang.String getVersion()

Returns the protocol version.

Returns:

e.g. "1.0" or null

getOnExhaust

public final java.lang.String getOnExhaust()

What to do if max retries is exhausted.

This mode is currently not configurable, we always destroy the login session. This is interpreted only server side if callback fails.

Returns:

Constants.ONEXHAUST_KILL_SESSION="killSession"

getOnExhaustKillSession

public final boolean getOnExhaustKillSession()

Kill login session if max callback retries is exhausted?

getCollectTime

public final long getCollectTime()

BurstMode: The time span to collect messages before sending.

Returns:

The time to collect in milliseconds (default is 0 == switched off)

setCollectTime

public void setCollectTime(long collectTime)

BurstMode: The time to collect messages for sending in a bulk.

Parameters:

The - time to collect in milliseconds

getBurstModeMaxEntries

public int getBurstModeMaxEntries()

How many messages maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

setBurstModeMaxEntries

public void setBurstModeMaxEntries(int burstModeMaxEntries)

getBurstModeMaxBytes

public long getBurstModeMaxBytes()

How many bytes maximum shall the callback thread take in one bulk out of the callback queue and deliver to the client in one bulk.

setBurstModeMaxBytes

public void setBurstModeMaxBytes(long burstModeMaxBytes)

getPingInterval

public final long getPingInterval()

How long to wait between pings to the callback server.

Returns:

The pause time between pings in millis

setPingInterval

public void setPingInterval(long pingInterval)

How long to wait between pings to the callback server.

Parameters:

pingInterval - The pause time between pings in millis

getRetries

public final int getRetries()

How often shall we retry callback attempt on callback failure

Returns:

-1 forever, 0 no retry, > 0 number of retries

setRetries

public void setRetries(int retries)

How often shall we retry callback attempt on callback failure

Parameters:

-1 - forever, 0 no retry, > 0 number of retries

getDelay

public final long getDelay()

Delay between callback retries in milliseconds, defaults to one minute

Returns:

The delay in millisconds

setDelay

public void setDelay(long delay)

Delay between callback retries in milliseconds, defaults to one minute

oneway

public final boolean oneway()

Shall the publish() or callback update() message be oneway. Is only with CORBA and our native SOCKET protocol supported

Returns:

true if you want to force oneway sending

setOneway

public void setOneway(boolean oneway)

Shall the publish() or callback update() message be oneway. Is only with CORBA and our native SOCKET protocol supported

Parameters:

oneway - false is default

setDispatcherActive

public void setDispatcherActive(boolean dispatcherActive)

Inhibits/activates the delivery of asynchronous dispatches of messages.

Parameters:

dispatcherActive -

isDispatcherActive

public boolean isDispatcherActive()

Returns:

true if the dispatcher is currently activated, i.e. if it is able to deliver asynchronous messages from the queue.

setPtpAllowed

public void setPtpAllowed(boolean ptpAllowed)

Parameters:

Set - if we accept point to point messages

isPtpAllowed

public final boolean isPtpAllowed()

Returns:

true if we may send PtP messages

setCompressType

public void setCompressType(java.lang.String compressType)

getSecretSessionId

public final java.lang.String getSecretSessionId()

The identifier sent to the callback client, the client can decide if he trusts this invocation

Returns:

never null

setSecretSessionId

public void setSecretSessionId(java.lang.String sessionId)

The identifier sent to the callback client, the client can decide if he trusts this invocation

getCompressType

public final java.lang.String getCompressType()

Get the compression method.

Returns:

"" No compression

getMinSize

public long getMinSize()

Messages bigger this size in bytes are compressed.
Note: This value is only used if compressType is set to a supported value

Returns:

size in bytes

setMinSize

public void setMinSize(long minSize)

Messages bigger this size in bytes are compressed.
Note: This value is only evaluated if compressType is set to a supported value

setDispatchPlugin

public void setDispatchPlugin(java.lang.String dispatchPlugin)

Specify your dispatcher plugin configuration.

Set to "undef" to switch off, or to e.g. "Priority,1.0" to access the PriorizedDispatchPlugin

This overwrites the xmlBlaster.properties default setting e.g.:

 DispatchPlugin[Priority][1.0]=org.xmlBlaster.util.dispatch.plugins.prio.PriorizedDispatchPlugin
 DispatchPlugin[SlowMotion][1.0]=org.xmlBlaster.util.dispatch.plugins.motion.SlowMotion
 DispatchPlugin/defaultPlugin=Priority,1.0
 

See Also:

The dispatch.control.plugin requirement

getDispatchPlugin

public java.lang.String getDispatchPlugin()

Returns:

"undef" or e.g. "Priority,1.0"

isStallOnPingTimeout

public final boolean isStallOnPingTimeout()

setStallOnPingTimeout

public final void setStallOnPingTimeout(boolean stallOnPingTimeout)

startElement

public final void startElement(java.lang.String uri,
                               java.lang.String localName,
                               java.lang.String name,
                               java.lang.StringBuffer character,
                               org.xml.sax.Attributes attrs)

Called for SAX callback start tag

endElement

public final void endElement(java.lang.String uri,
                             java.lang.String localName,
                             java.lang.String name,
                             java.lang.StringBuffer character)

Handle SAX parsed end element

toXml

public final java.lang.String toXml()

Dump state of this object into a XML ASCII string.

toXml

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

Dump state of this object into a XML ASCII string.
Only none default values are dumped for performance reasons

Parameters:

extraOffset - indenting of tags for nice output

Returns:

The xml representation

usage

public java.lang.String usage()

Get a usage string for the connection parameters. Currently only for client side usage

getSessionName

public SessionName getSessionName()

Returns:

Can be null

setSessionName

public void setSessionName(SessionName sessionName)

shutdown

public void shutdown()

isFromPersistenceRecovery

public boolean isFromPersistenceRecovery()

setFromPersistenceRecovery

public void setFromPersistenceRecovery(boolean fromPersistenceRecovery)