This chapter explains the parameters that can be configured for FioranoMQ Servers running in Replicated High Availability mode. These are the various parameters that are configured under the FioranoMQàFioranoàHAà* tree node in Replicated HA Profiles in Offline configuration using Studio.
For more information on High Availability, refer to the High Availability section.
Primary Server Configuration
FioranoHAConnectionManager
Presented below are the details for the parameters in Fiorano > HA > HAConnectionManager > FioranoHAConnectionManager > config.
Port
The Port parameter specifies the port on which the HA Manager listens on for connections from the peer HA Server. This parameter listens for a connection from HA Peer Server in order to know the status of its peer.
Valid values:
The default value of the Port parameter is 2000.
The range of integer values considered valid by the Port parameter in java is -2^31 to 2^31 -1.
Note: The port may not be used by other services when being used to listen to Peer servers..
NagleAlgo
The NagleAlgo parameter is a doolean value that determines whether Nagle's Algorithm is enabled during socket creation with peer HA Server. Nagle's algorithm is used in TCP/IP networks for congestion control. It works by coalescing a number of small outgoing messages and sending them together, all at once. If there is a sent packet for which the sender has received no acknowledgment, the sender should keep buffering its output until it has a full packet worth of output, so as to send the entire output in one go.
Valid values:
The default value for the NagleAlgo parameter is no.
- yes – Indicates that the NagleAlgo is enabled.
- no – Indicates that the NagleAlgo is not enabled.
Example:
The Nagle algorithm should not be enabled in situations involving Delayed ACK as that will cause TCP performance problems.
SocketInitializationTimeout
The SocketInitializationTimeout parameter indicates the time in milliseconds within which a client socket should identify itself and exchange its version number with the Server. The version number exchange is an authentication mechanism that FioranoMQ employs.
Valid values:
The default value for the SocketInitializationTimeout parameter is 60000 (which is equal to one minute).
The range of integer values considered valid by the SocketInitializationTimeout parameter in java is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
QGMSStubManager
Presented below are the details for the parameters in Fiorano > HA > HAConnectionManager > HAServiceManager > HASubSystems > QGMSStubManager.
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ with each request associated with a subsystem. The range of serviceIDs associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.
The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameteris null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1.All values less than zero retrieve the same result.
TGMSStubManager
Presented below are the details forthe parameters in Fiorano > HA > HAConnectionManager > HAServiceManager > HASubSystems > TGMSStubManager.
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1.All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameteris null. If the value is specified as null, there is no range defined for the serviceIDs.
The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
SyncRealmStubManager
Presented below are the details for the parameters in Fiorano > HA > HAConnectionManager > HAServiceManager > HASubSystems > SyncRealmStubManager.
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs..
The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1.All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameteris null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1.All values less than zero retrieve the same result.
SyncNamingStubManager
Presented below are the details for the parameters in Fiorano > HA > HAConnectionManager > HAServiceManager > HASubSystems > SyncNamingStubManager.
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MaxServiceID in java are-2^31 to 2^31 -1.All values less than zero retrieve the same result.
NamingStubManager
Presented below are the details for the parameters in Fiorano > HA > HAConnectionManager > HAServiceManager > HASubSystems > NamingStubManager
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determine the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs. The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determines the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
SyncQueueStubManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->SyncQueueStubManager
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determines the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
MaxServiceID
The MaxServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determines the operations accessible to the subsystem. The MaxServiceID defines the maximum value of the range that exists for the serviceIDs.
Valid values:
The default value for the MaxServiceID parameter is null. If the value is specified as null, there is no range defined for the serviceIDs.The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
RpStateStubManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->RpStateStubManager.
MinServiceID
The MinServiceID parameter defines a serviceID in FioranoMQ. Each request is associated with a subsystem. A range of serviceIDs associated with a subsystem determines the operations accessible to the subsystem. The MinServiceID defines the minimum value of the range that exists for the serviceIDs.
Valid values:
The default value of the MinServiceID is 2001.
The range of integer values considered valid by the MinServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ defines a serviceID with each request associated with a subsystem and thus the range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. This value defines the maximum value of that range.
Valid values:
The default value of the MaxServiceID is 3000.
The range of integer values considered valid by the MaxServiceID in java is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
FioranoRpRealmManager
Presented below are the details for the parameters in Fiorano > HA > ReplicableRealmMgr > RpRealmManager > FioranoRpRealmManager > config
AclZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize realm related (ACL based) information a zip file containing the ACL information present in this server must be created. The AclZipPath parameter allows the configuration of the path where this file is located.
Valid values:
The default value of the AclZipPath is fmq_acl.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
AclUnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize realm related (ACL based) information a zip file is created using the ACL information. The AclUnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value of the AclUnzipDir parameter is ACL_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
PrincipalZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize principal related (User-based) information, a zip file is created using the information related to the principal present in the Server. The PrincipalZipPath parameter allows the configuration of the path in where this file is located.
Valid values:
The default value of the PrincipalZipPath parameter is fmq_principal.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
PrincipalUnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize principal related (User-based) information, a zip file is created using the information related to the principal. The PrincipalUnzipDir parameter allows the configuration of the path where this zip file is temporarily unzipped.
Valid values:
The default value of the PrincipalUnzipDir parameter is PRINCIPAL_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of the principal and realm related information must be done within this time.
Valid values:
The default value of the ScoketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout parameter is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
FioranoRpNamingManager
Presented below are the details of the parameters in Fiorano > HA > ReplicableNamingMgr > RpNamingManager > FioranoRpNamingManager > config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information a zip file using naming related information present in the Server is created. The ZipPath parameter allows the configuration of the path where this file is located.
Valid values:
The default value of the ZipPath parameter is fmq_nmdb.zip.
Any valid file name for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information, a zip file using naming related information is created. The UnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value for the UnzipDir parameter is NM_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeOut parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of all naming related information must be done within this time.
Valid values:
The default value for the SocketTimeOut parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
FioranoHAKRPCProvider
Presented below are details of the parameters in Fiorano > HA > HAKRPCProvider > FioranoHAKRPCProvider > config.
BackupHAPort
The BackupHAPort parameter specifies the port of the backup peer Server on which the peer listens to status requests sent by the Server.
Valid values:
The default value of the BackupHAPort parameter is 3000.
Note: It is mandatory to have the BackupHAPort parameter to run HA.
BackupHAIPAddress
The BackupHAIPAddress parameter specifies the IP address of the backup peer Server on which the peer listens for status requests sent by the Server.
Valid values:
The default value of the BackupHAIPAddress parameter is localhost.
Note: It is mandatory to have the BackupHAIPAddress parameter to run HA.
SocketTimeout
The SocketTimeOut parameter indicates the time in milliseconds before the socket created for communication with the peer Server timesout occurs.
Valid values:
The default value for the SocketTimeOut parameter is 30000.
The range of integer values considered valid by the SocketTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 30000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
HaStateNotifBroadcaster
Presented below are the details of the parameters in Fiorano->HA->HAManager->EventManager->HaStateNotifBroadcaster.
LoggerName
The LoggerName parameter provides a unique Logger Name.
Valid values:
The default value of the LoggerName parameter is null.
Any String may be used as a valid value for this parameter.
FioranoStatusPersister
Presented below are the details of the parameters in Fiorano->HA->HAManager->StatusPersister->FioranoStatusPersister->config.
Path
In Replication-based HA mode state information is replicated between FioranoMQ Servers through replication channels. Loading and storing of the replicated are done by the StatusPersister. The Path parameter helps to configure the path of the file where the status that is persisted is located.
Valid values:
The default value of the Path parameter is haStatus.dat.
Any valid file name may be used by this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
FioranoHAManager
Presented below are the details of the parameters in Fiorano->HA->HAManager->RpManager->FioranoHAManager->config.
Primary
The Primary parameter is a boolean parameter that indicates whether the acting Server acts as the primary HA Server when in the Replication HA mode. In FioranoMQ's HA implementation, one of the two HA Servers is the primary server while the other is the secondary Server. For more information about FioranoMQ's HA implementation, please refer to High Availability section.
Valid values:
The default value of the Primary parameter is yes.
- yes - Indicates that the Server is the primary server.
- no - Indicates that the Server is the secondary server.
GatewayListenerNotUpMesg
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayListenerNotUpMesg parameter helps identify the message that will be displayed when the acting Server finds that no listener is present on the port configured.
Valid values:
The default value for the GatewayListenerNotUpMesg parameter is Connection refused.
Any String may be used as a valid value for this parameter.
PingInterval
The acting HA Server pings its peer Server intermittently to exchange status information. PingInterval is the time interval in milliseconds after which the remote Server is pinged in Replication HA mode.
Valid values:
The default value for the PingInterval parameter is 30000.
The range of integer values considered valid by the PingInterval is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
GatewayServerPort
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerPort parameter helps to specify the port on which the Gateway machine listens for incoming requests.
Valid values:
The default value GatewayServerPort parameter is 7.
The range of integer values considered valid by the GatewayServerPort is -2^31 to 2^31 -1.
Note: The port should not be in use.
SocketCreationTimeout
SocketCreationTimeout is the time in milliseconds within which the socket has to connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 10000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1All values less than zero retrieve the same result.
ServerName
The ServerName parameter specifies the name of the Server running in the Replication HA mode.
Valid values:
The default value for the ServerName is FMQServer
Any String may be used as a valid value for this parameter.
Example:
Naming the server in the most relevant way that explains its purpose makes distinguishing it from other servers easier.
GatewayServerIPAddress
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the Enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps to specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine that is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
MaxWaitTimeout
When an acting Server notices that there has been a change in its peer Server state it must change its state appropriately. While the acting Server begins changing its state it starts a timer. If for some reason the state change is not completed after a reasonable amount of time the acting server must be altered.
The MaxWaitTimeout parameter specifies the maximum waiting timeout in milliseconds the local Server waits for a state transition to complete.
Valid values:
The default value for the MaxWaitTimeout parameter is 30000.
The range of integer values considered valid by the MaxWaitTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
WaitTimeForBackupServer
This parameter indicates the wait time to detect backup server during local server bootup. If the backup server is not available then local server will switch to standalone after acquiring the lock. A higher value of this parameter can avoid one of the server switching to standalone, thus avoiding unnecessary database replication at the cost of more wait time during server boot up.
Default value:
30000(units in milliseconds)
Legal values:
Any positive integer which represents a few seconds.
MaxPingCount
This parameter indicates the maximum number of times gateway server will be pinged for detecting a server failure. This will be useful in case of a weak network link between gateway server and ha server. Increasing this parameter should be done after consulting the Fiorano support team as increasing this parameter can disrupt ha functionality.
Default value: 1
AutoPassiveResetEnabled
Boolean to denote if the automatic reset of the passive server is enabled or not.
Enabling this flag will switch on the “automatic reset of passive server” feature, and will result in active server initiated restarts/shutdowns of the passive server in case of exception limit breaches within the configured time thresholds. Restarts/shutdowns will be initiated with every breach of 'FioranoException' or 'IOException' exception counts. Whereas, in case of 'Disk Full' errors, passive server shutdowns will be initiated directly without any passive server restart attempts.
Enabling this flag auto enables other supporting APIs with their default values:
- MaxPassiveExceptionLimit: to set the exception limits.
- MaxPassiveIOExceptionThresholdPercentage: to set the IOException threshold percentage.
- MaxPassiveRestartAttempts: to set the maximum number of restart attempts.
- PassiveExceptionTimeThreshold: to set the threshold time.
The feature will prevent any potential hindrance to message processing which can occur due to any unhandled errors caught because of the passive server unresponsiveness.
Unresponsive passive servers will block the message flow, with the active server being stuck at the waiting stage and throwing large error logs of every message sent. This could also result in piling up of the CSP cache eating away the resources.
Hence, to overcome such situations, restarting or shutting down an unresponsive passive server is the way out, making sure that the primary broker continues serving the message flow either in the ACTIVE state or the STANDALONE state, minimizing flow blockages and HA performance degrades.
Server restart is required for changing default values
Valid values:
- true – automatic reset of passive server will be enabled.
- false - automatic reset of passive server will not be enabled.
Default Value :
- false - automatic reset of passive server will not be enabled.
MaxPassiveExceptionLimit
Maximum exception limit after which the passive server will be reset. The exception-count will get reset to '0' after every passive server restarts/shutdowns.
Server restart is required for changing the default values.
Valid values: Positive integer values
Default Value: 100 (breach happens at 101st exception)
Note: Values less than 0 are considered as illegal value as the count cannot be negative. The value '0' will result in passive reset with just a single exception hit.
MaxPassiveIOExceptionThresholdPercentage
Percentage of IOExceptions to be taken into account for checking if the maximum exception limit is breached.
Server restart is required for changing the default values.
Valid values: Positive float values
Default Value: 25.0 (i.e takes in 25 IOExceptions for every 100 IOExceptions caught)
Note: Values greater than '100' are considered as illegal values as it will increase the exception count much more than the actual number of exceptions caught. The value '0' will result in not considering any IOExceptions caught for calculating the exception limit count, whereas the value '100' will consider all the IOExceptions caught.
MaxPassiveRestartAttempts
The maximum number of attempts to reset passive server by restart after which it will be shut down.
In most cases, restarting a passive server will suffice its recovery. However, in certain cases of HA state correction, shutting down the passive server is recommended. Hence, after the breach of the desired number of restart attempts, the passive server will shut down.
The restart attempts count is reset back to '0' only after the active server is restarted.
Server restart is required for changing the default values.
Valid values: Positive integer values
Default Value: 5
Note: Values less than '0' are considered as illegal values as the number of attempts cannot be negative. Value '0' will result in an immediate shutdown of the passive server once the exception limits are breached.
PassiveExceptionTimeThreshold
Time threshold within which if the exception limit is breached, the passive server will be reset.
Server restart is required for changing the default values.
Units: Milliseconds
Valid values: java.lang.Long values
Default Value: 300000 (5 minutes)
Note: Values less than '0' are considered as illegal values as time cannot be negative. Whereas '0' is considered as infinite time.
FioranoFMQKernel
Presented below are the details for the parameters in Fiorano->HA->FMQKernel->FioranoFMQKernel->config.
MQUnDeploymentLists
While in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed.
These components are listed in FioranoMQ specified files. The MQUnDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be undeployed when necessary.
Valid values:
The default value for the MQUnDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalUnDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. When the Server is in the Active state these components need to be undeployed.
The components that need to be undeployed are listed in FioranoMQ specified files. The ExternalUnDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be undeployed when necessary.
Valid values:
The default value for the ExternalUnDeploymentLists parameter is null.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.
MQDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead then the acting Server goes into the Standalone state. In order to not accept any client connections while in a passive state, a few components of the Server need to be undeployed. These components are redeployed when the Server starts accepting connections.
The components that need to be redeployed are listed in FioranoMQ specified files. The MQDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be redeployed when necessary.
Valid values
The default value MQDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. In case a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed. There may be external components that need to be redeployed when the Server goes back to the Active state.
The components to be undeployed are listed in Fiorano files. The ExternalDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be redeployed when necessary.
Valid values:
The default value for the ExternalDeploymentLists parameter is null.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.
FioranoRpTopicManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableTopicMgr->RpTopicManager->FioranoRpTopicManager->config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. To be able to synchronize all topic related information a zip file containing topic related information present in the Server is created. The ZipPath parameter allows the configuration of the path in which that file is located.
Valid values:
The default value for the ZipPath parameter is fmq_tgmsdb.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. To be able to synchronize topic related information, a zip file containing topic related information is created. The UnZipDir parameter allows the configuration of the path in which that zip file is temporarily unzipped.
Valid values
The default value of the UnZipDir parameter is TGMS_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for the replicable component occurs. Replication of all topic related information must be done within this time.
Valid values:
The default value for the SocketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout is -2^31 to 2^31 -1All values less than zero retrieve the same result.
FioranoRpQueueManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableQueueMgr->RpQueueManager->FioranoRpQueueManager->config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. To be able to synchronize all the queue related information a zip file containing queue related information present in the Server is created. The ZipPath parameter allows the configuration of the path in which that file is located.
Valid values:
The default value for the ZipPath parameter is fmq_qgmsdb.zip.
Any valid filename for a zip file may be used as a parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. To be able to synchronize queue related information, a zip file containing queue related information is created. The UnzipDir parameter allows the configuration of the path in which that zip file is temporarily unzipped.
Valid values
The default value for the UnzipDir parameter is QGMS_TEMP.
Any valid filename may be used as a parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout indicates the time in milliseconds before the socket timeout for the replicable component occurs. Replication of all queue related information must be done within this time.
Valid values
The default value for the SocketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
Secondary Server Configuration
FioranoHAConnectionManager
Presented below are the details of the parameters in Fiorano->HA->HAConnectionManager->FioranoHAConnectionManager->config.
Port
The Port specifies the port on which HA Manager listens for connections from the peer HA Server. In addition, the HA Server listens for a connection from its HA peer Server to determine the status of its peer on this port. The Port parameter is used specifies this port.
Valid values
The default value for the Port parameter is 3000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1
Note: The port specified should not be in use.
NagleAlgo
The NagleAlgo is a boolean parameter that determines whether Nagle's Algorithm, is enabled at the time of socket creation with the peer HA Server. Nagle's algorithm is used in TCP/IP networks for congestion control. It works by coalescing a number of small outgoing messages and sending them all together. If there is a sent packet for which the sender has received no acknowledgment, the sender output needs to be buffered until if there is a full packet worth of output which can then be sent in one go.
Valid values:
The default value for the NagleAlgo is no.
- yes – Indicates that the NagleAlgo is enabled.
- no – Indicates that NagleAlgo is not enabled.
Example:
The Nagle algorithm should not be enabled in situations involving Delayed ACK as that will result in TCP performance problems.
SocketInitializationTimeout
The SocketInitializationTimeout parameter indicates the time in milliseconds within which a client socket should identify itself and exchange its version number with the Server. The version number exchange is an authentication mechanism employed by FioranoMQ.
Valid values:
The default value of the SocketInitializationTimeout is 60000 (equal to one minute).
The range of integer values considered valid by the SocketInitializationTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
SyncTopicStubManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->SyncTopicStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.
The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
RealmStubManager
Presented below are the details for the parameters in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->RealmStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem define the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem define the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
QGMSStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->QGMSStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero are retrieve the same result.
TGMSStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->TGMSStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.
The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
SyncRealmStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->SyncRealmStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
SyncNamingStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->SyncNamingStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
NamingStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->NamingStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.
The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
SyncQueueStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->SyncQueueStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values
The default value for the MinServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MinServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MaxServiceID is null. A null value indicates that there is no defined range of serviceIDs.The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
RpStateStubManager
Presented below are the details for the parameters present in Fiorano->HA->HAConnectionManager->HAServiceManager->HASubSystems->RpStateStubManager.
MinServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MinServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is 2001.
The range of integer values considered valid by the MinServiceID are -2^31 to 2^31 -1All values less than zero retrieve the same result.
MaxServiceID
FioranoMQ generates a serviceID with each request associated within a subsystem. The range of serviceIDs that are associated with a subsystem defines the operations that are accessible to that subsystem. The MaxServiceID value defines the minimum value of that range.
Valid values:
The default value for the MinServiceID is 3000.
The range of integer values considered valid by the MaxServiceID is -2^31 to 2^31 -1All values less than zero retrieve the same result.
FioranoRpRealmManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableRealmMgr->RpRealmManager->FioranoRpRealmManager->config.
AclZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize realm related (ACL based) information a zip file containing the ACL information present in this server must be created. The AclZipPath parameter allows the configuration of the path where this file is located.
Valid values:
The default value of the AclZipPath is fmq_acl.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
AclUnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize realm related (ACL based) information, a zip file is created using the ACL information. The AclUnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value of the AclUnzipDir parameter is ACL_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
PrincipalZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize principal related (User-based) information, a zip file is created using the information related to the principal present in the Server. The PrincipalZipPath parameter allows the configuration of the path in where this file is located.
Valid values:
The default value of the PrincipalZipPath parameter is fmq_principal.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
PrincipalUnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize principal related (User-based) information, a zip file is created using the information related to the principal. The PrincipalUnzipDir parameter allows the configuration of the path where this zip file is temporarily unzipped.
Valid values:
The default value of the PrincipalUnzipDir parameter is PRINCIPAL_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of the principal and realm related information must be done within this time.
Valid values:
The default value of the SocketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout parameter is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
FioranoRpNamingManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableNamingMgr->RpNamingManager->FioranoRpNamingManager->config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information a zip file using naming related information present in the Server is created. The ZipPath parameter allows the configuration of the path where this file is located.
Valid values:
The default value of the ZipPath parameter is fmq_nmdb.zip.
Any valid file name for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information, a zip file using naming related information is created. The UnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value for the UnzipDir parameter is NM_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of the principal and realm related information must be done within this time.
Valid values:
The default value of the ScoketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout parameter is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
FioranoHAKRPCProvider
Presented below are the details for the parameters in Fiorano->HA->HAKRPCProvider->FioranoHAKRPCProvider->config.
BackupHAPort
The BackupHAPort parameter specifies the port of the backup peer Server on which the peer is listens for status requests sent by the Server.
Valid values:
The default value of the BackupHAPort parameter is 2000.
Note: It is mandatory to have the BackupHAPort parameter to run HA.
BackupHAIPAddress
The BackupHAIPAddress parameter specifies the IP address of the backup peer Server on which the peer listens for status requests sent by the Server.
Valid values:
The default value of the BackupHAIPAddress parameter is localhost.
Note: It is mandatory to have the BackupHAIPAddress parameter to run HA.
SocketTimeout
The SocketTimeOut parameter indicates the time in milliseconds before the socket created for communication with the peer Server times out occurs.
Valid values:
The default value for the SocketTimeOut parameter is 30000.
The range of integer values considered valid by the SocketTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 30000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
HaStateNotifBroadcaster
Presented below are the details for the parameters in Fiorano->HA->HAManager->EventManager->HaStateNotifBroadcaster.
LoggerName
The LoggerName parameter provides a unique Logger Name.
Valid values:
The default value of the LoggerName parameter is null.
Any String may be used as a valid value for this parameter.
FioranoStatusPersister
Presented below are the details for the parameters in Fiorano->HA->HAManager->StatusPersister->FioranoStatusPersister->config.
Path
In Replication-based HA mode state information is replicated between FioranoMQ Servers through replication channels. Loading and storing of the replicated is done by the StatusPersister. The Path parameter helps to configure the path of the file where the status that is persisted is located.
Valid values:
The default value of the Path parameter is haStatus.dat.
Any valid file name may be used by this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
FioranoHAManager
Presented below are the details for the parameters in Fiorano->HA->HAManager->RpManager->FioranoHAManager->config.
Primary
The Primary parameter is a boolean parameter that indicates whether the acting Server acts as the primary HA Server when in the Replication HA mode. In FioranoMQ's HA implementation, one of the two HA Servers is the primary server while the other is the secondary Server. For more information about FioranoMQ's HA implementation, please refer to FioranoMQ Concepts Guide Chapter 16 or FioranoMQ High Availability Guide.
Valid values:
The default value of the Primary parameter is no.
- yes - Indicates that the Server is the primary server.
- no - Indicates that the Server is the secondary server.
GatewayListenerNotUpMesg
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayListenerNotUpMesg parameter helps identify the message that will be displayed when the acting Server finds that no listener is present on the port configured.
Valid values:
The default value for the GatewayListenerNotUpMesg parameter is Connection refused.
Any String may be used as a valid value for this parameter.
PingInterval
The acting HA Server pings its peer Server intermittently to exchange status information. PingInterval is the time interval in milliseconds after which the remote Server is pinged in Replication HA mode.
Valid values:
The default value for the PingInterval parameter is 30000.
The range of integer values considered valid by the PingInterval is -2^31 to 2^31 -1. All values less than zero retrieve the same result.
GatewayServerPort
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server that is no longer available on the network. It becomes imperative to choose a gateway machine that is least expected to be out of the network. It makes sense to use the actual gateway Server of the network where the enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerPort parameter helps to specify the port on which the Gateway machine listens for incoming requests.
Valid values:
The default value GatewayServerPort parameter is 7.
The range of integer values considered valid by the GatewayServerPort is -2^31 to 2^31 -1.
Note: The port should not be in use..
SocketCreationTimeout
The SocketCreationTimeout indicates the time in milliseconds within which socket must connect with the peer Server failing which the socket creation attempt fails.
Valid values:
The default value for the SocketCreationTimeout is 10000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1.
All values less than zero retrieve the same result.
ServerName
The ServerName parameter specifies the name of the Server running in the Replication HA mode.
Valid values:
The default value for the ServerName is FMQServer
Any String may be used as a valid value for this parameter.
Example:
Naming the server in the most relevant way that explains its purpose makes distinguishing it from other servers easier.
GatewayServerIPAddress
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the Enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps to specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine that is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
In FioranoMQ's HA implementation a gateway machine is used to detect the HA Server which is no longer available on the network. It makes sense to use the actual gateway Server of the network in which the Enterprise Server is deployed as the Gateway machine for HA.
The GatewayServerIPAddress parameter helps to specify the IP address on which the Gateway machine listens for incoming requests.
Valid values:
The default value for the GatewayServerIPAddress parameter is localhost.
Example:
Choose a machine that is least expected to be out of the network to ensure that it is most likely to performs its function as a Gateway machine.
MaxWaitTimeout
When an acting Server notices that there has been a change in its peer Server state it must change its state appropriately. While the acting Server begins changing its state it starts a timer. If for some reason the state change is not completed after a reasonable amount of time the acting server must be altered.
The MaxWaitTimeout parameter specifies the maximum waiting timeout in milliseconds the local Server waits for a state transition to complete.
Valid values:
The default value for the MaxWaitTimeout parameter is 30000.
The range of integer values considered valid by the SocketCreationTimeout is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
AutoPassiveResetEnabled
Boolean to denote if the automatic reset of the passive server is enabled or not.
Enabling this flag will switch on the “automatic reset of passive server” feature, and will result in active server initiated restarts/shutdowns of the passive server in case of exception limit breaches within the set time thresholds.
Restarts/shutdowns will be initiated with every breach of 'FioranoException' or 'IOException' exception counts.
Whereas, in case of 'Disk Full' errors directly passive server shutdowns will be initiated without any passive server restart attempts.
Enabling this flag auto enables other supporting APIs with their default values:
- MaxPassiveExceptionLimit: to set the exception limits.
- MaxPassiveIOExceptionThresholdPercentage: to set the IOException threshold percentage.
- MaxPassiveRestartAttempts: to set the maximum number of restart attempts.
- PassiveExceptionTimeThreshold: to set the threshold time.
The feature will prevent any potential hindrance to message processing which can occur due to any unhandled errors caught because of passive server unresponsiveness.
Unresponsive passive servers will block the message flow, with the active server being stuck at waiting stage and throwing large error logs of every message sent. This could also result in piling up of the CSP cache eating away the resources.
Hence to overcome such situations restarting or shutting down an unresponsive passive server is the way out, making sure the primary broker continues serving the message flow either in ACTIVE or STANDALONE states, minimizing flow blockages and HA performance degrades.
Server restart is required for changing the default values
Valid values:
- true – automatic reset of passive server will be enabled.
- false - automatic reset of passive server will not be enabled.
Default Value :
- false - automatic reset of passive server will not be enabled.
MaxPassiveExceptionLimit
Maximum exception limit after which the passive server will be reset. The exception-count will get reset to '0' after every passive server restarts/shutdowns.
Server restart is required for changing the default values.
Valid values: Positive integer values
Default Value: 100 (breach happens at 101st exception)
Note: Values less than 0 are considered as illegal value as the count cannot be negative. The value '0' will result in passive reset with just a single exception hit.
MaxPassiveIOExceptionThresholdPercentage
Percentage of IOExceptions to be taken into account for checking if the maximum exception limit is breached.
Server restart is required for changing the default values.
Valid values: Positive float values
Default Value: 25.0 (i.e takes in 25 IOExceptions for every 100 IOExceptions caught)
Note: Values greater than '100' are considered as illegal values as it will increase the exception count much more than the actual number of exceptions caught. The value '0' will result in not considering any IOExceptions caught for calculating the exception limit count, whereas the value '100' will consider all the IOExceptions caught.
MaxPassiveRestartAttempts
The maximum number of attempts to reset passive server by restart after which it will be shut down.
In most cases, restarting a passive server will suffice its recovery. However, in certain cases of HA state correction, shutting down the passive server is recommended. Hence, after the breach of the desired number of restart attempts, the passive server will shut down.
The restart attempts count is reset back to '0' only after the active server is restarted.
Server restart is required for changing the default values.
Valid values: Positive integer values
Default Value: 5
Note: Values less than '0' are considered as illegal values as the number of attempts cannot be negative. Value '0' will result in an immediate shutdown of the passive server once the exception limits are breached.
PassiveExceptionTimeThreshold
Time threshold within which if the exception limit is breached, the passive server will be reset.
Server restart is required for changing the default values.
Units: Milliseconds
Valid values: java.lang.Long values
Default Value: 300000 (5 minutes)
Note: Values less than '0' are considered as illegal values as time cannot be negative. Whereas '0' is considered as infinite time.
FioranoFMQKernel
Presented below are the details for the parameters in Fiorano->HA->FMQKernel->FioranoFMQKernel->config.
MQUnDeploymentLists
While in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed.
These components are listed in FioranoMQ specified files. The MQUnDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be undeployed when necessary.
Valid values:
The default value for the MQUnDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalUnDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead the Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. When the Server is in the Active state these components need to be undeployed.
The components that need to be undeployed are listed in FioranoMQ specified files. The ExternalUnDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be undeployed when necessary.
Valid values:
The default value for the ExternalUnDeploymentLists parameter is null.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
MQDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. If a peer Server goes dead then the acting Server goes into the Standalone state. In order to not accept any client connections while in passive state, a few components of the Server need to be undeployed. These components are redeployed when the Server starts accepting connections.
The components that need to be redeployed are listed in FioranoMQ specified files. The MQDeploymentLists parameter helps specify lists of files (separated by commas) containing Fiorano specific components that are to be redeployed when necessary.
Valid values
The default value MQDeploymentLists parameter is kernel.lst,DefaultMQObjects.lst
A comma separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in that directory.
ExternalDeploymentLists
When in the Active mode the HA Server works normally. While in the Passive mode, the HA Server only monitors its peer and does not handle any client requests. All client connections to the Server when it is in the Passive mode are refused. In case a peer Server goes dead the acting Server goes into the Standalone state. In order to not accept any client connections while in the Passive state, a few components of the Server need to be undeployed. There may be external components that need to be redeployed when the Server goes back to the Active state.
The components to be undeployed are listed in Fiorano files. The ExternalDeploymentLists parameter helps specify lists of files (separated by commas) containing external components that are to be redeployed when necessary.
Valid values:
The default value for the ExternalDeploymentLists parameter is null.
A comma-separated list of .lst files is a valid value for this parameter.
Given a relative path for a file name the files are searched for in the directory: <current-profile>/deploy/. If an absolute path is given files are searched in the directory.
FioranoRpTopicManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableTopicMgr->RpTopicManager->FioranoRpTopicManager->config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. To be able to synchronize all topic related information a zip file containing topic related information present in the Server is created. The ZipPath parameter allows the configuration of the path in which that file is located.
Valid values:
The default value for the ZipPath parameter is fmq_tgmsdb.zip.
Any valid filename for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in the directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information, a zip file using naming related information is created. The UnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value for the UnzipDir parameter is TGMS_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of the principal and realm related information must be done within this time.
Valid values:
The default value of the SocketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout parameter is -2^31 to 2^31 -1
All values less than zero retrieve the same result.
FioranoRpQueueManager
Presented below are the details for the parameters in Fiorano->HA->ReplicableQueueMgr->RpQueueManager->FioranoRpQueueManager->config.
ZipPath
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information a zip file using naming related information present in the Server is created. The ZipPath parameter allows the configuration of the path where this file is located.
Valid values:
The default value of the ZipPath parameter is fmq_qgmsdb.zip.
Any valid file name for a zip file may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
UnzipDir
In the Replicable mode of the FioranoMQ HA Server, consistency between the individual HA Servers must be maintained at all times. In order to be able to synchronize name related information, a zip file using naming related information is created. The UnzipDir parameter allows the configuration of the path where the zip file is temporarily unzipped.
Valid values:
The default value for the UnzipDir parameter is QGMS_TEMP.
Any valid filename may be used for this parameter.
Given a relative path for a zip file name, the zip file is created relative that path in the directory: <current-profile>/run/. If its an absolute path for a file name is given, the zip file is created in that directory.
SocketTimeout
The SocketTimeout parameter indicates the time in milliseconds before the socket times out for this replicable component occurs. Replication of the principal and realm related information must be done within this time.
Valid values:
The default value of the SocketTimeout parameter is 240000 (equal to four minutes).
The range of integer values considered valid by the SocketTimeout parameter is -2^31 to 2^31 -1
All values less than zero retrieve the same result.