svn commit: r1390488 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefattribencryptkeylength.dita

[ch...@apache.org]

Author: chaase3
Date: Wed Sep 26 13:56:48 2012
New Revision: 1390488

URL: http://svn.apache.org/viewvc?rev=1390488&view=rev
Log:
DERBY-4229  encryptionKeyLength connection attribute should be documented

Added new topic to Reference Manual.

Patch: DERBY-4229-3.diff

Added:
    db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita   (with props)
Modified:
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1390488&r1=1390487&r2=1390488&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Wed Sep 26 13:56:48 2012
@@ -1132,6 +1132,8 @@ URL syntax"></topicref>
 </topicref>
 <topicref href="rrefattribencryptkey.dita" navtitle="encryptionKey=key attribute">
 </topicref>
+<topicref href="rrefattribencryptkeylength.dita" navtitle="encryptionKeyLength=length attribute">
+</topicref>
 <topicref href="rrefattrib88843.dita" navtitle="encryptionProvider=providerName attribute">
 </topicref>
 <topicref href="rrefattrib60346.dita" navtitle="encryptionAlgorithm=algorithm attribute">

Added: db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita?rev=1390488&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita Wed Sep 26 13:56:48 2012
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.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.
+-->
+<reference id="rrefattribencryptkeylength" xml:lang="en-us">
+<title>encryptionKeyLength=length attribute</title>
+<prolog><metadata>
+<keywords><indexterm>encryptionKeyLength=length attribute</indexterm>
+<indexterm>encrypting databases<indexterm>encryption key length</indexterm></indexterm>
+<indexterm>databases<indexterm>attributes, encryption key length</indexterm></indexterm>
+<indexterm>attributes<indexterm>encryptionKeyLength</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section><title>Function</title>
+<p>Specifies the number of bits in the encryption key to be generated when a
+database is encrypted with the
+<i><xref href="rrefattrib42100.dita#rrefattrib42100">bootPassword=key</xref></i>
+attribute.</p>
+<p>The default encryption key length is 128.</p>
+<p>You need to specify <i>encryptionKeyLength=length</i> only if all of
+the following circumstances apply:
+<ul>
+<li>You are specifying a non-default encryption algorithm (the default is 
+DES).</li>
+<li>The encryption algorithm you are specifying allows for more than one key
+length.</li>
+<li>You want to use a non-default key length.</li>
+</ul></p>
+</section>
+<section><title>Combining with other attributes</title>
+<p>The <i>encryptionKeyLength=length</i> attribute can be combined with either
+the
+<i><xref href="rrefattrib42100.dita#rrefattrib42100">bootPassword=key</xref></i>
+attribute or the
+<i><xref href="rrefattribencryptkey.dita#rrefattribencryptkey">encryptionKey=key</xref></i>
+attribute (although it is redundant if you use <i>encryptionKey=key</i>).</p>
+<p>The <i>encryptionKeyLength=length</i> attribute may also be combined with the
+<i><xref href="rrefattrib88843.dita#rrefattrib88843">encryptionProvider=providerName</xref></i>
+and/or
+<i><xref href="rrefattrib60346.dita#rrefattrib60346">encryptionAlgorithm=algorithm</xref></i>
+attributes.</p> 
+<p>If you are using <i>encryptionKeyLength=length</i> with
+<i>encryptionKey=key</i>, make sure the key you specify has the length you
+specify.</p>
+</section>
+<example><title>Examples</title>
+<codeblock><b><ph>-- create a new, encrypted database</ph>
+jdbc:derby:newDB;create=true;dataEncryption=true;
+encryptionKeyLength=192;encryptionAlgorithm=AES/CBC/NoPadding;
+bootPassword=Thursday
+<ph>-- configure an existing unencrypted database for encryption</ph>
+jdbc:derby:myDB;dataEncryption=true;
+encryptionKeyLength=168;encryptionAlgorithm=DESede/CBC/NoPadding;
+bootPassword=Wednesday</b></codeblock>
+<note>If the specified algorithm does not support the specified
+encryption key length, <ph conref="../conrefs.dita#prod/productshortname"></ph>
+returns an exception.</note>
+</example>
+</refbody>
+</reference>

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