Contains MBeans related messaging Sub System which includes PubSub Sub System, Topics, Ptp Sub System, Queues & Connection Consumers.

Connection-Consumer

Attributes of FileDBManager

Fiorano.mq.connection-consumer.FileDBManager:ServiceType=FileDBManager, Name=FileDBManager5,type=config

Path
Description: Path for Initialization of FileBased dataStorage
Type: java.lang.String
Access: RW
Default Value: CONN_CONSUMER

DeletedThresholdPercent
Description: Threshold percentage of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 50

DeletedThresholdCount
Description: Threshold count of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 10

DbTableNamePrefix
Description: Prefix of file based DB table names
Type: java.lang.String
Access: RW
Default Value: #

Pubsub

Attributes of PubSub-Databases (FileDBManager4)

Fiorano.mq.pubsub.databases.file.FileDBManager:ServiceType=FileDBManager,Name=FileDBManager4,type=config

Path
Description: Path for Initialization of FileBased dataStorage
Type: java.lang.String
Access: RW
Default Value: PUBSUB

DeletedThresholdPercent
Description: Threshold percentage of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 50

DeletedThresholdCount
Description: Threshold count of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 10

DbTableNamePrefix
Description: Prefix of file based DB table names
Type: java.lang.String
Access: RW
Default Value: #

Attributes of PubSub-Databases (FileDBManager7)

Fiorano.mq.pubsub.databases.file.FileDBManager:ServiceType=FileDBManager,Name=FileDBManager7,type=config

Path
Description: Path for Initialization of FileBased dataStorage
Type: java.lang.String
Access: RW
Default Value: PSQ

DeletedThresholdPercent
Description: Threshold percentage of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 50

DeletedThresholdCount
Description: Threshold count of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 10

DbTableNamePrefix
Description: Prefix of file based DB table names
Type: java.lang.String
Access: RW
Default Value: #

Attributes of PubSub-Databases (FileDBManager8)

Fiorano.mq.pubsub.databases.file.FileDBManager:ServiceType=FileDBManager,Name=FileDBManager8,type=config

Path
Description: Path for Initialization of FileBased dataStorage
Type: java.lang.String
Access: RW
Default Value: LVC/Topics

DeletedThresholdPercent
Description: Threshold percentage of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 50

DeletedThresholdCount
Description: Threshold count of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 10

DbTableNamePrefix
Description: Prefix of file based DB table names
Type: java.lang.String
Access: RW
Default Value: #

Attributes of PubSub-Databases (FileDBManager9)

Fiorano.mq.pubsub.databases.file.FileDBManager:ServiceType=FileDBManager,Name=FileDBManager9,type=config

Path
Description: Path for Initialization of FileBased dataStorage
Type: java.lang.String
Access: RW
Default Value: LVC/Subscribers

DeletedThresholdPercent
Description: Threshold percentage of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 50

DeletedThresholdCount
Description: Threshold count of deleted Entries for starting Cache Compaction Process
Type: int
Access: RW
Default Value: 10

DbTableNamePrefix
Description: Prefix of file based DB table names
Type: java.lang.String
Access: RW
Default Value: #

Attributes of PubSub-Databases (TgmsManager)

Fiorano.mq.pubsub.databases.file:ServiceType=TgmsManager,Name=TgmsManager

InMemoryBufferSize
Description: Specifies the current message buffer size in bytes
Type: int
Access: RO
Default Value: 0

Fiorano.mq.pubsub.databases.file:ServiceType=TgmsManager,Name=TgmsManager,type=config
Attributes:

MaxBufferSize
Description: Specifies maximum buffer size for in memory message caching
Type: int
Access: RW
Default Value: 524288

Attributes of PubSub – Topics

Fiorano.mq.pubsub.Topics:ServiceType=Topic,Name="PRIMARYTOPIC"

Icon

It's a runtime MBean. Other Topic runtime MBeans could be accessed by assigning corresponding topic-name to the property "name" of ObjectName.

Declaring the ObjectNames by setting Topic values to a variable

NumberOfActiveConsumers
Description: Number of active consumers on this destination
Type: int
Access: RO

NumberOfActiveProducers
Description: Number of active producers on this destination
Type: int
Access: RO

NumberOfPassiveDurableConsumers
Description: Number of passive durable consumers on this destination
Type: int
Access: RO

Operations of PubSub - Topics

Declaring the ObjectNames by setting Topic values to a variable:

Operations

Icon

getNumberOfMessagesInBound
getRateOfMessagesInBound

To perform the above operations when the MessageMonitoring is enabled. Follow the following steps:

Set the enableMessageMonitoring flag to 'true'.
Set the filepath of the SubSystem to 'null'.

Operations

Icon

compactLastValueCacheStore
resetLastValueCache

To perform the above operations, the LastValueCache is to be set to 'true'. Set the EnableLastValueCache attribute to 'true' to perform the operation.

boolean isSnooperEnabled()
Description: Finds whether Snooper is enabled for this Topic
Return Type: boolean

Vector listDurableSubscribers()
Description: Gets durable subscriber for this topic
Return Type: java.util.Vector
Each element contains single string of format "ClientId=<CLIENT ID>, SubscriberId=<SUBSCRIBER ID>".
For example, if CLIENT ID is "DS_CLI1" & SUBSCRIBER ID is "DS_1" then the corresponding String would be "ClientId=DS_CLI1,SubscriberId=DS_1".

void enableSnooper(String enableSnooper)
Description: possible values are TRUE,FALSE,DEFAULT
Parameters: name="enableSnooper" type="String"

Vector listNonDurableSubscribers()
Description: Gets all non-durable subscribers for this Topic
Return Type: java.util.Vector
Each element contains single string of format "SubscriberId=<FIORANO_CONSUMERID>, ConnectionClientId=<CONNECTION_CLIENT_ID>, ConnectionHashCode=<CONNECTION_HASH_CODE>".

String getNumberOfMessagesInBound()
Description: Returns the number of messages pushed in the topic. Applies only when 'EnableMessageMonitoring' is set to true in the Topic Subsystem.
Return Type: java.lang.String

String getRateOfMessagesInBound()
Description: Returns the rate at which messages are pushed in the topic. Applies only when 'EnableMessageMonitoring' is set to true in the Topic Subsystem.
Return Type: java.lang.String

ArrayList getMessageMonitoringData()
Description: Returns the MessageMonitoring Data in tabular format
Return Type: java.util.ArrayList.
Structure of the elements of array list is: Time,IncomingMsgs(Value-firstValue),RateOfIncomingMsgs (Value-firstValue)

Vector listSubscribers()
Description: Gets all Subscribers for this Topic.
Return Type: java.util.Vector

Vector listPublishers()
Description: This will return the list of publishers created on that particular topic.
Return Type: java.util.Vector

TopicMetaData getMetaData()
Description: TopicMetaData object related to this object
Return Type: Topic Metadata Object

compactLastValueCacheStore
Description: Compacts the LV-Cache data store for the underlying topic.
Return Type: boolean

resetLastValueCache
Description: Resets the LV-Cache on the underlying topic. Clears the data store and in-memory buffers used for LastValue Caching.
Return Type: boolean

listSharedConsumers(durable)
Description: Lists shared consumers on the topic.
Parameters: name=”durable” type=”boolean” description=”Durable property”

getCumulativeNumberOfMessagesInBound()
Description: Returns the number of messages pushed into the topic since the server start.

shutdown(reason)
Description: This operation shuts down the topic.
Parameters: name="reason" type="java.lang.String"

restart(reason)
Description: This operation shuts down the topic and restarts it.
Parameters: name="reason" type="java.lang.String"

Attributes of PubSub – Topics ( Config )

Fiorano.mq.pubsub.Topics:ServiceType=Topic,Name="PRIMARYTOPIC",type=config

Declaring the ObjectNames by setting Topic values to a variable

PurgeLevelIndex
Description: Number of persistent messages after which purging is to be done.
Type: int
Access: RW
Default Value: 100

EnableJournaling
Description: Specifies whether Journaling Service is enabled on this Topic.
Type: boolean
Access: RO
Default Value: false

MaxPublisherBlockTime
Description: This is the maximum time for which a Publisher will wait while trying to push the messages to the PSQ after it has reached 95% of its max limit.
Type: int
Access: RW
Default Value: 120000

PublishBackoffThreshold
Description: Threshold on PSQ size for backoff algo to kick-in. Once the threshold is reached then flow-control will start the Publishers will be made to wait/block for the buffers to clear. The value indicates the factor after which Publisher needs to slowdown. Calculates as, PSQ size > factor* MaxPersistentSize
Type: double
Access: RW
Default Value: 0.6

PublishWait
Description: Minimum Wait time before RTL sends next publish call, in case of slow down. The actual time is calculated by a backoff algo depending on the current size of the PSQ and PublishBackoffThreshold value.
Type: int
Access: RW
Default Value: 50

PublishWaitTimeRecheckUnits
Description: Singular wait parameter for flow control algo. Whenever the PSQ size reaches 95% then the publisher is made to wait repeatedly until the size drop downs to 85%. The MaxWaitTime is distributed into chunks after which it again checks the size of the PSQ.

Icon

This flag may be used when there are a certain number of slow subscribers in use.

Type: int
Access: RW
Default Value: 8

EnablePublisherSlowdown
Description: Whether slowdown the publisher when message is stored in disk after session buffer overflows due to slow subscriber and the PSQ size has reached its threshold value. Setting this parameter to false may lead to message loss for slow subscribers.
Type: boolean
Access: RW
Default Value: true

StoreMessageToDisk
Description: Store message to disk when session buffer overflows due to slow subscriber. The messages will be stored in the PSQ only when this is set to true. In case it is set to false then the messages will be directly added to the ConnectionBuffer which will lead to extreme slowdown of publishers and message loss in extreme cases.
Type: boolean
Access: RW
Default Value: true

MaxPersistentStoreSize
Description: Maximum size of the persistent queue in disk. It will be ignored if set to -1, that is, Infinite. If EnablePublisherSlowDown is enabled then this limit will never be reached, and in case that is disabled then any NP messages coming in after the limit has exceeded will be dropped. In case IgnorePSQSizeForPersistentMessages is also disabled at the same time then even Persistent Messages will be dropped after the limit has reached. This buffer is popularly known as PSQ and applies to each Session of a slow subscriber.
Type: long
Access: RW
Default Value: 1073741824

DropOldestMessage
Description: Flag indicating whether oldest message should be dropped or the latest message should be dropped after persistent storage size(PSQ) crosses the maximum value and all the server buffers are filled. Generally this situation comes only when PublisherSlowDown is disabled on the server and slow subscribers are active.
Type: boolean
Access: RW
Default Value: true

IgnorePSQSizeForPersistentMessages
Description: Whether to persist persistent messages in PSQ even through the PSQ is full. If set to 'true', then even if the PSQ size exceeds the MaxPersistentStoreSize, still the messages will be stored to disk.
Type: boolean
Access: RW
Default Value: true

IsForceFullyKillDSubscriber
Description: Allow forcefully killing of Durable Subscriber. If set to true, then if a new Durable Subscriber is getting registered with the server whose Subscription ID is already present as active with the server then the Former Durable Subscriber will be forcefully killed and the later will be successfully registered with the server.
Type: boolean
Access: RW
Default Value: false

MinPurgeDifference
Description: Minimum Number of persistent messages after which purging can be done.
Type: int
Access: RW
Default Value: 50

AllowDeletionOfSubtopics
Description: Boolean determining if deletion of Subtopics is allowed
Type: boolean
Access: RW
Default Value: false

MessagePublishTimeout
Description: This is the maximum time for which a Publisher will wait while trying to push the messages to a connection level buffer when it is full. It mainly applies to NP messages as for Persistent Messages the wait never ends until buffer reaches 85% again.
Type: int
Access: RW
Default Value: 120000

EnableSnooper
Description: specifies whether Snooper Service is enabled on this topic
Type: java.lang.String
Access: RW
Default Value: "DEFAULT"

EnableLastValueCache
Description: This parameter determines whether to enable LV-Caching on the corresponding JMS Topic.
Type: boolean
Access: RW
Default Value: false

CacheKeyPropertyName
Description: This parameter determines the property name used to define the LV-Cache Key, in the JMS Message, using which the message is stored in the Topic's LV-Cache.
Type: java.lang.String
Access: RW
Default Value: "LVCacheKey"

CachePropertyName
Description: This parameter determines the property name used to define whether the JMS Message should be considered to be stored in the Topic's LV-Cache.
Type: java.lang.String
Access: RW
Default Value: "IsLVCache"

ParConsumptionLVCache
Description: This parameter determines whether to enable parallel consumption of LV-Cache messages from Subscriber's copy. If set to false, the consumption of messages will start only after the Subscriber completely copies the Topic's LV-Cache copy.
Type: boolean
Access: RW
Default Value: false

RedeliveryTriesOnListenerException
Description: Parameter specifying a number of redelivery tries when RuntimeException is thrown in a Message Listener.
This is used in AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE mode only. The redelivered message is discarded once this value is reached. This applies to all the subscribers
Type: int
Access: RW
Default Value: 2

DelayInMsgDeliveryOnListenerException
Description: Parameter specifying the delay in Message redelivery when RuntimeException is thrown in a Message Listener.
This is used in AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE mode only. The redelivered message is discarded once max redeliver tries value is reached
Type: long
Access: RW
Default Value: -1, which means there is no delay

HandlingDBCorruptionEnabled
Description: Specifies whether DB Corruption is enabled on this topic.
Default Value: Default
Possible Values: Default, True, False.

Operations of PubSub – TopicConnections

Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientID>

Operations

Icon

getNumberOfMessagesInBound
getRateOfMessagesInBound

To perform the above operations when the MessageMonitoring is enabled. Follow the following steps:

Set the enableMessageMonitoring flag to 'true'.
Set the filepath of the SubSystem to 'null'.

getNumberOfProducers()
Description: Returns the number of producers for the client connection
Type: int
Access: RO

getNumberOfConsumers()
Description: Returns the number of consumers for the client connection
Type: int
Access: RO

getNumberOfBrowsers()
Description: Returns the number of browsers for the client connection
Type: int
Access: RO

int getBufferSize()
Description: Pending data size for this Handle in bytes
Type: int
Access: RO

int getSize()
Description: Pending message count
Type: int
Access: RO

int getUpperBuffSizeThreshold()
Description: Upper threshold for message buffer. Flow control algo comes into act as soon as this limit reaches
Type: int
Access: RO

String getClientId()
Description: Client ID assigned to the connection
Type: java.lang.String
Access: RO

InetAddress getClientInetAddress()
Description: Inet Address of the client associated with this connection
Type: java.net.InetAddress
Access: RO

String getClientVersionInfo()
Description: This operation returns the Build number and the version number of that particular client.
Return Type: java.lang.String
Parameters: No parameters required

String getConnectionCreateTime()
Description: Timestamp when the connection was created
Type: java.lang.String
Access: RO

String getUserName()
Description: Username associated with this connection
Type: java.lang.String
Access: RO

Hashtable listAllSessionsWithStates()
Description: List all Sessions in this connection and state of each
Type: java.lang.String
Access: RO

long countMessagesInConnectionQueue()
Description: Returns the number of pending messages in the connection queue buffer
Type: long
Access: RO

void close()
Description: Closes this connection
Type: void
Access: RO

void closeOnDemand(String reason)
Description: Closes this connection on demand.
Type: void
Access: RO

Map<String, Map> listAllSessionsInfo
Description: This operation returns a list of all Topic sessions along with their PSQ metrics.
Return Type: java.util.Map

Parameters: No parameters required.
Key: Session token
Value: Info such as PSQ size, PSQ available message count, and state.

Example

Icon

Key	Value
SessionID_3	{SessionState=PAUSED, PSQMessageCount=190188, PSQSize=20640118}
SessionID_4	{SessionState=PAUSED, PSQMessageCount=44787, PSQSize=4836809}

Operations of PubSub – Topic Connections – FioranoSession

Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientId>,session=FioranoSession

getNumberOfProducers()
Description: Returns the number of producers for the client session
Type: int
Access: RO

getNumberOfConsumers()
Description: Returns the number of consumers for the client session
Type: int
Access: RO

getNumberOfBrowsers()
Description: Returns the number of browsers for the client session
Type: int
Access: RO

getAcknowledgementMode()
Description: Returns the acknowledgement mode for the client session
Type: int
Access: RO

long getPersistentQueueSize()
Description: Returns the current size of the PSQ.
Return Type: long
Parameters: No parameters required.

long getPSQAvailableMessageCount()
Description: Returns the number of messages lying in PSQ.
Return Type: long
Parameters: No parameters required.

void close()
Description: Closes this Session
Type: void

Operations of PubSub – Topic Connections – FioranoSession – FioranoConsumer ( FioranoProducer )

Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientId>,session=FioranoSession,subscriber=FioranoConsumer
Or
Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientId>,session=FioranoSession,publisher=FioranoProducer

Note1

Icon

All the operations which are for the Monitoring purpose, the Message Monitoring flag needs to be set to 'true', that is, set EnableMessageMonitoring to 'true'.

Note 2

Icon

If Durable Subscriber is Active for the corresponding clientID then the value of subscriber need to be the Subscription-Name of Durable-Subscriber.

Use Object name:
Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientId>,session=FioranoSession,subscriber=SUBID

instead of:
Fiorano.mq.pubsub.TopicConnections:ServiceType=TopicConnection,Name=<ClientId>,session=FioranoSession,subscriber=FioranoConsumer

getMessageSelectors()
Description: Returns the message selector with which the consumer has been created.
Type: java.util.Enumeration
Access: RO

int getCountOfDroppedMessages

Description: Returns the number of messages dropped for the subscriber. This counter is enabled if EnableMessageMonitoring is enabled. Some scenarios where the message for a Subscriber is dropped -

When StoreMessageToDisk is set to FALSE, and the Server-side connection level buffers have become full, which means that the PSQ flow-control is disabled for the subscribers.
When the PSQ is enabled for the subscribers and the PSQ size exceeds the maximum limit. In this case, one message is dropped based on the value of the DropOldestMessage parameter.
When the server-side connection level buffers are full and the incoming message is a "DISCARDABLE" Non_Persistent message.

Return Type: int
Access: Read-only

int getNumSubscribedMsgs()
Description: Returns the number of messages subscribed by the subscriber in the specified time
Type: int
Access: RO

void close()
Description: Closes the Subscriber/Publisher
Type: void
Access: RO

int getNumPublishedMsgs()
Description: Returns the number of messages published by this publisher in the specified time
Type: int
Access: RO

Attributes of PubSub – Topic Subsystem

Fiorano.mq.pubsub:ServiceType=PubSubManager,Name=TopicSubSystem

None

Operations of PubSub – Topic Subsystem

Fiorano.mq.pubsub:ServiceType=PubSubManager,Name=TopicSubSystem

boolean getEnableSnooperOnAllTopics()
Description: get SnoopingStatus for all Topics
Return Type: boolean

void setEnableSnooperOnAllTopics(boolean enableSnooper)
Description: Set SnoopingStatus for all Topics
Return Type: void
Parameters: name="enableSnooper" type="boolean"

Vector listClientIDs()
Description: Gets a vector of all the clientIDs
Return Type: java.util.Vector
Each element will have String representation of clientID.

long findNumberOfDeliverableMessages(String clientID, String subscriberID)
Description: Gets the number of messages deliverable (undelivered+redeliverable) for a durable subscription
Return Type: long
Parameters:

name="clientID" type="java.lang.String"
name="subscriberID" type="java.lang.String"

Vector listSubscriberIDs(String clientID)
Description: Gets the list of subscriberIds for given clientId
Return Type: java.util.Vector
Each element will have String representation of SubscriberID.
Parameters: name="clientID" type="java.lang.String"

String findSubscriptionTopicName(String clientID, String subscriberID)
Description: Gets the topicName on which this subscription is created
Return Type: java.lang.String
Parameters:

name="clientID" type="java.lang.String"
name="subscriberID" type="java.lang.String"

String getClientID(TopicSessionToken)
Description: Returns the clientID associated with the topic session token
Return Type: String
Parameters: name="TopicSessionToken" type="int"

void createTopic(String adminObjectName, TopicMetaData metaData)
Description: Creates Topic using given meta data info
Parameters:

name="adminObjectName" type="java.lang.String"
name="metaData" type="fiorano.jms.md.TopicMetaData"

void createTopic(TopicMetaData metaData)
Description: Creates Topic using given meta data info
Parameters: name="metaData" type="fiorano.jms.md.TopicMetaData"

void createTopicConnectionFactory(String adminObjectName, TopicConnectionFactoryMetaData metaData)
Description: Create a new Topic Connection Factory
Parameters:

name="adminObjectName" type="java.lang.String"
name="metaData" type="fiorano.jms.md.TopicConnectionFactoryMetaData"

void createTopicConnectionFactory(TopicConnectionFactoryMetaData metaData)
Description: Create a new Topic Connection Factory
Parameters: name="metaData" type="fiorano.jms.md.TopicConnectionFactoryMetaData"

void createTopicConnectionFactory(String name, String url)
Description: Operation for TCF creation
Parameters:

description = "TCFName" name="name" type="java.lang.String"
description = "lookupURL" name="url" type="java.lang.String"

void unsubscribe(String clientID, String subscriberID)
Description: unsubscribes the durable subscription identified by the pair [clientID, subscriberID]
Parameters:

name="clientID" type="java.lang.String"
name="subscriberID" type="java.lang.String"

void deleteTopicConnectionFactory(String tcf)
Description: Deletes a topic connection factory
Parameters: description = "TCFName" name="name" type="java.lang.String"

void createTopic(String topicName, byte type)
Description: Creates Topic with given name of type 0 - File, 1 - Rdbms
Parameters:

name="topicName" type="java.lang.String"
name="type" type="byte"

void deleteTopic(String topicName)
Description: Delete the given topic
Parameters: name="topicName" type="java.lang.String"

HashMap listAllTopics (boolean includeTemporaryTopics)
Description: Returns a HashMap with key as name of the topic and value as metadata of the topic.
Return Type: HashMap
Parameters: name="includeTemporaryTopics" type="boolean" description="Whether to include temporary topics in the result".

HashMap listAllTopicConnectionFactories()
Description: List all Topics Connection Factories
Return Type: java.util.HashMap
Each element will be a key-value pair where key will be String depicting ConnectionFactory name and value will be corresponding Connection Factory Meta Data.

HashMap listAllXATopicConnectionFactories()
Description: List all XA Topics Connection Factories
Return Type: java.util.HashMap
Each element will be a key-value pair where key will be String depicting XAConnectionFactory name and value will be corresponding XA Connection Factory Meta Data.

void purgeSubscriptionMessages(String clientID, String subscriberID)
Description: deletes all the pending messages for this durable subscription identified by clientID and subscriberID.
Parameters:

name="clientID" type="java.lang.String"
name="subscriberID" type="java.lang.String"

void createXATopicConnectionFactory(String name, String url)
Description: Operation for XATCF creation
Parameters:

description = "TCFName" name="name" type="java.lang.String"
description = "lookupURL" name="url" type="java.lang.String"

