|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.util.qos.SessionQos
public final class SessionQos
This class encapsulates the qos of session attributes of a login() or connect().
ConnectQosSaxFactory
,
org.xmlBlaster.test.classtest.ConnectQosTest
,
Serialized FormField Summary | |
---|---|
static int |
DEFAULT_maxSessions
Maximum of ten parallel logins for the same client "session.maxSessions 10" |
protected 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). |
Constructor Summary | |
---|---|
SessionQos(Global glob)
Constructor for client side. |
|
SessionQos(Global glob,
NodeId nodeId)
Constructor for cluster server. |
Method Summary | |
---|---|
boolean |
clearSessions()
If clearSessions is true, all old sessions of this user are discarded. |
void |
clearSessions(boolean clear)
If clearSessions is true, all old sessions of this user are discarded. |
java.lang.Object |
clone()
Returns a shallow clone, you can change safely all basic or immutable types like boolean, String, int. |
int |
getMaxSessions()
If maxSession == 1, only a single login is possible |
long |
getPublicSessionId()
The public session ID to support reconnect to an existing session. |
java.lang.String |
getSecretSessionId()
Get our secret session identifier which authenticates us for xmlBlaster. |
SessionName |
getSessionName()
Get our unique SessionName. |
long |
getSessionTimeout()
Timeout until session expires if no communication happens |
boolean |
hasPublicSessionId()
|
boolean |
isSessionNameModified()
|
boolean |
reconnectSameClientOnly()
|
PropBoolean |
reconnectSameClientOnlyProp()
|
void |
setMaxSessions(int max)
If maxSession == 1, only a single login is possible |
void |
setReconnectSameClientOnly(boolean reconnectSameClientOnly)
|
void |
setSecretSessionId(java.lang.String id)
Set our session identifier which authenticates us for xmlBlaster. |
void |
setSessionName(SessionName sessionName)
Set our unique SessionName. |
void |
setSessionTimeout(long timeout)
Timeout until session expires if no communication happens |
java.lang.String |
toString()
Converts the data into a valid XML ASCII string. |
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 |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_maxSessions
protected PropBoolean reconnectSameClientOnly
Constructor Detail |
---|
public SessionQos(Global glob)
public SessionQos(Global glob, NodeId nodeId)
nodeId
- The the unique cluster node id, supports configuration per nodeMethod Detail |
---|
public final long getSessionTimeout()
public final void setSessionTimeout(long timeout)
timeout
- The login session will be destroyed after given milliseconds.public final int getMaxSessions()
public final void setMaxSessions(int max)
max
- How often the same client may loginpublic final boolean clearSessions()
public void clearSessions(boolean clear)
clear
- Defaults to falsepublic void setReconnectSameClientOnly(boolean reconnectSameClientOnly)
Set
- if we allow multiple updates for the same message if we have subscribed multiple times to it.public boolean reconnectSameClientOnly()
public PropBoolean reconnectSameClientOnlyProp()
public void setSecretSessionId(java.lang.String id)
id
- The unique and secret sessionIdpublic final java.lang.String getSecretSessionId()
public final long getPublicSessionId()
This is extracted from the sessionName.getPublicSessionId()
public final boolean hasPublicSessionId()
public void setSessionName(SessionName sessionName)
sessionName
- public boolean isSessionNameModified()
public final SessionName getSessionName()
public java.lang.String toString()
toString
in class java.lang.Object
public final java.lang.String toXml()
public final java.lang.String toXml(java.lang.String extraOffset)
extraOffset
- indenting of tags for nice output
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String usage()
|
xmlBlaster 2.2.0 client API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |