xmlBlaster 2.2.0 client API

Serialized Form


Package <Unnamed>

Class hsqlServlet extends org.hsqldb.Servlet implements Serializable


Package http.applet

Class http.applet.HelloWorld3 extends java.applet.Applet implements Serializable

serialVersionUID: 1L

Serialized Fields

xb

I_XmlBlasterAccessRaw xb

applet

HelloWorld3 applet

textArea

java.awt.TextArea textArea

Class http.applet.SystemInfoApplet extends java.applet.Applet implements Serializable

Serialized Fields

xmlBlasterAccess

I_XmlBlasterAccessRaw xmlBlasterAccess

textArea

java.awt.TextArea textArea

runAsApplet

boolean runAsApplet

Class http.applet.XmlScript extends java.applet.Applet implements Serializable

Serialized Fields

xmlBlasterAccess

I_XmlBlasterAccessRaw xmlBlasterAccess

textArea

java.awt.TextArea textArea

requestArea

java.awt.TextArea requestArea

connectButton

java.awt.Button connectButton

sendButton

java.awt.Button sendButton

runAsApplet

boolean runAsApplet

Package http.dhtml.systemInfo

Class http.dhtml.systemInfo.SystemInfo extends javax.servlet.http.HttpServlet implements Serializable


Package org.xmlBlaster.client.jmx

Class org.xmlBlaster.client.jmx.ConnectorException extends javax.management.JMException implements Serializable

Serialized Fields

exception

java.lang.Exception exception

Class org.xmlBlaster.client.jmx.UserFilter extends java.lang.Object implements Serializable

Class org.xmlBlaster.client.jmx.XmlBlasterCallback extends java.lang.Object implements Serializable

Serialized Fields

status

int status

ID

java.lang.String ID

mi

MethodInvocation mi

glob

Global glob

Package org.xmlBlaster.client.protocol.rmi

Class org.xmlBlaster.client.protocol.rmi.RmiCallbackServer extends java.rmi.server.UnicastRemoteObject implements Serializable

Serialized Fields

ME

java.lang.String ME

glob

Global glob

client

I_CallbackExtended client

loginName

java.lang.String loginName

callbackRmiServerBindName

java.lang.String callbackRmiServerBindName
The name for the RMI registry


rmiUrl

org.xmlBlaster.protocol.rmi.RmiUrl rmiUrl

callbackAddress

CallbackAddress callbackAddress

Package org.xmlBlaster.client.queuemsg

Class org.xmlBlaster.client.queuemsg.MsgQueueConnectEntry extends MsgQueueEntry implements Serializable

serialVersionUID: -2955028300581264869L

Serialized Fields

connectQosData

ConnectQosData connectQosData

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueueDisconnectEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 2227605254463221335L

Serialized Fields

disconnectQos

DisconnectQos disconnectQos

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueueEraseEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 3720551167058323026L

Serialized Fields

eraseQos

EraseQos eraseQos

eraseKey

EraseKey eraseKey

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueueGetEntry extends MsgQueueEntry implements Serializable

Serialized Fields

getQos

GetQos getQos

getKey

GetKey getKey

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueuePublishEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 1L

Serialized Fields

msgQosData

MsgQosData msgQosData

receiver

SessionName receiver

msgUnit

MsgUnit msgUnit
The MsgUnit with key/content/qos (raw struct)


immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueueSubscribeEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 1L

Serialized Fields

subscribeQosData

QueryQosData subscribeQosData

subscribeKeyData

QueryKeyData subscribeKeyData

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Class org.xmlBlaster.client.queuemsg.MsgQueueUnSubscribeEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 1L

Serialized Fields

unSubscribeQos

UnSubscribeQos unSubscribeQos

unSubscribeKey

UnSubscribeKey unSubscribeKey

receiver

SessionName receiver

immutableSizeInBytes

long immutableSizeInBytes

Package org.xmlBlaster.util

Class org.xmlBlaster.util.EncodableData extends java.lang.Object implements Serializable

serialVersionUID: 1320428639197394397L

Serialized Fields

ME

java.lang.String ME

name

java.lang.String name

type

java.lang.String type

value

java.lang.String value
The value encoded as specified with encoding


encoding

java.lang.String encoding

