db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From be...@apache.org
Subject svn commit: r641762 - in /db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda: NetworkServerMBean.java package.html
Date Thu, 27 Mar 2008 10:01:29 GMT
Author: bernt
Date: Thu Mar 27 03:01:27 2008
New Revision: 641762

URL: http://svn.apache.org/viewvc?rev=641762&view=rev
Log:
DERBY-3435 Javadoc changes + package.html. Submitted by John Embretsen

Added:
    db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html   (with props)
Modified:
    db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/NetworkServerMBean.java

Modified: db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/NetworkServerMBean.java
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/NetworkServerMBean.java?rev=641762&r1=641761&r2=641762&view=diff
==============================================================================
--- db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/NetworkServerMBean.java (original)
+++ db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/NetworkServerMBean.java Thu
Mar 27 03:01:27 2008
@@ -22,16 +22,27 @@
 package org.apache.derby.mbeans.drda;
 
 /**
+ * <p>
  * This is an MBean defining a JMX management and monitoring interface of 
- * Derby's Network Server.
- * This interface consists of getter and setter methods for attributes that may
- * be read and/or modified, and methods representing operations that can be 
- * invoked.
+ * Derby's Network Server.</p>
+ * <p>
+ * This MBean is created and registered automatically at Network Server startup
+ * if all requirements are met (J2SE 5.0 or better).</p>
+ * <p>
+ * Key properties for the registered MBean:
+ * <ul>
+ * <li><code>type=NetworkServer</code></li>
+ * <li><code>system=</code><em>runtime system identifier</em>
(see 
+ *     <a href="../package-summary.html#package_description">description of 
+ * package org.apache.derby.mbeans</a>)</li>
+ * </ul>
  * 
- * For more information on Managed Beans, refer to the JMX specification.
+ * <p>
+ * For more information on Managed Beans, refer to the JMX specification.</p>
  *
  * @see org.apache.derby.drda.NetworkServerControl
  * @see org.apache.derby.security.SystemPermission
+ * @see <a href="../package-summary.html"><code>org.apache.derby.mbeans</code></a>
  */
 public interface NetworkServerMBean {
     
@@ -43,259 +54,385 @@
     //   No attribute setting yet due to security concerns, see DERBY-1387.
     
     /**
-     * Gets the value of the <code>derby.drda.host</code> network server
-     * setting. In this context, the host defines the network interface on which
-     * the Network Server is listening for connections. "<code>0.0.0.0</code>"

-     * means that the server allows connections from any host on the network.
-     * 
-     * <P>
-     * Require <code>SystemPermission("server", "control")</code> if a security
-     * manager is installed.
-     *
-     * @return the value of <code>derby.drda.host</code>
+     * <p>
+     * Gets the network interface address on which the Network Server is 
+     * listening. This corresponds to the value of the 
+     * <code>derby.drda.host</code> property.</p>
+     * <p>
+     * For example, the value "<code>localhost</code>" means that the 
+     * Network Server is listening on the local loopback interface only.
+     * <p>
+     * The special value "<code>0.0.0.0</code>" (IPv4 environments only)
+     * represents the "unspecified address" - also known as the anylocal or 
+     * wildcard address.  In this context this means that the server is 
+     * listening on all network interfaces (and may thus be able to see 
+     * connections from both the local host as well as remote hosts, depending
+     * on which network interfaces are available).</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "control")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the the network interface address on which the Network Server is 
+     *         listening (<code>derby.drda.host</code>)
      */
     public String getDrdaHost();
     
     /**
-     * Gets the value of the <code>derby.drda.keepAlive</code> network server
-     * setting. 
+     * <p>
+     * Reports whether or not the Derby Network Server will send keepalive 
+     * probes and attempt to clean up connections for disconnected clients (the 
+     * value of the <code>derby.drda.keepAlive</code> property).</p>
+     * <p>
+     * If <code>true</code>, a keepalive probe is sent to the client if a "long

+     * time" (by default, more than two hours) passes with no other data being 
+     * sent or received. This will detect and clean up connections for clients 
+     * on powered-off machines or clients that have disconnected unexpectedly.
+     * </p>
+     * <p>
+     * If false, Derby will not attempt to clean up connections from
+     * disconnected clients, and will not send keepalive probes.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
      * 
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
      * @see <a href="http://db.apache.org/derby/docs/dev/adminguide/radmindrdakeepalive.html"><code>derby.drda.keepAlive</code>
documentation</a>
-     * @return the value of <code>derby.drda.keepAlive</code>
+     * @return whether or not the Derby Network Server will send keepalive 
+     *         probes and attempt to clean up connections for disconnected 
+     *         clients (<code>derby.drda.keepAlive</code>)
      */
     public boolean getDrdaKeepAlive();
     
     /**
-     * Gets the value of the <code>derby.drda.maxThreads</code> network server

-     * setting.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
+     * <p>
+     * Reports the maximum number of client connection threads the Network 
+     * Server will allocate at any given time. This corresponds to the 
+     * <code>derby.drda.maxThreads</code> property.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
      *
-     * @return the value of the <code>derby.drda.maxThreads</code> network 
-     *         server setting
+     * @return the maximum number of client connection threads the Network 
+     *         Server will allocate at any given time 
+     *         (<code>derby.drda.maxThreads</code>)
      */
     public int getDrdaMaxThreads();
     //public void setDrdaMaxThreads(int max) throws Exception;
     
     /**
-     * Gets the value of the <code>derby.drda.portNumber</code> network server
-     * setting. This is the port number on which the Network Server is listening
-     * for client connections.
-     * 
-     * <P>
-     * Require <code>SystemPermission("server", "control")</code> if a security
-     * manager is installed.
-     *
+     * <p>
+     * Gets the port number on which the Network Server is listening for client 
+     * connections. This corresponds to the value of the 
+     * <code>derby.drda.portNumber</code> Network Server setting.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "control")</code> if a security
+     * manager is installed.</p>
+     * 
      * @return the port number on which the Network Server is listening
      *         for client connections.
      */
     public int getDrdaPortNumber();
     
     /**
-     * Gets the value of the <code>derby.drda.securityMechanism</code> network

-     * server setting. 
+     * <p>
+     * The Derby security mechanism required by the Network Server for all 
+     * client connections. This corresponds to the value of the 
+     * <code>derby.drda.securityMechanism</code> property on the server.</p>
+     * <p>
+     * If not set, the empty String will be returned, which means that the 
+     * Network Server accepts any connection which uses a valid security 
+     * mechanism.</p>
+     * <p>
+     * For a list of valid security mechanisms, refer to the 
+     * documentation for the <code>derby.drda.securityMechanism</code> property
+     * in the <i>Derby Server and Administration Guide</i>.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "control")</code> if a security
+     * manager is installed.</p>
      * 
-     * <P>
-     * Require <code>SystemPermission("server", "control")</code> if a security
-     * manager is installed.
-     *
-     * @return the value of the <code>derby.drda.securityMechanism</code> 
-     *         network server setting.
+     * @return the security mechanism required by the Network Server for all 
+     *         client connections (<code>derby.drda.securityMechanism</code>)
      */
     public String getDrdaSecurityMechanism();
     
     /**
-     * Gets the value of the <code>derby.drda.sslMode</code> network server 
-     * setting. 
+     * <p>
+     * Reports whether client connections must be encrypted using Secure 
+     * Sockets Layer (SSL), and whether certificate based peer authentication 
+     * is enabled. Refers to the <code>derby.drda.sslMode</code> property.</p>
+     * <p>
+     * Peer authentication means that the other side of the SSL connection is 
+     * authenticated based on a trusted certificate installed locally.</p>
+     * <p>
+     * The value returned is one of "<code>off</code>" (no SSL encryption), 
+     * "<code>basic</code>" (SSL encryption, no peer authentication) and 
+     * "<code>peerAuthentication</code>" (SSL encryption and peer
+     * authentication). Refer to the <i>Derby Server and Administration 
+     * Guide</i> for more details.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "control")</code> if a security
+     * manager is installed.</p>
      * 
-     * <P>
-     * Require <code>SystemPermission("server", "control")</code> if a security
-     * manager is installed.
-     *
-     * @return the value of the <code>derby.drda.sslMode</code> network server

-     *         setting.
+     * @return whether client connections must be encrypted using Secure 
+     *         Sockets Layer (SSL), and whether certificate based peer 
+     *         authentication is enabled (<code>derby.drda.sslMode</code>)
      */
     public String getDrdaSslMode();
     
     /**
-     * Gets the value of the <code>derby.drda.streamOutBufferSize</code> network
-     * server setting.
-     * This setting is used to configure the size of the buffer used for 
-     * streaming blob/clob from server to client.
+     * <p>
+     * The size of the buffer used for streaming BLOB and CLOB from server to 
+     * client. Refers to the <code>derby.drda.streamOutBufferSize</code> 
+     * property.</p>
+     * <p>
+     * This setting may improve streaming performance when the default sizes of 
+     * packets being sent are significantly smaller than the maximum allowed 
+     * packet size in the network.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
      * 
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
      * @return the size of the buffer used for streaming blob/clob from server 
-     *         to client
+     *         to client (<code>derby.drda.streamOutBufferSize</code>)
      */
     public String getDrdaStreamOutBufferSize();
     
     /**
-     * Gets the value of the <code>derby.drda.timeSlice</code> network server

-     * setting.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
+     * <p>
+     * If the server property <code>derby.drda.maxThreads</code> is set to a

+     * non-zero value, this is the number of milliseconds that each client 
+     * connection will actively use in the Network Server before yielding to 
+     * another connection. If this value is 0, a waiting connection will become
+     * active once a currently active connection is closed.</p>
+     * <p>
+     * Refers to the <code>derby.drda.timeSlice</code> server property.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
      *
-     * @return the value of the <code>derby.drda.timeSlice</code> network 
-     *         server setting
+     * @return the number of milliseconds that each client connection will 
+     *         actively use in the Network Server before yielding to 
+     *         another connection (<code>derby.drda.timeSlice</code>)
+     * @see #getDrdaMaxThreads()
      */
     public int getDrdaTimeSlice();
     //public void setDrdaTimeSlice(int timeSlice) throws Exception;
     
     /**
-     * Gets the value of the <code>derby.drda.traceAll</code> network server

-     * setting.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
+     * <p>
+     * Whether server-side tracing is enabled for all client connections 
+     * (sessions). Refers to the <code>derby.drda.traceAll</code> server 
+     * property.</p>
+     * <p>
+     * Tracing may for example be useful when providing technical support 
+     * information. The Network Server also supports tracing for individual
+     * connections (sessions), see the <i>Derby Server and Administration 
+     * Guide</i> ("Controlling tracing by using the trace facility") for 
+     * details.</p>
+     * <p>
+     * When tracing is enabled, tracing information from each client 
+     * connection will be written to a separate trace file.
+     * </p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
      *
-     * @return the value of the <code>derby.drda.traceAll</code> network 
-     *         server setting
+     * @return whether tracing for all client connections is enabled
+     *         (<code>derby.drda.traceAll</code>)
+     * @see #getDrdaTraceDirectory()
      */
     public boolean getDrdaTraceAll();
     //public void setDrdaTraceAll(boolean on) throws Exception;
     
     /**
-     * Gets the value of the <code>derby.drda.traceDirectory</code> network 
-     * server setting. If this setting has not been explicitly set by the
-     * network server administrator, the default value is returned.
-     * @return the value of the <code>derby.drda.timeSlice</code> network 
-     *         server setting
-     * <P>
-     * Require <code>SystemPermission("server", "control")</code> if a security
-     * manager is installed.
+     * <p>
+     * Indicates the location of tracing files on the server host, if server
+     * tracing has been enabled.</p>
+     * <p>
+     * If the server setting <code>derby.drda.traceDirectory</code> is set,
+     * its value will be returned. Otherwise, the Network Server's default 
+     * values will be taken into account when producing the result.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "control")</code> if a security
+     * manager is installed.</p>
      *
+     * @return the potential location of tracing files on the server host
+     * @see #getDrdaTraceAll()
      */
     public String getDrdaTraceDirectory();
     //public void setDrdaTraceDirectory(String dir) throws Exception;
+    
     /**
-     * Get the number of connections.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of connections.
+     * <p>
+     * Gets the total number of current connections (waiting or active) to the
+     * Network Server.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the number of current connections
+     * @see #getActiveConnectionCount()
+     * @see #getWaitingConnectionCount()
      */
     public int getConnectionCount();
 
     /**
-     * Get the number of active connections. All connections are active if drdaMaxThreads
is 0.
      * <p>
-     * If drdaMaxThreads is > 0 and drdaTimeSlice is 0, connections remain active until
they are
-     * closed. If there are more than drdaMaxThreads connections, connections will be waiting
for some 
-     * connection to close and the call to getConnection will return when the connection
becomes active.
-     * <p>
-     * If drdaMaxThreads is > 0 and drdaTimeSlice > 0, connections will be alternating
beetween active 
-     * and waiting according to Derby's time slicing algorithm.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of active connections
+     * Gets the number of currently active connections. All connections are 
+     * active if the DrdaMaxThreads attribute (<code>derby.drda.maxThreads</code>

+     * property) is 0.</p>
+     * <p>
+     * If DrdaMaxThreads is > 0 and DrdaTimeSlice is 0, connections remain 
+     * active until they are closed. If there are more than DrdaMaxThreads 
+     * connections, inactive connections will be waiting for some active 
+     * connection to close. The connection request will return when the 
+     * connection becomes active.</p>
+     * <p>
+     * If DrdaMaxThreads is > 0 and DrdaTimeSlice > 0, connections will be 
+     * alternating beetween active and waiting according to Derby's time 
+     * slicing algorithm.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the number of active connections
+     * @see #getDrdaMaxThreads()
+     * @see #getDrdaTimeSlice()
+     * @see #getWaitingConnectionCount()
      */
     public int getActiveConnectionCount();
     
     /**
-     * get the number of waiting connections. Always 0 if drdaMaxThreads is 0. 
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of waiting connections
-     * @see NetworkServerMBean#getActiveConnectionCount
+     * <p>
+     * Gets the number of currently waiting connections. This number will always
+     * be 0 if DrdaMaxThreads is 0. Otherwise, if the total number of 
+     * connections is less than or equal to DrdaMaxThreads, then no connections
+     * are waiting.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the number of waiting connections
+     * @see #getActiveConnectionCount()
+     * @see #getDrdaMaxThreads()
+     * @see #getDrdaTimeSlice()
      */
     public int getWaitingConnectionCount();
     
     /**
-     * Get the size of the thread pool.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return size of thread pool
+     * <p>
+     * Get the size of the connection thread pool. If DrdaMaxThreads 
+     * (<code>derby.drda.maxThreads</code>) is set to a non-zero value, the size
+     * of the thread pool will not exceed this value.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the size of the Network Server's connection thread pool
+     * @see #getDrdaMaxThreads()
      */
     public int getConnectionThreadPoolSize();
     
     /**
-     * Get the accumulated number of connections.
-     * <P>
+     * <p>
+     * Gets the accumulated number of connections. This includes all active and
+     * waiting connections since the Network Server was started. This number
+     * will not decrease as long as the Network Server is running.</p>
+     * <p>
      * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of connections.
+     * manager is installed.</p>
+     * 
+     * @return the accumulated number of connections made since server startup
      */
     public int getAccumulatedConnectionCount();
     
     /**
-     * Get the total number of bytes read
-     * <P>
+     * <p>
+     * Gets the total number of bytes read by the server since it was started.
+     * </p>
+     * <p>
      * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of bytes
+     * manager is installed.</p>
+     * 
+     * @return the total number of bytes received by the server
      */
     public long getBytesReceived();
     
-    /** 
-     * Get the total number of bytes written.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return number of bytes
+    /**
+     * <p> 
+     * Gets the total number of bytes written by the server since it was 
+     * started.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the total number of bytes sent by the server
      */
     public long getBytesSent();
     
     /**
-     * Get the number of bytes received pr second. 
-     * Shortest interval measured is 1 second.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return bytes per millisecond
+     * <p>
+     * Gets the number of bytes received per second by the Network 
+     * Server. This number is calculated by taking into account the number of
+     * bytes received since the last calculation (or since MBean startup if
+     * it is the first time this attibute is being read).</p>
+     * <p>
+     * The shortest interval measured is 1 second. This means that a new value
+     * will not be calculated unless there has been at least 1 second since the
+     * last calculation.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the number of bytes received per second
      */
-    
     public int getBytesReceivedPerSecond();
     
      /**
-     * Get the number of bytes sent pr second. 
-     * Shortest interval measured is 1 second.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return bytes per millisecond
+     * <p>
+     * Gets the number of bytes sent per second by the Network Server. 
+     * This number is calculated by taking into account the number of
+     * bytes sent since the last calculation (or since MBean startup if
+     * it is the first time this attibute is being read).</p>
+     * <p> 
+     * The shortest interval measured is 1 second. This means that a new value
+     * will not be calculated unless there has been at least 1 second since the
+     * last calculation.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the number of bytes sent per millisecond
      */
-    
     public int getBytesSentPerSecond();
     
     /**
-     * Return the start time of the network server.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return Time in milli-seconds since the epoch that the network server started.
-     * @see System#currentTimeMillis()
+     * <p>
+     * Gets the start time of the network server. The time is reported as
+     * the number of milliseconds (ms) since Unix epoch (1970-01-01 00:00:00 
+     * UTC), and corresponds to the value of 
+     * <code>java.lang.System#currentTimeMillis()</code> at the time the
+     * Network Server was started.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the difference, measured in milliseconds, between the time the
+     *         Network Server was started and Unix epoch (1970-01-01T00:00:00Z)
+     * @see java.lang.System#currentTimeMillis()
      */
     public long getStartTime();
     
     /**
-     * Return the time the network server has been running.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
-     * @return Time in milli-seconds the server has been running.
+     * <p>
+     * Gets the time (in milliseconds) the Network Server has been running. In
+     * other words, the time passed since the server was started.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
+     * @return the difference, measured in milliseconds, between the current 
+     *         time and the time the Network Server was started
+     * @see #getStartTime()
      */
     public long getUptime(); 
     
@@ -306,14 +443,41 @@
     // ---
 
     /**
+     * <p>
      * Executes the network server's <code>ping</code> command.
-     * Returns without errors if the server was successfully pinged.
-     * <P>
-     * Require <code>SystemPermission("server", "monitor")</code> if a security
-     * manager is installed.
-     *
+     * Returns without errors if the server was successfully pinged.</p>
+     * <p>
+     * Note that the <code>ping</code> command itself will be executed from the

+     * network server instance that is actually running the server, and that the 
+     * result will be transferred via JMX to the JMX client invoking this
+     * operation. 
+     * This means that this operation will test network server connectivity 
+     * from the same host (machine) as the network server, as opposed to when 
+     * the <code>ping</code> command (or method) of 
+     * <code>NetworkServerControl</code> is executed from a remote machine.</p>
+     * <p>
+     * This operation requires the following permission to be granted to
+     * the network server code base if a Java security manager is installed
+     * in the server JVM:</p>
+     * <codeblock>
+     *   <code>
+     *     permission java.net.SocketPermission "*", "connect,resolve";
+     *   </code>
+     * </codeblock>
+     * <p>The value <code>"*"</code> will allow connections from the network

+     * server to any host and any port, and may be replaced with a more specific
+     * value if so desired. The required value will depend on the value of the
+     * <code>-h</code> (or <code>derby.drda.host</code>) (host) and

+     * <code>-p</code> (or <code>derby.drda.portNumber</code>) (port)
settings
+     * of the Netowrk Server.</p>
+     * <p>
+     * Requires <code>SystemPermission("server", "monitor")</code> if a security
+     * manager is installed.</p>
+     * 
      * @throws java.lang.Exception if the ping attempt fails (an indication that
      *         the network server is not running properly)
+     * @see org.apache.derby.drda.NetworkServerControl#ping()
+     * @see java.net.SocketPermission
      */
     public void ping() throws Exception;
     

Added: db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html?rev=641762&view=auto
==============================================================================
--- db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html (added)
+++ db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html Thu Mar 27 03:01:27
2008
@@ -0,0 +1,62 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<body>
+<p>This package contains JMX MBeans that are intended to provide monitoring
+and management capabilities of the Derby Network Server.</p>
+<p>
+Derby's management service (including JMX management and monitoring 
+capabilities) will be enabled automatically on Network Server startup if a
+set of requirements are met. See 
+<a href="../package-summary.html">org.apache.derby.mbeans</a>
+for details.</p>
+<p>
+Upon startup, the Network Server will attempt to register MBeans related to
+the Network server. In addition to the MBeans included in this package, an
+instance of the <a href="../VersionMBean.html">VersionMBean</a> will be 
+registered, providing access to Network Server version information.</p>
+<p>
+When the Network Server starts, Derby's embedded driver is automatically booted
+in the server JVM. This means that any MBeans that are automatically registered
+at Derby system startup (booting/loading of the embedded driver) will also be
+attempted registered with the MBean server at this point. Such MBeans are 
+described in the <a href="../package-summary.html">org.apache.derby.mbeans</a>

+package.</p>
+<p>
+Derby registers its JMX MBeans in the <code>org.apache.derby</code> domain and
+always includes values for <code>type</code> and <code>system</code>
in the 
+key properties of each MBean's ObjectName. The <code>system</code> key property
+is described in the package description for 
+<a href="../package-summary.html#package_description">org.apache.derby.mbeans</a>.
+Conventions for how the main key property values are defined are also described 
+there. Other key properties are described in the interface class for each MBean.
+
+<!-- TODO - INCLUDE INFO ABOUT NETWORK SERVER JMX SECURITY PERMISSIONS, SEE
+     E.G. DERBY-3462, DERBY-3491
+
+<h3>Security</h3>
+    
+<p> OLD:
+Permissions in policy files need to use the MBean interface to define fine 
+grained access. For example, the permission to allow access to the 
+<a href="NetworkServerMBean.html#getUpTime()"<code>UpTime</code> attribute</a>
+of the <a href="NetworkServerMBean.html">NetworkServerMBean</a> may be written

+as:
+<pre>
+
+</pre>
+-->
+</body>

Propchange: db/derby/code/trunk/java/drda/org/apache/derby/mbeans/drda/package.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message