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 bp...@apache.org on 2009/12/01 05:54:15 UTC

svn commit: r885669 - in /db/derby/docs/trunk/src/adminguide: radminconfigdb2jdrdatracedirectory.dita tadminadv804410.dita

Author: bpendleton
Date: Tue Dec  1 04:54:14 2009
New Revision: 885669

URL: http://svn.apache.org/viewvc?rev=885669&view=rev
Log:
DERBY-4153: Document that Network Server will try to create the trace directory

This change adds additional documentation regarding the Network Server's
tracing directory feature, clarifying that, starting with 10.5, Network
Server will attempt to create the trace directory (and any parent
directories) if they do not exist. This will require that derbynet.jar
permit verification of the existence of the named trace directory and
all necessary parent directories.

The new documentation provides example syntax for the security policy
rules needed, and pointers to the other sections of the guide which
discuss security policy issues in greater detail.


Modified:
    db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
    db/derby/docs/trunk/src/adminguide/tadminadv804410.dita

Modified: db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita?rev=885669&r1=885668&r2=885669&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita Tue Dec  1 04:54:14 2009
@@ -24,10 +24,33 @@
 <keywords><indexterm>derby.drda.traceDirectory property</indexterm></keywords>
 </metadata></prolog>
 <refbody>
-<section>Indicates the location of tracing files. </section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.traceDirectory=<i>tracefiledirectory</i></codeblock> </refsyn>
+    <section>Indicates the location of tracing files.</section>
+<section><title>Security Considerations</title>
+<p>
+    The Network Server will attempt to create the trace directory
+    (and any parent directories) if they do not exist.
+    This will require that the Java security policy for 
+    <codeph>derbynet.jar</codeph>
+    permits verification of the existence of the named trace directory
+    and all necessary parent directories.
+    For each directory created, the policy must allow
+    <codeblock>
+    permission java.io.FilePermission "&lt;<i>directory</i>&gt;", "read,write";
+    </codeblock>
+    and for the trace directory itself, the policy must allow
+    <codeblock>
+    permission java.io.FilePermission "&lt;<i>tracedirectory</i>&gt;${/}-", "write";
+    </codeblock>
+</p>
+<p>
+    See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
+    information about customizing the Network Server's security policy.
+</p>
+    </section>
+<refsyn><title>Syntax</title> <codeblock>derby.drda.traceDirectory=<i>tracefiledirectory</i></codeblock></refsyn>
 <section><title>Default</title> <p>If the derby.system.home property
-has been set, it is the default. Otherwise, the default is the current directory.</p> </section>
+        has been set, it is the default. Otherwise, the default is the current directory.</p>
+</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

Modified: db/derby/docs/trunk/src/adminguide/tadminadv804410.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminadv804410.dita?rev=885669&r1=885668&r2=885669&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminadv804410.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminadv804410.dita Tue Dec  1 04:54:14 2009
@@ -29,14 +29,34 @@
 <info>If you specify a &lt;<i>connection number</i>&gt;, tracing will be turned
 on only for that connection.</info></step>
 <step><cmd>Set the location of the tracing files by specifying the following
-property:</cmd><stepxmp><codeblock>derby.drda.traceDirectory=&lt;<i>directory for tracing files</i>&gt;</codeblock></stepxmp>
-<info>You need to specify only the directory where the tracing files will
+property:</cmd><stepxmp><codeblock>derby.drda.traceDirectory=&lt;<i>directory for tracing files</i>&gt;</codeblock>
+Alternatively,
+while the Network Server is running, enter the following command
+to set the trace directory:<codeblock>java org.apache.derby.drda.NetworkServerControl traceDirectory 
+&lt;<i>directory for tracing files</i>&gt; [-h &lt;<i>hostname</i>&gt;] [-p &lt;<i>portnumber</i>&gt;]  </codeblock> </stepxmp>
+<p>You need to specify only the directory where the tracing files will
 reside. The names of the tracing files are determined by the system. If you
-do not set a trace directory, the tracing files will be placed in derby.system.home.</info>
-</step>
-<step><cmd>While the Network Server is running, enter the following command
-to set the trace directory:</cmd><stepxmp><codeblock>java org.apache.derby.drda.NetworkServerControl traceDirectory 
-&lt;<i>directory for tracing files</i>&gt;[-h &lt;<i>hostname</i>&gt;] [-p &lt;<i>portnumber</i>&gt;]  </codeblock> </stepxmp>
+do not set a trace directory, the tracing files will be placed in derby.system.home.</p>
+<p>
+    The Network Server will attempt to create the trace directory
+    (and any parent directories) if they do not exist.
+    This will require that the Java security policy for 
+    <codeph>derbynet.jar</codeph>
+    permits verification of the existence of the named trace directory
+    and all necessary parent directories.
+    For each directory created, the policy must allow
+    <codeblock>
+    permission java.io.FilePermission "&lt;<i>directory</i>&gt;", "read,write";
+    </codeblock>
+    and for the trace directory itself, the policy must allow
+    <codeblock>
+    permission java.io.FilePermission "&lt;<i>tracedirectory</i>&gt;${/}-", "write";
+    </codeblock>
+</p>
+<p>
+    See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
+    information about customizing the Network Server's security policy.
+</p>
 </step>
 </steps>
 </taskbody>