Bug 864600 - Mbean documentation is incomplete
Summary: Mbean documentation is incomplete
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Data Grid 6
Classification: JBoss
Component: Documentation
Version: 6.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: 6.1.0
Assignee: gsheldon
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-10-09 17:52 UTC by Alan Santos
Modified: 2015-02-06 01:19 UTC (History)
5 users (show)

Fixed In Version:
Clone Of:
Environment:
Instance Name: Not Defined Build: CSProcessor Builder Version 1.6 Build Filter: null Build Name: Build Date: 17-09-2012 15:39:23
Last Closed: 2013-02-18 00:13:04 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Alan Santos 2012-10-09 17:52:04 UTC
Description of problem:

The description of JMX MBeans in the Admin documentation lacks a full list of all possible mbeans and does not differentiate between client/serber mode (where the manual registration is not necessary) and library.



Expected results:

A full list of mbeans, their supported operations and attributes.

Comment 4 Tomas Sykora 2012-10-31 09:54:34 UTC
Hi Gemma, 
nice and precise work!
I was browsing the code directly to prove doc.

'Big' change A.13.20: 

please see this MBean: http://docs.jboss.org/infinispan/5.2/apidocs/jmxComponents.html#XSiteAdmin
there were added new operations meanwhile, we need to include them too.

Sorry for nitpicking:
A.13.4: DefinedCacheName --> DefinedCacheNames
A.13.4: StartCache --> startCache

A.13.8: CacheName and its type is String[] (array) apidocs say only String but code really says String[] (I don't know why it is not included in apidoc? Developers should clarify this I suppose.)

A.13.16: StateTransferManager have no operations recently. I can see some TODOs inside of code. Don't know what is happening right now.

Comment 6 Tomas Sykora 2012-11-02 09:59:22 UTC
Checked, perfect! Thanks


Note You need to log in before you can comment on or make changes to this bug.