This module contains the objects managers like adminManager, Resource Manager, Thread Manager and all general operations performed by the server.

5.1 Job Managers

Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name=TopicDemuxJobManager

5.1.1 Attributes of TopicDemuxJobManager

5.1.1.1 OverloadTime

Description: Time at which overload is detected.
Type: long
Access: RO
Default Value: -1

5.1.1.2 ThreadsAtOverloadInstance

Description: Number of threads at which system panicked last time.
Type: int
Access: RO
Default Value: -1
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name= TopicDemuxJobManager,type=config

5.1.2 Attributes of TopicDemuxJobManager Config

5.1.2.1 MinimumJobWorkers

Description: Minimum number of job workers always present in the system.
Type: int
Access: RW
Default Value: 4

5.1.2.2 MaximuJobWorkers

Description: Maximum number of job workers that can be present at any instance.
Type: int
Access: RW
Default Value: 40

5.1.2.3 JobsPerWorker

Description: Number of jobs used per worker
Type: int
Access: RO
Default Value: 4
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name= PTPWriteJobManager

5.1.3 Attributes of PTPWriteJobManager

5.1.3.1 OverloadTime

Description: Time at which overload is detected.
Type: long
Access: RO
Default Value: -1

5.1.3.2 ThreadsAtOverloadInstance

Description: Number of threads at which system panicked last time.
Type: int
Access: RO
Default Value: -1
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name=PTPWriteJobManager,type=config

5.1.4 Attributes of PTPWriteJobManager Config

5.1.4.1 MinimumJobWorkers

Description: Minimum number of job workers always present in the system.
Type: int
Access: RW
Default Value: 4

5.1.4.2 MaximuJobWorkers

Description: Maximum number of job workers that can be present at any instance.
Type: int
Access: RW
Default Value: 40

5.1.4.3 JobsPerWorker

Description: Number of jobs used per worker
Type: int
Access: RO
Default Value: 4
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name= PTPReadJobManager

5.1.5 Attributes of PTPReadJobManager

5.1.5.1 OverloadTime

Description: Time at which overload is detected
Type: long
Access: RO
Default Value: -1

5.1.5.2 ThreadsAtOverloadInstance

Description: Number of threads at which system panicked last time.
Type: int
Access: RO
Default Value: -1
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name=PTPReadJobManager,type=config

5.1.6 Attributes of PTPReadJobManager Config

5.1.6.1 MinimumJobWorkers

Description: Minimum number of job workers always present in the system.
Type: int
Access: RW
Default Value: 4

5.1.6.2 MaximuJobWorkers

Description: Maximum number of job workers that can be present at any instance.
Type: int
Access: RW
Default Value: 40

5.1.6.3 JobsPerWorker

Description: Number of jobs used per worker.
Type: int
Access: RO
Default Value: 4
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name=TopicWriteJobManager

5.1.7 Attributes of TopicWriteJobManager

5.1.7.1 OverloadTime

Description: Time at which overload is detected.
Type: long
Access: RO
Default Value: -1

5.1.7.2 ThreadsAtOverloadInstance

Description: Number of threads at which system panicked last time.
Type: int
Access: RO
Default Value: -1
Fiorano.etc.jobManagers:ServiceType=JobManager,Impl=Impl2,Name=TopicWriteJobManager,type=config

5.1.8 Attributes of TopicWriteJobManager Config

5.1.8.1 MinimumJobWorkers

Description: Minimum number of job workers always present in the system.
Type: int
Access: RW
Default Value: 4

5.1.8.2 MaximumJobWorkers

Description: Maximum number of job workers that can be present at any instance.
Type: int
Access: RW
Default Value: 40

5.1.8.3 JobsPerWorker

Description: Number of jobs used per worker.
Type: int
Access: RO
Default Value: 4

5.1.8.4 runtimeObjectManagers

Fiorano.etc.runtimeObjectManagers:ServiceType=ObjectManager,Name=gmsObjectManager,type=config

5.1.9 Attributes of gmsObjectManager Config

5.1.9.1 MaxHashcodeValidationAttempts

Description: Specifies the maximum number of the hashCode revalidation attempts in Object creation.
Type: int
Access: RO
Default Value: 16

5.1.9.2 HashcodeReuseAlgoUsed

Description: Specifies whether hashcode reuse algorithm is used.
Type: boolean
Access: RW
Default Value: yes

5.1.9.3 MaxObjectTypes

Description: Maximum number of object types that can be stored.
Type: int
Access: RO
Default Value: 14
Fiorano.etc.runtimeObjectManagers:ServiceType=ObjectManager,Name=ObjectManager,type=config

5.1.10 Attributes of ObjectManager Config

5.1.10.1 MaxHashcodeValidationAttempts

Description: Specifies the maximum number of the hashCode revalidation attempts in Object creation.
Type: int
Access: RO
Default Value: 16

5.1.10.2 HashcodeReuseAlgoUsed

Description: Specifies whether hashcode reuse algorithm is used.
Type: boolean
Access: RW
Default Value: yes

5.1.10.3 MaxObjectTypes

Description: Maximum number of object types that can be stored.
Type: int
Access: RO
Default Value: 14

5.2 AdminService

Fiorano.etc:ServiceType=AdminService,Name=AdminService

5.2.1 Operations of AdminService

5.2.1.1 getUser

Description: Gets user with the specified user name.
Return Type: java.security.Principal
Parameters: name="username" type="java.lang.String" description="UserName"

5.2.1.2 getGroup

Description: Gets group with the specified group name.
Return Type: java.security.acl.Group
Parameters: name="name" type="java.lang.String" description="UserName"

5.2.1.3 getUserNames

Description: Gets the enumeration of usernames.
Return Type: java.util.Enumeration description="String representation of user names"
Parameters: no parameters

5.2.1.4 getGroupNames

Description: Gets the enumeration of group names.
Return Type: java.util.Enumeration description="String representation of group names"
Parameters: no parameters

5.2.1.5 getAclNames

Description: Returns the Enumeration of acl names.
Return Type: java.util.Enumeration description="String representation of acl names"
Parameters: no parameters

5.2.1.6 getDurableSubscribersForTopic

Description: Gets the enumeration of registered durable subscribers for topic.
Return Type: java.util.Enumeration description="Client Id and name of Durable Subcriber"
Parameters: name="topicName" type="java.lang.String" description="topicName"

5.2.1.7 getNumberOfDeliverableMessages

Description: Gets the Number of DeliverableMessages to the passed DurableSubcriber.
Return Type: long
Parameters:

  1. name="clientID" type="java.lang.String" description="clientID"
  2. name="subscriberID" type="java.lang.String" description="subscriberID"

5.2.1.8 getNumberOfDeliverableMessages

Description: Gets the Number of DeliverableMessages to the queue
Return Type: long
Parameters: name="name" type="java.lang.String" description="queue Name"

5.2.1.9 getDurableSubscriberClientIDs

Description: Gets the enumeration of DurableSubscriberClientIDs which are both in active and passive states.
Return Type: java.util.Enumeration description="String representation of DurableSubscriberClientIDs"
Parameters: no parameters

5.2.1.10 getSubscriberIDs

Description: Gets the enumeration of Subscriber IDs for Client IDs.
Return Type: java.util.Enumeration description="String representation of SubscriberIDs"
Parameters: name="clientID" type="java.lang.String" description="clientID"

5.2.1.11 getPTPClientIDs

Description: Gets the enumeration of PTP Client IDs.
Return Type: java.util.Enumeration description="String representation of PTP ClientIDs"
Parameters: no parameters

5.2.1.12 getPubSubClientIDs

Description: Gets the enumeration of PubSub Client IDs.
Return Type: java.util.Enumeration description="String representation of PubSub ClientIDs"
Parameters: no parameters

5.2.1.13 getSubscriptionTopicName

Description: the topic name on which the durable subscriber identified by the pair [clientID, subscriberID] is created.
Return Type: java.lang.String
Parameters:

  1. name="clientID" type="java.lang.String" description="clientID"
  2. name="subscriberID" type="java.lang.String" description="subscriberID"

5.2.1.14 getNumberOfUndeletedMessages

Description: Gets the number of undeleted messages in the queue.
Return Type: long
Parameters: name="name" type="java.lang.String" description="queue Name"

5.2.1.15 getNamingManagerImpl

Description: Gets the implementation class of Naming Services at server.
Return Type: java.lang.String
Parameters: no parameters

5.2.1.16 getAllTransactions

Description: Gets the enumeration of all transactions.
Return Type: java.util.Enumeration description= "an enumeration of all the transactions of the specified type. The elements of the enumeration are byte[] containing the GMSXid. Byte array is constructed as follows first 4 bytes - formatId next 4 bytes - global TransactionId length next set of bytes - global transactionId next set of bytes - branch qualifier"
Parameters: name="type" type="byte" description="Transcation type"

5.2.1.17 getAllTraceComponents

Description: Gets all the traceable components and their log levels.
Return Type: java.util.Hashtable description= "Keys are logger class names and values are their log levels."
Parameters: no parameters

5.2.1.18 getRegisteredSnooperDestinations

Description: Gets an enumeration of all the registered snoopers.
Return Type: java.util.Enumeration description= "Gets the enumeration of snooped registered destinations."
Parameters: no parameters.

5.2.1.19 isDestinationRegistered

Description: Checks if the snooper is registered for the specified destination
Return Type: boolean
Parameters: name="destinationName" type="String" description="Destination Name"

5.2.1.20 getServersInCluster

Description: Gets an Enumeration of all the Servers in the cluster catered by this Dispatcher in a dispatcher enabled server.
Return Type: java.util.Enumeration description= "ServerMetaData representing the Servers in the Cluster".
Parameters: no parameters

5.2.1.21 getActiveServersInCluster

Description: Gets an Enumeration of all the Active Servers in the cluster catered by this Dispatcher in a dispatcher enabled server.
Return Type: java.util.Enumeration description= "ServerMetaData representing the Active Servers in the Cluster".
Parameters: no parameters

5.2.1.22 getPreferredServer

Description: Gets PreferredServer MetaData for cluster
Return Type: fiorano.jms.md.ServerMetaData
Parameters: no parameters

5.2.1.23 getDefaultSnooperStatusOnDestinations

Description: get Snooping Status of destination domain based on type
Return Type: boolean
Parameters: name="destinationType" type="byte" description="Destination Type"
Legal Values:

  • 0 = Topics
  • 1 = Queues

5.2.1.24 setAsPreferredServer

Description: Set the Preferred Server in cluster in a dispatcher enabled server
Return Type: No return value
Parameters: name="server" type="java.net.URL" description="server URL"

5.2.1.25 setMaximumClientConnections

Description: Sets maximum client connections for the specified server in a dispatcher enabled server.
Return Type: no return value
Parameters:

  1. name="server" type="java.net.URL" description="server URL"
  2. name="conns" type="int" description="No of client connections to be Set"

5.2.1.26 setDefaultSnooperStatusOnDestinations

Description: Enable Snooping on Destinations based on DestinationType
Return Type: No return value
Parameters:

  1. name="destinationType" type="byte" description="Destination Type"
  2. name="status" type="boolean" description="Snooping status"

