org::xmlBlaster::util::SessionName Class Reference

Inheritance diagram for org::xmlBlaster::util::SessionName:

Inheritance graph
[legend]
Collaboration diagram for org::xmlBlaster::util::SessionName:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SessionName (org::xmlBlaster::util::Global &global, std::string &absoluteName="")
 When using this constructor you can let it assign the defaults by passing an empty std::string as the 'absoluteName' argument, or you force the SessionName to set the SessionName to what you specify in the 'absoluteName' argument.
 SessionName (org::xmlBlaster::util::Global &global, std::string &defaultUserName, long publicSessionId)
 is the name to use as a default for the user (the subjectId).
 SessionName (SessionName &data)
SessionNameoperator= (SessionName &data)
virtual ~SessionName ()
void setAbsoluteName (std::string &name)
 Sets the absolute name.
std::string getRelativeName ()
std::string getRelativeName (bool forceSessionMarker)
std::string getAbsoluteName ()
std::string getClusterNodeId ()
void setClusterNodeId (std::string &clusterNodeId)
std::string getSubjectId ()
void setSubjectId (std::string &subjectId)
long getPubSessionId ()
void setPubSessionId (long pubSessionId)
bool useSessionMarker ()
std::string getSecretSessionId ()
void setSecretSessionId (std::string &sessionId)
std::string toXml (std::string &extraOffset="")

Detailed Description

Definition at line 19 of file SessionName.h.


Constructor & Destructor Documentation

org::xmlBlaster::util::SessionName::SessionName ( org::xmlBlaster::util::Global global,
std::string &  absoluteName = "" 
)

When using this constructor you can let it assign the defaults by passing an empty std::string as the 'absoluteName' argument, or you force the SessionName to set the SessionName to what you specify in the 'absoluteName' argument.

Parameters:
absoluteName the sessionId to assign to this SessionName. You can either pass an absolute name, or a relative name or an empty std::string.

org::xmlBlaster::util::SessionName::SessionName ( org::xmlBlaster::util::Global global,
std::string &  defaultUserName,
long  publicSessionId 
)

is the name to use as a default for the user (the subjectId).

It is stronger than the properties set but if an empty std::string is used, then the default name is taken from the 'user' property. This is just a default and as such it is weaker than the property 'session.name'. In other words, even if defaultUserName is not empty, it will be overwritten by eventual setting of the property 'session.name'.

is the public sessionId to be used. Note that this is just a suggestion, so if you have the 'session.name' property set, it will overwrite this. If the publicSessionId is '0', then it is omitted (the server will assign one for you).

org::xmlBlaster::util::SessionName::SessionName ( SessionName data  ) 

Definition at line 77 of file SessionName.cpp.

org::xmlBlaster::util::SessionName::~SessionName (  )  [virtual]

Definition at line 35 of file SessionName.cpp.


Member Function Documentation

SessionName & org::xmlBlaster::util::SessionName::operator= ( SessionName data  ) 

Definition at line 82 of file SessionName.cpp.

void org::xmlBlaster::util::SessionName::setAbsoluteName ( std::string &  name  ) 

Sets the absolute name.

Note that you can overwrite the nodeId here. It returns 'true' if the name was absolute, 'false' otherwise.

string org::xmlBlaster::util::SessionName::getRelativeName (  ) 

Definition at line 147 of file SessionName.cpp.

Referenced by getAbsoluteName().

string org::xmlBlaster::util::SessionName::getRelativeName ( bool  forceSessionMarker  ) 

Definition at line 152 of file SessionName.cpp.

References org::xmlBlaster::util::lexical_cast().

string org::xmlBlaster::util::SessionName::getAbsoluteName (  ) 

Definition at line 164 of file SessionName.cpp.

References getRelativeName().

string org::xmlBlaster::util::SessionName::getClusterNodeId (  ) 

Definition at line 170 of file SessionName.cpp.

void org::xmlBlaster::util::SessionName::setClusterNodeId ( std::string &  clusterNodeId  ) 

string org::xmlBlaster::util::SessionName::getSubjectId (  ) 

Definition at line 180 of file SessionName.cpp.

void org::xmlBlaster::util::SessionName::setSubjectId ( std::string &  subjectId  ) 

long org::xmlBlaster::util::SessionName::getPubSessionId (  ) 

Definition at line 190 of file SessionName.cpp.

void org::xmlBlaster::util::SessionName::setPubSessionId ( long  pubSessionId  ) 

Definition at line 195 of file SessionName.cpp.

bool org::xmlBlaster::util::SessionName::useSessionMarker (  ) 

Definition at line 82 of file SessionName.h.

Referenced by org::xmlBlaster::test::TestConnectQos::TestConnectQos(), org::xmlBlaster::test::TestDoubleGlobal::TestDoubleGlobal(), and org::xmlBlaster::test::TestFailsafe::TestFailsafe().

std::string org::xmlBlaster::util::SessionName::getSecretSessionId (  ) 

void org::xmlBlaster::util::SessionName::setSecretSessionId ( std::string &  sessionId  ) 

std::string org::xmlBlaster::util::SessionName::toXml ( std::string &  extraOffset = ""  ) 


The documentation for this class was generated from the following files: