db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rhille...@apache.org
Subject svn commit: r644555 - in /db/derby/docs/trunk/src/adminguide: derbyadmin.ditamap radminappsclientxmp.dita tadminconfig813694.dita tadminconfig815333.dita tadminconfig815357.dita tadminconfigshuttingdownthenetworkserver.dita tadminnetservusrauth.dita
Date Thu, 03 Apr 2008 23:14:10 GMT
Author: rhillegas
Date: Thu Apr  3 16:14:08 2008
New Revision: 644555

URL: http://svn.apache.org/viewvc?rev=644555&view=rev
Log:
DERBY-3585: Commit Martin's changes to the admin guide reflecting the introduction of credentials
for starting and halting the network server.

Added:
    db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita   (with props)
Modified:
    db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
    db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita
    db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita
    db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita
    db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita
    db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita

Modified: db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap (original)
+++ db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap Thu Apr  3 16:14:08 2008
@@ -197,6 +197,7 @@
 <topicref href="tadminnetservcustom.dita" navtitle="Customizing the Network Server's security
policy"></topicref>
 <topicref href="tadminnetservopen.dita" navtitle="Running the Network Server without a
security policy"></topicref>
 </topicref>
+<topicref href="tadminnetservusrauth.dita" navtitle="Running the Network Server with user
authentication"></topicref>
 <topicref collection-type="family" href="cadminssl.dita" navtitle="Network encryption
and authentication with SSL/TLS">
 <topicref href="cadminsslkeys.dita" navtitle="Key and certificate handling"></topicref>
 <topicref href="cadminsslserver.dita" navtitle="Starting the server with SSL/TLS"></topicref>

Modified: db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita Thu Apr  3 16:14:08 2008
@@ -24,7 +24,10 @@
 <p>The following examples specify the user and password URL attributes. 
 To enable user authentication, the  property <i>derby.connection.requireAuthentication</i>
 must be set to true, otherwise, <ph conref="../conrefs.dita#prod/productshortname"></ph>
-does not require a user name and password. For a multi-user product, you would
+does not require a user name and password. For details on how to enable
+user authentication, please see "Working with user authentication" in the
+<ph conref="../conrefs.dita#pub/citdevelop"/>.</p>
+<p>For a multi-user product, you would
 typically set it for the system in the <i>derby.properties</i> file for your
 server, since it is in a trusted environment. Below is a sample
 <i>derby.properties</i> file that conforms to these examples:

Modified: db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig813694.dita Thu Apr  3 16:14:08 2008
@@ -25,19 +25,19 @@
 </metadata></prolog>
 <taskbody>
 <context> <p>You need to create an instance of the NetworkServerControl class
-if you are using the API. There are two constructor methods for this class:</p><note>Before
+if you are using the API. There are four constructors for this class:</p><note>Before
 enabling connections from other systems, ensure that you are running under
-security manager.</note></context>
+a security manager.</note></context>
 <steps-unordered>
-<step><cmd>NetworkServerControl()</cmd><stepresult><p>This
constructor method
+<step><cmd>NetworkServerControl()</cmd><stepresult><p>This
constructor
 creates an instance that listens either on the default port (1527) or the
 port that is set by the <codeph>derby.drda.portNumber</codeph> property. It
 will also listen on the host set by the <codeph>derby.drda.host</codeph> property
 or the loopback address if the property is not set. This is the default constructor;
 it does not allow remote connections. It is equivalent to calling NetworkServerControl(InetAddress.getByName("localhost"),1527)
 if no properties are set.</p></stepresult></step>
-<step><cmd>NetworkServerControl (InetAddress address, int portNumber)</cmd>
-<stepresult><p>This constructor method creates an instance that listens on
+<step><cmd>NetworkServerControl(InetAddress address, int portNumber)</cmd>
+<stepresult><p>This constructor creates an instance that listens on
 the specified <codeph>portNumber</codeph> on the specified address. The <codeph>InetAddress</codeph>
will
 be passed to <codeph>ServerSocket</codeph>. NULL is an invalid address value.
  The following examples show how you might allow Network Server to accept