LegalValues:

  1. For destinationType
    • 0 = Topics
    • 1= Queues
  2. For status
  • true = set the snooping status
  • false = don't set the snooping status

5.2.1.27 listAdminConnectionFactories

Description: Lists all Admin Connection Factories
Return Type: java.util.Hashmap description = "Keys are names (java.lang.String) of connectionFactories and values are MetaData(fiorano.jms.md.AdminConnectionFactoryMetaData)"
Parameters: no parameters

5.2.1.28 listCommonConnectionFactories

Description: Lists all common Connection Factories.
Return Type: java.util.Hashmap description = "Keys are names (java.lang.String) of connectionFactories and values are MetaData(fiorano.jms.md.UnifiedConnectionFactoryMetaData)"
Parameters: no parameters

5.2.1.29 createAdminConnectionFactory

Description: Creates an admin connection factory.
Return Type: No return value
Parameters:

  1. name="tcfName" type="String" description="ConnectionFactory name"
  2. name="primaryURL" type="String" description="primary Connect URL"
  3. name="backupUrls" type="String" description="backup Connect URLs"
  4. name="isForLPC" type="boolean" description="Is Local Connetion Factory"
  5. name="Description" type="String" description="Desciption of ConnectionFactory"

5.2.1.30 createCommonConnectionFactory

Description: Creates a common connection factory
Return Type: No return value
Parameters:

  1. name="cfName" type="String" description="ConnectionFactory name"
  2. name="primaryURL" type="String" description="primary Connect URL"
  3. name="backupUrls" type="String" description="backup Connect URLs"
  4. name="isForLPC" type="boolean" description="Is Local Connetion Factory"
  5. name="Description" type="String" description="Description of ConnectionFactory"

5.2.1.31 printServerInfo

Description: Prints the complete Server Info
Return Type: java.lang.String
Parameters: no parameters

5.2.1.32 destroy

Description: Remove the adminObject identified by a given adminObjectName from the list of administered Objects.
Return Type: boolean
Parameters: name="adminObjectName" type="java.lang.String" description="To be Destroy adminObjectName"

5.2.1.33 elements

Description: Gets an enumeration of all admin objects.
Return Type: java.util.Enumeration description = "Values are MetaData objects corresponding to the admin Objects. For queues values are QueueMetaData and for topics values are TopicMetaData".
Parameters: no parameters

5.2.1.34 createGroup

Description: Creates group with the specified name
Return Type: java.security.acl.Group
Parameters: name="name" type="java.lang.String" description="GroupName"

5.2.1.35 createUser

Description: Creates user with the specied user name and password
Return Type: java.security.Principal
Parameters:

  1. name="username" type="java.lang.String" description="UserName"
  2. name="passwd" type="java.lang.String" description="Password"

5.2.1.36 deleteUser

Description: Deletes the user if underlying realm implementation supports deletion.
Return Type: boolean
Parameters: name="name" type="java.lang.String" description="UserName"

5.2.1.37 deleteGroup

Description: Deletes the group if underlying realm implementation supports deletion.
Return Type: boolean
Parameters: name="name" type="java.lang.String" description="GroupName"

5.2.1.38 changePassword

Description: Changes the password of the specified user to specified password.
Return Type: boolean
Parameters:

  1. name="username" type="java.lang.String" description="UserName"
  2. name="newPasswd" type="java.lang.String" description="Password"
  3. name="oldPasswd" type="java.lang.String" description="Password"

5.2.1.39 authunticateUser

Description: Authenticates the user
Return Type: Boolean
Parameters:

  1. 1. name="username" type="java.lang.String" description="UserName"
  2. 2. name="passwd" type="java.lang.String" description="Password"

5.2.1.40 elements

Description: Returns the elements based on the passed MetaData type.
Return Type: java.util.Enumeration description= "MetaDatas depending on the passed type"
Parameters: name="type" type="byte" description="type of administered object"
LegalValues:

  • 100 = Topic
  • 101 = Queue
  • 102 = TopicConnectionFactory
  • 103 = QueueConnectionFactory
  • 104 = AdminConnectionFactory
  • 108 = CommonConnectionFactory
  • 109 = XaQueueConnectionFactory
  • 110 = XaTopicConnectionFactory
  • 111 = XaCommonConnectionFactory

5.2.1.41 unsubscribe

Description: Unsubscribes the durable subscription identified by the clientID and subscriberID
Return Type: No return value
Parameters:

  1. name="clientID" type="java.lang.String" description="Client ID"
  2. name="subscriberID" type="java.lang.String" description="Subscriber ID"

5.2.1.42 purgeSubscriptionMessages

Description: Deletes the messages stored for the durable subscription identified by the clientID and subscriberID
Return Type: No return value
Parameters:

  1. name="clientID" type="java.lang.String" description="Client ID"
  2. name="subscriberID" type="java.lang.String" description="Subscriber ID"

5.2.1.43 deleteTopic

Description: Deletes a topic from the server
Return Type: No return value
Parameters: name="name" type="java.lang.String" description="Name of the topic"

5.2.1.44 deleteQueue

Description: Deletes a queue from the server
Return Type: No return value
Parameters: name="name" type="java.lang.String" description="Name of the queue"

5.2.1.45 currentUsers

Description: Gets the list of all logged in users.
Return Type: java.util.Enumeration description="Contains the entire logged in user names"
Parameters: No parameters

5.2.1.46 purgeQueueMessages

Description: Deletes all the messages of the queue if there are no active consumers of the queue
Return Type: No return value
Parameters: name="queueName" type="java.lang.String" description="queueName"

5.2.1.47 deleteMessagesOnServer

