Created NullOutputStream.wrapOrNullStream() and used it in all tools instead of duplicating the null checks everywhere.

Fix for OPENDJ-617. Resolve race condition in Windows Services when stopping the server.

Fix checkstyle, trailing space on the copyright statement, removed tabs as well.

Fix OPENDJ-161 - Rebranding Windows service integration to OpenDJ

Improves the time to start-up the server and the way service tags are detected

Fix for issue 4381 (Enabling windows service once server started fails to detect server status) If the server is running, launch the service after the service has been enabled. The code of the service (native code in service.c) already handles the case where the server is running before the service code has been launched.

Fix for issue 4273 (server does not work as service if Windows UAC enabled in Windows Server 2008) The problem was that the code assumed that the only windows OS supporting UAC was Windows Vista. This was the case before Windows 2008 came out. The fix consists on creating a method that allows identifying which OS versions of vista support UAC and which do not.

Allow the windows service name and windows service description to be customizable at the product level.

Allow productization in the name of the Window service by allowing to pass the name and description of the service name in ConfigureWindowsService. Remove references to OpenDS in the messages displayed by the Windows Service command-lines.

Remove inappropiate label.

Fix for issue 2130 (i18n CLI usage placeholders) The fix consists on changing the placeHolderValue from a String to a Message so that it can be localized. The interfaces and constructors of the argument objects have been updated to reflect this change. The placeholders are defined in tool.properties.

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

Fix for issue 1618 unable to install to folder with DN syntax. There is a problem in windows when we launch scripts using Runtime.exec if the script path contains a '=' character. The fix consists on quoting the script paths on windows when we launch them using Runtime.exec.

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.

Fix for issue 1603 (quickInstall fails to register service on vista) With the new user access control of Vista, even if we are administrators we are not allowed to do certain operations (such as writing in the service registry) in some circumstances. For instance if we launch net start <service_name> from a normal command prompt this will fail systematically. In order to be able to execute these "privileged" operations we have different alternatives: Execute the binary that will do the operations using the "Run as Administrator" option in Vista (or launching them from a command prompt that has been started using that same option). Add a manifest to the binary informing that the binary requires administrator privileges. The first alternative is one of the workarounds for the bug, however it does not apply to the case of the Java Web Start Installer. The second alternative is in what consists the bug fix. A new binary has been created. This binary has a manifest informing that it requires administrator privileges. This binary will be used in Vista as a wrapper to call operations that require administrator privileges (modifying the registry in windows-services.bat command line and calling "net start" and "net stop"). If the user is running the setup, the status-panel using the "Run as Administrator" option or is using the command lines from a command prompt launched with that option the behavior in Vista does not change with the behavior in previous versions of Windows. If the UAC is enabled and the user is not using the "Run as Administrator" options, (s)he will be prompted for confirmation each time the registry is modified and the server is started or stopped as a service. The wrapper is called on any of the individual operations. An alternative would be to call the wrapper when we launch the setup or the status-panel but this generates some issues: 1. This does not work (directly) with the Java Web Start installer. 2. This would force users that are not administrators to provide administrator credentials even to install/run an OpenDS that does not require to do privileged operations (an OpenDS that does not run as a service).

Update all of the command-line tools to ensure that the exit code should always be between 0 and 255, which are the bounds enforced by most shells and operating environments. Any negative value, or any positive value greater than 255 will be changed to 255. OpenDS Issue Number: 1883

issue 1430 fix (all utilities should provide as standard option -V/--version) to specify the LDAP protocol version number, we should use now -V/--ldapVersion to get the 'product' version --version In all other tools/CLIs -V/--version will print the version info

Fix a number of issues with David's approval: 1. A char array was set to NULL wrongly which caused a core in the windows services code. This problem appeared almost systematically when the install path was long. 2. The windows services code got into an infinite loop when the server could not be started. 3. The windows services code was missing to unlock a file after testing if it could lock it. 4. Create specific loggers for Setup, Uninstall and StatusPanel applications. This avoids having duplicated and not very user friendly log lines on the output of these applications. 5. When we cannot launch the graphical applications store the stack trace we get in the log file associated with the application and inform the user about the existence of this file in the same message where we tell that we are falling back to the CLI mode. 6. Fix a refresh problem in the status panel. Now when the number of entries of the database increase the contents of the panel are automatically updated. 7. Modify the name of the Age of Oldest Missing Changes as mentioned by Brian. 8. Redirect some logging/debugging lines of the windows services to a file called windows-service in the logs directory.