@@ -46,6 +46,20 @@
   new NetworkServerControl(InetAddress.getByName("0.0.0.0"),1527);</codeblock> <codeblock>//accepts
connections from other hosts on an IPV6 system
 NetworkServerControl serverControl = 
   new NetworkServerControl(InetAddress.getByName("::"),1527);</codeblock></p></stepresult>
+</step>
+<step><cmd>NetworkServerControl(String userName, String password)</cmd>
+<stepresult><p>If a network server should run with user authentication,
+certain operations like NetworkServerControl.shutdown()
+require that you provide user credentials. This constructor creates an instance
+with user credentials, which are then used for operations
+that require them. In all other aspects, this constructor behaves like
+NetworkServerControl().</p></stepresult>
+</step>
+<step><cmd>NetworkServerControl(InetAddress address, int portNumber, String userName,
String password)</cmd>
+<stepresult><p>This constructor creates an instance with user
+credentials, which are then used for operations that require them. In
+all other aspects, this constructor behaves like
+NetworkServerControl(InetAddress address, int portNumber).</p></stepresult>
 </step>
 </steps-unordered>
 </taskbody>

Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815333.dita Thu Apr  3 16:14:08 2008
@@ -25,9 +25,26 @@
 line</indexterm></indexterm></keywords>
 </metadata></prolog>
 <taskbody>
-<context> <p>From the command line, shut down the Network Server with the
-following command: </p> <codeblock>java org.apache.derby.drda.NetworkServerControl
-	shutdown [-h <i>&lt;hostname&gt;</i>][-p <i>&lt;portnumber&gt;</i>]
</codeblock></context>
+<context>
+<p>From the command line, you can shut down a Network Server by invoking a
+jar file or a class. </p>
+<p>Note that you need to provide user credential arguments to shut down a server running
with user authentication.</p>
+</context>
+<steps-unordered>
+<step><cmd>To shut down the Network Server by invoking a jar file from the
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"/>/lib</codeph>
+directory, use:</cmd><stepxmp>
+<codeblock>java -jar derbyrun.jar server shutdown [-h <i>&lt;hostname&gt;</i>]
[-p <i>&lt;portnumber&gt;</i>] [-user <i>&lt;username&gt;</i>]
[-password <i>&lt;password&gt;</i>]
+</codeblock></stepxmp>
+<stepxmp>or
+<codeblock>java -jar derbyrun.jar shutdown [-h <i>&lt;hostname&gt;</i>]
[-p <i>&lt;portnumber&gt;</i>] [-user <i>&lt;username&gt;</i>]
[-password <i>&lt;password&gt;</i>]
+</codeblock></stepxmp>
+</step>
+<step><cmd>To shut down the Network Server by invoking a class,
+use:</cmd><stepxmp>
+<codeblock>java org.apache.derby.drda.NetworkServerControl shutdown [-h <i>&lt;hostname&gt;</i>]
[-p <i>&lt;portnumber&gt;</i>] [-user <i>&lt;username&gt;</i>]
[-password <i>&lt;password&gt;</i>]
+</codeblock></stepxmp></step>
+</steps-unordered>
 </taskbody>
 </task>
 

Modified: db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfig815357.dita Thu Apr  3 16:14:08 2008
@@ -28,8 +28,19 @@
 <context> <p>You can use the NetworkServerControl API to shut down the Network
 Server from within a Java application. The name of the method that you use
 to shutdown the Network Server is <codeph>shutdown()</codeph>.</p> </context>
-<example><p>For example, the following command shuts down the Network Server
-running on the current machine using the default port number (1527):</p><codeblock>NetworkServerControl
server = new NetworkServerControl();
-server.shutdown();</codeblock></example>
+<example>
+<p>For example, the following command shuts down the Network Server
+running on the current machine using the default port number (1527):</p>
+<codeblock>
+NetworkServerControl server = new NetworkServerControl();
+server.shutdown();
+</codeblock>
+<p>To shut down a server running with user authentication, you need to use
+a NetworkServerControl instance created with user credentials:</p>
+<codeblock>
+NetworkServerControl server = new NetworkServerControl(username, password);
+server.shutdown();
+</codeblock>
+</example>
 </taskbody>
 </task>

Modified: db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita?rev=644555&r1=644554&r2=644555&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/tadminconfigshuttingdownthenetworkserver.dita Thu Apr
 3 16:14:08 2008
@@ -19,29 +19,37 @@
 -->
 <task id="tadminconfigshuttingdownthenetworkserver" xml:lang="en-us">
 <title>Shutting down the Network Server</title>
-<shortdesc>If user authentication is disabled, a <ph conref="../conrefs.dita#prod/productshortname"></ph>
database
-will shut down normally when the Network Server is shut down. If user authentication
-is enabled, you must explicitly shut down the database <i>before</i> shutting
-down the Network Server by specifying a valid <ph conref="../conrefs.dita#prod/productshortname"></ph>
user
-name and password.</shortdesc>
+<shortdesc>To shut down a Network Server, you can invoke a script, a jar
+file, or a class.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>Shutting down Network Server<indexterm>from scripts</indexterm></indexterm>
 <indexterm>Network Server<indexterm>shutting down</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <taskbody>
-<context> <p>The database can be shut down either directly, or by the <ph
-conref="../conrefs.dita#prod/productshortname"></ph> server.</p></context>
+<context>
+<p>The scripts to shut down a Network Server are located in the
+<codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"/>/bin</codeph>
+directory.</p>
+<note type="important">If user authentication is enabled, you must specify a
+valid <ph conref="../conrefs.dita#prod/productshortname"></ph> user name
+and password; if the user authentication check fails, you'll see an
+authentication error and the running server remains intact. Note that <ph
+conref="../conrefs.dita#prod/productshortname"></ph> does not yet restrict
+the shutdown privilege to specific users: the server can be shut down by
+any user on the server machine who presents valid credentials.</note>
+</context>
 <steps-unordered>
-<step><cmd>To shut down the Network Server by using the scripts that are provided
+<step><cmd>To shut down the Network Server by using the scripts provided
 for Windows systems, use:</cmd><stepxmp>
-<codeblock><b><userinput>stopNetworkServer.bat [-h <varname>hostname</varname>]
[-p <varname>portnumber</varname>]</userinput></b></codeblock></stepxmp>
+<codeblock><b><userinput>stopNetworkServer.bat [-h <varname>hostname</varname>]
[-p <varname>portnumber</varname>] [-user <varname>username</varname>]
[-password <varname>password</varname>]</userinput></b>
+</codeblock></stepxmp>
 </step>
-<step><cmd>To shut down the Network Server by using the scripts that are provided
+<step><cmd>To shut down the Network Server by using the scripts provided
 for UNIX systems, use:</cmd><stepxmp>
-<codeblock><b><userinput>stopNetworkServer [-h <varname>hostname</varname>]
[-p <varname>portnumber</varname>]</userinput></b></codeblock></stepxmp>
-<info>These scripts are located in the <codeph>$<ph conref="../conrefs.dita#prod/productinstallpath"></ph>/bin</codeph>
-directory.</info></step>
+<codeblock><b><userinput>stopNetworkServer [-h <varname>hostname</varname>]
[-p <varname>portnumber</varname>] [-user <varname>username</varname>]
[-password <varname>password</varname>]</userinput></b>
+</codeblock></stepxmp>
+</step>
 </steps-unordered>
 </taskbody>
 </task>

Added: db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita?rev=644555&view=auto
==============================================================================
--- db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita (added)
+++ db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita Thu Apr  3 16:14:08 2008
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+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.
+-->
+<task id="tadminnetservusrauth" xml:lang="en-us">
+<title>Running the Network Server with User Authentication</title>
+<prolog><metadata>
+<keywords><indexterm>Network Server<indexterm>running with user authentication</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<taskbody>
+<context>
+<p>
+By default, the Network Server boots with user
+authentication disabled. However, it is strongly recommended that you run your Network Server
with user
+authentication enabled. For details on how to enable user authentication,
+please see "Working with user authentication" in the
+<ph conref="../conrefs.dita#pub/citdevelop"/>.
+</p>
+</context>
+</taskbody>
+</task>

Propchange: db/derby/docs/trunk/src/adminguide/tadminnetservusrauth.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message