org.xmlBlaster.util.qos.address
Class CallbackAddress

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

All Implemented Interfaces:

java.lang.Cloneable

public class CallbackAddress
extends AddressBase

Helper class holding callback address string and protocol string.

 <callback type='XMLRPC' sessionId='4e56890ghdFzj0'
           pingInterval='60000' retries='5' delay='10000'
           oneway='false' useForSubjectQueue='true'
           dispatchPlugin='Priority,1.0'>
    http://server:8080/cb
    <compress type='gzip' minSize='1000'/>
    <burstMode collectTime='400'/>
 </callback>
 

Field Summary

Fields inherited from class org.xmlBlaster.util.qos.address.AddressBase

burstModeMaxBytes, burstModeMaxEntries, className, collectTime, compressType, context, DEFAULT_bootstrapPort, DEFAULT_burstModeMaxBytes, DEFAULT_burstModeMaxEntries, DEFAULT_collectTime, DEFAULT_compressType, DEFAULT_dispatcherActive, DEFAULT_dispatchPlugin, DEFAULT_minSize, DEFAULT_oneway, DEFAULT_ptpAllowed, DEFAULT_sessionId, DEFAULT_stallOnPingTimeout, DEFAULT_type, DEFAULT_useForSubjectQueue, DEFAULT_version, delay, dispatcherActive, dispatchPlugin, envPrefix, fromPersistenceRecovery, glob, instanceName, minSize, nodeId, oneway, pingInterval, ptpAllowed, retries, rootTag, sessionId, sessionName, stallOnPingTimeout, type, useForSubjectQueue, version

Constructor Summary

CallbackAddress(Global glob)

CallbackAddress(Global glob, java.lang.String type)

CallbackAddress(Global glob, java.lang.String type, java.lang.String nodeId)

Method Summary

long	getDefaultDelay() Delay between connection retries in milliseconds: defaults to one minute
long	getDefaultPingInterval() Ping interval: pinging every given milliseconds, defaults to one minute
int	getDefaultRetries() How often to retry if connection fails: defaults to 0 retries, on failure we give up
protected void	initialize() Configure property settings
static void	main(java.lang.String[] argsDefault) For testing: java org.xmlBlaster.util.qos.address.CallbackAddress
void	setFromPersistenceRecovery(boolean fromPersistenceRecovery)
void	setSecretCbSessionId(java.lang.String cbSessionId) The identifier sent to the callback client, the client can decide if he trusts this invocation
java.lang.String	toString()
java.lang.String	usage() Client side usage used by XmlBlasterAccess
boolean	useForSubjectQueue() Shall this address be used for subject queue messages?
void	useForSubjectQueue(boolean useForSubjectQueue) Shall this address be used for subject queue messages?

Methods inherited from class org.xmlBlaster.util.qos.address.AddressBase

addClientProperty, endElement, getBootstrapHostname, getBootstrapPort, getBootstrapUrl, getBurstModeMaxBytes, getBurstModeMaxEntries, getCallbackDriver, getClone, getCollectTime, getCompressType, getDelay, getDispatchPlugin, getEnv, getEnv, getEnv, getEnv, getEnvLookupKey, getEnvPrefix, getLogId, getMinSize, getName, getOnExhaust, getOnExhaustKillSession, getPingInterval, getRawAddress, getRetries, getSecretSessionId, getSessionName, getSettings, getType, getVersion, hasAttributeEnv, hasBootstrapHostname, isDispatcherActive, isFromPersistenceRecovery, isPtpAllowed, isSameAddress, isStallOnPingTimeout, oneway, setBootstrapHostname, setBootstrapPort, setBurstModeMaxBytes, setBurstModeMaxEntries, setCallbackDriver, setCollectTime, setCompressType, setDefaultBootstrapHostname, setDefaultBootstrapPort, setDelay, setDispatcherActive, setDispatchPlugin, setMinSize, setOneway, setPingInterval, setPluginInfoParameters, setPluginProperty, setPtpAllowed, setRawAddress, setRetries, setSecretSessionId, setSessionName, setStallOnPingTimeout, setType, setVersion, shutdown, startElement, toXml, toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackAddress

public CallbackAddress(Global glob)

CallbackAddress

public CallbackAddress(Global glob,
                       java.lang.String type)

Parameters:

type - The protocol type, e.g. "IOR", "EMAIL", "XMLRPC"

CallbackAddress

public CallbackAddress(Global glob,
                       java.lang.String type,
                       java.lang.String nodeId)

Parameters:

type - The protocol type, e.g. "IOR", "EMAIL", "XMLRPC"

nodeId - A unique string (typically the cluster node id we connect to).
This is used for extended env-variable support, e.g. for a given nodeId="heron" the command line argument (or xmlBlaster.property entry) -/node/heron/dispatch/callback/retries 20 is precedence over -dispatch/callback/retries 10

Method Detail

getDefaultRetries

public int getDefaultRetries()

How often to retry if connection fails: defaults to 0 retries, on failure we give up

Specified by:

getDefaultRetries in class AddressBase

getDefaultDelay

public long getDefaultDelay()

Delay between connection retries in milliseconds: defaults to one minute

Specified by:

getDefaultDelay in class AddressBase

getDefaultPingInterval

public long getDefaultPingInterval()

Ping interval: pinging every given milliseconds, defaults to one minute

Specified by:

getDefaultPingInterval in class AddressBase

initialize

protected void initialize()

Configure property settings

Overrides:

initialize in class AddressBase

useForSubjectQueue

public boolean useForSubjectQueue()

Shall this address be used for subject queue messages?

Returns:

false if address is for session queue only

useForSubjectQueue

public void useForSubjectQueue(boolean useForSubjectQueue)

Shall this address be used for subject queue messages?

Parameters:

useForSubjectQueue - false if address is for session queue only

setSecretCbSessionId

public void setSecretCbSessionId(java.lang.String cbSessionId)

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

See Also:

AddressBase.setSecretSessionId(String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The literal address as given by getRawAddress()

usage

public final java.lang.String usage()

Client side usage used by XmlBlasterAccess

Overrides:

usage in class AddressBase

main

public static void main(java.lang.String[] argsDefault)

For testing: java org.xmlBlaster.util.qos.address.CallbackAddress

setFromPersistenceRecovery

public void setFromPersistenceRecovery(boolean fromPersistenceRecovery)

Overrides:

setFromPersistenceRecovery in class AddressBase