|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.engine.qos.ConnectQosServer
public final class ConnectQosServer
This class encapsulates the qos of a connect() invocation.
ConnectQosSaxFactory
,
connect interfaceField Summary | |
---|---|
private AddressServer |
addressServer
The address information got from the protocol plugin. |
private boolean |
allowExceptionsThrownToClient
E.g. |
private boolean |
bypassCredentialCheck
|
private ConnectQosData |
connectQosData
|
private long |
persistenceUniqueId
|
private boolean |
sessionLimitsPubSessionIdSpecific
defaults to false If true the pubSessionId<0 and pubSessionId>0 can have different maxSessions and clearSession specified TODO: make configurable from client side and in xmlBlaster.properties currently you can only manipulate it using a security plugin I_Session.init(ConnectQosServer, java.util.Map) |
Constructor Summary | |
---|---|
ConnectQosServer(Global glob,
ConnectQosData connectQosData)
|
|
ConnectQosServer(Global glob,
java.lang.String xmlQos)
|
Method Summary | |
---|---|
void |
addCallbackAddress(CallbackAddress callback)
Add a callback address where to send the message (for PtP or subscribes). |
boolean |
allowExceptionsThrownToClient()
|
boolean |
bypassCredentialCheck()
|
void |
bypassCredentialCheck(boolean bypassCredentialCheck)
Tell authenticate to not check the password. |
boolean |
clearSessions()
If clearSessions is true, all old sessions of this user are discarded. |
boolean |
duplicateUpdates()
|
AddressServer |
getAddressServer()
The address information got from the protocol plugin. |
java.lang.String |
getClientPluginType()
Return the type of the referenced SecurityPlugin. |
java.lang.String |
getClientPluginVersion()
Return the version of the referenced SecurityPlugin. |
ConnectQosServer |
getClone(Global newGlob)
Serialize first to have a clone for security reasons (and to guarantee our Global). |
ConnectQosData |
getData()
|
int |
getMaxSessions()
|
long |
getPersistenceUniqueId()
|
I_SecurityQos |
getSecurityQos()
|
CbQueueProperty |
getSessionCbQueueProperty()
Returns never null |
SessionName |
getSessionName()
|
SessionQos |
getSessionQos()
|
long |
getSessionTimeout()
Timeout until session expires if no communication happens |
CbQueueProperty |
getSubjectQueueProperty()
Returns never null. |
java.lang.String |
getUserId()
|
boolean |
hasPublicSessionId()
|
boolean |
isClusterNode()
|
boolean |
isFromPersistenceRecovery()
Marker if the message comes from persistent store after recovery. |
void |
isFromPersistenceRecovery(boolean fromPersistenceRecovery)
|
boolean |
isPtpAllowed()
|
boolean |
isSessionLimitsPubSessionIdSpecific()
|
I_ClientPlugin |
loadClientPlugin(java.lang.String mechanism,
java.lang.String version,
java.lang.String loginName,
java.lang.String passwd)
Allows to set or overwrite the parsed security plugin. |
void |
setAddress(Address address)
Set the address to which we want to connect, with all the configured parameters. |
void |
setAddressServer(AddressServer addressServer)
The address information got from the protocol plugin. |
void |
setAllowExceptionsThrownToClient(boolean allowExceptionsThrownToClient)
Can be set by e.g. |
void |
setDuplicateUpdates(boolean duplicateUpdates)
|
void |
setPersistenceUniqueId(long persistenceUniqueId)
|
void |
setPtpAllowed(boolean ptpAllowed)
|
void |
setSessionCbQueueProperty(CbQueueProperty prop)
Adds a queue description. |
void |
setSessionLimitsPubSessionIdSpecific(boolean sessionLimitsPubSessionIdSpecific)
|
void |
setSessionName(SessionName sessionName)
Set the login session name. |
void |
setSessionTimeout(long timeout)
Timeout until session expires if no communication happens |
void |
setUserId(java.lang.String loginName)
Allows to set or overwrite the login name for I_SecurityQos. |
java.lang.String |
toString()
Converts the data into a valid XML ASCII string. |
java.lang.String |
toXml()
Converts the data into a valid XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset)
Dump state of this object into a XML ASCII string. |
java.lang.String |
toXml(java.lang.String extraOffset,
java.util.Properties props)
Dump state of this object into a XML ASCII string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private final ConnectQosData connectQosData
private boolean bypassCredentialCheck
private boolean sessionLimitsPubSessionIdSpecific
I_Session.init(ConnectQosServer, java.util.Map)
private long persistenceUniqueId
private AddressServer addressServer
private boolean allowExceptionsThrownToClient
Constructor Detail |
---|
public ConnectQosServer(Global glob, ConnectQosData connectQosData)
public ConnectQosServer(Global glob, java.lang.String xmlQos) throws XmlBlasterException
XmlBlasterException
Method Detail |
---|
public ConnectQosServer getClone(Global newGlob) throws XmlBlasterException
glob
- Use the new Global for the returned clone
XmlBlasterException
public ConnectQosData getData()
public void setAddressServer(AddressServer addressServer)
addressServer
- The address information of the current protocol pluginpublic AddressServer getAddressServer()
public void bypassCredentialCheck(boolean bypassCredentialCheck)
public boolean bypassCredentialCheck()
public void isFromPersistenceRecovery(boolean fromPersistenceRecovery)
public long getPersistenceUniqueId()
public void setPersistenceUniqueId(long persistenceUniqueId)
public boolean isFromPersistenceRecovery()
public SessionQos getSessionQos()
public int getMaxSessions()
public boolean clearSessions()
public long getSessionTimeout()
public void setSessionTimeout(long timeout)
public boolean hasPublicSessionId()
public void setSessionName(SessionName sessionName)
public SessionName getSessionName()
public void setUserId(java.lang.String loginName) throws XmlBlasterException
This will call setSessionName() as well if sessionName is not set yet.
loginName
- The unique user id
XmlBlasterException
public java.lang.String getUserId()
public I_ClientPlugin loadClientPlugin(java.lang.String mechanism, java.lang.String version, java.lang.String loginName, java.lang.String passwd) throws XmlBlasterException
mechanism
- The client side security plugin to usepasswd
- If null the environment -passwd is checked
XmlBlasterException
public I_SecurityQos getSecurityQos()
public java.lang.String getClientPluginType()
public java.lang.String getClientPluginVersion()
public void setPtpAllowed(boolean ptpAllowed)
Set
- if we accept point to point messagespublic boolean isPtpAllowed()
public void setDuplicateUpdates(boolean duplicateUpdates)
Set
- if we allow multiple updates for the same message if we have subscribed multiple times to it.public boolean duplicateUpdates()
public void setAddress(Address address)
address
- An object containing the protocol (e.g. EMAIL) the address (e.g. hugo@welfare.org) and the connection propertiespublic void addCallbackAddress(CallbackAddress callback)
callback
- An object containing the protocol (e.g. EMAIL) and the address (e.g. hugo@welfare.org)public void setSessionCbQueueProperty(CbQueueProperty prop)
prop
- The property object of the callback queue which shall be established in the server for calling us back.CallbackAddress
public CbQueueProperty getSessionCbQueueProperty()
public CbQueueProperty getSubjectQueueProperty()
public boolean isClusterNode()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toXml(java.lang.String extraOffset)
extraOffset
- indenting of tags for nice output
public java.lang.String toXml(java.lang.String extraOffset, java.util.Properties props)
extraOffset
- indenting of tags for nice outputflag
- For example Constants.TOXML_NOSECURITY
public java.lang.String toXml()
public boolean isSessionLimitsPubSessionIdSpecific()
public void setSessionLimitsPubSessionIdSpecific(boolean sessionLimitsPubSessionIdSpecific)
public boolean allowExceptionsThrownToClient()
public void setAllowExceptionsThrownToClient(boolean allowExceptionsThrownToClient)
allowExceptionsThrownToClient
-
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |