Follow-up to the OPENDJ-295 patch: fixed the checkstyle errors and added the missing properties file.

Patch for OPENDJ-295

Merge ASN1 branch to trunk

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

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 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.

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.

Add support for two new password validators: - Issue #338: Prevent users from selecting a password that matches the value of any attribute (or a specified set of attributes) in that user's entry. - Issue #341: Prevent users from selecting a password that matches a value contained in a dictionary. Both validators support both forward and reverse matching, and for the dictionary password validator I have compiled a dictionary from public domain word lists.