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 2012/04/13 19:25:31 UTC
svn commit: r1325856 - /db/derby/docs/trunk/src/adminguide/
Author: chaase3
Date: Fri Apr 13 17:25:30 2012
New Revision: 1325856
URL: http://svn.apache.org/viewvc?rev=1325856&view=rev
Log:
DERBY-5637 Document Derby's JMX capabilities and how to disable them
Modified 8 Admin Guide topics.
Patch: DERBY-5637-2.diff
Modified:
db/derby/docs/trunk/src/adminguide/cadminjmxoverview.dita
db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita
db/derby/docs/trunk/src/adminguide/radminjmxintro.dita
db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita
db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita
Modified: db/derby/docs/trunk/src/adminguide/cadminjmxoverview.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminjmxoverview.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminjmxoverview.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminjmxoverview.dita Fri Apr 13 17:25:30 2012
@@ -46,7 +46,7 @@ security features to enable this access.
<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> JMX features are
automatically available when
<ph conref="../conrefs.dita#prod/productshortname"></ph> is started in a JVM
-that supports the platform MBean Server. Java SE 5 and subsequent releases all
+that supports the platform MBean server. Java SE 5 and subsequent releases all
support JMX technology.</p>
<p>You start <ph conref="../conrefs.dita#prod/productshortname"></ph> by loading
the <ph conref="../conrefs.dita#prod/productshortname"></ph> embedded driver. If
Modified: db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxcode.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxcode.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxcode.dita Fri Apr 13 17:25:30 2012
@@ -33,9 +33,8 @@ application. How to do this may depend o
running <ph conref="../conrefs.dita#prod/productshortname"></ph>, how you
configure user authentication and authorization, or the host(s) from which you
want to access the MBeans.</p>
-<p>This section has some example code to help you get started. It is assumed
-that the client JVM supports Java SE 5, 6, or 7. You will find the JMX classes
-you need in the packages <codeph>javax.management</codeph> and
+<p>This section has some example code to help you get started. You will find the
+JMX classes you need in the packages <codeph>javax.management</codeph> and
<codeph>javax.management.remote</codeph>.</p>
<p>You do not need any <ph conref="../conrefs.dita#prod/productshortname"></ph>
libraries in the JMX client application's classpath (unless MBean proxies are
@@ -43,7 +42,7 @@ used).</p>
</section>
<section id="connmbeanserver"><title>Connecting to the MBean Server</title>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> will attempt to
-register its MBeans with the Platform MBean Server of the JVM running the
+register its MBeans with the platform MBean server of the JVM running the
<ph conref="../conrefs.dita#prod/productshortname"></ph> system (embedded or
Network Server). The following examples assume that you have configured the
<ph conref="../conrefs.dita#prod/productshortname"></ph> JVM to enable remote
Modified: db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita Fri Apr 13 17:25:30 2012
@@ -50,15 +50,9 @@ permission javax.management.MBeanPermiss
"org.apache.derby.*#[org.apache.derby:*]",
"registerMBean,unregisterMBean";</codeblock>
<p>If the permission to register MBeans is not granted to
-<codeph>derby.jar</codeph>, the
-<codeph>JMXManagementService.jmxRegister()</codeph> method will silently ignore
-any requests to register MBeans, as can be seen from this <codeph>catch</codeph>
-block in that method:</p>
-<codeblock> } catch (SecurityException se) {
- // If we can't register the MBean, then so be it.
- // The application can later enable the MBeans
- // by using org.apache.derby.mbeans.Management
- } </codeblock>
+<codeph>derby.jar</codeph>,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> will silently skip
+starting the management service at boot time.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita Fri Apr 13 17:25:30 2012
@@ -29,7 +29,7 @@ limitations under the License.
<p>The following simple example starts the
<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server on the
command line with <i>insecure</i> remote JMX management and monitoring enabled,
-using the Oracle JDK 6 or 7 JVM. Password authentication over SSL is enabled by
+using an Oracle JDK 6 or later JVM. Password authentication over SSL is enabled by
default, but here these security features are disabled, to keep the example
simple.</p>
<p><note type="important">It is not recommended to disable authentication or SSL
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita Fri Apr 13 17:25:30 2012
@@ -27,7 +27,7 @@ limitations under the License.
<refbody>
<section>
<p>Some JVMs include built-in support for JMX password authentication. For
-example, with Oracle Java Development Kit (JDK) 6 or 7, authentication is
+example, with Oracle Java Development Kit (JDK) 6 or later, authentication is
enabled by default, and it is possible to specify a properties file that
contains usernames and passwords. The properties file syntax is the same as for
other Java properties files.</p>
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita Fri Apr 13 17:25:30 2012
@@ -28,7 +28,7 @@ limitations under the License.
<section>
<p>This example shows how to start the Network Server as follows:</p>
<ul>
-<li>Using Oracle JDK 6 or 7</li>
+<li>Using Oracle JDK 6 or later</li>
<li>Using a Java security manager and a custom policy file,
<codeph>jmx.policy</codeph></li>
<li>Allowing connections from remote hosts (that is, on all IPv4 network
Modified: db/derby/docs/trunk/src/adminguide/radminjmxintro.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxintro.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxintro.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxintro.dita Fri Apr 13 17:25:30 2012
@@ -42,8 +42,8 @@ scope="external">http://db.apache.org/de
<ph conref="../conrefs.dita#prod/productshortname"></ph> system jar file.</p>
<ul>
<li>Interface: <codeph>org.apache.derby.mbeans.VersionMBean</codeph></li>
-<li>Implementation: <codeph>org.apache.derby.iapi.services.info.Version (not
-public)</codeph></li>
+<li>Implementation: <codeph>org.apache.derby.iapi.services.info.Version</codeph>
+(not in the public API)</li>
<li>ObjectName:
<codeph>org.apache.derby:type=Version,system=<sysID>,jar=derby.jar</codeph>
(monitors <codeph>derby.jar</codeph>, the
@@ -58,8 +58,8 @@ public)</codeph></li>
<p><codeph>JDBCMBean</codeph> exposes information about the JDBC driver.</p>
<ul>
<li>Interface: <codeph>org.apache.derby.mbeans.JDBCMBean</codeph></li>
-<li>Implementation: <codeph>org.apache.derby.jdbc.JDBC</codeph> (not
-public)</li>
+<li>Implementation: <codeph>org.apache.derby.jdbc.JDBC</codeph> (not in the
+public API)</li>
<li>ObjectName: <codeph>org.apache.derby:type=JDBC,system=<sysID></codeph>
</li>
<li>Instruments:
@@ -73,17 +73,17 @@ public)</li>
not).</p>
<ul>
<li>Interface <codeph>org.apache.derby.mbeans.ManagementMBean</codeph></li>
-<li>Implementation: <codeph>org.apache.derby.mbeans.Management</codeph> (public;
-may be registered by JMX clients)</li>
+<li>Implementation: <codeph>org.apache.derby.mbeans.Management</codeph> (part of
+the public API; may be registered by JMX clients)</li>
<li>Extended by:
<codeph>org.apache.derby.iapi.services.jmx.ManagementService</codeph>
-(interface; not public), with the following implementations:
+(interface; not in the public API), with the following implementations:
<ul>
<li><codeph>org.apache.derby.impl.services.jmx.JMXManagementService</codeph>
(not public)</li>
<li><codeph>org.apache.derby.impl.services.jmxnone.NoManagementService</codeph>
-(not public; empty implementation for environments without the required JMX
-support)</li>
+(not in the public API; empty implementation for environments without the
+required JMX support)</li>
</ul>
</li>
<li>ObjectName:
@@ -102,7 +102,7 @@ of the Network Server.</p>
<codeph>org.apache.derby.mbeans.drda.NetworkServerMBean</codeph></li>
<li>Implementation:
<codeph>org.apache.derby.impl.drda.NetworkServerMBeanImpl</codeph> (not
-public)</li>
+in the public API)</li>
<li>ObjectName:
<codeph>org.apache.derby:type=NetworkServer,system=<sysID></codeph></li>
<li>Instruments:
Modified: db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita Fri Apr 13 17:25:30 2012
@@ -30,12 +30,12 @@ limitations under the License.
<p>JConsole is a graphical JMX-compliant tool that is available in recent
versions of the Oracle JDKs. JConsole enables you to monitor and manage Java
applications and virtual machines on a local or remote machine.</p>
-<p>You may use JConsole from JDK 6 or 7 even if you are running
+<p>You may use JConsole from JDK 6 or later even if you are running
<ph conref="../conrefs.dita#prod/productshortname"></ph> using an earlier
version of the JDK (or just the JRE). (You could also use JConsole from JDK 5 if
you are running <ph conref="../conrefs.dita#prod/productshortname"></ph> using
-JDK 6 or 7.) It is recommended that you use the newest version possible. More
-information about JConsole is available in the OpenJDK project at
+JDK 6 or later.) It is recommended that you use the newest version possible.
+More information about JConsole is available in the OpenJDK project at
<xref format="html"
href="http://openjdk.java.net/tools/svc/jconsole/index.html"
scope="external">http://openjdk.java.net/tools/svc/jconsole/index.html</xref>.</p>
@@ -45,7 +45,7 @@ scope="external">http://openjdk.java.net
<codeph>JDK_HOME/bin</codeph>, where JDK_HOME is the directory in which the JDK
is installed. To start JConsole, use the <codeph>jconsole</codeph> command, as
in the following example on a UNIX system:</p>
-<codeblock><b>/usr/local/java/jdk1.6.0/bin/jconsole</b></codeblock>
+<codeblock><b>/usr/local/java/jdk1.7.0/bin/jconsole</b></codeblock>
<p>If you did not disable SSL when booting the managed JVM, you probably have
to provide a truststore containing the server's SSL certificate to be able to
establish JMX connections. If SSL client authentication is enabled, a keystore
@@ -67,8 +67,8 @@ and port number, or a JMX service URL, i
<p>If you cannot find the Derby JVM running on the local host, make sure you are
running JConsole as the same user as the Derby JVM, or as a different user with
sufficient file system permissions. If you are using Java SE 5, make sure you
-have enabled JMX. When you use Java SE 6 or 7, local JMX access is enabled by
-default.</p>
+have enabled JMX. When you use Java SE 6 or later, local JMX access is enabled
+by default.</p>
</section>
<section><title>Accessing MBeans</title>
<p>Once you have connected to a JVM via JConsole, the JVM's MBeans should be
Modified: db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita?rev=1325856&r1=1325855&r2=1325856&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita Fri Apr 13 17:25:30 2012
@@ -28,7 +28,7 @@ limitations under the License.
<section>
<p>If you experience problems connecting remotely to an MBean server using JMX
(as described in <xref href="radminjmxjconsole.dita#radminjmxjconsole"></xref>
-and <xref href="radminjmxcode.dita#radminjmxcode"></xref>), It may be helpful to
+and <xref href="radminjmxcode.dita#radminjmxcode"></xref>), it may be helpful to
obtain some tracing information. The JMX implementation in the Oracle JDK uses
the <codeph>java.util.logging</codeph> API to log JMX traces. For example, in
order to trace SSL connection issues, set the system property