JMX MBean View

647c07faf5bd

Sat Dec 21 13:56:47 UTC 2024

Name	Domain	jboss.messaging
Name	service	ServerPeer
Java Class	org.jboss.mx.modelmbean.XMBean
Description	JBoss Messaging Server Peer

Attribute Name	Access	Type	Description	Attribute Value
PersistenceManager	RW	javax.management.ObjectName	The ObjectName of the persistence manager	View MBean
PostOffice	RW	javax.management.ObjectName	The ObjectName of the post office	View MBean
JMSUserManager	RW	javax.management.ObjectName	The ObjectName of the jms user manager	View MBean
Instance	R	java.lang.Object	The instance to be accessed by select plugins via a typed hard reference	ServerPeer[0]
JMSVersion	R	java.lang.String	The version of the JMS specification implemented by this provider	1.1
JMSMajorVersion	R	int	The major version of the JMS specification implemented by this provider	1
JMSMinorVersion	R	int	The minor version of the JMS specification implemented by this provider	1
JMSProviderName	R	java.lang.String	The JMS provider name	JBoss Messaging
ProviderVersion	R	java.lang.String	The fully qualified provider version string	1.4.3.GA
ProviderMajorVersion	R	int	The JMS provider major version number	1
ProviderMinorVersion	R	int	The JMS provider minor version number	4
Destinations	R	java.util.Set	Returns a Set of javax.jms.Destinations (Queues and Topics) containing the current active destinations	[JBossQueue[DLQ], JBossQueue[ExpiryQueue], JBossTopic[testTopic]]
MessageCounters	R	java.util.List	The message counters	[Queue,Queue.ExpiryQueue,-,-,0,0,0,0,-, Queue,Queue.DLQ,-,-,0,0,0,0,-]
MessageStatistics	R	java.util.List	The message statistics	[Queue,Queue.ExpiryQueue,-,-,0,0,0,0,-, Queue,Queue.DLQ,-,-,0,0,0,0,-]
DefaultDLQ	RW	javax.management.ObjectName	The ObjectName of the default DLQ - used when an individual queue does not specify a DLQ	View MBean
DefaultExpiryQueue	RW	javax.management.ObjectName	The ObjectName of the default expiry queue - used when an individual queue does not specify an expiry queue	View MBean
ServerPeerID	RW	int	The ID of the ServerPeer. Must be unique per JBoss instance
DefaultQueueJNDIContext	RW	java.lang.String	The default JNDI context queues are bound under.
DefaultTopicJNDIContext	RW	java.lang.String	The default JNDI context topics are bound under.
ServerAopConfig	RW	java.lang.String	The aop.xml resource name for the server aspects.
ClientAopConfig	RW	java.lang.String	The aop.xml resource name for the client aspects.
SecurityStore	RW	org.jboss.jms.server.SecurityStore	The SecurityStore implementation for the server.
DefaultMaxDeliveryAttempts	RW	int	The default maximum delivery attempts for destinations, unless overridden on the destination
FailoverStartTimeout	RW	long	The maximum amount of time to wait for failover to begin
FailoverCompleteTimeout	RW	long	The maximum amount of time to wait for failover to complete
DefaultRedeliveryDelay	RW	long	How long to wait before redelivery, can be overridden on the destination
MessageCounterSamplePeriod	RW	long	The period between which the message counter manager enquires for statistics from queues
ClusterPullConnectionFactoryName	RW	java.lang.String	The name of the connection factory used to create connections to pull messages from one node to another
DefaultPreserveOrdering	RW	boolean	When pulling messages do we need to preserve the ordering of messages consumed from a particular producer, for a particular consumer?	TrueFalse
RecoverDeliveriesTimeout	RW	long	When a failover occurs the max. amount of time the server will keep messages in its recovery area. waiting for clients to reconnect
DefaultMessageCounterHistoryDayLimit	RW	int	The default max number of messages per day in message counter history
SupportsFailover	RW	boolean	Should Server Side Failover be executed	TrueFalse
StrictTck	RW	boolean	Should strict TCK behaviour be always followed?	TrueFalse
EnableMessageCounters	RW	boolean	Enable message counters	TrueFalse
SuckerPassword	W	java.lang.String	The password used for message suckers. Must match the SecurityStore.SuckerPassword.

Operation

Return Type

Description

Parameters

create

void

JBoss Service lifecycle operation

start

void

JBoss Service lifecycle operation

stop

void

JBoss Service lifecycle operation

destroy

void

JBoss Service lifecycle operation

deployQueue

java.lang.String

Deploys a queue with the specified name/JNDI name. The corresponding destination service will be instantiated, created and started.

deployQueue

java.lang.String

Deploys a queue with the specified name/JNDI name and paging parameters. The corresponding destination service will be instantiated, created and started.

undeployQueue

boolean

Undeploys the queue, but does not delete its data from storage.

destroyQueue

boolean

Undeploys the queue, and deletes its data from storage

deployTopic

java.lang.String

Deploys a topic with the specified name/JNDI name. The corresponding destination service will be instantiated, created and started.

deployTopic

java.lang.String

Deploys a topic with the specified name/JNDI name and paging parameters. The corresponding destination service will be instantiated, created and started.

undeployTopic

boolean

Undeploys the topic, but does not delete all its data from storage

destroyTopic

boolean

Undeploys the topic and deletes all its data

listMessageCountersAsHTML

java.lang.String

List all message counters in HTML

resetAllMessageCounters

void

Reset all message counters

resetAllMessageCounterHistories

void

Reset all message counter histories

enableMessageCounters

void

Enable message counters

disableMessageCounters

void

Disable message counters

retrievePreparedTransactions

java.util.List

Retrieve list of all prepared transaction ids

showPreparedTransactionsAsHTML

java.lang.String

Show of all prepared transaction ids in HTML

showActiveClientsAsHTML

java.lang.String

Show of all information about active clients