Inheritance diagram for org::xmlBlaster::util::key::KeyData:
Public Member Functions | |
KeyData (org::xmlBlaster::util::Global &global) | |
Minimal constructor. | |
KeyData (const KeyData &key) | |
Copy constructor. | |
KeyData & | operator= (const KeyData &key) |
Assignement constructor. | |
virtual | ~KeyData () |
void | setOid (const std::string &oid) |
std::string | getOid () const |
| |
bool | isDeadMessage () const |
Test if oid is '__sys__deadMessage'. | |
bool | isPluginInternal () const |
Messages starting with "_" are reserved for usage in plugins. | |
bool | isInternal () const |
Messages starting with "__" are reserved for internal usage. | |
bool | isAdministrative () const |
Messages starting with "__cmd:" are administrative messages. | |
void | setContentMime (const std::string &contentMime) |
Set mime type (syntax) of the message content. | |
std::string | getContentMime () const |
Find out which mime type (syntax) the content of the message has. | |
void | setContentMimeExtended (const std::string &contentMimeExtended) |
Some further specifying information of the content. | |
std::string | getContentMimeExtended () const |
Some further specifying information of the content. | |
void | setDomain (const std::string &domain) |
Set the domain for this message, can be used for a simple grouping of messages to their master node with xmlBlaster clusters. | |
std::string | getDomain () const |
Access the domain setting. | |
bool | isDefaultDomain () const |
| |
std::string | getQueryType () const |
Access the query type "XPATH" or "EXACT". | |
bool | isExact () const |
bool | isQuery () const |
bool | isXPath () const |
bool | isDomain () const |
int | size () const |
The size in bytes of the data in XML form. | |
virtual std::string | toXml (const std::string &extraOffset) const |
Dump state of this object into a XML ASCII std::string. | |
virtual std::string | toXml () const |
virtual KeyData * | getClone () const |
Allocate a clone, the derived classes need to implement this method. | |
std::string | generateOid (const std::string &uniquePrefix) const |
Generates a unique key oid in scope of a cluster node (on server or on client side). | |
bool | isGeneratedOid () const |
| |
Protected Member Functions | |
void | init () |
void | copy (const KeyData &key) |
Protected Attributes | |
std::string | ME |
org::xmlBlaster::util::Global & | global_ |
org::xmlBlaster::util::I_Log & | log_ |
std::string | oid_ |
value from attribute <key oid="..."> | |
std::string | contentMime_ |
value from attribute <key oid="" contentmime="..."> | |
std::string | contentMimeExtended_ |
value from attribute <key oid="" contentmimeextended="..."> | |
std::string | domain_ |
value from attribute <key oid="" domain="..."> | |
bool | isGeneratedOid_ |
Is the key oid generated? | |
std::string | queryType_ |
The query type. | |
std::string | queryString_ |
The query std::string. |
A typical key could look like this:
<key oid='4711' contentMime='text/xml'> <AGENT id='192.168.124.20' subId='1' type='generic'> <DRIVER id='FileProof' pollingFreq='10'> </DRIVER> </AGENT> </key>
NOTE: Message oid starting with "__" is reserved for internal usage.
NOTE: Message oid starting with "_" is reserved for xmlBlaster plugins.
Definition at line 50 of file KeyData.h.
org::xmlBlaster::util::key::KeyData::KeyData | ( | org::xmlBlaster::util::Global & | global | ) |
org::xmlBlaster::util::key::KeyData::KeyData | ( | const KeyData & | key | ) |
Copy constructor.
org::xmlBlaster::util::key::KeyData::~KeyData | ( | ) | [virtual] |
Definition at line 64 of file KeyData.cpp.
void org::xmlBlaster::util::key::KeyData::init | ( | ) | [protected] |
Definition at line 24 of file KeyData.cpp.
References contentMime_, contentMimeExtended_, org::xmlBlaster::util::key::DEFAULT_DOMAIN, domain_, isGeneratedOid_, oid_, queryString_, queryType_, and org::xmlBlaster::util::key::QUERYTYPE_DEFAULT.
void org::xmlBlaster::util::key::KeyData::copy | ( | const KeyData & | key | ) | [protected] |
Assignement constructor.
void org::xmlBlaster::util::key::KeyData::setOid | ( | const std::string & | oid | ) |
Reimplemented in org::xmlBlaster::util::key::QueryKeyData.
std::string org::xmlBlaster::util::key::KeyData::getOid | ( | ) | const |
Reimplemented in org::xmlBlaster::util::key::MsgKeyData.
Referenced by org::xmlBlaster::util::dispatch::ConnectionsHandler::publish(), and org::xmlBlaster::util::dispatch::ConnectionsHandler::queuePublish().
bool org::xmlBlaster::util::key::KeyData::isDeadMessage | ( | ) | const |
Test if oid is '__sys__deadMessage'.
Dead letters are unrecoverable lost messages, usually an administrator should subscribe to those messages.
This is an internal message (isInternal() returns true)
bool org::xmlBlaster::util::key::KeyData::isPluginInternal | ( | ) | const |
Messages starting with "_" are reserved for usage in plugins.
bool org::xmlBlaster::util::key::KeyData::isInternal | ( | ) | const |
Messages starting with "__" are reserved for internal usage.
bool org::xmlBlaster::util::key::KeyData::isAdministrative | ( | ) | const |
Messages starting with "__cmd:" are administrative messages.
void org::xmlBlaster::util::key::KeyData::setContentMime | ( | const std::string & | contentMime | ) |
Set mime type (syntax) of the message content.
std::string org::xmlBlaster::util::key::KeyData::getContentMime | ( | ) | const |
Find out which mime type (syntax) the content of the message has.
Referenced by org::xmlBlaster::test::TestKeys::testPublishKey().
void org::xmlBlaster::util::key::KeyData::setContentMimeExtended | ( | const std::string & | contentMimeExtended | ) |
Some further specifying information of the content.
For example the application version number the document in the content.
You may use this attribute for you own purposes.
The | MIME-extended info, for example "Version 1.1" in <key oid='' contentMime='text/xml' contentMimeExtended='Version 1.1'> or "" (empty std::string) if not known |
std::string org::xmlBlaster::util::key::KeyData::getContentMimeExtended | ( | ) | const |
Some further specifying information of the content.
For example the application version number the document in the content.
You may use this attribute for you own purposes.
Referenced by org::xmlBlaster::test::TestKeys::testPublishKey().
void org::xmlBlaster::util::key::KeyData::setDomain | ( | const std::string & | domain | ) |
Set the domain for this message, can be used for a simple grouping of messages to their master node with xmlBlaster clusters.
The | domain, any chosen std::string in your problem domain, e.g. "RUGBY" or "RADAR_TRACK" defaults to "" where the local xmlBlaster instance is the master of the message. |
std::string org::xmlBlaster::util::key::KeyData::getDomain | ( | ) | const |
Access the domain setting.
bool org::xmlBlaster::util::key::KeyData::isDefaultDomain | ( | ) | const |
std::string org::xmlBlaster::util::key::KeyData::getQueryType | ( | ) | const |
Access the query type "XPATH" or "EXACT".
bool org::xmlBlaster::util::key::KeyData::isExact | ( | ) | const |
bool org::xmlBlaster::util::key::KeyData::isQuery | ( | ) | const |
bool org::xmlBlaster::util::key::KeyData::isXPath | ( | ) | const |
bool org::xmlBlaster::util::key::KeyData::isDomain | ( | ) | const |
int org::xmlBlaster::util::key::KeyData::size | ( | ) | const |
The size in bytes of the data in XML form.
virtual std::string org::xmlBlaster::util::key::KeyData::toXml | ( | const std::string & | extraOffset | ) | const [virtual] |
Dump state of this object into a XML ASCII std::string.
Needs to be implemented by derived classes.
extraOffset | indenting of tags for nice output |
Reimplemented in org::xmlBlaster::util::key::MsgKeyData, and org::xmlBlaster::util::key::QueryKeyData.
Referenced by org::xmlBlaster::client::protocol::corba::CorbaConnection::copyToCorba(), org::xmlBlaster::util::queue::MsgQueueEntry::getEmbeddedObject(), and org::xmlBlaster::client::protocol::socket::SocketDriver::publish().
virtual std::string org::xmlBlaster::util::key::KeyData::toXml | ( | ) | const [virtual] |
Reimplemented in org::xmlBlaster::util::key::MsgKeyData, and org::xmlBlaster::util::key::QueryKeyData.
virtual KeyData* org::xmlBlaster::util::key::KeyData::getClone | ( | ) | const [virtual] |
Allocate a clone, the derived classes need to implement this method.
Reimplemented in org::xmlBlaster::util::key::MsgKeyData, and org::xmlBlaster::util::key::QueryKeyData.
std::string org::xmlBlaster::util::key::KeyData::generateOid | ( | const std::string & | uniquePrefix | ) | const |
bool org::xmlBlaster::util::key::KeyData::isGeneratedOid | ( | ) | const |
std::string org::xmlBlaster::util::key::KeyData::ME [protected] |
std::string org::xmlBlaster::util::key::KeyData::oid_ [mutable, protected] |
std::string org::xmlBlaster::util::key::KeyData::contentMime_ [protected] |
std::string org::xmlBlaster::util::key::KeyData::contentMimeExtended_ [protected] |
std::string org::xmlBlaster::util::key::KeyData::domain_ [protected] |
bool org::xmlBlaster::util::key::KeyData::isGeneratedOid_ [mutable, protected] |
std::string org::xmlBlaster::util::key::KeyData::queryType_ [protected] |
std::string org::xmlBlaster::util::key::KeyData::queryString_ [protected] |