Description: Deletes the messages specified by the passed parameters.
Return Type: int description="Number of messages deleted from the server."
Parameters:

  1. name="queueName" type="java.lang.String" description="QueueName"
  2. name="startIndex" type="long" description="startIndex of Message"
  3. name="endIndex" type="long" description="endIndex of Message"
  4. name="priority" type="int" description="priority of Messages"

5.2.1.48 trace

Description: Set tracing for all components at specified level.
Return Type: No return value
Parameters: name="level" type="int" description="level to be Set"

5.2.1.49 registerMessageSnooperForAll

Description: Registers the message snooper for all destinations.
Return Type: No return value
Parameters: No parameters

5.2.1.50 unregisterMessageSnooperForAll

Description: Unregisters message snooper for all destinations.
Return Type: No return value
Parameters: No parameters

5.2.1.51 registerMessageSnooperForDestination

Description: Registers message snooper for a particular destination
Return Type:No return value
Parameters: name="destinationName" type="String" description="Destination Name"

5.2.1.52 registerMessageSnooperForDestination

Description: Unregisters message snooper for a particular destination
Return Type:No return value
Parameters: name="destinationName" type="String" description="Destination Name"

5.2.1.53 startSystemEvents

Description: Starts the system events
Return Type: No return value
Parameters: No parameters

5.2.1.54 stopSystemEvents

Description: Gets the list of all logged in users.
Return Type: No return value
Parameters: No parameters

5.2.1.55 addMonitor

Description: Adds an event for monitoring
Return Type: java.util.Enumeration description="Contains the entire logged in user names"
Parameters:

  1. name="type" type="int" description="Monitor Type"
  2. name="timeout" type="long" description="specified timeout

Legal Values:

    • For type
      1. 1024 = MemoryEvents
      2. 2048 = ThreadEvents
      3. 4096 = PubsubEvents
      4. 8192 = PtpEvents

5.2.1.56 removeMonitor

Description: Adds an event for monitoring
Return Type: java.util.Enumeration description="Contains the entire logged in user names"
Parameters:

    • name="type" type="int" description="Monitor Type"

Legal Values:

    • For type
      1. 1024 = MemoryEvents
      2. 2048 = ThreadEvents
      3. 4096 = PubsubEvents
      4. 8192 = PtpEvents

5.2.1.57 saveDispatcherConfigurations

Description: Saves the configurations of dispatcher to a file.
Return Type:No return value
Parameters: No parameters

5.2.1.58 getPermission

Description: Return the permission Object based on permission type.
Return Type: java.security.acl.Permission
Parameters: name="type" type="int" description="type of permission"

5.2.1.59 listConnectionAndDestinationMapping

Description: Return the hash table of connection and destination mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.60 listConnectionAndProducerMapping

Description: Return the hash table of connection and producer mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.61 listConnectionAndConsumerMapping

Description: Return the hash table of connection and consumer mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.62 getNoOfActiveClientConnections

Description: Return the hash table of connection and consumer mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.63 listAdminConnectionFactories

Description: Return the hash table of connection and consumer mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.64 listAllConnectionFactories

Description: Return the hash table of connection and consumer mapping.
Return Type: java.util.Hashtable
Parameters: No parameters

5.2.1.65 listActiveClientConnections

Description: returns the Enumeration of Active Client Connections. Enumeration will contain one string per Topic/Queue/Admin connection of the format: user_name/IP: connected_since, Type: PTP/PubSub/Admin Connection.
Return Type: java.util.Enumeration
Parameters: No parameters

5.2.1.66 isUserActive

Description: Gets the Connection State of the Users.
Return Type: boolean
Parameters: java.lang.String

5.2.1.67 trace

Description: Sets tracing for specified component at specified level.
Return Type: void
Parameters:

  1. name="componentName" type="java.lang.String" description="Component Name"
  2. name="level" type="int" description="level to be Set"

5.2.1.68 isAdmin

Description: Specifies whether this user is a member of administrators group.
Return Type: boolean
Parameters:

  1. name="name" type="String" description = "specify the user name"

5.2.1.69 getServerInfo

Description: Returns the server version and build number.
Return Type: java.lang.String
Parameters: No parameters

5.2.1.70 recheckJournalingStatusOnDestinations

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

5.2.1.71 disconnectClient

Description: Disconnects the client identified by the clientID.
Return Type: boolean, returns TRUE if client is successfully disconnected, FALSE otherwise.
Parameters: name="clientID" type="java.lang.String" description="Client ID"

5.2.1.72 disconnectClientWithToken

Description: Disconnects the client identified by the connectionToken.
Return Type: boolean, returns TRUE if client is successfully disconnected, FALSE otherwise.
Parameters: name="connToken" type="java.lang.Integer" description="connToken"

5.2.1.73 addMember

Description: Adds user to given group
Return Type: boolean
Parameters:

  1. name="grpName" type="java.lang.String" description="Group Name"
  2. name="userName" type="java.lang.String" description="User Name"

5.2.1.74 removeMember

Description: Removes user from the given group
Return Type: boolean
Parameters:

  1. name="grpName" type="java.lang.String" description="Group Name"
  2. name="userName" type="java.lang.String" description="User Name"

5.2.1.75 isGroupPresent

Description: Returns whether group is present in the server or not.
Return Type: boolean
Parameters: name="groupName" type="java.lang.String" description="Group name"

5.2.1.76 createUser

Description: Creates User with the specified Name and specified max connections
Return Type: java.security.Principal
Parameters:

  1. name="username" type="java.lang.String" description="UserName"
  2. name="passwd" type="java.lang.String" description="Password"
  3. name="maxNoOfConnections" type="int" description="maximum number of connections"

5.2.1.77 setMaxNoOfConnections

Description: Change the max number of connections
Return Type: boolean
Parameters:

  1. name="username" type="java.lang.String" description="UserName"
  2. name="maxNoOfConnections" type="int" description="no of connection(s)"

5.2.1.78 getMaxNoOfConnections

Description: Gets the maximum number of connections
Return Type: Int
Parameters: No parameters

5.2.1.79 threadDump

Description: This api will dump all the threads stack trace to server log file.
Return Type: void
Parameters: No parameters

5.3 DefaultLogManager

Fiorano.etc:ServiceType=ClientLogManager,Name=DefaultLogManager,type=config

5.3.1 Attributes of DefaultLogManager

5.3.1.1 LogDir

Description: Base Directory where logs will be stored.
Type: java.lang.String
Access: RW
Default Value: ..\profiles\FioranoMQ\run\logs.

5.3.1.2 Encoding

Description: Encoding scheme used by the Loggers to log messages.
Type: java.lang.String
Access: RW
Default Value: UTF-8

5.3.1.3 Level

Description: Log level that is used by newly constructed Handler objects.
Type: int
Access: RW
Default Value: 2

5.3.1.4 FileSizeLimit

Description: Maximum size of each log file used by FileHandler. 0 means infinite.
Type: int
Access: RW
Default Value: 0

5.3.1.5 FileCount

Description: Maximum number of files that can be used by FileHandler.
Type: int
Access: RW
Default Value: 1

5.3.1.6 AppendToFile

Description: Specifies the append mode to filehandler.
Type: boolean
Access: RW
Default Value: yes

5.3.1.7 Formatter

Description: Specifies the formatter for logs
Type: java.lang.String
Access: RW
Default Value: fiorano.jms.log2.def.DefaultFormatter

5.4 Memory Manager

Fiorano.etc:ServiceType=MemoryManager,Name=MemoryManager

5.4.1 Attributes of Memory Manager

FreeMemory
Description: Free memory (bytes) available to JVM.
Type: long
Access: RO
Default Value: No default value
UsedMemory
Description: Used memory (bytes) available to JVM
Type: long
Access: RO
Default Value: No default value
MaxMemory
Description: Maximum memory (bytes) available to JVM
Type: int
Access: RO
Default Value: depends on connections.

5.4.2 Operations of Memory Manager

gc
Description: Does garbage collection of unused objects in JVM.
Return Type: No return type
Parameters: No parameters
getTotalMemory
Description: Returns the total amount of memory in the Java virtual machine.
Return Type: long
Parameters: No parameters

5.5 RdbmsDBManager

Fiorano.etc:ServiceType=RdbmsDBManager,Name=RdbmsDBManager,type=config

5.5.1 Attributes of RdbmsDBManager Config

Url
Description: Url of the database where messages are stored
Type: java.lang.String
Access: RW
Default Value: jdbc:hsqldb:..\profiles\FioranoMQ\run\RDBMS\FMQ
Password
Description: Password for RDBMS user. Used for connecting to the server.
Type: java.lang.String
Access: RW
Default Value: No default value
Username
Description: User name used for connecting to the RDBMS server.
Type: java.lang.String
Access: RW
Default Value: sa
JdbcDriver
Description: JDBC Driver used to connect to the RDBMS data storage
Type: java.lang.String
Access: RW
Default Value: org.hsqldb.jdbcDriver
MaxConnections
Description: Allowed maximum number of connections that would be created.
Type: int
Access: RW
Default Value: 200
DefaultConnections
Description: Number of connections created while server startup.
Type: int
Access: RW
Default Value: 1
ConnectionTimeoutInterval
Description: Connection timeout interval in milliseconds.
Type: int
Access: RW
Default Value: 10000
ReconnectTimeInterval
Description: Reconnection time interval in milliseconds.
Type: int
Access: RW
Default Value: 10000
WaitTime
Description: Wait time if the no additional connections are available. 0 means infinite
Type: int
Access: RW
Default Value: 0
EnableRdbms
Description: Enables or disable db manager for using the rdbms server. This must be set for using the rdbms server
Type: boolean
Access: RW
Default Value: no
EnableReconnect
Description: Boolean used to specify whether reconnection should be done or not.
Type: boolean
Access: RW
Default Value: yes
PropertiesFilename
Description: JDBC Properties file name. This file contains database specific details for various SQL Types. Point this to the name of the file jdbc_*.cfg which should be available in %FIORANO_HOME%/fmq/profiles/%PROFILE%/conf directory
Type: java.lang.String
Access: RW
Default Value: jdbc_hsql.cfg
DbConnectivityQuery
Description: Query that must be executed to check health of the connection.
Type: java.lang.String
Access: RW
Default Value: select * from tab
MaxNoRowsFetch
Description: Maximum number of rows fetched in a shot from the database as a result of any select query.
Type: int
Access: RW
Default Value: 100

5.6 ThreadManager

Fiorano.etc:ServiceType=ThreadManager,Name=ThreadManager,type=config

5.6.1 Attributes of ThreadManager

(a) DelayBetweenAttempts
Description: Delay between two successive attempts by thread manager to create a thread if thread creation fails in a critical operation in milliseconds.
Type: int
Access: RW
Default Value: 100
(b) MaxIdleThreads
Description: Maximum number of idle threads in thread pool.
Type: int
Access: RW
Default Value: 4
(c) MaximumAttempts
Description: Maximum number of attempts to create a thread.
Type: int
Access: RW
Default Value: 8

5.7 MQDefObjCreater

