MX4J/Http Adaptor
JMX Management Console
MX4J logo

Server viewMBean viewTimersMonitorsRelationsMLetAbout
MBean org.jumpmind.symmetric.SymmetricDS:name=Node
Description The management interface for a node
Attributes
Name
Description
Type
Value
New Value
BasicDataSourceWhether the basic DataSource is being used as the default datasource.booleantrueRead-only attribute
ExternalIdAn external name given to this SymmetricDS nodejava.lang.String2368908Read-only attribute
NodeConcurrencyStatisticsAsTextGet connection statistics about indivdual nodesjava.lang.StringRead-only attribute
NodeGroupIdThe group this node belongs tojava.lang.StringCONCENTRADORES_N1Read-only attribute
NodeIdThe node id given to this SymmetricDS nodejava.lang.String2368908Read-only attribute
NodesInWhiteListGet a list of nodes that have been added to the white list, a list of node ids that always get through the concurrency manager.java.lang.StringRead-only attribute
NumberOfActiveConnectionsIf a BasicDataSource, then show the number of active connectionsint0Read-only attribute
NumfNodeConnectionsPerInstanceGet the number of current connections allowed to this instance of the node via HTTP. If this value is 20, then 20 concurrent push clients and 20 concurrent pull clients will be allowedint5Read-only attribute
NumOfNodeConnectionsPerInstanceConfigure the number of connections allowed to this node. If the value is set to zero you are effectively disabling your transport (wihch can be useful for maintainanceintWrite-only attribute
StartedChecks if SymmetricDS has been started.booleantrueRead-only attribute
Operations
Name
Return type
Description
encryptTextjava.lang.StringEncrypts plain text for use with db.user and db.password properties
Parameters
idNameDescriptionClass
0
plainTextPlain text to encryptjava.lang.String
reopenRegistrationvoidRe-open the registration for a node with the specified external id
Parameters
idNameDescriptionClass
0
nodeIdThe node id to reopen registration forjava.lang.String
writeBatchRangeToFilevoidWrite a range of batches to a file in SymmetricDS Data Format.
Parameters
idNameDescriptionClass
0
nodeIdThe node id for the batches which will be writtenjava.lang.String
1
startBatchIdStarting batch ID of rangejava.lang.String
2
endBatchIdEnding batch ID of rangejava.lang.String
3
fileNameFile name to write batchesjava.lang.String
cleanStaginglongClean up both incoming and outgoing resources that are older than the passed in number of milliseconds
Parameters
idNameDescriptionClass
0
timeToLiveInMSThe number of milliseconds old a resource should be before it is cleaned uplong
getNumfNodeConnectionsPerInstanceintGet the number of current connections allowed to this instance of the node via HTTP. If this value is 20, then 20 concurrent push clients and 20 concurrent pull clients will be allowed
getNodeConcurrencyStatisticsAsTextjava.lang.StringGet connection statistics about indivdual nodes
getNodesInWhiteListjava.lang.StringGet a list of nodes that have been added to the white list, a list of node ids that always get through the concurrency manager.
addNodeToWhiteListvoidAdd a node id to the list of nodes that will always get through the concurrency manager
Parameters
idNameDescriptionClass
0
nodeIdThe node id to add to the white listjava.lang.String
removeNodeFromWhiteListvoidRemove a node id to the list of nodes that will always get through the concurrency manager
Parameters
idNameDescriptionClass
0
nodeIdThe node id to remove from the white listjava.lang.String
setNumOfNodeConnectionsPerInstancevoidConfigure the number of connections allowed to this node. If the value is set to zero you are effectively disabling your transport (wihch can be useful for maintainance
Parameters
idNameDescriptionClass
0
valuevalueint
isBasicDataSourcebooleanWhether the basic DataSource is being used as the default datasource.
getNumberOfActiveConnectionsintIf a BasicDataSource, then show the number of active connections
setSyncEnabledForNodebooleanEnable or disable synchronization completely for a node
Parameters
idNameDescriptionClass
0
nodeIdThe node to enable or disablejava.lang.String
1
syncEnabledtrue is enabled, false is disabledbooleantrue false
extractBatcheRangebooleanExtract multiple batches to a file for a time range
Parameters
idNameDescriptionClass
0
fileNameThe file to write the batch output tojava.lang.String
1
nodeIdThe target node id whose batches need extractedjava.lang.String
2
startTimeThe start time range to extract. The format is yyyy-MM-dd hh:mmjava.lang.String
3
endTimeThe start time range to extract. The format is yyyy-MM-dd hh:mmjava.lang.String
4
channelIdListA comma separated list of channels to extractjava.lang.String
purgevoidRun the outgoing purge process
snapshotjava.lang.StringCreate a snapshot of the current state of the system
openRegistrationvoidOpen the registration for a node with the specified external id
Parameters
idNameDescriptionClass
0
nodeGroupThe node group id this node will belong tojava.lang.String
1
externalIdThe external id for the nodejava.lang.String
isStartedbooleanChecks if SymmetricDS has been started.
clearCachesvoidForce the cached objects to be reread from the database the next time they are accessed
sendSQLjava.lang.StringSend a SQL event to a node.
Parameters
idNameDescriptionClass
0
nodeIdThe node id to sent the event to.java.lang.String
1
catalogNameThe catalog name to reload. Can be null.java.lang.String
2
schemaNameThe schema name to reload. Can be null.java.lang.String
3
tableNameThe table name the SQL is for.java.lang.String
4
sqlThe SQL statement to send.java.lang.String
reloadNodejava.lang.StringSend an initial load of data to a node.
Parameters
idNameDescriptionClass
0
nodeIdThe node id to reload.java.lang.String
syncTriggersvoidSynchronize the triggers
getNodeIdjava.lang.StringThe node id given to this SymmetricDS node
getNodeGroupIdjava.lang.StringThe group this node belongs to
getExternalIdjava.lang.StringAn external name given to this SymmetricDS node
clearAllLocksvoidEmergency remove all locks (if left abandoned on a cluster)
ignoreNodeChannelForExternalIdvoidEnable or disable a channel for a specific external id
Parameters
idNameDescriptionClass
0
ignoreSet to true to enable and false to disablebooleantrue false
1
channelIdThe channel id to enable or disablejava.lang.String
2
nodeGroupIdThe node group id for a nodejava.lang.String
3
externalIdThe external id for a nodejava.lang.String
isExternalIdRegisteredbooleanCheck to see if the external id is registered
Parameters
idNameDescriptionClass
0
nodeGroupIdThe node group id for a nodejava.lang.String
1
externalIdThe external id for a nodejava.lang.String
reloadTablejava.lang.StringSend a delete and reload of a table to a node.
Parameters
idNameDescriptionClass
0
nodeIdThe node id to reload.java.lang.String
1
catalogNameThe catalog name to reload. Can be null.java.lang.String
2
schemaNameThe schema name to reload. Can be null.java.lang.String
3
tableNameThe table name to reload.java.lang.String
4
overrideInitialLoadSelectOverride initial load select where-clause.java.lang.String
reloadTablejava.lang.StringSend a delete and reload of a table to a node.
Parameters
idNameDescriptionClass
0
nodeIdThe node id to reload.java.lang.String
1
catalogNameThe catalog name to reload. Can be null.java.lang.String
2
schemaNameThe schema name to reload. Can be null.java.lang.String
3
tableNameThe table name to reload.java.lang.String
areAllLoadBatchesCompletebooleanCheck to see if the initial load for a node id is complete. This method will throw an exception if the load error'd out or was never started.
Parameters
idNameDescriptionClass
0
nodeIdThe node idjava.lang.String
startbooleanStart the SymmetricDS engine
stopvoidStop the SymmetricDS engine
Constructors
 
Built using MX4J HttpAdaptor