Added the following capabilities to OpenDS: - Index rebuilding capabilities. All indexes including system and attribute indexes can be rebuilt. Each index will be rebuilt by a seperate thread to increase performance. A max number of rebuild threads could be set to limit the resources used by large rebuild jobs. Partial rebuilds of attribute indexes could also be done by specifying the attribute index type after the attribute type (ie. sn.approximate). - Index rebuilding standalone tool. Rebuilding of attribute indexes could be done with the backend online. However, rebuilds including system indexes must be done with the backend offline. - Index rebuilding task. Rebuilding of attribute indexes are done with the backend online. Rebuilds that include system indexes will be performed after bring the backend offline. The user must have index-rebuild privilages to rebuild indexes. - Approxitae indexing capability. The value of the attribute will be normalized using the approximate maching rule of that attribute type. This is used as the key for the index. Approximate indexes are fully supported by the index verify, rebuild, and import jobs. - Fixed bug in build.xml where weave is enabled even if a test.* property is set. - Consolidated some common tool messages. - Consolidated some JE backend methods common to all tools. - Added unit tests for rebuild job and approximate indexes. Fix for issues 35, 39, 40, 41

Fix CLI consistency issues: 1407 1408 1410 1411 1412 1413 1414 1416 1417 1418 1419 1420 1421

Fix for issue 1382 (Provide a way to cleanup the registry/service information for Windows). Provide a new option in the windowsservice.bat command line to do a cleanup of a service. The option usage is: -c {serviceName} or --cleanupService {serviceName} Allows to disable the OpendS service and to clean up the windows registry information associated with the provided service name.o

Fix for issue 528 (Windows Service Definition for Automatic Startup). The following changes are targeted to be able to run OpenDS as a windows service. The idea is to be able to run OpenDS to run as a service and to be able also to disable this feature. The setup has been updated to run OpenDS as a service in windows (which is the standard behavior in this platform). The uninstall has also been updated to remove all references to OpenDS in the Registry and in the list of services once OpenDS has been uninstalled. A new executable (opends_service.exe) has been added to be able to perform all the tasks that require native code (registering/unregistering the service, sending events to the event log, etc.). Most of the code required by this executable is in the file service.c. The README file has been updated and a Makefile file provided to generate all the executables. A new command line has been added: windowsservice.bat. The usage of this command line is the following one: This utility may be used to configure OpenDS as a Windows service. Usage: windowsservice {options} where {options} include: -e or --enableService Enables OpenDS as a Windows service. -d or --disableService Disables OpenDS as a Windows service and stops the server -s or --serviceState Provides information about the state of OpenDS as a Windows service. -H or --help Display this usage information. The class associated with this command line (ConfigureWindowsService) uses opends_service.exe. ConfigureWindowsService is basically a wrapper that allows to have the messages displayed to the user in the Java code (and so to minimize what is done by the native code). Some changes have been made in the start-ds(.bat) and stop-ds(.bat) scripts by extending what the --checkStartability (in DirectoryServer class) and --checkStoppability (in StopDS class) do. I think that it is a good idea to have all the parsing of the arguments into the java code (specially considering the limitations of the .bat files). So I have moved most of the parsing to the java code so that the is the java code that provides a return code to the scripts to tell them what to do (start the server in detach mode, stop the server using a system call, stop the server using protocol, etc.). In the particular case of how start-ds.bat and stop-ds.bat have been updated to manage the case where the server must be started using the system call 'net start <service_name>' and 'net stop <service_name>'. --checkstoppability and --checkstartability tell whether the server must be stopped/started directly with a system call (or stopped using LDAP protocol) or using the Windows Service system. If it is the latter the bat files use two new auxiliary classes (StopWindowsService and StartWindowsService). These classes figure out the service name associated with the OpenDS instance and call net stop (or net start) using that service name. When net start/net stop are called start-ds.bat (or stop-ds.bat) are called. The Windows Services have been configured to call start-ds.bat and stop-ds.bat with some particular options (--windowsNetStart and --windowsNetStop) to identify the case where we must start/stop the server directly (and so not having an infinite recursive loop of calls to net start/net stop). In order to have the same user experience when the server is configured to run as a service and when is not the tool class WaitForDelete has also been updated to write its output to a file. This has been done because piping from the standard output to a file in the context of a Windows Service call does not seem to work properly. So now WaitForDelete has a new option --outputFile. setup --cli on windows has a new option '-n' or '-noWindowsService' to allow not to enable the windows service. When run in interactive mode and this options is not specified the user will systematically be asked whether to enable the windows service or not.