charset

java.lang.String charset
Mark the charset for a base64 encoded String


tagName

java.lang.String tagName

size

long size

forceCdata

boolean forceCdata

Class org.xmlBlaster.util.MsgUnit extends java.lang.Object implements Serializable

serialVersionUID: -4816978454646848077L

Serialized Fields

qosData

QosData qosData

content

byte[] content

keyData

KeyData keyData

Class org.xmlBlaster.util.MsgUnitRaw extends java.lang.Object implements Serializable

Serialized Fields

qos

byte[] qos

key

byte[] key

content

byte[] content

encodedContent

EncodableData encodedContent

Class org.xmlBlaster.util.RcvTimestamp extends Timestamp implements Serializable

Class org.xmlBlaster.util.SessionName extends java.lang.Object implements Serializable

serialVersionUID: 2684742715895586788L

Serialized Fields

absoluteName

java.lang.String absoluteName
The absolute name


nodeId

NodeId nodeId

relativeName

java.lang.String relativeName

subjectId

java.lang.String subjectId

pubSessionId

long pubSessionId

nodeIdExplicitlyGiven

boolean nodeIdExplicitlyGiven

Class org.xmlBlaster.util.StopParseException extends java.lang.RuntimeException implements Serializable

serialVersionUID: -8413175809990498728L

Serialized Fields

e

XmlBlasterException e

Class org.xmlBlaster.util.Timestamp extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

timestamp

long timestamp
The timestamp in nanoseconds


tagName

java.lang.String tagName
You may overwrite the tag name for XML dumps in derived classes, defaults to <timestamp ...

Class org.xmlBlaster.util.XmlBlasterException extends java.lang.Exception implements Serializable

serialVersionUID: -973794183539996697L

Serialized Fields

errorCodeStr

java.lang.String errorCodeStr

node

java.lang.String node

location

java.lang.String location

lang

java.lang.String lang

versionInfo

java.lang.String versionInfo

timestampNanos

long timestampNanos

stackTrace

java.lang.String stackTrace

isServerSide

boolean isServerSide

embeddedMessage

java.lang.String embeddedMessage

transactionInfo

java.lang.String transactionInfo

logFormatInternal

java.lang.String logFormatInternal

logFormatResource

java.lang.String logFormatResource

logFormatCommunication

java.lang.String logFormatCommunication

logFormatUser

java.lang.String logFormatUser

logFormatLegacy

java.lang.String logFormatLegacy

logFormat

java.lang.String logFormat

cleanupSession

boolean cleanupSession

Package org.xmlBlaster.util.admin.extern

Class org.xmlBlaster.util.admin.extern.MethodInvocation extends java.lang.Object implements Serializable

serialVersionUID: 7235369610255097138L

Serialized Fields

objectName

java.lang.String objectName

methodName

java.lang.String methodName

targetHost

java.lang.String targetHost

params

java.lang.Object[] params

returnValue

java.lang.Object returnValue

status

int status

ID

java.lang.String ID

Class org.xmlBlaster.util.admin.extern.NotifListener extends java.lang.Object implements Serializable

Serialized Fields

connector

XmlBlasterConnector connector

returnCon

I_XmlBlasterAccess returnCon

glob

Global glob

serHelp

SerializeHelper serHelp

Package org.xmlBlaster.util.cluster

Class org.xmlBlaster.util.cluster.NodeId extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

java.lang.String id

Class org.xmlBlaster.util.cluster.RouteInfo extends java.lang.Object implements Serializable

Serialized Fields

nodeId

NodeId nodeId

stratum

int stratum

timestamp

Timestamp timestamp

dirtyRead

boolean dirtyRead

Package org.xmlBlaster.util.def

Class org.xmlBlaster.util.def.ErrorCode extends java.lang.Object implements Serializable

serialVersionUID: 6926365721931493917L

Serialization Methods

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException
This code is a helper for serialization so that after deserial the check
ErrorCode.INTERNAL_UNKNOWN == internalUnknownInstance
is still usable (the singleton is assured when deserializing)
See inner class SerializedForm

Throws:
java.io.ObjectStreamException
Serialized Fields

errorCode

java.lang.String errorCode

description

java.lang.String description

resourceInfos

