Derby
  1. Derby
  2. DERBY-4377

Developer's Guide statement on shutting down Derby needs qualification

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.5.3.0
    • Fix Version/s: 10.6.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      The topic "Shutting down Derby or an individual database" (http://db.apache.org/derby/docs/dev/devguide/tdevdvlp40464.html) begins,

      "Applications in an embedded environment shut down the Derby system by specifying the shutdown=true attribute in the connection URL. To shut down the system, you do not specify a database name, and you must not specify any other attribute."

      This statement actually needs some qualification, because (according to Francois Orsini) "if you have defined Derby's BUILT-IN user authentication at the System level (e.g. setting username / password in derby.properties file)" you do need to specify a username and password when you shut down the database.

      The topic needs to include this information. Further suggestions on the wording are welcome.

      1. DERBY-4377.diff
        2 kB
        Kim Haase
      2. DERBY-4377-2.diff
        2 kB
        Kim Haase
      3. DERBY-4377-3.diff
        2 kB
        Kim Haase
      4. DERBY-4377-4.diff
        1 kB
        Kim Haase
      5. tdevdvlp40464.html
        7 kB
        Kim Haase
      6. tdevdvlp40464.html
        6 kB
        Kim Haase
      7. tdevdvlp40464.html
        6 kB
        Kim Haase
      8. tdevdvlp40464.html
        6 kB
        Kim Haase

        Activity

        Hide
        Kim Haase added a comment -

        Attaching DERBY-4377.diff and the resulting HTML file, tdevdvlp40464.html, with a proposed correction to the topic. Please let me know if any wording changes are needed here.

        Thanks again to Francois for pointing out this issue.

        Show
        Kim Haase added a comment - Attaching DERBY-4377 .diff and the resulting HTML file, tdevdvlp40464.html, with a proposed correction to the topic. Please let me know if any wording changes are needed here. Thanks again to Francois for pointing out this issue.
        Hide
        Francois Orsini added a comment -

        Hi Kim,

        Thanks for taking care of it.

        It looks good - just some minor changes to consider.

        If you have enabled Derby's BUILTIN user authentication and created some user at the system level (for example, by setting some username and password in the derby.properties file), you will need to specify credentials (e.g. username and password) in order to shut down a Derby system.

        Show
        Francois Orsini added a comment - Hi Kim, Thanks for taking care of it. It looks good - just some minor changes to consider. If you have enabled Derby's BUILTIN user authentication and created some user at the system level (for example, by setting some username and password in the derby.properties file), you will need to specify credentials (e.g. username and password) in order to shut down a Derby system.
        Hide
        Kim Haase added a comment -

        Thanks, Francois! Here are an updated patch (DERBY-4377-2.diff) and output file that I hope incorporate your edits.

        Show
        Kim Haase added a comment - Thanks, Francois! Here are an updated patch ( DERBY-4377 -2.diff) and output file that I hope incorporate your edits.
        Hide
        Francois Orsini added a comment - - edited

        Hi Kim,

        Thanks for the prompt turnaround

        Just a minor nit, sorry:

        I would replace:

        If you have defined Derby BUILTIN user authentication....

        with:

        If you have enabled Derby BUILTIN user authentication

        Thanks

        Show
        Francois Orsini added a comment - - edited Hi Kim, Thanks for the prompt turnaround Just a minor nit, sorry: I would replace: If you have defined Derby BUILTIN user authentication.... with: If you have enabled Derby BUILTIN user authentication Thanks
        Hide
        Kim Haase added a comment -

        Another good catch – thanks, Francois. Here's another patch.

        Show
        Kim Haase added a comment - Another good catch – thanks, Francois. Here's another patch.
        Hide
        Francois Orsini added a comment -

        Looks great, Kim. Thanks for taking care of it! +1

        Show
        Francois Orsini added a comment - Looks great, Kim. Thanks for taking care of it! +1
        Hide
        Kim Haase added a comment -

        Thanks for the very helpful reviews, Francois!

        Committed patch DERBY-4377-3.diff to documentation trunk at revision 817850.

        Show
        Kim Haase added a comment - Thanks for the very helpful reviews, Francois! Committed patch DERBY-4377 -3.diff to documentation trunk at revision 817850.
        Hide
        Kim Haase added a comment -

        Fix appears in latest alpha manuals, so closing.

        Show
        Kim Haase added a comment - Fix appears in latest alpha manuals, so closing.
        Hide
        Kim Haase added a comment -

        Reopening because we need to improve the revised statement:

        Dag.Wanvik@Sun.COM (Dag H. Wanvik) writes:

        > > "Francois Orsini (JIRA)" <jira@apache.org> writes:
        > >
        >> >> If you have enabled Derby's BUILTIN user authentication and created
        >> >> some user at the system level (for example, by setting some username
        >> >> and password in the derby.properties file), you will need to specify
        >> >> credentials (e.g. username and password) in order to shut down a
        >> >> Derby system.
        > >
        > > So if I understand this correctly; if users are defined only on the
        > > database level (but BUILTIN user authentication is defined at the
        > > system level), it will still be possible to shut down a Derby system
        > > without supplying credentials?

        Actually not. I tested this, and there needs to be defined at least
        one user at the system level for a shutdown to work. So a more
        precise wording would be:

        "If you have enabled Derby's BUILTIN user authentication at the system
        level (for example, by setting the property

        derby.connection.requireAuthentication=true

        in the derby.properties file), you will need to specify credentials
        (e.g. username and password) in order to shut down a Derby system
        and the supplied username/password must also be defined at the
        system level."

        Show
        Kim Haase added a comment - Reopening because we need to improve the revised statement: Dag.Wanvik@Sun.COM (Dag H. Wanvik) writes: > > "Francois Orsini (JIRA)" <jira@apache.org> writes: > > >> >> If you have enabled Derby's BUILTIN user authentication and created >> >> some user at the system level (for example, by setting some username >> >> and password in the derby.properties file), you will need to specify >> >> credentials (e.g. username and password) in order to shut down a >> >> Derby system. > > > > So if I understand this correctly; if users are defined only on the > > database level (but BUILTIN user authentication is defined at the > > system level), it will still be possible to shut down a Derby system > > without supplying credentials? Actually not. I tested this, and there needs to be defined at least one user at the system level for a shutdown to work. So a more precise wording would be: "If you have enabled Derby's BUILTIN user authentication at the system level (for example, by setting the property derby.connection.requireAuthentication=true in the derby.properties file), you will need to specify credentials (e.g. username and password) in order to shut down a Derby system and the supplied username/password must also be defined at the system level."
        Hide
        Kim Haase added a comment -

        Here's yet another patch, DERBY-4377-4.diff, and the output file tdevdvlp40464.html. The patch is against the previously committed revision of the topic.

        Please let me know of any needed edits.

        Show
        Kim Haase added a comment - Here's yet another patch, DERBY-4377 -4.diff, and the output file tdevdvlp40464.html. The patch is against the previously committed revision of the topic. Please let me know of any needed edits.
        Hide
        Kim Haase added a comment -

        Having heard of no issues with the revised patch, I've committed patch DERBY-4377-4.diff to the documentation trunk at revision 822457.

        Show
        Kim Haase added a comment - Having heard of no issues with the revised patch, I've committed patch DERBY-4377 -4.diff to the documentation trunk at revision 822457.
        Hide
        Kim Haase added a comment -

        Fix has appeared in Latest Alpha Manuals, so closing.

        Show
        Kim Haase added a comment - Fix has appeared in Latest Alpha Manuals, so closing.

          People

          • Assignee:
            Kim Haase
            Reporter:
            Kim Haase
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development