Fiorano.etc:ServiceType=MQDefObjCreater,Name=MQDefObjCreater,type=config

5.7.1 Attributes of MQDefObjCreater

(a) AutoUpdationAllowedForCFs
Description: Sets the AutoUpdate property for MQ default CFs based on this flag.
Type: boolean
Access: RW
Default Value: false
(b) BackupServerIp
Description: Backup server url used by default connection factories.
Type: java.lang.String
Access: RW
Default Value: No default value
(c) BackupServerPort
Description: Backup server port used by default connection factories.
Type: int
Access: RW
Default Value: -1

5.8 PingManager

Fiorano.etc:ServiceType=PingManager,Name=PingManager,type=config

5.8.1 Attributes of PingManager

(a) PingerTimeout
Description: Ping time out interval in milliseconds.
Type: long
Access: RW
Default Value: 60000

5.9 TimerService

Fiorano.etc:ServiceType=TimerService,Name=TimerService,type=config

5.9.1 Attributes of TimerService

(a) Name
Description: Name of the Fiorano timer service.
Type: java.lang.String
Access: RW
Default Value: FioranoTimerService
(b) Clocktick
Description: Interval in milliseconds after which timer service will invoke registered timers.
Type: long
Access: RW
Default Value: 500

5.10 RouteManager

Fiorano.etc:ServiceType=RouteManager,Name=RouteManager,type=config

5.10.1 Attributes of RouteManager

(a) UpperLimitOnConnectionSharing
Description: Specifies the maximum number of routes that will share a single JMS connection.
Type: int
Access: RO
Default Value: 10
(b) MaxCreateSessionTries
Description: Specifies the maximum number of attempts to create a JMS Object.
Type: int
Access: RO
Default Value: 1
(c) MaxTopicBuffer
Description: Route level upper limit for message buffer size in bytes.
Type: int
Access: RW
Default Value: 131072
(d) UseConnectionSharing
Description: Specifies whether connection sharing by routes is switched on or not.
Type: boolean
Access: RO
Default Value: yes

5.10.2 Operations of RouteManager

(a) removeRoute
Description: Removes the given Route.
Return Type: No return type
Parameters:
name="routeGUID" type="String"
(b) listAllRoutes
Description: lists all routes created for this route Manager.
Return Type: java.util.Vector
Parameters: No parameters
(c) addRoute
Description: Adds a route with given parameters.
Return Type: long
Parameters:

    • name="routeGUID" type="String" description="ID to uniquely distinguish this route"
    • name="lookupUrl" type="String" description="Provider url to lookup the target CF"
    • name="srcDest" type="String" description="Source destination of this route (should be local)"
    • name="tgtCF" type="String" description="Target Connection Factory for this route"
    • name="tgtDest" type="String" description="Target destination for this route (can be remote)"
    • name="isDurSub" type="boolean" description="Boolean to indicate whether durable subscribers should be used or not"
    • name="durSubID" type="String" description="Durable Subscriber ID that is used in case isDurSub is true"
    • name="clientID" type="String" description="Client ID that is used"
    • name="jmsSelector" type="String" description="JMS Selector used for this route"
    • name="isJMSReplyToAsTarget" type="boolean" description="Boolean indicating whether target destination should be set dynamically based on the incoming message's JMSReplyTo header property."
    • name="enableDMQOnRoute" type="boolean" description="Boolean indicating whether DMQ is enabled on route or not"
    • name="msgPropertyForTargetCF" type="String" description="JMS message property used to set TargetCF, in case isJMSReplyToAsTarget is true and no Target CF is specified"
    • name="srcServerUserName" type="String" description="User name of source server for creating route."
    • name="srcServerPassword" type="String" description="Password of source server for creating route."
    • name="tarServerUserName" type="String" description="User name of target server for creating route."
    • name="tarServerPassword" type="String" description="Password of target server for creating route."
    • name="dmqExpiryTime" type="long" description="Expiration Time for messages in Dead Message queue"

Another method for adding a route: addRoute(HashMap route_properties)
Description: Adds a route with parameters given in HashMap.
Return Type: void
Key-names and value-types in HashMap:

    • name="routeGUID" value-type="String" description="ID to uniquely distinguish this route"
    • name="Lookup URL" value-type="String" description="Provider url to lookup the target CF"
    • name="Source Destination" value-type="String" description="Source destination of this route (should be local)"
    • name="Target CF" value-type="String" description="Target Connection Factory for this route"
    • name="Target Destination" value-type="String" description="Target destination for this route (can be remote)"
    • name="IsDurableSubscriber" value-type="String" description="true/false to indicate whether durable subscribers should be used or not"
    • name="Durable Subscriber ID" value-type="String" description="Durable Subscriber ID that is used in case isDurSub is true"
    • name="Client ID" value-type="String" description="Client ID that is used"
    • name="JMS Selector" value-type="String" description="JMS Selector used for this route"
    • name="IsJMSReplyToAsTarget" value-type="String" description="true/false indicating whether target destination should be set dynamically based on the incoming message's JMSReplyTo header property."
    • name="EnableDMQOnRoute" value-type="String" description="true/false indicating whether DMQ is enabled on route or not"
    • name="MessagePropertyForTargetCF" value-type="String" description="JMS message property used to set TargetCF, in case isJMSReplyToAsTarget is true and no Target CF is specified"
    • name="TargetServer UserName" value-type="String" description="User name of target server for creating route."
    • name="TargetServer Password" value-type="String" description="Password of target server for creating route."
    • name="DMQExpiryTime" value-type="String" description="Expiration Time for messages in Dead Message queue"
    • name="TargetServer Transport Protocol" value-type="String" description="Protocol of Target server . Only TCP and HTTP protocols are supported "