org.xmlBlaster.util.def.ResourceInfo[] resourceInfos

Class org.xmlBlaster.util.def.MethodName extends java.lang.Object implements Serializable

serialVersionUID: -6644144030401574462L

Serialization Methods

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException
Throws:
java.io.ObjectStreamException
Serialized Fields

methodName

java.lang.String methodName

argType

int argType

returnType

int returnType

Class org.xmlBlaster.util.def.PriorityEnum extends java.lang.Object implements Serializable

serialVersionUID: -7570828192018997712L

Serialization Methods

writeReplace

public java.lang.Object writeReplace()
                              throws java.io.ObjectStreamException
Throws:
java.io.ObjectStreamException
Serialized Fields

priority

int priority

Package org.xmlBlaster.util.dispatch

Class org.xmlBlaster.util.dispatch.ConnectionStateEnum extends java.lang.Object implements Serializable

serialVersionUID: -8057592644593066934L

Serialized Fields

connectionState

int connectionState

Package org.xmlBlaster.util.error

Class org.xmlBlaster.util.error.MsgErrorInfo extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

glob

Global glob

sessionName

SessionName sessionName

msgUnitRaw

MsgUnitRaw msgUnitRaw

msgUnit

MsgUnit msgUnit

msgQueueEntries

MsgQueueEntry[] msgQueueEntries

dispatchManager

I_DispatchManager dispatchManager

xmlBlasterException

XmlBlasterException xmlBlasterException

Package org.xmlBlaster.util.key

Class org.xmlBlaster.util.key.KeyData extends java.lang.Object implements Serializable

Serialized Fields

oid

java.lang.String oid
value from attribute


contentMime

java.lang.String contentMime
value from attribute


contentMimeExtended

java.lang.String contentMimeExtended
value from attribute


domain

java.lang.String domain
value from attribute


queryType

java.lang.String queryType
The query type


queryString

java.lang.String queryString
The query string

Class org.xmlBlaster.util.key.MsgKeyData extends KeyData implements Serializable

Serialized Fields

clientTags

java.lang.String clientTags

Class org.xmlBlaster.util.key.QueryKeyData extends KeyData implements Serializable

serialVersionUID: 1L

Serialized Fields

filterList

java.util.ArrayList<E> filterList
subscribe(), get() and cluster configuration keys may contain a filter rule


Package org.xmlBlaster.util.property

Class org.xmlBlaster.util.property.PropBoolean extends PropEntry implements Serializable

serialVersionUID: 5664321757271875143L

Serialized Fields

value

boolean value

Class org.xmlBlaster.util.property.PropDouble extends PropEntry implements Serializable

Serialized Fields

value

double value

Class org.xmlBlaster.util.property.PropEntry extends java.lang.Object implements Serializable

Serialized Fields

creationOrigin

int creationOrigin

propName

java.lang.String propName

Class org.xmlBlaster.util.property.PropertyChangeEvent extends java.util.EventObject implements Serializable

serialVersionUID: 1L

Serialization Methods

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.NotSerializableException
Throws NotSerializableException, since PropertyChangeEvent objects are not intended to be serializable.

Throws:
java.io.NotSerializableException

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.NotSerializableException
Throws NotSerializableException, since PropertyChangeEvent objects are not intended to be serializable.

Throws:
java.io.NotSerializableException
Serialized Fields

key

java.lang.String key

oldValue

java.lang.String oldValue

newValue

java.lang.String newValue

Class org.xmlBlaster.util.property.PropInt extends PropEntry implements Serializable

Serialized Fields

value

int value

Class org.xmlBlaster.util.property.PropLong extends PropEntry implements Serializable

Serialized Fields

valueDefault

long valueDefault

value

long value

Class org.xmlBlaster.util.property.PropString extends PropEntry implements Serializable

serialVersionUID: 1L

Serialized Fields

valueDefault

java.lang.String valueDefault

value

java.lang.String value

Package org.xmlBlaster.util.qos

Class org.xmlBlaster.util.qos.ClientProperty extends EncodableData implements Serializable

serialVersionUID: 6415499809321164696L

Class org.xmlBlaster.util.qos.ConnectQosData extends QosData implements Serializable

serialVersionUID: 1L

Serialized Fields

ME

java.lang.String ME

