Partial fix for OPENDJ-885: Replication replay may lose changes if it can't acquire a writeLock * remove a bunch of dead code in our entry cache implementations. OPENDJ-885 requires that we no longer use timeouts when using the LockManager. Our entry caches were one such place where we used the lock manager with timeouts. However, on closer examination I found that we never use the locking capabilities of our entry caches, so a simple fix is to remove the dead functionality

Fix OPENDJ-525: Remove compiler warnings when building using JDK7 Fix redundant method call resulting from previous automated refactoring.

Fix OPENDJ-525: Remove compiler warnings when building using JDK7

Fix OPENDJ-471. FIFOEntryCache may leave stalled data on low memory conditions. Now, when low memory conditions are detected, the FIFOEntryCache removes the previous version of the updated entry if it exists, instead of just removing the first-in entry.

Fix minor issues, optimizations detected by FindBugs and Netbeans.

- use ReentrantReadWriteLock to protect entry cache maps against unsynchronized concurrent structural modifications.

Updated the copyright statement to reflect that Sun owns the full copyright on the project files.

- [Issue 2007] generic mechanism for using mulitple caches. - [Issue 2049] dsconfig is unable to configure the entry cache.

- fix FindBugs positives.

- [Issue 1594] entry caches should have monitor information: implement generic entry cache monitor provider which allows any entry cache implementation current or future to provide a common or custom set of entry cache state data. update all existing entry cache implementations so that they provide their common state data to the entry cache monitor provider.

entry cache cleanup: - remove obsolete methods, fields and messages. - aggregate filters evaluation for config phases. - simplify filters evaluation and error reporting. - use a single set of filter messages.

- [Issue 1481] Ability to set any JE property in config.ldif - [Issue 2031] provide core JE configurable attributes for FileSystemEntryCache - fixes to entry cache config manager for proper configuration, re-configuration, error reporting.

- fix entry cache mutable properties [properties that can be changed on the fly without any admin action required] functionality which got broken presumably when migrating to new admin framework.

- remove toVerboseString method from the public EntryCache API. - make toVerboseString method private in implementation classes. - make toVerboseString use StringBuilder instead of string concat. - make toVerboseString use ServerConstants.EOL where required.

- implement new toVerboseString() method. - fix bugs found by entry cache unit tests. - sanitize backend map maintenance.

Update package-info.java files to include the @PublicAPI annotation to indicate whether any or all of the classes in that package are intended to be part of the public API. Further, mark all classes that we intend to be part of the public API with the @PublicAPI annotation to indicate the ways in which they may be used. Note that the use of these annotations and the ultimate determination as to what is in our public API and the ways in which those elements may be used still needs to be carefully reviewed before the 1.0 release. Also, perform minor cleanup in various places througout the code. This includes: - Eliminate the use of protected fields in classes that are in the org.opends.server.api package (and the classes that extend them). The use of protected fields can be troublesome, and there are generally better ways to accomplish the same thing. - Eliminate the use of the {@inheritDoc} Javadoc tag in classes that are intended to be part of the public API. Some IDEs don't resolve {@inheritDoc} to show the actual documentation. Further, there were problems in the way that some instances of {@inheritDoc} were used, namely having a method sourced from multiple parents, and in some cases {@inheritDoc} was used to refer to code defined outside of the OpenDS codebase, which will not be properly handled by the javadoc utility. - Update a number of public API classes to mark them as final if we do not intend for them to be overridden. Further, for some classes that cannot be marked final, mark some methods final if we do not intend for those methods to be overridden.