Example:
HashMap routeMap = new HashMap();
routeMap.put("routeGUID","R1");
routeMap.put("Lookup URL","http://localhost:1856");
routeMap.put("Source Destination","primaryQueue");
routeMap.put("Target CF","PrimaryQCF");
routeMap.put("Target Destination","secondaryQueue");
routeMap.put("TargetServer UserName","anonymous");
routeMap.put("TargetServer Password","anonymous");
routeMap.put("TargetServer Transport Protocol","TCP");
(d) saveRoutes
Description: This operation saves all the routes present in the server. Once these routes are saved, they will be recreated by the active server upon each restart of the server.
Return Type: No return type
Parameters: No parameters

5.11 FMQConfigLoader

Fiorano.etc:ServiceType=FMQConfigLoader,Name=FMQConfigLoader,type=config

5.11.1 Attributes of FMQConfigLoader

(a) LazyRSCreation
Description: Boolean determining if RTL Receive threads Creation is to be optimized or not. In optimized mode, a thread is created only when the first consumer is created on a session created by a connection.
Type: boolean
Access: RW
Default Value: no
(b) AllowDurableConnections
Description: Specifies whether durable connections are allowed or not
Type: boolean
Access: RW
Default Value: no
(c) UseSingleSocket
Description: Each JMS Connection internally results in creation of two sockets with the server. By turning on this Flag Fiorano's Runtime is instructed to use a single socket instead.
Type: boolean
Access: RW
Default Value: no
(d) UseSingleSocketForAdmin
Description: Turning on this flag, will result in starting off a thread for admin connection that would constantly be waiting for data on socket. This will detect loss of connection immediately.
Type: boolean
Access: RW
Default Value: yes.
(e) UseFioranoCbr
Description: FioranoMQ provides support for Content Based Routing (CBR). Enabling CBR support (by specifying this variable as true) allows client applications to define XPath Selectors when creating consumers.
Type: boolean
Access: RW
Default Value: no
(f) CreateDefaultACL
Description: Flag indication whether to create default ACL for MQ objects.
Type: boolean
Access: RW
Default Value: yes
(g) AclBasedDestinationSecurity
Description: Flag indicating whether ACL based security is enabled or not. If Enabled, user operations will first be checked against the associated ACL
Type: boolean
Access: RW
Default Value: no
(h) AllPermissions
Description: Flag indicating whether all default permissions for a new ACL should be negative or positive
Type: boolean
Access: RW
Default Value: yes
(info) AllowOnFlyAclCheck
Description: Flag to indicate whether modifications in an ACL would be reflected in currently connected clients or not.
Type: boolean
Access: RW
Default Value: no
(j) AllowOnTheFlyCreationOfDestinations
Description: Flag to control the behavior of createTopic and createQueue APIs' in JMS Session. If set to true, a new destination would be automatically created when invoked with a destination name that doesn't exist, if set to false an exception would be thrown.
Type: boolean
Access: RW
Default Value: yes
(k) EnsureUniquenessOfClientId
Description: Flag to indicate whether uniqueness of clientID is required or not. If set to true, a connection that sets a client Id that is already set on another connection will get an exception on doing so.
Type: boolean
Access: RW
Default Value: no
(l) MaxTransactionBufferSize
Description: Maximum amount of data (in bytes) that a transacted Session would store in un-commited state. Attempt to publish more data in un-committed transaction will result in an exception.
Type: int
Access: RW
Default Value: 10240000
(m) EnableAutoRevalidation
Description: Boolean controlling if auto-revalidation is enabled by default. If enabled, Fiorano's runtime upon detecting loss of connectivity will automatically try to re-connect back to the server
Type: boolean
Access: RW
Default Value: no
(thumbs down) HttpPollingInterval
Description: Polling interval used for http connections
Type: int
Access: RW
Default Value: 10000
(o) IncludeMessageID
Description: Sets whether to enable or disable message id at server.
Type: boolean
Access: RW
Default Value: no
(p) IsLMSEnabled
Description: Boolean controlling if Large Message Size Functionality is enabled in FioranoMQ.
Type: boolean
Access: RW
Default Value: no
(q) Resumetimeoutinterval
Description: Integer specifying the resume timeout to be used by the application. If resume does not happens in this timeout it comes out from resuming and starts normal transfer.
Type: long
Access: RW
Default Value: -1
(r) MessageSelectorFactoryClassName
Description: Class Name that provides CBR Engine functionality for FioranoMQ Server. This property would be used only if Content Based Routing (CBR) is enabled in FioranoMQ Server.
Type: java.lang.String
Access: RW
Default Value: fiorano.jms.cbr.cbr1.def.MessageSelectorFactory
(s) PingEnabled
Description: Boolean controlling if client connections are automatically pinged. Pinging is essential for detecting Network problems.
Type: boolean
Access: RW
Default Value: no
(t) SystemEncodingFormat
Description: Encoding format for UTF-8
Type: java.lang.String
Access: RW
Default Value: UTF-8

5.12 ResourceManager

Fiorano.etc:ServiceType=ResourceManager,Name=ResourceManager,type=config

5.12.1 Attributes of ResourceManager