initialConnectionState

ConnectionStateEnum initialConnectionState

ptpAllowed

PropBoolean ptpAllowed
PtP messages wanted? True is default

 <ptp>false<ptp/> 
 


clusterNode

PropBoolean clusterNode
Allows to mark that we are an xmlBlaster cluster node.


refreshSession

PropBoolean refreshSession
If the client automatically notifies xmlBlaster that it is alive and the login session is extended


duplicateUpdates

PropBoolean duplicateUpdates
If duplicateUpdates=false we will send only one update, even if the same client subscribed multiple times on the same message. Defaults to true.


reconnected

PropBoolean reconnected
Used for ConnetReturnQos only: If reconnected==true a client has reconnected to an existing session


serverInstanceId

java.lang.String serverInstanceId

sessionQos

SessionQos sessionQos
Session settings


defaultType

java.lang.String defaultType

clientPlugin

org.xmlBlaster.authentication.plugins.I_ClientPlugin clientPlugin

securityQos

org.xmlBlaster.authentication.plugins.I_SecurityQos securityQos

serverRefVec

java.util.Vector<E> serverRefVec

nodeId

NodeId nodeId
The node id to which we want to connect

Class org.xmlBlaster.util.qos.DisconnectQosData extends QosData implements Serializable

serialVersionUID: 2690405423464959314L

Serialized Fields

deleteSubjectQueue

PropBoolean deleteSubjectQueue

clearSessions

PropBoolean clearSessions

Class org.xmlBlaster.util.qos.MsgQosData extends QosData implements Serializable

serialVersionUID: 1L

Serialized Fields

topicProperty

TopicProperty topicProperty

subscriptionId

java.lang.String subscriptionId
If Pub/Sub style update: contains the subscribe ID which caused this update


subscribable

PropBoolean subscribable
As default you can subscribe even PtP messages, set it to false if you don't want any subscriber to see your PtP message


redeliver

int redeliver
the number of resend tries on failure


queueIndex

long queueIndex

queueSize

long queueSize

fromPersistenceStore

boolean fromPersistenceStore
Internal use only, is this message sent from the persistence layer?


forceUpdate

PropBoolean forceUpdate

lifeTime

PropLong lifeTime
A message expires after some time and will be discarded. Clients will get a notify about expiration. This is the configured lifeTime in millis of the message. It defaults to -1L (== forever).


remainingLifeStatic

long remainingLifeStatic

administrative

PropBoolean administrative

forceDestroy

PropBoolean forceDestroy

priority

PriorityEnum priority
The priority of the message


priorityIsModified

boolean priorityIsModified

destinationList

java.util.ArrayList<E> destinationList
ArrayList for loginQoS, holding all destination addresses (Destination objects)

Class org.xmlBlaster.util.qos.QosData extends java.lang.Object implements Serializable

serialVersionUID: -8909581788281969020L

Serialized Fields

state

java.lang.String state
the state of the message, defaults to "OK" if no state is returned


stateInfo

java.lang.String stateInfo
Human readable information


rcvTimestamp

Timestamp rcvTimestamp
The receive timestamp (UTC time), when message arrived in requestBroker.publish() method.
In nanoseconds elapsed since midnight, January 1, 1970 UTC


persistent

PropBoolean persistent

sender

SessionName sender
The sender (publisher) of this message (unique loginName), is set by server on arrival, and delivered with UpdateQos (with XML).


routeNodeList

java.util.ArrayList<E> routeNodeList
ArrayList containing RouteInfo objects


methodName

MethodName methodName

clientProperties

java.util.Map<K,V> clientProperties

Class org.xmlBlaster.util.qos.QueryQosData extends QosData implements Serializable

serialVersionUID: 1L

Serialized Fields

subscriptionId

java.lang.String subscriptionId
A client can force a specific subscription id


forceDestroy

PropBoolean forceDestroy
On erase forceDestroy


meta

PropBoolean meta
not yet supported


content

PropBoolean content
not yet supported


multiSubscribe

PropBoolean multiSubscribe
allow duplicate identical subscriptions


local

PropBoolean local
update messages i have sent myself to myself?


initialUpdate

PropBoolean initialUpdate
send on subscribe an initial update with the current message


notify