void createXATopicConnectionFactory(XATopicConnectionFactoryMetaData metaData)
Description: Create a new XATopic Connection Factory
Parameters: name="XATopicConnectionFactoryMetaData" type="fiorano.jms.md.XATopicConnectionFactoryMetaData"

void deleteXATopicConnectionFactory(String name)
Description: Delete the given xaTopic connection factory
Parameters: name="tcfName" type="java.lang.String"

ArrayList listTopicConsumers()
Description: Lists all Topic Consumers
Return Type: java.lang.ArrayList
Each element of this list will have a format:
[TopicName :: <TOPIC_NAME>, Type: : <Durable/NonDurable>, UserName :: <USER_NAME>, ClientID :: <CLIENT_ID>, SubscriberID :: <SUBSCRIBER_ID>] (Subscriber ID will only exist for Durable Subscribers.)

ArrayList listTopicProducers()
Description: Lists all Topic Producers
Return Type: java.lang.ArrayList
Each element of this list will have a format:
[TopicName :: <TOPIC_NAME>, UserName :: <USER_NAME>, ClientID :: <CLIENT_ID>]

void setEnableJournalingOnTopic(String topicName, boolean enableJournaling)
Description: Set Journaling Status on the Topic. By default, on Snooper Topics such as SYSTEM_MESSAGESNOOPER_TOPIC and SYSTEM_MESSAGESNOOPER_QUEUE and Events topic EVENTS_TOPIC, Journaling is disabled.
Parameters:

topicName = "Name of the topic" type = "java.lang.String"
enableJournaling = "true/false denoting Journaling status is enabled/disabled" type = boolean

boolean getJournalingStatusOnTopic(String topicName)
Description: Get Journaling Status on the Topic.
Return Type: boolean true if Journaling is enabled on the topic, otherwise, false.
Parameters: topicName = "Name of the Topic" type = "java.lang.String"

ArrayList listActivePassiveSubscriberInfo()
Description: Gets the list of subscriberIds active/passive along with thier clientID and states
Return Type: java.util.ArrayList
Each element of this ArrayList will be of format
CLIENT_ID,SUBSCRIBER_ID,ACTIVE/PASSIVE,NumberOfDeliverableMessages,TOPIC_NAME

recheckJournalingStatusOnTopics
Description: Creates the journaling topic corresponding to each topic based on the journaling status.
Return Type: java.lang.Boolean
True - If the operation is successful and the journaling topics are created, otherwise false.
Parameters: No parameters

restart(reason,topicNames)
Description: Restarts the specified Topics
Parameters:

name="reason" type="java.lang.String" description="Reason to restart."
name="topicNames" type="java.util.ArrayList" description="ArrayList of all the topics that need to be restarted."

shutdown(reason,topicNames)
Description: Shuts down the spcecified Queues.
Parameters:

name="reason" type="java.lang.String" description="Reason to shutdown."
name="topicNames" type="java.util.ArrayList" description="ArrayList of all the topics that need to be shutdown."

listSharedConsumers(topicName,durable)
Description: Lists shared consumers on the topic
Parameters:

name=”topicName” type=”java.lang.String” description= Name of the Topic
name=”durable” type=”boolean” description=”Durable property”

getCorruptedTopics()
Description: Returns the list of Corrupted topics.
Return Type: Returns Hash map of corrupted topics.

recoverCorruptedTopics(topicNames)
Description: Recovers the list of corrupted topics.
Parameters: name=”topicNames” type=”java.util.ArrayList” description=”ArrayList of all the topics to be recovered”

deleteTopicCorruptionInstances(topicName, timeStamps)
Description: Deletes the specified corrupted topic instances
Parameters:

name=”topicName” type=”java.lang.String” description=”Name of the topic”
name=”timeStamps” type=”java.util.ArrayList” description=”List of all the topic instances”

recoverSelectedTopicInstances(topicName, topicInstances)
Description: Recovers the specified topic instances
Return Type: Returns the List of all the failed instances that are not recovered.
Parameters:

name="topicName" type="java.lang.String" description="Name of the topic"
name="topicInstances" type="java.util.ArrayList" description="List of all the topic instances"

replayMessagesFromTopic(topicNames)
Description: Replays the messages from topic.
Parameters: name="topicNames" type="java.util.ArrayList" description="ArrayList of all the topics that need to be recovered."

replayMessagesFromTopic(topicName, topicInstances)
Description: Replays the messages from topic instances
Parameters:

name="topicName" type="java.lang.String" description="Name of the topic"
name="topicInstances" type="java.util.ArrayList" description="List of all the topic instances

shutdown(reason)
Description: This operation shuts down the topic.
Parameters: name="reason" type="java.lang.String"

restart(reason)
Description: This operation shuts down the topic and restarts it.
Parameters: name="reason" type="java.lang.String"

Attributes of PubSub – Topic Subsystem Config

Fiorano.mq.pubsub:ServiceType=PubSubManager,Name=TopicSubSystem,type=config

DupsOkBatchSize
Description: Batch size for DUPS_OK Ack mode
Type: int
Access: RW
Default Value: 20

RedeliveryTriesOnListenerException
Description: Parameter specifying a number of redelivery tries when Runtime Exception is thrown in Message Listener. This is used in AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE mode only. The redelivered message is discarded once this value is reached.
Type: int
Access: RW
Default Value: 2

PublishWait
Description: Minimum Wait time before RTL sends next publish call, in case of slow down. The actual time is calculated by a backoff algo depending on the current size of the PSQ and PublishBackoffThreshold value.
Type: int
Access: RW
Default Value: 5

MaxNumberOfTopics
Description: Maximum no. of Topics that can be created, by default its -1, i.e. infinite. (It also includes Temporary Topics)
Type: int
Access: RW
Default Value: -1

EnablePublisherSlowdown
Description: Enable/disable slowdown of the publisher when message is stored in disk after session buffer overflows due to slow subscriber and the PSQ size has reached its threshold value. Setting this parameter to false may lead to message loss for slow subscribers.
Type: boolean
Access: RW
Default Value: false

DropOldestMessage
Description: flag indicating whether oldest message should be dropped or the latest message should be dropped after persistent storage size crosses the predefined threshold value
Type: boolean
Access: RW
Default Value: true

DefaultStorageTypeForTopics
Description: Get the default storage types for Topics
Type: java.lang.String
Access: RW
Default Value: file

StoreMessageToDisk
Description: Store message to disk when session buffer overflows due to slow subscriber
Type: boolean
Access: RW
Default Value: true

EnableSnooperOnAllTopics
Description: specifies whether Snooper Service is enabled on all topics
Type: boolean
Access: RW
Default Value: false

EventTopicName
Description: Specifies the Name of the Topic on which Events are published and processed
Type: java.lang.String
Access: RO
Default Value: Events_Topic

IsForceFullyKillDSubscriber
Description: Allow forcefully killing of Durable Subscriber
Type: boolean
Access: RW
Default Value: false

MaxPersistentStoreSize
Description: maximum size of the persistent queue in the disk.
Type: long
Access: RW
Default Value: 1073741824

MaxMsgInOneRecv
Description: Maximum number of messages that can be received in one call
Type: int
Access: RW
Default Value: 128

BasicAllowedSize
Description: Connection level upper limit for message buffer size in bytes.
Type: int
Access: RW
Default Value: 131072

Icon

Please note that this attribute is deprecated since FioranoMQ 10.3.0.

Use the 'MaxConnectionBufferSize' attribute and corresponding values as mentioned below in place of the 'BasicAllowedSize' attribute.

MaxConnectionBufferSize

Description: Maximum size (in bytes) for a connection buffer to hold messages that need to be delivered to subscriptions created under the connection. When the limit is reached, every push in the connection buffer waits for MessagePublishTimeout or until some space gets created. In general, this buffer limit will not exceed, as the flow control logic between the server and the RTL session layer manages the limit.
Type: int
Access: RW
DefaultValue: 2097152

UseOptimizedTCPReceive
Description: Use optimized TCP Receive is enabled.
Type: boolean
Access: RW
Default Value: true

EnableMessageMonitoring
Description: Enables the message monitoring and stores the data
Type: boolean
Access: RW
Default Value: false

FilePath
Description: The file path set to store server message monitoring data
Type: java.lang.String
Access: RW
Default Value: %FIORANO_HOME%/fmq/profiles/%PROFILE_NAME%/run/PUBSUB/JMSX_MESSAGEMONITOR

TimeDuration
Description: The time interval between which the rate needs to be calculated or the time duration in 'seconds' to monitor message flow.
Type: int
Access: RW
Default Value: 3600

RedeliveryTriesOnMessageException
Description: Parameter specifying number of redelivery tries when Runtime Exception is thrown in Message Listener. This is used in AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE mode only. The redelivered message is discarded once this value is reached. This applies to all the subscribers
Type: int
Access: RW
Default Value: 2

DelayInMsgDeliveryOnListenerException
Description: Parameter specifying the delay in Message redelivery when Runtime Exception is thrown in Message Listener. This is used in AUTO_ACKNOWLEDGE or DUPS_OK_ACKNOWLEDGE mode only. The redelivered message is discarded once max redeliver tries value is reached.
Type: int
Access: RW
Default Value: -1

PublishWaitTimeRecheckUnits
Description: Singular wait parameter for flow control algorithm used when there are slow subscribers in use. Whenever the PSQ size reaches 95% then the publisher is made to wait repeatedly until the size drop downs to 85%. The MaxWaitTime is distributed into chunks after which it again checks the size of the PSQ. This applies to all the publishers.
Type: int
Access: RW
Default Value: 8

PurgeLevelIndex
Description: Number of persistent messages after which purging is to be done if OPTIMIZED TCP RECEIVE is false. This applies to all the Topics.
Type: int
Access: RW
Default Value: 100

PublishBackoffThreshold
Description: Threshold on PSQ size for backoff algo to kick-in. Once the threshold is reached then flow-control will start the Publishers will be made to wait/block for the buffers to clear. The value indicates the factor after which Publisher needs to slowdown. Calculates as, PSQ size > factor * MaxPersistentSize
Type: double
Access: RW
Default Value: 0.6

IgnorePSQSizeForPersistentMessages
Description: Whether to persist persistent messages in PSQ even through the PSQ is full. If set to 'true, then even if the PSQ size exceeds the MaxPersistentStoreSize, still the messages will be stored to disk. This applies to all the Publishers.
Type: boolean
Access: RW
Default Value: false

JournalingTopicPrefix
Description: Prefix used for Journaling Topic Name. For example, if the prefix is \'JOURNAL_\' then for PRIMARYTOPIC the Journaling Topic Name will be \'JOURNAL_PRIMARYTOPIC\'. The journaling topic will be created only when Journaling is enabled on the Topic. Also, this prefix can't be null or an empty String.
Type: java.lang.String
Access: RW
Default Value: JOURNAL_

MinPurgeDifference
Description: Minimum Number of persistent messages after which purging can be done. Generally purging is done in batches in the server and this is the minimum number of delete request which the server will accumulate before actually deleting the messages. This applies to all the Topics.
Type: int
Access: RW
Default Value: 50

AllowDeletionOfSubtopics
Description: Boolean determining if deletion of Subtopics is allowed. If set to true then deleting a Topic will automatically delete the SubTopics. This applies to all the topics.
Type: boolean
Access: RW
Default Value: true

MessagePublishTimeout
Description: This is the maximum time for which a Publisher will wait while trying to push the messages to a connection level buffer when it is full. It mainly applies to NP messages as for Persistent Messages the wait never ends until buffer reaches 85% again. This applies to all the publishers.
Type: long
Access: RW
Default Value: 120000

MaxPublisherBlockTime
Description: This is the maximum time for which a Publisher will wait while trying to push the messages to the PSQ after it has reached 95% of its max limit. This applies to all the publishers.
Type: long
Access: RW
Default Value: 120000

LoadLVCIndicesAtLookup
Description: This parameter determines whether to load the LV-Cache indices at the time when the message is first sent to the JMS Topic. If set to true, the LV-Cache indices are loaded at the time of Topic lookup.
Type: boolean
Access: RW
Default Value: false

IgnoreNullLVCKey
Description: This parameter determines whether to ignore the message sent to a JMS Topic on which LV-Caching is enabled with cache-key property not set. If set to false, an exception is thrown if the message has no cache-key set.
Type: boolean
Access: RW
Default Value: true

FlushLVCDataAtStartup
Description: This parameter determines whether to clean-up LVC data stores at the time of start-up of the FioranoMQ Server.
Type: boolean
Access: RW
Default Value: false

HandlingDBCorruptionEnablee
Description: Specifies whether DB corruption handling is enabled for topics.
Default Value: false
Possible Value: false, true

MaxTopicSessionCount
Description: Maximum number of topic sessions that can be created under a topic connection
Default Value: -1

Icon

-1 represents infinite.

MaxPublisherCount
Description: Maximum number of publishers that can be created under a topic connection.
Default Value: -1

Icon

-1 represents infinite.

MaxSubscriberCount
Description: Maximum number of subscribers that can be created under a topic connection.
Default Value: -1

Icon

-1 represents infinite.

MaxTempTopicCount
Description: Maximum number of temporary topics that can be created under a topic connection.
Default Value: -1

Icon

-1 represents infinite.

EnableSessionStateChangeNotification
Description: This parameter defines whether to raise notifications related to the topic session's state changes corresponding to slow subscribers. That is, whenever the underlying subscriber undergoes state changes- becomes slow or normal – a notification is raised to all event listeners.
Default Value: no
Default Value: no, yes

UseTopicIDBaseForSharedSubs
Description: This parameter is used in case of shared subscriptions; when clientID is unset for the JMS connection.
Default Value: no
Default Value: no, yes

Operations of PubSub – Topic Subsystem Config

None

PTP

Attributes of PTP – Queues

Fiorano.mq.ptp.Queues:ServiceType=Queue,Name="PRIMARYQUEUE"

Icon

It's a runtime MBean. Other Queue runtime MBeans could be accessed by assigning corresponding queue-name to the property "name" of ObjectName.

Declaring the ObjectNames by setting Queue values to a variable

NumberOfActiveConsumers
Description: Number of active consumers on this destination
Type: int
Access: RO

NumberOfActiveProducers
Description: Number of active producers on this destination
Type: int
Access: RO

NumberOfDeliverableMessages
Description: Gets the number of deliverable messages on this destination.
Type: long
Access: RO

NumberOfUndeletedMessages
Description: Gets the number of undeleted messages on this destination.
Type: long
Access: RO

NumberOfUndeletedPersistentMessages
Description: Gets the number of undeleted persistent messages.

NumberOfUndeletedNonPersistentMessages
Description: Gets the number of undeleted non-persistent messages.

NumberOfDeliverablePersistentMessages
Description: Gets the number of deliverable persistent messages.

NumberOfDeliverableNonPersistentMessages
Description: Gets the number of deliverable non-persistent messages.

Shutdown
Description: Returns the status of the destination whether shutdown/alive.

StateString
Description: It represents different states of a queue.
Possible Values: "Stopped", "Stopping", "Starting", "Started", "Failed","Destroyed", "Created", "Unregistered", "Registered", "Not Used"

Operations of PTP – Queues

Fiorano.mq.ptp.Queues:ServiceType=Queue,Name="PRIMARYQUEUE"

Declaring the ObjectNames by setting Queue values to a variable

Operations

Icon

getNumberOfMessagesInBound
getRateOfMessagesInBound
getNumberOfMessagesOutBound
getNumberOfMessagesOutBound

To perform the above operations, follow the steps below:

Set the enableMessageMonitoring flag to 'true'
Set the filepath of the SubSystem to 'null'

IExpiryMessageListener getRegisteredExpiryListener()
Description: Get the all RegisteredListeners for Destination
Return Type: fiorano.jms.services.msg.IExpiryMessageListener

boolean isDMQEnabled()
Description: Finds whether DMQ is enabled for this Queue.
Return Type: boolean

boolean isSnooperEnabled()
Description: Finds whether Snooper is enabled for this Queue.
Return Type: boolean

void enableDMQ(String enableSnooper)
Description: possible values are TRUE,FALSE,DEFAULT
Parameters:
name="enableDMQ" type="String"

void enableSnooper(String enableSnooper)
Description: possible values are TRUE,FALSE,DEFAULT
Parameters:
name="enableSnooper" type="String"

String getNumberOfMessagesInBound()
Description: Returns the number of messages pushed in the queue
Return Type: java.lang.String

String getRateOfMessagesInBound()
Description: Returns the rate at which messages are pushed in the queue
Return Type: java.lang.String

String getNumberOfMessagesOutBound()
Description: Returns the number of messages popped from the queue
Return Type: java.lang.String

String getRateOfMessagesOutBound()
Description: Returns the rate at which messages are popped from the queue
Return Type: java.lang.String

ArrayList getMessageMonitoringData()
Description: Returns the MessageMonitoring Data in tabular format
Return Type: java.util.ArrayList.
Structure of the elements of array list is: Time,IncomingMsgs(Value-firstValue),RateOfIncomingMsgs (Value-firstValue)

String countPendingMessages()
Description: Returns the number of message present in the queue
Return Type: java.lang.String

void deleteExpiredMessages()
Description: Delete all the expired messages.

void purgeMessagesWithActiveClients()
Description: Purge all the messages for this queue with ActiveClients.

void purgeMessages(boolean forcefully)
Description: Purge all the messages for this queue
Parameters: name="forcefully" type="boolean"

void listReceivers()
Description: This will return the list of receivers created on that particular queue.
Return Type: java.util.Vector
Each element of this Vector will have the format:

ReceiverName=<CONSUMER_NAME>, ConnectionClientId=<CLIENT_ID>, ConnectionHashCode=<CONNECTION_HASHCODE>

Parameters: No Parameters

void listSenders()
Description: This will return the list of senders created on that particular queue.
Return Type: java.util.Vector
Each element of this Vector will have the format:

SenderName=<PRODUCER_NAME>, ConnectionClientId=<CLIENT_ID>, ConnectionHashCode=<CONNECTION_HASHCODE>

Parameters: No Parameters

double getPersistentQueueBufferFactor()
Description: Returns how much persistent buffer is filled with messages
Return Type: double
Parameters: No parameters

double getNonPersistentQueueBufferFactor()
Description: Returns how much non_persistent buffer is filled with messages
Return Type: double
Parameters: No parameters

getCumulativeNumberOfMessagesInBound()
Description: Returns the number of messages added to the queue since the server start.

getCumulativeNumberOfMessagesOutBound()
Description: Returns the number of messages popped from the queue since the server start.

shutdown(reason)
Description: This operation shuts down the queue.
Parameter: name="reason" type="java.lang.String"

restart(reason)
Description: This operation shuts down the queue and restarts it.
Parameter: name="reason" type="java.lang.String".

Attributes of PTP – Queues (Config)

Fiorano.mq.ptp.Queues:ServiceType=Queue,Name="PRIMARYQUEUE",type=config

Declaring the ObjectNames by setting Queue values to a variable

LoadBitSetOnStartup
Description: Loads inMemory message index status BitSet on startup.
Type: boolean
Access: RW
Default Value: false

UseInMemStatusCache
Description: Status Cache for Messages.
Type: boolean
Access: RW
Default Value: true

CleanupInterval
Description: Specifies the interval after which QueueCleaner utility cleans the messages from the Queue.
Type: long
Access: RW
Default Value: 60000

IsDbCleanupEnabled
Description: specifies whether Queue Cleaner utility is enabled or not, Default this utility is disable.
Type: boolean
Access: RW
Default Value: false

EnableSnooper
Description: specifies whether Snooper Service is enabled on this queue
Type: java.lang.String
Access: RW
Default Value: DEFAULT

EnableDMQ
Description: specifies whether DMQ Service is enabled on this queue
Type: java.lang.String
Access: RW
Default Value: DEFAULT

EnableGMSQueueExpose
Description: Boolean specifies whether RunTimeGMS Config MBean should be exposed or not
Type: boolean
Access: RW
Default Value: false

InMemoryBlockingInterval
Description: Blocking interval
Type: long
Access: RW
Default Value: 10

PersistentInMemoryBufferSize
Description: Specifies the buffer size of the In-Memory Cache for PERSISTENT messages
Type: long
Access: RW
Default Value: 524288

InMemoryBufferSize
Description: Specifies the buffer size of the In-Memory Cache for NONPERSISTENT messages
Type: long
Access: RW
Default Value: 1048576

MaxPushAttempts
Description: Maximum number of attempts for pushing in in-memory buffer
Type: int
Access: RW
Default Value: 64

WaitBetweenAttempts
Description: Wait time between attempts
Type: long
Access: RW
Default Value: 16

DepthMonitoringEnabled
Description: This will enable depth (pending message count) monitoring at queue level. If this flag is enabled, pending message count can be retrieved at any moment in the server. To enable depth monitoring at queue level, depth monitoring must be enabled at server level.
Type: boolean
Access: RW
Default Value: false

JumpDeletedFiles
Description: boolean controlling the optimization that was added for flying broom that allows the code to jump over files if there are a number of indices that are deleted
Type: java.lang.String
Access: RW
Default Value: FALSE

EnableJournaling
Description: Specifies whether Journaling Service is enabled on this Queue.
Type: boolean
Access: RO
Default Value: false

DMQExpiryTime
Description: Time in milliseconds after which any stored message in Dead Message Queue is deleted
Type: long
Access: RW
Default Value: 0

EnableNotificationOnDeadMessage
Description: Enabling the Notification on DeadMessage
Type: boolean
Access: RW
Default Value: false

DepthMonitoringLevels
Description: Jmx notifications will be fired, whenever pending message count crosses one of these depth values. All depths should be specified positive values with each of them separated by comma, for example '10,20,30'. If this value is not specified, then its value will be taken from queuing subsystem.
Type: java.lang.String
Access: RW
Default Value: null

QueueBehaviorOnBufferOverflow
Description: Determines the Queue behavior for the incoming messages when the size of the in-memory buffer used for the storing NON-PERSISTENT messages reaches its maximum limit.
Default Value: DEFAULT.
Possible Values: DropOldestMessage, Exception, WriteToDisk

MessageGroupingEnabled
Description: Determines the Queue behavior for MessageGrouping. If enabled, messages belonging to the same group identified by the property JMSXGroupID will be sent to the same consumer.
Return Type: Returns a Boolean TRUE if MessageGrouping is enabled on this queue.

MinConsumersCount
Description: Determines the minimum number of consumers on the queue before the message groups are distributed between them.

MaxWaitTime
Description: Determines the maximum wait time before the message groups are distributed among the existing consumers on a queue.
Default Value: 10000

WaitIntervalTime
Description: Determines the wait interval time in case of Message Grouping, after which the minimum number of consumers or maximum wait time is checked until one of the condition is satisfied.
Default Value: 10000

ExclusiveConsumerEnabled
Description: Determines the Queue behavior for Exclusive Consumer functionality. If enabled, all messages in the queue will be sent to the same consumer until its down.
Default Value: False

UseReAssignableMessageGroupID
Description: Parameter specifying whether Message Group IDs used are re-assignable or unique.
Default Value: Default.
Possible Value: True, False.

Operations of PTP – Queues (Config)

None

Operations of PTP – QueueConnections

Fiorano.mq.ptp.QueueConnections:ServiceType=QueueConnection,Name=<ClientID>