You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2008/04/04 21:07:38 UTC
svn commit: r644825 - in /db/derby/docs/trunk/src:
adminguide/cadminconfig86869.dita
adminguide/tadminconfigsysteminformation.dita devguide/cdevbabejgjd.dita
tuning/ctunsetprop824983.dita
Author: chaase3
Date: Fri Apr 4 12:07:35 2008
New Revision: 644825
URL: http://svn.apache.org/viewvc?rev=644825&view=rev
Log:
DERBY-3540: Document the JMX management and monitoring functionality
First step toward documenting this new functionality: modifications to four files providing minimal documentation and pointers to wiki and javadoc.
Patch: DERBY-3540-3.diff
Contributed by John Embretsen and Kim Haase
Modified:
db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita
db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
db/derby/docs/trunk/src/devguide/cdevbabejgjd.dita
db/derby/docs/trunk/src/tuning/ctunsetprop824983.dita
Modified: db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita?rev=644825&r1=644824&r2=644825&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita Fri Apr 4 12:07:35 2008
@@ -24,7 +24,18 @@
an embedded part of the application. </shortdesc>
<prolog></prolog>
<conbody>
-<p>It can also be managed remotely from a web server by using a servlet interface.
+<p>You can use Java Management Extensions (JMX) technology to monitor and manage
+<ph conref="../conrefs.dita#prod/productshortname"></ph> and the Network Server. For information on how
+to do this, visit the wiki page
+<xref format="html" href="http://wiki.apache.org/db-derby/DerbyJMX"
+scope="external">http://wiki.apache.org/db-derby/DerbyJMX</xref> and refer to
+the API documentation for the packages <codeph>org.apache.derby.mbeans</codeph>
+and <codeph>org.apache.derby.mbeans.drda</codeph>. For information on JMX
+technology, see
+<xref format="html" href="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"
+scope="external">http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/</xref>.
+</p>
+<p>The Network Server can also be managed remotely from a web server by using a servlet interface.
You can manage the Network Server by using shell scripts, the command line,
or the Network Server API. See <xref href="cadminservlet98430.dita#cadminservlet98430"></xref> for
information about starting and shutting down the Network Server using the
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita?rev=644825&r1=644824&r2=644825&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita Fri Apr 4 12:07:35 2008
@@ -38,6 +38,16 @@
</steps-unordered>
<example><p>For more information on the <codeph>sysinfo</codeph> utility, see
the <ph conref="../conrefs.dita#pub/citutilities"></ph>.</p>
+<p>You can also use Java Management Extensions (JMX) technology to obtain
+system information. For details, visit the wiki page
+<xref format="html" href="http://wiki.apache.org/db-derby/DerbyJMX"
+scope="external">http://wiki.apache.org/db-derby/DerbyJMX</xref> and refer to
+the API documentation for the packages <codeph>org.apache.derby.mbeans</codeph>
+and <codeph>org.apache.derby.mbeans.drda</codeph>. For information on JMX
+technology, see
+<xref format="html" href="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"
+scope="external">http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/</xref>.
+</p>
</example>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/devguide/cdevbabejgjd.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevbabejgjd.dita?rev=644825&r1=644824&r2=644825&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevbabejgjd.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevbabejgjd.dita Fri Apr 4 12:07:35 2008
@@ -90,7 +90,31 @@
can reload the policy file by calling the <codeph>SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY</codeph> system
procedure. For more information, see the section which describes this procedure
in <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>. </dd>
-</dlentry></dl> </section>
+</dlentry><dlentry>
+<dt>permission javax.management.MBeanServerPermission "createMBeanServer";</dt>
+<dd>Allows Derby to create an MBean server. If the JVM running Derby supports
+the platform MBean server, Derby will automatically try to create such a
+server if it does not already exist. For details, visit the wiki page
+<xref format="html" href="http://wiki.apache.org/db-derby/DerbyJMX"
+scope="external">http://wiki.apache.org/db-derby/DerbyJMX</xref>.
+</dd>
+</dlentry><dlentry>
+<dt>permission javax.management.MBeanPermission "org.apache.derby.*#[org.apache.derby:*]","registerMBean,unregisterMBean";</dt>
+<dd>Allows Derby to register and unregister its (JMX) MBeans. Such MBeans are
+associated with the domain "org.apache.derby", which is also the prefix of
+the fully qualified class name of all Derby MBeans. For more information about
+Derby's MBeans, refer to the public API (Javadoc) of the package
+org.apache.derby.mbeans and its subpackages. It is possible to fine tune
+this permission, for example in order to allow access only to certain MBeans.
+To fine tune this permission, see the javadoc of javax.management.MBeanPermission
+or the JMX Instrumentation and Agent Specification.
+</dd>
+</dlentry><dlentry>
+<dt>permission javax.management.MBeanTrustPermission "register";</dt>
+<dd>Trusts Derby code to be the source of MBeans and to register these in
+the MBean server.</dd>
+</dlentry>
+</dl> </section>
<section><title>Combining permissions</title><p>You might grant one <i>FilePermission</i> that
encompasses several or all of the permissions instead of separately granting
a number of the more specific permissions. For example:<codeblock>permission java.io.FilePermission "${derby.system.home}/-", "read,write,delete";</codeblock
Modified: db/derby/docs/trunk/src/tuning/ctunsetprop824983.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tuning/ctunsetprop824983.dita?rev=644825&r1=644824&r2=644825&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tuning/ctunsetprop824983.dita (original)
+++ db/derby/docs/trunk/src/tuning/ctunsetprop824983.dita Fri Apr 4 12:07:35 2008
@@ -30,4 +30,15 @@
System.out.println("derby.storage.pageSize value: "
+ sprops.getProperty("derby.storage.pageSize"));
</b></codeblock></p>
+<p>You can also use Java Management Extensions (JMX) technology to obtain
+system information, including some settings that correspond to system
+properties. For details, visit the wiki page
+<xref format="html" href="http://wiki.apache.org/db-derby/DerbyJMX"
+scope="external">http://wiki.apache.org/db-derby/DerbyJMX</xref>
+and refer to the API documentation
+for the packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda.
+For information on JMX technology, see
+<xref format="html" href="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/"
+scope="external">http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/</xref>
+</p>
</conbody></concept>