PropBoolean notify
for erase(): Notify the subscribers on erase?


updateOneway

PropBoolean updateOneway
Set for each subscription if you want updateOneway() instead of update() currently this is a flag of the connectQos as well


filters

java.util.ArrayList<E> filters
Mime based filter rules


queries

java.util.ArrayList<E> queries
Query based filter rules


historyQos

HistoryQos historyQos
Query history messages


containsHistoryQos

boolean containsHistoryQos

Class org.xmlBlaster.util.qos.SessionQos extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

sessionTimeout

PropLong sessionTimeout
Default session span of life is one day, given in millis "-session.timeout 86400000"


maxSessions

PropInt maxSessions

clearSessions

PropBoolean clearSessions
Clear on login all other sessions of this user (for recovery reasons) "session.clearSessions false"


reconnectSameClientOnly

PropBoolean reconnectSameClientOnly
If reconnectSameClientOnly=true a client with a given publicSessionId can only reconnect to xmlBlaster if it is the the client instance which created the login session (other clients can't capture the session). This option is useful if you want to assure a singleton client (set additionally maxSessions=1). Defaults to false.


sessionId

java.lang.String sessionId
Passing own secret sessionId


sessionName

SessionName sessionName
The unified session name which is a clusterwide unique identifier


sessionNameModified

boolean sessionNameModified

nodeId

NodeId nodeId
The node id to which we want to connect

Class org.xmlBlaster.util.qos.StatusQosData extends QosData implements Serializable

serialVersionUID: 1L

Serialized Fields

subscriptionId

java.lang.String subscriptionId
The subscription ID of a subscribe() invocation


keyOid

java.lang.String keyOid
The key oid of a publish(), helpful if the oid was generated by xmlBlaster


ex

java.lang.Throwable ex
is set only in case of an exception

Class org.xmlBlaster.util.qos.TopicProperty extends java.lang.Object implements Serializable

serialVersionUID: -8978046284014075499L

Serialized Fields

readonly

PropBoolean readonly

destroyDelay

PropLong destroyDelay
A topic is destroyed 60 sec after state=UNREFERENCED is reached This is the configured destroyDelay in millis


createDomEntry

PropBoolean createDomEntry

msgDistributor

PropString msgDistributor

Package org.xmlBlaster.util.qos.address

Class org.xmlBlaster.util.qos.address.Destination extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

ME

java.lang.String ME

destination

SessionName destination
The destination address (==login name) or the XPath query string


queryType

java.lang.String queryType
EXACT is default


DEFAULT_forceQueuing

boolean DEFAULT_forceQueuing
No queuing is default


forceQueuing

boolean forceQueuing

Package org.xmlBlaster.util.queue

Class org.xmlBlaster.util.queue.QueueEntryId extends Timestamp implements Serializable

Class org.xmlBlaster.util.queue.StorageId extends java.lang.Object implements Serializable

serialVersionUID: 485407826616456805L

Serialized Fields

glob

Global glob

strippedId

java.lang.String strippedId

id

java.lang.String id

parentContextNode

ContextNode parentContextNode

Package org.xmlBlaster.util.queuemsg

Class org.xmlBlaster.util.queuemsg.DummyEntry extends MsgQueueEntry implements Serializable

serialVersionUID: 1L

Serialized Fields

sizeOfMsg

long sizeOfMsg

content

byte[] content

Class org.xmlBlaster.util.queuemsg.MsgQueueEntry extends java.lang.Object implements Serializable

Serialized Fields

logId

java.lang.String logId

storageId

StorageId storageId
The queue to which this entry belongs (set in the constructors)


redeliverCounter

int redeliverCounter
How often the entry was tried to send but failed


uniqueIdTimestamp

Timestamp uniqueIdTimestamp
The unique creation timestamp (unique in a Global of a virtual machine)


priority

PriorityEnum priority
The message priority, see Constants.java


persistent

boolean persistent
the flag telling if a message is persistent (opposite to transient)


entryType

java.lang.String entryType
Which method we invoke, e.g. "update" or "publish"


uniqueIdString

java.lang.String uniqueIdString
The queue to which this entry belongs (set in the constructors)


xmlBlaster 2.2.0 client API

Copyright © 1999-2014 The xmlBlaster.org contributers.