A constant representing active queues.
const long ACTIVE_QUEUES = 1;
A constant representing the number of active selectors for a topic.
const short ACTIVE_SELECTORS = 10;
A constant representing active topics.
const long ACTIVE_TOPICS = 2;
A constant representing the number of messages available (in memory).
const short AVAILABLE_MESSAGES = 1;
const short AVERAGE_ENTRY_SIZE = 21;
Deprecated.
const short AVERAGE_READER_QUEUE_LENGTH = 8;
A constant representing the average reader thread wait time. This is the average number of seconds that the server is waiting for a reader thread to become available to read from the client's IIOP connection.
const short AVERAGE_READER_WAIT = 8;
Deprecated.
const short AVERAGE_WRITER_QUEUE_LENGTH = 9;
A constant representing the average writer thread wait time. This is the average number of seconds that the server is waiting for a writer thread to become available to write to the client's IIOP connection.
const short AVERAGE_WRITER_WAIT = 9;
A constant representing binary data.
const long BINARY_DATA = 0;
A constant representing a binary value.
const long BINARY_VALUE = 11;
A constant representing a boolean value.
const long BOOLEAN_VALUE = 1;
const short CACHE_ENTRY_COUNT = 1;
const short CACHE_HIT_RATIO = 2;
const short CACHE_HITS = 3;
const short CACHE_MISSES = 4;
const short CACHE_TIMEOUTS = 5;
A constant representing a char value.
const long CHAR_VALUE = 2;
A constant representing configured queues.
const long CONFIGURED_QUEUES = 8;
A constant representing configured topics.
const long CONFIGURED_TOPICS = 16;
A constant bit flag representing a message consumer operation.
const long CONSUMER = 8;
const short CURRENT_CACHE_SIZE = 11;
const long DATA_NOT_FOUND = 1;
A constant representing a date value.
const long DATE_VALUE = 14;
A constant representing a decimal value.
const long DECIMAL_VALUE = 12;
A constant to indicate the 'default' timeout value for receive,
const long DEFAULT_TIMEOUT = -1;
A constant representing the number of messages delivered.
const short DELIVERED_MESSAGES = 2;
A constant representing the number of messages discarded.
const short DISCARDED_MESSAGES = 3;
A constant representing a 9 value.
const long DOUBLE_VALUE = 9;
A constant representing a float value.
const long FLOAT_VALUE = 8;
A constannt message option to indicate that the flush api is being called from the Active Queues, so that the statistics of the Discarded messages will be updated.
const long FLUSH_MESSAGES = 16384;
A constant message option to indicate that a message should be ignored if it is a duplicate of another message that has already been sent to a queue.
const long IGNORE_DUPLICATE_KEY = 32;
const long INSTANCE_VALID = 2;
A constant representing a Java Object value.
const long JAVA_OBJECT_VALUE = 17;
A constant message option for maintaining the original delivery mode for JMS messages.
const long JMS_PERSISTENT = 32768;
A constant message otion to indicate that a transient message should be queued on the local server.
const long LOCAL_SERVER = 2048;
A constant representing a long value.
const long LONG_VALUE = 6;
const short MAXIMUM_CACHE_SIZE = 12;
const short MAXIMUM_ENTRY_SIZE = 23;
A constant representing a message queue.
const long MESSAGE_QUEUE = 1;
A constant representing the message service.
const long MESSAGE_SERVICE = 0;
A constant representing a message topic.
const long MESSAGE_TOPIC = 2;
const short MINIMUM_ENTRY_SIZE = 22;
A constant message otion to indicate that a transient message should be queued on the peers that are part of the local server's mirror group.
const long MIRROR_PEERS = 4096;
A constant representing a money value.
const long MONEY_VALUE = 13;
const long NEW_VALUES = 2;
A constant message option to indicate that a queue or topic should not be implicitly created when a client attempts to access it.
const long NO_IMPLICIT_CREATION = 64;
A constant representing a null value.
const long NULL_VALUE = 0;
const long OBJECT_CACHE = 1;
A constant representing an octet value.
const long OCTET_VALUE = 3;
const long OLD_VALUES = 1;
const long PAGE_CACHE = 2;
A constant message otion to indicate that a transient message should be queued on all of the local server's peers (other cluster members).
const long PEER_SERVERS = 8192;
A constant message option for persistent messages.
const long PERSISTENT = 1;
A constant bit flag representing a message producer operation.
const long PRODUCER = 16;
A constant representing the number of 'publish' calls.
const short PUBLISH_CALLS = 6;
A constant representing the number of messages published. When a message is published to multiple consumers, it is counted multiple times.
const short PUBLISHED_MESSAGES = 4;
const long QUERY_CACHE = 3;
A constant representing a JMS queue connection factory.
const long QUEUE_CONNECTION_FACTORY = 5;
A constant representing the number of 'receive' calls.
const short RECEIVE_CALLS = 5;
A constant message option to indicate that a message may have been redelivered.
const long REDELIVERED = 256;
A constant message option for replicated messages.
const long REPLICATED = 2;
A constant message option for use with messages that must be acknowledged after they are received.
const long REQUIRES_ACKNOWLEDGE = 4;
A constant message option to indicate that operations should be carried out in the caller's transaction - the caller is expected to provide a transaction context when this option is used.
const long REQUIRES_TRANSACTION = 8;
A constant bit flag representing a message security operation.
const long SECURITY = 32;
A constant representing the number of 'send' calls.
const short SEND_CALLS = 7;
A constant representing a short value.
const long SHORT_VALUE = 4;
A constant representing a string value.
const long STRING_VALUE = 10;
A constant message option to indicate that operations should be carried out in the caller's transaction if the caller provides a transaction context.
const long SUPPORTS_TRANSACTION = 512;
A constant representing a thread pool.
const long THREAD_POOL = 4;
A constant representing thread pools.
const long THREAD_POOLS = 4;
A constant representing a time value.
const long TIME_VALUE = 15;
const long TIMESTAMP_ONLY = 3;
A constant representing a timestamp value.
const long TIMESTAMP_VALUE = 16;
A constant representing a JMS topic connection factory.
const long TOPIC_CONNECTION_FACTORY = 6;
A constant message option to indicate that transparent failover should be enabled (when a cluster is available).
const long TRANSPARENT_FAILOVER = 1024;
A constant representing an unsigned long value.
const long ULONG_VALUE = 7;
A constant representing an unsigned short value.
const long USHORT_VALUE = 5;
A constant message option to indicate that a message was not acknowledged.
const long WAS_NOT_ACKNOWLEDGED = 16;
A constant representing a WCHAR value.
const long WCHAR_VALUE = 18;
An exception that is thrown upon failure to create an object.
exception CreateException
{
string message;
};
An exception that is thrown upon failure to find an object.
exception FinderException
{
string message;
};
An exception that is thrown upon failure to remove an object.
exception RemoveException
{
string message;
};
typedef sequence < BCD::Binary > BinarySeq;
struct BinaryValue
{
BCD::Binary value;
boolean isNull;
};
typedef sequence < boolean > BooleanSeq;
struct BooleanValue
{
boolean value;
boolean isNull;
};
typedef sequence < char > CharSeq;
struct CharValue
{
char value;
boolean isNull;
};
typedef sequence < MJD::Date > DateSeq;
struct DateValue
{
MJD::Date value;
boolean isNull;
};
typedef sequence < BCD::Decimal > DecimalSeq;
struct DecimalValue
{
BCD::Decimal value;
boolean isNull;
};
typedef sequence < double > DoubleSeq;
struct DoubleValue
{
double value;
boolean isNull;
};
typedef sequence < float > FloatSeq;
struct FloatValue
{
float value;
boolean isNull;
};
typedef Object HomeInter;
struct LongLongValue
{
long long value;
boolean isNull;
};
typedef sequence < long > LongSeq;
struct LongValue
{
long value;
boolean isNull;
};
A generic message type that uses a sequence of name-value pairs and a text field as the representation for message data.
struct Message
{
CtsComponents::MessageKey key;
CtsComponents::Properties props;
long options;
string replyTo;
string text;
};
Each property appears once. The order of properties in the sequence is not significant.
The following properties may be used to configure delivery options.
| Property | Type | Default Value | Description |
|---|---|---|---|
| priority | short | 0 | -32767 = lowest, 32767 = highest |
| timeout | long | 0 | message timeout in seconds (zero or negative = no timeout) |
The following properties are automatically added (or replaced) when a message is produced.
| Property | Type | Set By |
|---|---|---|
| queue | string | publish, send |
| topic | string | publish |
The options field is automatically set when a message is produced.
The replyTo field should be set to a non-empty string
(usually a queue name) by the message producer if a reply is requested.
The text field is included as a convenience as it is
common for messages (such as XML messages) to be represented as text values.
An opaque value type representing a message key.
struct MessageKey
{
BCD::Binary value;
};
typedef sequence < CtsComponents::MessageKey > MessageKeys;
A collection of messages. Unless otherwise stated, it can be assumed that messages are ordered first by priority, then by delivery time.
typedef sequence < CtsComponents::Message > MessageSeq;
typedef sequence < BCD::Money > MoneySeq;
struct MoneyValue
{
BCD::Money value;
boolean isNull;
};
A structure representing serialized object data.
struct ObjectData
{
long type;
BCD::Binary timestamp;
BCD::Binary binaryData;
BCD::Binary old_binaryData;
};
typedef sequence < octet > OctetSeq;
struct OctetValue
{
octet value;
boolean isNull;
};
struct PageCacheEntry
{
BCD::Binary response;
long timeout;
CtsComponents::PageCacheResponseHeaders headers;
};
struct PageCacheKey
{
string pageURL;
string sessionID;
CtsComponents::Properties requestParamaters;
CtsComponents::Properties requestHeaders;
CtsComponents::Properties sessionAttributes;
CtsComponents::StringSeq locales;
CtsComponents::Properties otherProperties;
};
typedef sequence < CtsComponents::PageCacheKey > PageCacheKeys;
typedef sequence < CtsComponents::PageCache > PageCacheList;
typedef sequence < CtsComponents::StringSeq > PageCacheResponseHeaders;
A collection of name-value pairs.
typedef sequence < CtsComponents::Property > Properties;
A name-value pair.
struct Property
{
string name;
CtsComponents::PropertyValue value;
};
A discriminated union type that can be used to represent values of primitive IDL types, common business data types, and null values.
union PropertyValue switch (long)
{
case NULL_VALUE: long nullValue;
case BOOLEAN_VALUE: boolean booleanValue;
case CHAR_VALUE: char charValue;
case OCTET_VALUE: octet octetValue;
case SHORT_VALUE: short shortValue;
case USHORT_VALUE: unsigned short ushortValue;
case LONG_VALUE: long longValue;
case ULONG_VALUE: unsigned long ulongValue;
case FLOAT_VALUE: float floatValue;
case DOUBLE_VALUE: double doubleValue;
case STRING_VALUE: string stringValue;
case BINARY_VALUE: BCD::Binary binaryValue;
case DECIMAL_VALUE: BCD::Decimal decimalValue;
case MONEY_VALUE: BCD::Money moneyValue;
case DATE_VALUE: MJD::Date dateValue;
case TIME_VALUE: MJD::Time timeValue;
case TIMESTAMP_VALUE: MJD::Timestamp timestampValue;
case JAVA_OBJECT_VALUE: BCD::Binary javaObjectValue;
case WCHAR_VALUE: wchar wcharValue;
};
struct QueryCacheEntry
{
CtsComponents::BinarySeq results;
long timeout;
};
struct QueryCacheKey
{
string query;
CtsComponents::Properties parameters;
};
typedef sequence < CtsComponents::QueryCacheKey > QueryCacheKeys;
typedef sequence < CtsComponents::QueryCache > QueryCacheList;
typedef Object RemoteInterface;
An opaque value type representing a request key.
struct RequestKey
{
BCD::Binary value;
};
typedef sequence < short > ShortSeq;
struct ShortValue
{
short value;
boolean isNull;
};
An opaque value type representing a storage key.
struct StorageKey
{
BCD::Binary value;
};
typedef sequence < string > StringSeq;
struct StringValue
{
string value;
boolean isNull;
};
typedef sequence < MJD::Time > TimeSeq;
typedef sequence < MJD::Timestamp > TimestampSeq;
struct TimestampValue
{
MJD::Timestamp value;
boolean isNull;
};
struct TimeValue
{
MJD::Time value;
boolean isNull;
};
struct ULongLongValue
{
unsigned long long value;
boolean isNull;
};
typedef sequence < unsigned long > ULongSeq;
struct ULongValue
{
unsigned long value;
boolean isNull;
};
typedef sequence < unsigned short > UShortSeq;
struct UShortValue
{
unsigned short value;
boolean isNull;
};