xmlBlaster 2.1.0 API

org.xmlBlaster.engine.qos
Class ConnectReturnQosServer

java.lang.Object
  extended by org.xmlBlaster.engine.qos.ConnectReturnQosServer

public final class ConnectReturnQosServer
extends java.lang.Object

This class wraps the return string of org.xmlBlaster.authentication.authenticate.connect(...).

It is used on the server side to wrap the return.

See Also:
The interface.connect requirement

Field Summary
private  ConnectQosData connectQosData
           
private  Global glob
           
static java.lang.String ME
           
 
Constructor Summary
ConnectReturnQosServer(Global glob, ConnectQosData connectQosData)
           
ConnectReturnQosServer(Global glob, java.lang.String xmlQos)
           
 
Method Summary
 void addServerRef(ServerRef addr)
          Adds a server reference
 ConnectQosData getData()
           
 java.lang.String getSecretSessionId()
           
 java.lang.String getServerInstanceId()
          Unique id of the xmlBlaster server, changes on each restart.
 ServerRef getServerRef()
           
 SessionName getSessionName()
           
 SessionQos getSessionQos()
           
 java.lang.String getUserId()
           
 boolean isReconnected()
           
 boolean removeServerRef(java.lang.String type)
           
 void setReconnected(boolean reconnected)
          If reconnected==true a client has reconnected to an existing session
 void setSecretSessionId(java.lang.String id)
           
 void setServerInstanceId(java.lang.String instanceId)
          Unique id of the xmlBlaster server, changes on each restart.
 void setSessionName(SessionName sessionName)
           
 java.lang.String toXml()
           
 java.lang.String toXml(java.lang.String extraOffset)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ME

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

glob

private Global glob

connectQosData

private ConnectQosData connectQosData
Constructor Detail

ConnectReturnQosServer

public ConnectReturnQosServer(Global glob,
                              ConnectQosData connectQosData)
                       throws XmlBlasterException
Throws:
XmlBlasterException

ConnectReturnQosServer

public ConnectReturnQosServer(Global glob,
                              java.lang.String xmlQos)
                       throws XmlBlasterException
Throws:
XmlBlasterException
Method Detail

getData

public ConnectQosData getData()

toXml

public java.lang.String toXml()

toXml

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

setSecretSessionId

public void setSecretSessionId(java.lang.String id)

setSessionName

public void setSessionName(SessionName sessionName)

addServerRef

public void addServerRef(ServerRef addr)
Adds a server reference


getServerRef

public ServerRef getServerRef()

removeServerRef

public boolean removeServerRef(java.lang.String type)
Returns:
true If the entry of protocol given by type was found and removed

getSessionQos

public SessionQos getSessionQos()

getSecretSessionId

public java.lang.String getSecretSessionId()

getSessionName

public SessionName getSessionName()

getUserId

public java.lang.String getUserId()

setReconnected

public void setReconnected(boolean reconnected)
If reconnected==true a client has reconnected to an existing session


isReconnected

public boolean isReconnected()
Returns:
true A client has reconnected to an existing session

getServerInstanceId

public java.lang.String getServerInstanceId()
Unique id of the xmlBlaster server, changes on each restart. If 'node/heron' is restarted, the instanceId changes.

Returns:
nodeId + timestamp, '/node/heron/instanceId/33470080380'

setServerInstanceId

public void setServerInstanceId(java.lang.String instanceId)
Unique id of the xmlBlaster server, changes on each restart. If 'node/heron' is restarted, the instanceId changes.

Parameters:
instanceId - e.g. '/node/heron/instanceId/33470080380'

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.