(a) MaxMemoryThresholdAllowed
Description: Maximum memory threshold allowed, value can range from 0.0 to 1.0
Type: java.lang.String
Access: RW
Default Value: 0.8
(b) TimeInterval
Description: Interval after which monitoring thread will run again.
Type: long
Access: RW
Default Value: 10000
(c) EnableMonitoringThread
Description: Whether to enable monitoring thread or not
Type: boolean
Access: RW
Default Value: false
(d) EnableVerboseLogging
Description: Whether to enable verbose logging or not, if set to false logs will be maintained in monitor.txt file in the format:
[Date][space][Time][comma][QueueConnections][comma][TopicConnections][comma][sessions][comma][senders][comma][receivers][comma][publisher][comma[subscriber][comma][threads][comma][usedMemory]
Type: boolean
Access: RW
Default Value: true
(e) EnableThreadDumpInfo
Description: Whether to enable Thread Dump info in case server goes low on memory.
Type: boolean
Access: RW
Default Value: false

5.12.2 Operations of ResourceManager

Fiorano.etc:ServiceType=ResourceManager,Name=ResourceManager
getUsedMemory
Description: Returns the amount of memory used in KiloBytes.
Return Type: long
Parameters: No parameters
isServerLowOnMemory
Description: Check whether the used memory of the server has exceeded, the allowed threshold of the total memory available.
Return Type: boolean
Parameters: No parameters
isServerMemoryLow
Description: Check whether the used memory of the server has exceeded, the allowed threshold of the total memory available.
Return Type: boolean
Parameters: No parameters
gc
Description: Does garbage collection of unused objects in JVM.
Return Type: No return type
Parameters: No parameters

5.13 Directory Service

Contains MBeans related to Fiorano MQ Directory Service.
Fiorano.etc:ServiceType=DirectoryService,Name=DirectoryService

5.13.1 Attributes of Directory Service

(a) StateString:
Description: State of the Directory Service.
Type: String
Access: R
Default Value:

5.13.2 Operations of Directory Service

(a) boolean deregisterServer(String serverIP, String serverPort, String profileName)
Description: This operation will deregister the Fiorano Server in the Cluster Manager.
Return type: boolean
Parameters:
name="serverIP" type="java.lang.String" description="IP on which the Server is present."

  • name="serverPort" type="java.lang.String" description="Port on which Server is running (can be a unique port that distinguishes different Servers.)"
  • name="profileName" type="java.lang.String" description="Name of the profile"

5.13.3 Attributes of Directory Service Config

Fiorano.etc:ServiceType=DirectoryService,Name=DirectoryService,type=config
(a) EnableCluster:
Description: Returns whether cluster manager should be started or not with FioranoMQ Server.
Type: boolean
Access: RW
Default Value: true
(b) EnableProfileMonitoring:
Description: This parameter will define whether to monitor the configurational changes made to the profiles residing inside the Management Server. If enabled, all the configurational changes will be logged automatically to the file $DBPATH/logs/profile-monitor.log
Type: boolean
Access: RW
Default Value: false
(c) DirectoryServiceAddress:
Description: Returns the IPAddress on which cluster manager will be running.
Type: String
Access: RW
Default Value: localhost
(d) DirectoryServicePort:
Description: Returns the port on which cluster manager must be running.
Type: integer
Access: RW
Default Value: 10389
(e) SecurityPrincipal:
Description: Returns the securityPrincipal required for creating a connection to cluster manager.
Type: String
Access: RW
Default Value: uid=admin,ou=system
(f) SecurityCredentials:
Description: the securityCredentials required for creating a connection to cluster manager.
Type: String
Access: RW
Default Value: secret
(g) AuthenticationMode:
Description: the authentication mode in which connection will be created to cluster manager.
Type: boolean
Access: RW
Default Value: simple
(h) Instancepath:
Description: the path of the Instance on which cluster manager will be running. If set to null, the default value set for the working directory is $FIORANO_HOME/DSInstance/$PROFILE_NAME.
Type: String
Access: RW
Default Value: null
(info) SynchPeriodMillis:
Description: the synchronization time of the DS in milli seconds.
Type: long
Access: RW
Default Value: 15000

5.14 Jetty Server

Fiorano.etc:ServiceType=JettyServer,Name=JettyServer,type=config

5.14.1 Attributes of JettyServer

Max Threads

Description: The maximum number of Threads that can be created for embedded jetty server.
Type: int
Access: RW
Default Value: 250

EnableStart

Description: Its value determine whether jetty server should be started or not with FioranoMQ Server.
Type: boolean
Access: RW
Default Value: true

MinThreads

Description: The minimum number of Threads created for embedded jetty server running.
Type: int
Access: RW
Default Value: 10

LowThreads

Description: Returns Low Threads for the embedded jetty server.
Type: int
Access: RW
Default Value: 25

MaxIdleTime

Description: Determines the maximum idle time for the embedded jetty server.
Type: int
Access: RW
Default Value: 30000

StatsOn

Description: Determines whether stats should be on or off
Type: boolean
Access: RW
Default Value: false

LowResourceMaxIdleTime

Description: Determines the maximum idle time for embedded Jetty Server, in case of low resources.
Type: int
Access: RW
Default Value: 5000

PortNumber

Description: The port used by the embedded jetty server.
Type: int
Access: RW
Default Value: 1780

LogLevel

Description: The log level for jetty server log. There are 5 Log levels available. They are 0,3,4,5,10. They represent Quiet, Warn, Info, Debug and All levels respectively.
Type: int
Access: RW
Default Value: 4 or Info level.

MaximumLogSize

Description: The maximum file size set for jetty server log. There is rolling log implementation for jetty server logs. So, once this limit is reached, current log will be copied to backup and it will start logging from beginning again.
Type: int
Access: RW
Default Value: 10485760

MaxBackupFiles

Description: The maximum number of backup files for jetty server log.
Type: int
Access: RW
Default Value: 4

JettyLogName

Description: The log file name for jetty server log.
Type: String
Access: RW
Default Value: jettyserver.log

Adaptavist ThemeBuilder EngineAtlassian Confluence