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/12 22:57:09 UTC
svn commit: r1325511 - /db/derby/docs/trunk/src/adminguide/
Author: chaase3
Date: Thu Apr 12 20:57:09 2012
New Revision: 1325511
URL: http://svn.apache.org/viewvc?rev=1325511&view=rev
Log:
DERBY-5653 We should document that the NetServlet is a testing tool and not appropriate for production use.
Modified 13 Admin Guide topics.
Patch: DERBY-5653.diff
Modified:
db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita
db/derby/docs/trunk/src/adminguide/cadminov825266.dita
db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita
db/derby/docs/trunk/src/adminguide/cadminservlet98430.dita
db/derby/docs/trunk/src/adminguide/radminconfig.dita
db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita
db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita
db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita
db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita
db/derby/docs/trunk/src/adminguide/tadminlogfile.dita
db/derby/docs/trunk/src/adminguide/tadmintracefacility.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=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminconfig86869.dita Thu Apr 12 20:57:09 2012
@@ -42,11 +42,6 @@ For information on how to do this, see
<xref href="cadminjmxoverview.dita#cadminjmxoverview"></xref>.</p>
<p>
You can manage the Network Server by using shell scripts, the command line,
-or the Network Server API.
- The Network Server can also be managed remotely from a web server by
- using a servlet interface.
-See <xref href="cadminservlet98430.dita#cadminservlet98430"></xref> for
-information about starting and shutting down the Network Server using the
-servlet interface.</p>
+or the Network Server API.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/adminguide/cadminov825266.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminov825266.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminov825266.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminov825266.dita Thu Apr 12 20:57:09 2012
@@ -46,7 +46,6 @@ Server, including:</p>
<ul>
<li>Through the command line</li>
<li>By using .bat and .ksh scripts</li>
-<li>Through the servlet interface</li>
<li>With your own Java program (written using the Network Server API)</li>
<li>By setting Network Server properties</li>
</ul>
@@ -57,8 +56,6 @@ Server.</p>
<p><xref href="cadminconfig86869.dita#cadminconfig86869"></xref> explains
how to manage the Network Server by using the command line, including starting
and stopping it.</p>
-<p><xref href="cadminservlet98430.dita#cadminservlet98430"></xref> explains
-how to use the servlet interface to manage the Network Server.</p>
<p><xref href="cadminadvtops.dita#cadminadvtops"></xref> contains advanced
topics for <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
Server users.</p>
Modified: db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita Thu Apr 12 20:57:09 2012
@@ -34,7 +34,8 @@ Network Server.</p></li>
<p>Describes how to use shell scripts, the command
line, and the Network Server API to manage the Network Server.</p></li>
<li><i><xref href="cadminservlet98430.dita#cadminservlet98430"/></i>
-<p>Describes how to use the servlet interface to manage the Network Server.</p></li>
+<p>Describes how to use the servlet interface to manage the Network Server. (The
+servlet interface should be used for testing purposes only, not in production.)</p></li>
<li><i><xref href="cadminadvtops.dita#cadminadvtops"/></i>
<p>Describes
advanced topics for <ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server users.</p></li>
Modified: db/derby/docs/trunk/src/adminguide/cadminservlet98430.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminservlet98430.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminservlet98430.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminservlet98430.dita Thu Apr 12 20:57:09 2012
@@ -23,6 +23,8 @@ limitations under the License.
remotely. To use the servlet interface, the servlet must be registered with
an Application Server, and derby.system.home must be known to the Application Server.</shortdesc>
<conbody>
+<p><note type="important">The servlet interface is suitable only for testing
+purposes. It should not be used in production.</note></p>
<p>A Web application archive (WAR) file, <i>derby.war</i>, for the <ph conref="../conrefs.dita#prod/productshortname"></ph>
Network Server is available in <i>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/lib.</i> This
file registers the Network Server's servlet at the relative path <i>/derbynet</i>.
Modified: db/derby/docs/trunk/src/adminguide/radminconfig.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfig.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfig.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfig.dita Thu Apr 12 20:57:09 2012
@@ -28,9 +28,9 @@ limitations under the License.
<refsyn><title>Syntax</title> <codeblock>derby.drda.traceAll=[true|false]</codeblock> </refsyn>
<section><title>Default</title> <p>False.</p> </section>
<example> <title>Example</title><codeblock><b>derby.drda.traceAll=true</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. System values can be
-changed by using commands or the servlet interface after the Network Server has
-been started.</p> </section>
+<section><title>Static or dynamic</title> <p>Dynamic. You can change system
+values by using commands after the Network Server has been started.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita Thu Apr 12 20:57:09 2012
@@ -29,8 +29,8 @@ the <codeph>derby.log</codeph> file and
<refsyn><title>Syntax</title> <codeblock>derby.drda.logConnections=[true|false]</codeblock> </refsyn>
<section><title>Default</title> <p>False.</p> </section>
<example> <title>Example</title><codeblock><b>derby.drda.logConnections=true </b></codeblock></example>
-<section><title>Static or dynamic</title><p>Dynamic. System values can be
-changed by using commands or the servlet interface after the Network Server
-has been started.</p> </section>
+<section><title>Static or dynamic</title><p>Dynamic. You can change system
+values by using commands after the Network Server has been started.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita Thu Apr 12 20:57:09 2012
@@ -53,9 +53,9 @@ limitations under the License.
</section>
<example> <title>Example</title><codeblock><b>derby.drda.traceDirectory=c:/<ph
conref="../conrefs.dita#prod/productshortname"></ph>/trace</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. System values can be
-changed by using commands or the servlet interface after the Network Server has
-been started.</p> </section>
+<section><title>Static or dynamic</title> <p>Dynamic. You can change system
+values by using commands after the Network Server has been started.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita Thu Apr 12 20:57:09 2012
@@ -41,9 +41,9 @@ it will improve performance of streaming
<refsyn><title>Syntax</title> <codeblock>derby.drda.streamOutBufferSize=<i>size of buffer</i></codeblock> </refsyn>
<section><title>Default</title> <p>0</p> </section>
<example> <title>Example</title><codeblock><b>derby.drda.streamOutBufferSize=1024</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. System values can be
-changed by using commands or the servlet interface after the Network Server has
-been started.</p> </section>
+<section><title>Static or dynamic</title> <p>Dynamic. You can change system
+values by using commands after the Network Server has been started.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815822.dita Thu Apr 12 20:57:09 2012
@@ -38,7 +38,5 @@ in the previous example, you can look up
with individual properties if needed by using various APIs on the Properties
class. You can also print out all the properties by using the Properties.list()
method.</p></example>
-<postreq><p>See <xref href="cadminservlet98430.dita#cadminservlet98430"></xref> for
-information about obtaining system information using the servlet interface.</p></postreq>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigsysteminformation.dita Thu Apr 12 20:57:09 2012
@@ -23,8 +23,7 @@ limitations under the License.
<context> <p>You can obtain information about the Network Server, such as
version and current property values, Java information, and <ph conref="../conrefs.dita#prod/productshortname"></ph> database
server information, by using the <codeph>sysinfo</codeph> utility. The <codeph>sysinfo</codeph> utility
-is available from scripts, the command line, the NetworkServerControl API,
-and through the servlet interface.</p><p>The following scripts are located
+is available from scripts, the command line, and the NetworkServerControl API.</p><p>The following scripts are located
in the <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
directory. Before running these scripts, make sure that the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
Server is started.</p> </context>
Modified: db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfiguringthenetworkserver.dita Thu Apr 12 20:57:09 2012
@@ -26,7 +26,7 @@ limitations under the License.
<taskbody>
<context> <p>You can configure the Network Server to use a specific number
of threads to handle connections. You can change the configuration on the
-command line or by using the servlet interface.</p> <p>The minimum number
+command line.</p> <p>The minimum number
of threads is the number of threads that are started when the Network Server
is booted. This value is specified as a property, <codeph>derby.drda.minThreads
= <<i>min</i>></codeph>. The maximum number of threads is the maximum
Modified: db/derby/docs/trunk/src/adminguide/tadminlogfile.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminlogfile.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminlogfile.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminlogfile.dita Thu Apr 12 20:57:09 2012
@@ -35,12 +35,12 @@ set to <codeph>true</codeph>. </p><p> Wh
it also logs the Connection Number; this log message is written both to the <codeph>derby.log</codeph> file
and to the Network Server console.</p> </context>
<steps-unordered>
-<step><cmd>To turn on connection logging, you can use the servlet interface
-or you can issue the following command:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
+<step><cmd>To turn on connection logging, issue the following command:</cmd>
+<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
logconnections on [-h <<i>hostname</i>>] [-p <<i>portnumber</i>>] </codeblock></stepxmp>
</step>
-<step><cmd>To turn connection logging off you can use the servlet interface
-or you can issue the following command:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
+<step><cmd>To turn off connection logging, issue the following command:</cmd>
+<stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl
logconnections off [-h <<i>hostname</i>>][-p <<i>portnumber</i>>] </codeblock></stepxmp>
</step>
</steps-unordered>
Modified: db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita?rev=1325511&r1=1325510&r2=1325511&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadmintracefacility.dita Thu Apr 12 20:57:09 2012
@@ -27,7 +27,5 @@ limitations under the License.
<taskbody>
<context> <p>Use the trace facility only if you are working with technical
support and they require tracing information.</p> </context>
-<postreq><p>See <xref href="cadminservlet98430.dita#cadminservlet98430"></xref> for
-information about managing the trace facility using the servlet interface. </p></postreq>
</taskbody>
</task>