This commit is a step toward getting OpenDS internationalized. There are still issues to be resolved before we can declare that we are internationalized but this commit covers the bulk of changes needed at this time. In general this commit converts any string values that might potentially be shown to an end user (client or administrator) to a new class called Message. This includes exception messages, error log messages, alert and email text, labels, and CLI output. Message's main interface includes methods for rendering itself as a string in the default locale using toString() or a specified locale toString(Locale). In addition to addressing localization, this would allow us to potentially support controls allowing clients to set a preferred locale for server communication or output log messages in different languages. Message extends CharSequence so it can be used in some places where strings are currently used with not code change (e.g. writing to a buffer) as well as allowing messages to be composed of one another. In order to create localized messages, instead of adding them to the *Messages.java class, you define them in the corresponding properties files. In general the property file keys are used to derive the new messages severity, category, and ordinal. There are directives that can be used in the properties file in order to avoid doing this however. For instance all the properties files used internally include the 'global.category' directive at the top of the file that instructs the generator to make all the following message belong to a single category. So for internal messages the property value key will be as follows: [SEVERITY]_[DESCRIPTION]_[ORDINAL] See the properties files themselves for more information. Once your messages are in the properties file you can use the ant target 'generatemessages' to create create MessageDescriptor objects that are referred to in the Java code. In the code you might think of these objects as replacing the int-valued message IDs. To create messages you call MessageDescriptor.get() which replaces MessageHandler.getMessage(). It might be helpful then to try to define your messages before referring to them in your code since until you run 'generatemessages' you won't have any Java-code with with to create your message objects. In order to support non-localizable text in messages (host names, DN's, etc.) Message's can be created from String values by calling Message.raw(String). In this way it is also possible to circumvent the intention of changing the APIs to use Message objects instead of Strings which is to support writing of localizable messages. This method is currently used in the code as a crutch for areas of the code that need internationalization (tagged with a 'TODO: i18n' comment). It might also be used by 3rd party developers that don't intend to localize their products. However for internal use we should not be using this method to create Messages for text that is locale sensitive. Additionally this code includes a MessageBuilder that can be used in much the same way that a StringBuilder can be used. It has a method toMessage() that can be used to generate a message object when needed. At this time this method just converts the buffer contents to a raw, unlocalizable message so this will need to addressed in the future. Some other issues: - While all of the unit tests pass after this commit, there may be issues in the code where we have no or minimal test coverage. This includes much of the setup and GUI tools packages for which I have not done any testing but will begin after this commit. - The new message related Java sources are contained in package org.opends.messages and organized in a new module src/module modeled somewhat after the admin module: src/messages/src (non-generated Java source files) src/messages/generated (generated source files) src/messages/messages (properties files for messages) If you run the code from within your IDE you will have to mark all messages/src, messages/generated and messages as source directories. - To generated the MessageDescriptor files you invoke the 'generatemessages' target. - If you run the code from within your IDE you will probably ne - This commit would change the plugin API. Here are the changes caught by DirectoryServerPluginTestCase: doShutdown(String)->doShutdown(Message) doPostDisconnect(PostDisconnectPluginResult,ClientConnection,DisconnectReason,int,String) -> doPostDisconnect(PostDisconnectPluginResult,ClientConnection,DisconnectReason,Message); - This commit aligns the entire code-base behind the new Formatter class (printf style formattings like %s) as opposed to the older MessageFormat style (using curly braces for message arguments). This allows us to provide more type safety for message arguments. So for instance you can include a %c argument specifier in your format string and the MessageDescriptor will enforce specification of a Character as message creation time. - Not all of the config framework has not been converted to use Messages. Perhaps as some point we might have a 'message' syntax for locale-sensitive textural data. I'm sure Matt will have ideas about this. - In addition to Message, MessageDescriptor and MessageBuilder, the org.opends.server.message package includes enums for Category and Severity that replace the definitions formerly found in MessageHandler. - The interface for the ErrorLogger has been simplified to allow logging of messages using a single Message parameter. The severity and category of the message will be derived from the Message itself instead of specified as arguments when a message is logged. - I will provide more documentation about this plumbing on the Wiki shortly. - I will expand on the included tests soon.

- [Issue 1591] consolidate common exclude/include EntryCache functionality: this fix consolidates exclude and include filter sets functionality under the single filtersAllowCaching() method, common to all cache implementations.

- [Issue 1588] consolidate cache entry locking code: getEntry(lck) locking code logic is now consolidated in a single method inside the EntryCache abstract class effectively moving it out of entry cache implementing subclasses. - [Issue 1589] entry cache implementations can lock and return stale entry: Prevent stale entries by check [checking that given entry does indeed exist in the cache], lock [acquiring a lock] and load [loading the entry].

Make a few generic fixes to various configuration classes, including: - Fix copy and paste errors in javadoc documentation. - Prevent hiding instance variables with local variables of the same name - Eliminate a few unused methods left over from the use of ConfigurableComponent

Fix a set of problems with the configuration interface in which there were a number of cases in which insufficient validation was performed. In particular, if a new configuration object was added over protocol or an existing configuration object was changed from disabled to enabled, then the server would only perform generic validation for that component and would not have any way to perform more detailed validation that could detect larger numbers of problems. This change introduces a new "isConfigurationAcceptable" method for lots of different types of configuration objects. There are default implementations in the superclasses for those objects, so components aren't required to implement this method, but they can if appropriate and these changes also include updating all components that implement the ConfigurationChangeListener interface in a non-trivial manner so that they provide this method to perform the same kinds of validation. This fix was initially targeted at issue #1861, but it should also correct problems like those reported in issues 1932, 1936, and 1937.

Remove the dependence on AspectJ for all non method-entry and method-exit related debug messages. All debug statements will now work w/o weaving enabled. However, method-entry and method-exit debug messages work only with weaving enabled.

Perform miscellaneous cleanup from bugs and other potential problems found by FindBugs - A couple of cases in which it was possible to reference a variable before it had been initialized. - Several cases of unnecessary or inefficient type conversion (e.g., calling String.toString() or new String(String), or calling new Long(long) instead of Long.valueOf(long)). - Several cases of code that was either unused or could not possibly be reached. - One case in which an error message was created but not added to an operation response, and a case in which an exception was created but never thrown. - Renaming a method in the replication code from "NewChangeNumber()" to "newChangeNumber()", since method names should start with a lowercase letter.

Fix configuration problems that would cause the server to fail to start if an entry cache was enabled.

Issue #1560 - Migrate some objects to the new admin framework: - Entry Cache - Account Status Notification Handler - Password Storage Scheme

Make several significant changes to the OpenDS code base, including: - Narrow down the set of packages that external developers will need to access in order to write a plugin or other type of extension. Hopefully, for most things developers will only need to interact with the following packages (and their sub-packages): * org.opends.server.admin * org.opends.server.api * org.opends.server.config * org.opends.server.protocols.internal * org.opends.server.types * org.opends.server.util - As part of the attempted narrowing of packages that external developers need to access, I have moved the org.opends.server.core.Operation and org.opends.server.protocols.ldap.LDAPException classes to the org.opends.server.types package. I have also created org.opends.server.types.RawAttribute to wrap the org.opends.server.protocols.ldap.LDAPAttribute class, and org.opends.server.types.RawModification to wrap the org.opends.server.protocols.ldap.LDAPModification class. - I have updated the internal operations API to add a few new convenience methods when performing internal operations. - I have updated all of our message strings so that none of them end in periods (except those that end with an ellipsis). This will help us avoid the problem in which we see multiple periods due to embedding one message in another. - I have moved a message file from a synchronizaiton package to the messages package and resolved conflicts with existing message IDs. - I have updated a number of cases in which StaticUtils.stackTraceToSingleLineString() was used in client-facing code to replace those calls with StaticUtils.getExceptionMessage() instead. This should provide a more user-friendly message that will hopefully not reduce our ability to debug problems that may arise. - I have cleaned up some of the code in the org.opends.server.api package so that all of the classes use consistent formatting, and to fix a couple of potential Javadoc problems. - I have moved the build-tools/src directory to src/build-tools to be more consistent with other components of the server. - I have updated the build script so that the xslt task will no longer dump lots of output to the terminal when generating code. I have also gotten rid of warnings about run.classpath not being set properly.

Fixed spelling error of a debug method (org.opends.server.loggers.debug.DebugLogger.debugCought should be debugCaught).

Remove blank lines at the beginning of methods left after eliminating the debugEnter and debugConstructor calls.

Update all CDDL headers in source files to remove a typo.

This removes old debug logging framework method calls that are going to be automatically instrumented by AspectJ. Non instrumented debug method calls are updated to use the new debug framework methods. However, the new debug logging framework is not yet active as the Aspects are not weaved in. After this revision, debug logging will be disabled in the server until the new AOP framework is complete. - Removed debugEnter and debugConstructor from all source files. - Removed CLASS_NAME static string for debug purposes. - Removed old debug logging framework. - Added new debug logging frameworking using AOP. - Added AspectJ binary and libraries. - Change all modified files copyrights to include 2007.

Perform significant refactoring in the core and plugin code in order to help make it easier for external developers to extend OpenDS. In particular, this is a big step towards eliminating the need for developers to reference anything in the core package, and it's also a signficant simplification to the plugin API because it helps expose which operation methods are safe to call at various points in the plugin processing. The most significant changes in this commit include: - I've created a new org.opends.server.types.operation package and added a lot of interfaces into it. These interfaces define the set of methods that may be called on operations at various points in plugin processing (e.g., there's a PreParseAddOperation interface that exposes the methods of the AddOperation class that are safe to call from a pre-parse plugin). All of the core operation types now implement the appropriate set of interfaces, and the plugin API methods now take these interfaces as arguments rather than the Operation subclass itself. - I've moved a number of classes from the core package to the types package. All references to these classes anywhere in the code were updated to reflect the change. The classes that were moved include: * CancelledOperationException * CancelRequest * CancelResult * CryptoManager * DirectoryException * InitializationException * LockManager * OperationType * Schema - I've also moved the test cases for the DirectoryException and InitializationException classes from the core to the types package. - Some general cleanup in the core operation classes. Virtually all methods should now be marked final. All methods inherited from the abstract Operation class now use "{@inheritDoc}" for the javadoc documentation and have the "@override" annotation. - The DirectoryServerPlugin class has been updated so that the default implementations for all plugin methods now throw a runtime exception to indicate that the requested functionality has not been implemented.

Implement test suite for org.opends.server.util.StaticUtils and make the following changes to the class: * fix issue #685 (StaticUtils.charsToBytes incorrectly encodes non-ascii characters) * rename charsToBytes to getBytes for consistency with getBytes(String) * fix potential NPE in bytesToHex * modified listsAreEqual so that it handles all types of List and falls back to default List.equals() implementation if the provided lists are not random access * removed setsDiffer and replaced references to it with calls to Set.equals()

Update the configuration and the associated code to be more consistent in the time and size units used for various purposes. A new set of constants have been added to allow the same units to be used throughout the code, including providing both full and abbreviated unit names. In addition, the ds-cfg-time-limit and ds-cfg-profile-sample-interval attributes have been updated so that they use the integer with unit format rather than just an integer with an implied unit. OpenDS Issue Number: 559

Update the FIFO and soft reference entry cache implementations to convert the lock timeout attribute to use an integer with unit syntax rather than just an integer. Also, update the FIFO entry cache implementation to get rid of the calls to run the garbage collector. Instead, if we detect that too much memory is being used, we'll not store the new entry and get rid of an old entry. This is much more palatable in terms of performance and response time when the cache gets full.

Initial public commit of OpenDS Directory Server source code.