Java > Open Source Codes > org > apache > derby > iapi > reference > Property


1 /*
2
3    Derby - Class org.apache.derby.iapi.reference.Property
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to you under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.iapi.reference;
23
24 /**
25     List of all properties understood by the system. It also has some other static fields.
26
27
28     <P>
29     This class exists for two reasons
30     <Ol>
31     <LI> To act as the internal documentation for the properties.
32     <LI> To remove the need to declare a java static field for the property
33     name in the protocol/implementation class. This reduces the footprint as
34     the string is final and thus can be included simply as a String constant pool entry.
35     </OL>
36     <P>
37     This class should not be shipped with the product.
38
39     <P>
40     This class has no methods, all it contains are String's which by
41     are public, static and final since they are declared in an interface.
42 */
43
44 public interface Property {
45
46     /**
47      * Name of the file that contains system wide properties. Has to be located
48      * in ${derby.system.home} if set, otherwise ${user.dir}
49      */
50     public static final String PROPERTIES_FILE = "derby.properties";
51
52
53     /**
54         By convention properties that must not be stored any persistent form of
55         service properties start with this prefix.
56     */
57     public static final String PROPERTY_RUNTIME_PREFIX = "derby.__rt.";
58
59     /*
60     ** derby.service.* and related properties
61     */
62
63
64     /*
65     ** derby.stream.* and related properties
66     */
67     
68     /**
69         derby.stream.error.logSeverityLevel=integerValue
70         <BR>
71         Indicates the minimum level of severity for errors that are reported to the error stream.
72         Default to 0 in a "sane" server, and SESSION_SEVERITY in the insane (and product) server.
73
74         @see org.apache.derby.iapi.error.ExceptionSeverity#SESSION_SEVERITY
75     */
76     String LOG_SEVERITY_LEVEL = "derby.stream.error.logSeverityLevel";
77
78         /**
79         derby.stream.error.file=<b>absolute or relative error log filename</b>
80         Takes precendence over derby.stream.error.method.
81         Takes precendence over derby.stream.error.field
82     */
83     
84     String ERRORLOG_FILE_PROPERTY = "derby.stream.error.file";
85
86         /**
87         derby.stream.error.method=
88             <className>.<methodName> returning an OutputStream or Writer object
89         Takes precendence over derby.stream.error.field
90     */
91     
92     String ERRORLOG_METHOD_PROPERTY = "derby.stream.error.method";
93
94         /**
95         derby.stream.error.field=
96             <className>.<fieldName> returning an OutputStream or Writer object>
97     */
98     
99     String ERRORLOG_FIELD_PROPERTY = "derby.stream.error.field";
100
101     /**
102     derby.infolog.append={true,false}
103     <BR>
104     * If the info stream goes to a file and the file already exist, it can
105     * either delete the existing file or append to it. User can specifiy
106     * whether info log file should append or not by setting
107     * derby.infolog.append={true/false}
108     *
109     * The default behavior is that the exiting file will be deleted when a new
110     * info stream is started.
111     */
112     String LOG_FILE_APPEND = "derby.infolog.append";
113
114     /*
115     ** derby.service.* and related properties
116     */
117     /**
118         derby.system.home
119         <BR>
120         Property name for the home directory. Any relative path in the
121         system should be accessed though this property
122     */
123     String SYSTEM_HOME_PROPERTY = "derby.system.home";
124
125     /**
126         derby.system.bootAll
127         <BR>
128         Automatically boot any services at start up time. When set to true
129         this services will be booted at startup, otherwise services
130         will be booted on demand.
131     */
132     String BOOT_ALL = "derby.system.bootAll";
133
134     /**
135         derby.database.noAutoBoot
136         <BR>
137         Don't automatically boot this service at start up time. When set to true
138         this service will only be booted on demand, otherwise the service
139         will be booted at startup time if possible.
140     */
141     String NO_AUTO_BOOT = "derby.database.noAutoBoot";
142     
143     /**
144         derby.__deleteOnCreate
145         <BR>
146         Before creating this service delete any remenants (e.g. the directory)
147         of a previous service at the same location.
148
149         <P>
150         <B>INTERNAL USE ONLY</B>
151     */
152     String DELETE_ON_CREATE = "derby.__deleteOnCreate";
153
154     /**
155         derby.database.forceDatabaseLock
156         <BR>
157         Cloudscape attempts to prevent two instances of Cloudscape from booting
158         the same database with the use of a file called db.lck inside the
159         database directory.
160
161         On some platforms, Cloudscape can successfully prevent a second
162         instance of Cloudscape from booting the database, and thus prevents
163         corruption. If this is the case, you will see an SQLException like the
164         following:
165
166         ERROR XJ040: Failed to start database 'toursDB', see the next exception
167         for details.
168         ERROR XSDB6: Another instance of Cloudscape may have already booted the
169         database C:\databases\toursDB.
170
171         The error is also written to the information log.
172
173         On other platforms, Cloudscape issues a warning message if an instance
174         of Cloudscape attempts to boot a database that may already have a
175         running instance of Cloudscape attached to it.
176         However, it does not prevent the second instance from booting, and thus
177         potentially corrupting, the database.
178
179         If a warning message has been issued, corruption may already have
180         occurred.
181
182
183         NOTE: When you are using Cloudview, error messages appear in the
184         console or operating system window from which Cloudview was started.
185
186         The warning message looks like this:
187
188         WARNING: Cloudscape (instance 80000000-00d2-3265-de92-000a0a0a0200) is
189         attempting to boot the database /export/home/sky/wombat even though
190         Cloudscape (instance 80000000-00d2-3265-8abf-000a0a0a0200) may still be
191         active. Only one instance of Cloudscape
192         should boot a database at a time. Severe and non-recoverable corruption
193         can result and may have already occurred.
194
195         The warning is also written to the information log.
196
197         This warning is primarily a Technical Support aid to determine the
198         cause of corruption. However, if you see this warning, your best
199         choice is to close the connection and exit the JVM. This minimizes the
200         risk of a corruption. Close all instances of Cloudscape, then restart
201         one instance of Cloudscape and shut down the database properly so that
202         the db.lck file can be removed. The warning message continues to appear
203         until a proper shutdown of the Cloudscape system can delete the db.lck
204         file.
205
206         If the "derby.database.forceDatabaseLock" property is set to true
207         then this default behavior is altered on systems where cloudscape cannot
208         prevent this dual booting. If the to true, then if the platform does
209         not provide the ability for cloudscape to guarantee no double boot, and
210         if cloudscape finds a db.lck file when it boots, it will throw an
211         exception (TODO - mikem - add what exception), leave the db.lck file
212         in place and not boot the system. At this point the system will not
213         boot until the db.lck file is removed by hand. Note that this
214         situation can arise even when 2 VM's are not accessing the same
215         cloudscape system. Also note that if the db.lck file is removed by
216         hand while a VM is still accessing a derby.database, then there
217         is no way for cloudscape to prevent a second VM from starting up and
218         possibly corrupting the database. In this situation no warning
219         message will be logged to the error log.
220
221         To disable the default behavior of the db.lck file set property as
222         follows:
223
224         derby.database.forceDatabaseLock=true
225
226     */
227     String FORCE_DATABASE_LOCK = "derby.database.forceDatabaseLock";
228
229
230     /*
231     ** derby.locks.* and related properties
232     */
233
234     String LOCKS_INTRO = "derby.locks.";
235
236     /**
237         derby.locks.escalationThreshold
238         <BR>
239         The number of row locks on a table after which we escalate to
240         table locking. Also used by the optimizer to decide when to
241         start with table locking. The String value must be convertible
242         to an int.
243      */
244     String LOCKS_ESCALATION_THRESHOLD = "derby.locks.escalationThreshold";
245
246     /**
247         The default value for LOCKS_ESCALATION_THRESHOLD
248      */
249     int DEFAULT_LOCKS_ESCALATION_THRESHOLD = 5000;
250
251     /**
252         The minimum value for LOCKS_ESCALATION_THRESHOLD
253      */
254     int MIN_LOCKS_ESCALATION_THRESHOLD = 100;
255
256     /**
257         Configuration parameter for deadlock timeouts, set in seconds.
258     */
259     public static final String DEADLOCK_TIMEOUT = "derby.locks.deadlockTimeout";
260
261     /**
262         Default value for deadlock timesouts (20 seconds)
263     */
264     public static final int DEADLOCK_TIMEOUT_DEFAULT = 20;
265
266     /**
267         Default value for wait timeouts (60 seconds)
268     */
269     public static final int WAIT_TIMEOUT_DEFAULT = 60;
270
271     /**
272         Turn on lock monitor to help debug deadlocks. Default value is OFF.
273         With this property turned on, all deadlocks will cause a tracing to be
274         output to the db2j.LOG file.
275         <BR>
276         This property takes effect dynamically.
277      */
278     public static final String DEADLOCK_MONITOR = "derby.locks.monitor";
279
280     /**
281         Turn on deadlock trace to help debug deadlocks.
282         
283         Effect 1: This property only takes effect if DEADLOCK_MONITOR is turned
284         ON for deadlock trace. With this property turned on, each lock object
285         involved in a deadlock will output its stack trace to db2j.LOG.
286         
287         Effect 2: When a timeout occurs, a lockTable dump will also be output
288         to db2j.LOG. This acts independent of DEADLOCK_MONITOR.
289         <BR>
290         This property takes effect dynamically.
291      */
292     public static final String DEADLOCK_TRACE = "derby.locks.deadlockTrace";
293
294     /**
295         Configuration parameter for lock wait timeouts, set in seconds.
296     */
297     public static final String LOCKWAIT_TIMEOUT = "derby.locks.waitTimeout";
298
299     /*
300     ** db2j.database.*
301     */
302     
303     /**
304         derby.database.classpath
305         <BR>
306         Consists of a series of two part jar names.
307     */
308     String DATABASE_CLASSPATH = "derby.database.classpath";
309
310     /**
311         internal use only, passes the database classpathinto the class manager
312     */
313     String BOOT_DB_CLASSPATH = PROPERTY_RUNTIME_PREFIX + "database.classpath";
314
315
316
317     /**
318         derby.database.propertiesOnly
319     */
320     String DATABASE_PROPERTIES_ONLY = "derby.database.propertiesOnly";
321
322     /*
323     ** derby.storage.*
324     */
325
326     /**
327      * Creation of an access factory should be done with no logging.
328      * This is a run-time property that should not make it to disk
329      * in the service.properties file.
330      **/
331     public static final String CREATE_WITH_NO_LOG =
332         PROPERTY_RUNTIME_PREFIX + "storage.createWithNoLog";
333
334     /**
335      * The page size to create a table or index with. Must be a multiple
336      * of 2k, usual choices are: 2k, 4k, 8k, 16k, 32k, 64k. The default
337      * if property is not set is 4k.
338      **/
339     public static final String PAGE_SIZE_PARAMETER = "derby.storage.pageSize";
340
341     /**
342      * The default page size to use for tables that contain a long column.
343      **/
344     public static final String PAGE_SIZE_DEFAULT_LONG = "32768";
345
346     /**
347      * The bump threshold for pages sizes for create tables
348      * If the approximate column sizes of a table is greater than this
349      * threshold, the page size for the tbl is bumped to PAGE_SIZE_DEFAULT_LONG
350      * provided the page size is not already specified as a property
351      **/
352     public static final int TBL_PAGE_SIZE_BUMP_THRESHOLD = 4096;
353
354     /**
355      * The bump threshold for pages size for index.
356      * If the approximate key columns of an index is greater than this
357      * threshold, the page size for the index is bumped to PAGE_SIZE_DEFAULT_LONG
358      * provided the page size is not already specified as a property
359      **/
360     public static final int IDX_PAGE_SIZE_BUMP_THRESHOLD = 1024;
361
362     /**
363      * In cloudscape products which support Row Level Locking (rll), use this
364      * property to disable rll. Application's which use rll will use more
365      * system resources, so if an application knows that it does not need rll
366      * then it can use this system property to force all locking in the system
367      * to lock at the table level.
368      *
369      * This property can be set to the boolean values "true" or "false".
370      * Setting the property to true is the same as not setting the property at
371      * all, and will result in rll being enabled. Setting the property to
372      * false disables rll.
373      *
374      **/
375     public static final String ROW_LOCKING = "derby.storage.rowLocking";
376
377     /**
378         derby.storage.propertiesId
379         <BR>
380         Stores the id of the conglomerate that holds the per-database
381         properties. Is stored in the service.properties file.
382
383         <P>
384         <B>INTERNAL USE ONLY</B>
385     */
386     String PROPERTIES_CONGLOM_ID = "derby.storage.propertiesId";
387
388     /**
389         derby.storage.tempDirectory
390         <BR>
391         Sets the temp directory for a database.
392         <P>
393     */
394     String STORAGE_TEMP_DIRECTORY = "derby.storage.tempDirectory";
395     
396     /**
397      * derby.system.durability
398      * <p>
399      * Currently the only valid supported case insensitive value is 'test'
400      * Note, if this property is set to any other value other than 'test', this
401      * property setting is ignored
402      *
403      * In the future, this property can be used to set different modes - for
404      * example a form of relaxed durability where database can recover to a
405      * consistent state, or to enable some kind of in-memory mode.
406      * <BR>
407      * When set to 'test', the store system will not force sync calls in the
408      * following cases
409      * - for the log file at each commit
410      * - for the log file before data page is forced to disk
411      * - for page allocation when file is grown
412      * - for data writes during checkpoint
413      *
414      * That means
415      * - a commit no longer guarantees that the transaction's modification
416      * will survive a system crash or JVM termination
417      * - the database may not recover successfully upon restart
418      * - a near full disk at runtime may cause unexpected errors
419      * - database can be in an inconsistent state
420      * <p>
421      * This setting is provided for performance reasons and should ideally
422      * only be used when the system can withstand the above consequences.
423      * <BR>
424      * One sample use would be to use this mode (derby.system.durability=test)
425      * when using Derby as a test database, where high performance is required
426      * and the data is not very important
427      * <BR>
428      * Valid supported values are test
429      * <BR>
430      * Example
431      * derby.system.durability=test
432      * One can set this as a command line option to the JVM when starting the
433      * application or in the derby.properties file. It is a system level
434      * property.
435      * <BR>
436      * This property is static; if you change it while Derby is running,
437      * the change does not take effect until you reboot.
438      */
439     public static final String DURABILITY_PROPERTY =
440         "derby.system.durability";
441     
442     /**
443      * This is a value supported for derby.system.durability
444      * When derby.system.durability=test, the storage system does not
445      * force syncs and the system may not recover. It is also possible that
446      * the database might be in an inconsistent state
447      * @see #DURABILITY_PROPERTY
448      */
449     public static final String DURABILITY_TESTMODE_NO_SYNC = "test";
450     
451     /**
452      * derby.storage.fileSyncTransactionLog
453      * <p>
454      * When set, the store system will use sync() call on the log at
455      * commit instead of doing a write sync on all writes to the log;
456      * even if the write sync mode (rws) is supported in the JVM.
457      * <p>
458      *
459      **/
460     public static final String FILESYNC_TRANSACTION_LOG =
461         "derby.storage.fileSyncTransactionLog";
462
463
464     /**
465      * derby.storage.logArchiveMode
466      *<BR>
467      *used to identify whether the log is being archived for the database or not.
468      * It Is stored in the service.properties file.
469      *
470      * This property can be set to the boolean values "true" or "false".
471      * Setting the property to true means log is being archived, which could be
472      * used for roll-forward recovery. Setting the property to
473      * false disables log archive mode.
474      *<P>
475      *<B>INTERNAL USE ONLY</B>
476      */
477     String LOG_ARCHIVE_MODE = "derby.storage.logArchiveMode";
478
479
480     /**
481      * derby.storage.logDeviceWhenBackedUp
482      *<BR>
483      * This property indicates the logDevice location(path) when the backup was
484      * taken, used to restore the log to the same location while restoring from
485      * backup.
486      *<P>
487      *<B>INTERNAL USE ONLY</B>
488      */
489     String LOG_DEVICE_AT_BACKUP = "derby.storage.logDeviceWhenBackedUp";
490     
491     /**
492      * derby.module.modulename
493      * <P>
494      * Defines a new module. Modulename is a name used when loading the definition
495      * of a module, it provides the linkage to other properties used to define the
496      * module, derby.env.jdk.modulename and derby.env.classes.modulename.
497      *
498      * The value is a Java class name that implements functionality required by
499      * the other parts of a Derby system or database. The class can optionally implement
500      * these classes to control its use and startup.
501      * <UL>
502      * <LI> org.apache.derby.iapi.services.monitor.ModuleControl
503      * <LI> org.apache.derby.iapi.services.monitor.ModuleSupportable
504      * </UL>
505      */
506     String MODULE_PREFIX = "derby.module.";
507
508     /**
509      * derby.subSubProtocol.xxx
510      *<p>
511      *
512      * A new subsubprotocol can be defined by specifying the class that handles storage for the
513      * subsubprotocol by implementing the
514      * {@link org.apache.derby.io.StorageFactory StorageFactory} or
515      * {@link org.apache.derby.io.WritableStorageFactory WritableStorageFactory} interface. This
516      * is done using a property named db2j.subsubprotocol.<i>xxx</i> where <i>xxx</i> is the subsubprotocol name.
517      * Subsubprotocol names are case sensitive and must be at least 3 characters in length.
518      *<p>
519      *
520      * For instance:
521      *<br>
522      * derby.subSubProtocol.mem=com.mycompany.MemStore
523      *<br>
524      * defines the "mem" subsubprotocol with class com.mycompany.MemStore as its StorageFactory implementation.
525      * A database implemented using this subsubprotocol can be opened with the URL "jdbc:derby:mem:myDatabase".
526      *<p>
527      *
528      * Subsubprotocols "directory", "classpath", "jar", "http", and "https" are built in and may not be overridden.
529      */
530     String SUB_SUB_PROTOCOL_PREFIX = "derby.subSubProtocol.";
531     
532     
533     /**
534      * Declare a minimum JDK level the class for a module or sub sub protocol supports.
535      * Set to an integer value from the JVMInfo class to represent a JDK.
536      * If the JDK is running at a lower level than the class requires
537      * then the class will not be loaded and will not be used.
538      *
539      * If there are multiple modules classes implementing the same functionality
540      * and supported by the JVM, then the one with the highest JDK
541      * requirements will be selected. This functionality is not present for
542      * sub sub protocol classes yet.
543      *
544      * See org.apache.derby.iapi.services.info.JVMInfo.JDK_ID
545      */
546     String MODULE_ENV_JDK_PREFIX = "derby.env.jdk.";
547
548     /**
549      * Declare a set of classes that the class for a module or sub sub protocol requires.
550      * Value is a comma separated list of classes. If the classes listed are not
551      * loadable by the virtual machine then the module class will not be loaded and will not be used.
552     */
553     String MODULE_ENV_CLASSES_PREFIX = "derby.env.classes.";
554
555     /*
556     ** derby.language.*
557     */
558
559     /**
560      * The size of the table descriptor cache used by the
561      * data dictionary. Database. Static.
562      * <p>
563      * Undocumented.
564      */
565     String LANG_TD_CACHE_SIZE = "derby.language.tableDescriptorCacheSize";
566     int LANG_TD_CACHE_SIZE_DEFAULT = 64;
567
568     /**
569      * The size of the permissions cache used by the data dictionary.
570      * Database. Static.
571      * <p>
572      * Undocumented.
573      */
574     String LANG_PERMISSIONS_CACHE_SIZE = "derby.language.permissionsCacheSize";
575     int LANG_PERMISSIONS_CACHE_SIZE_DEFAULT = 64;
576     /**
577      * The size of the stored prepared statment descriptor cache
578      * used by the data dictionary. Database. Static.
579      * <p>
580      * Externally visible.
581      */
582     String LANG_SPS_CACHE_SIZE = "derby.language.spsCacheSize";
583     int LANG_SPS_CACHE_SIZE_DEFAULT =32;
584
585     /**
586       derby.language.stalePlanCheckInterval
587
588       <P>
589       This property tells the number of times a prepared statement should
590       be executed before checking whether its plan is stale. Database.
591       Dynamic.
592       <P>
593       Externally visible.
594      */
595     String LANGUAGE_STALE_PLAN_CHECK_INTERVAL =
596                                 "derby.language.stalePlanCheckInterval";
597
598     
599     /** Default value for above */
600     int DEFAULT_LANGUAGE_STALE_PLAN_CHECK_INTERVAL = 100;
601
602     /** Minimum value for above */
603     int MIN_LANGUAGE_STALE_PLAN_CHECK_INTERVAL = 5;
604
605
606     /*
607         Statement plan cache size
608         By default, 100 statements are cached
609      */
610     String STATEMENT_CACHE_SIZE = "derby.language.statementCacheSize";
611     int STATEMENT_CACHE_SIZE_DEFAULT = 100;
612
613   /* some static fields */
614     public static final String DEFAULT_USER_NAME = "APP";
615     public static final String DATABASE_MODULE = "org.apache.derby.database.Database";
616
617     /*
618         Property to enable Grant & Revoke SQL authorization. Introduced in Derby 10.2
619         release. New databases and existing databases (in Derby 10.2) still use legacy
620         authorization by default and by setting this property to true could request for
621         SQL standard authorization model.
622      */
623     public static final String
624     SQL_AUTHORIZATION_PROPERTY = "derby.database.sqlAuthorization";
625
626     public static final String
627     DEFAULT_CONNECTION_MODE_PROPERTY = "derby.database.defaultConnectionMode";
628
629     public static final String NO_ACCESS = "noAccess";
630     public static final String READ_ONLY_ACCESS = "readOnlyAccess";
631     public static final String FULL_ACCESS = "fullAccess";
632     public static final String DEFAULT_ACCESS = FULL_ACCESS;
633
634     public static final String
635     READ_ONLY_ACCESS_USERS_PROPERTY = "derby.database.readOnlyAccessUsers";
636
637     public static final String
638     FULL_ACCESS_USERS_PROPERTY = "derby.database.fullAccessUsers";
639
640     /*
641     ** Authentication
642     */
643
644     // This is the property that turn on/off authentication
645 public static final String REQUIRE_AUTHENTICATION_PARAMETER =
646                                 "derby.connection.requireAuthentication";
647
648     public static final String AUTHENTICATION_PROVIDER_PARAMETER =
649                                 "derby.authentication.provider";
650
651     // This is the user property used by Cloudscape and LDAP schemes
652 public static final String USER_PROPERTY_PREFIX = "derby.user.";
653
654     // These are the different built-in providers Cloudscape supports
655
656     public static final String AUTHENTICATION_PROVIDER_BUILTIN =
657                                 "BUILTIN";
658
659     public static final String AUTHENTICATION_PROVIDER_LDAP =
660                                 "LDAP";
661
662     public static final String AUTHENTICATION_SERVER_PARAMETER =
663                                 "derby.authentication.server";
664
665     /*
666     ** Log
667     */
668
669     /**
670         Property name for specifying log switch interval
671      */
672     public static final String LOG_SWITCH_INTERVAL = "derby.storage.logSwitchInterval";
673
674     /**
675         Property name for specifying checkpoint interval
676      */
677     public static final String CHECKPOINT_INTERVAL = "derby.storage.checkpointInterval";
678
679     /**
680         Property name for specifying log archival location
681      */
682     public static final String LOG_ARCHIVAL_DIRECTORY = "derby.storage.logArchive";
683
684     /**
685         Property name for specifying log Buffer Size
686      */
687     public static final String LOG_BUFFER_SIZE = "derby.storage.logBufferSize";
688     
689     
690     /*
691     ** Upgrade
692     */
693     
694     /**
695      * Allow database upgrade during alpha/beta time. Only intended
696      * to be used to allow Derby developers to test their upgrade code.
697      * Only supported as a system/application (derby.properties) property.
698      */
699     String ALPHA_BETA_ALLOW_UPGRADE = "derby.database.allowPreReleaseUpgrade";
700         
701     /**
702         db2j.inRestore
703         <BR>
704         This Property is used to indicate that we are in restore mode if
705         if the system is doing a restore from backup.
706         Used internally to set flags to indicate that service is not booted.
707         <P>
708         <B>INTERNAL USE ONLY</B>
709     */
710     String IN_RESTORE_FROM_BACKUP = PROPERTY_RUNTIME_PREFIX + "inRestore";
711     
712             
713     /**
714         db2j.deleteRootOnError
715         <BR>
716         If we a new root is created while doing restore from backup,
717         it should be deleted if a error occur before we could complete restore
718         successfully.
719         <P>
720         <B>INTERNAL USE ONLY</B>
721     */
722     String DELETE_ROOT_ON_ERROR = PROPERTY_RUNTIME_PREFIX + "deleteRootOnError";
723     
724     public static final String HTTP_DB_FILE_OFFSET = "db2j.http.file.offset";
725     public static final String HTTP_DB_FILE_LENGTH = "db2j.http.file.length";
726     public static final String HTTP_DB_FILE_NAME = "db2j.http.file.name";
727
728     /**
729      * derby.drda.startNetworkServer
730      *<BR>
731      * If true then we will attempt to start a DRDA network server when Cloudscape boots,
732      * turning the current JVM into a server.
733      *<BR>
734      * Default: false
735      */
736     public static final String START_DRDA = "derby.drda.startNetworkServer";
737
738     /**
739      * derby.drda.logConnections
740      *<BR>
741      * Indicates whether to log connections and disconnections.
742      *<BR>
743      * Default: false
744      */
745     public final static String DRDA_PROP_LOGCONNECTIONS = "derby.drda.logConnections";
746     /**
747      * derby.drda.traceAll
748      *<BR>
749      * Turns tracing on for all sessions.
750      *<BR>
751      * Default: false
752      */
753     public final static String DRDA_PROP_TRACEALL = "derby.drda.traceAll";
754     public final static String DRDA_PROP_TRACE = "derby.drda.trace";
755
756     /**
757      * derby.drda.traceDirectory
758      *<BR>
759      * The directory used for network server tracing files.
760      *<BR>
761      * Default: if the derby.system.home property has been set,
762      * it is the default. Otherwise, the default is the current directory.
763      */
764     public final static String DRDA_PROP_TRACEDIRECTORY = "derby.drda.traceDirectory";
765
766     public final static String DRDA_PROP_MINTHREADS = "derby.drda.minThreads";
767     public final static String DRDA_PROP_MAXTHREADS = "derby.drda.maxThreads";
768     public final static String DRDA_PROP_TIMESLICE = "derby.drda.timeSlice";
769
770     /**
771      * derby.drda.securityMechanism
772      *<BR>
773      * This property can be set to one of the following values
774      * USER_ONLY_SECURITY
775      * CLEAR_TEXT_PASSWORD_SECURITY
776      * ENCRYPTED_USER_AND_PASSWORD_SECURITY
777      * STRONG_PASSWORD_SUBSTITUTE_SECURITY
778      * <BR>
779      * if derby.drda.securityMechanism is set to a valid mechanism, then
780      * the Network Server accepts only connections which use that
781      * security mechanism. No other types of connections are accepted.
782      * <BR>
783      * if the derby.drda.securityMechanism is not set at all, then the
784      * Network Server accepts any connection which uses a valid
785      * security mechanism.
786      * <BR>
787      * E.g derby.drda.securityMechanism=USER_ONLY_SECURITY
788      * This property is static. Server must be restarted for the property to take effect.
789      * Default value for this property is as though it is not set - in which case
790      * the server will allow clients with supported security mechanisms to connect
791      */
792     public final static String DRDA_PROP_SECURITYMECHANISM = "derby.drda.securityMechanism";
793
794     /**
795      * derby.drda.portNumber
796      *<BR>
797      * The port number used by the network server.
798      */
799     public final static String DRDA_PROP_PORTNUMBER = "derby.drda.portNumber";
800     public final static String DRDA_PROP_HOSTNAME = "derby.drda.host";
801
802     /**
803      * derby.drda.keepAlive
804      *
805      *<BR>
806      * client socket setKeepAlive value
807      */
808     public final static String DRDA_PROP_KEEPALIVE = "derby.drda.keepAlive";
809     
810
811     /**
812      * derby.drda.streamOutBufferSize
813      * size of buffer used when stream out for client.
814      *
815      */
816     public final static String DRDA_PROP_STREAMOUTBUFFERSIZE = "derby.drda.streamOutBufferSize";
817
818     /*
819     ** Internal properties, mainly used by Monitor.
820     */
821     public static final String SERVICE_PROTOCOL = "derby.serviceProtocol";
822     public static final String SERVICE_LOCALE = "derby.serviceLocale";
823
824     /**
825      * db2j.storage.dataNotSyncedAtCheckPoint
826      * <p>
827      * When set, the store system will not force a sync() call on the
828      * containers during a checkpoint.
829      * <p>
830      * An internal debug system only flag. The recovery system will not
831      * work properly if this flag is enabled, it is provided to do performance
832      * debugging to see whether the system is I/O bound based on checkpoint
833      * synchronous I/O.
834      * <p>
835      *
836      **/
837     public static final String STORAGE_DATA_NOT_SYNCED_AT_CHECKPOINT =
838         "db2j.storage.dataNotSyncedAtCheckPoint";
839
840     /**
841      * db2j.storage.dataNotSyncedAtAllocation
842      * <p>
843      * When set, the store system will not force a sync() call on the
844      * containers when pages are allocated.
845      * <p>
846      * An internal debug system only flag. The recovery system will not
847      * work properly if this flag is enabled, it is provided to do performance
848      * debugging to see whether the system is I/O bound based on page allocation
849      * synchronous I/O.
850      * <p>
851      *
852      **/
853     public static final String STORAGE_DATA_NOT_SYNCED_AT_ALLOCATION =
854         "db2j.storage.dataNotSyncedAtAllocation";
855
856     /**
857      * db2j.storage.logNotSynced
858      * <p>
859      * When set, the store system will not force a sync() call on the log at
860      * commit.
861      * <p>
862      * An internal debug system only flag. The recovery system will not
863      * work properly if this flag is enabled, it is provided to do performance
864      * debugging to see whether the system is I/O bound based on log file
865      * synchronous I/O.
866      * <p>
867      *
868      **/
869     public static final String STORAGE_LOG_NOT_SYNCED =
870         "db2j.storage.logNotSynced";
871
872 }
873

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags