You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2013/04/19 00:24:23 UTC
svn commit: r1469599 [4/4] - in /incubator/jspwiki/branches/MVN3_BRANCH: ./
jspwiki-war/
Added: incubator/jspwiki/branches/MVN3_BRANCH/README
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/MVN3_BRANCH/README?rev=1469599&view=auto
==============================================================================
--- incubator/jspwiki/branches/MVN3_BRANCH/README (added)
+++ incubator/jspwiki/branches/MVN3_BRANCH/README Thu Apr 18 22:24:22 2013
@@ -0,0 +1,187 @@
+
+Apache JSPWiki 2.9.1-incubating - Documentation
+===============================================
+
+ 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.
+
+The license file can be found in LICENSE.
+
+
+What is JSPWiki?
+----------------
+
+JSPWiki is a simple (well, not any more) WikiWiki clone, written in Java
+and JSP. A WikiWiki is a web site which allows anyone to participate
+in its development. JSPWiki supports all the traditional wiki features,
+as well as very detailed access control and security integration using JAAS.
+
+
+Why is the version named 2.9.1-incubating? - Is it not a "real" version 2.9.1?
+------------------------------------------------------------------------------
+
+Short answer: Don't worry, it really is a mature and official Apache release!
+
+Explanation: JSPWiki is on its way to become an Apache top level project.
+ The Incubator project is the entry path into the Apache Software Foundation
+ (ASF) for projects and codebases wishing to become part of the Foundation's
+ efforts. This is why the version is named 2.9.1-incubating.
+
+
+Pre-requirements
+----------------
+
+Okay, so you wanna Wiki? You'll need the following things:
+
+REQUIRED:
+
+* A JSP engine that supports Servlet API 2.4. We recommend Tomcat from
+ http://tomcat.apache.org/ for a really easy installation.
+ Tomcat 5.5.x or later is supported.
+
+* Some previous administration experience... If you've ever installed
+ Apache or any other web server, you should be pretty well off.
+
+* And of course, a server to run the JSP engine on.
+
+* JDK 1.5+
+
+
+OPTIONAL:
+
+* JavaMail package from java.sun.com, if you want to use log4j mailing
+ capabilities. You'll also need the Java Activation Framework.
+
+* RCS versioning system installed and available in your PATH if you
+ want to use RCS versioning. It is also possible (and on Windows, it
+ is even recommended) to use the VersioningFileProvider, which does
+ not require RCS.
+
+
+Really simple installation
+--------------------------
+
+This section is meant for you, if you just want to have a really quick
+install without much worries. If you want to have a more complicated
+installation (with more power as to how to do things),
+check out the "Install" section below.
+
+Since JSPWiki 2.1.153, JSPWiki comes with a really simple installation
+engine. Just do the following:
+
+1) Install Tomcat from http://tomcat.apache.org/ (or any other servlet
+ container)
+
+2) After you've installed the engine and checked that it works, you just make a
+ subdirectory under $TOMCAT_HOME/webapps/.
+ For example, if you want your application to be called 'wiki', just create a
+ directory called 'wiki', then extract all files from the war file into that
+ directory, preserving the directory structure.
+
+3) Point your browser at http://<myhost>/JSPWiki/Install.jsp
+ (Or, if you renamed it in the previous phase, use something like
+ http://<myhost>/wiki/Install.jsp)
+
+4) Answer a couple of simple questions
+
+5) Restart your container
+
+6) Point your browser to http://<myhost>/JSPWiki/ (or whatever name you
+ chose in point 2)
+
+That's it!
+
+
+Advanced Installation
+---------------------
+
+First, install a JSP engine and a web server. You can download Tomcat
+from http://tomcat.apache.org. This software was built
+originally on top of Tomcat 5.5, but probably most other versions
+work, too, and most other JSP containers.
+
+After you've installed the engine and checked that it works, you just
+make a subdirectory under $TOMCAT_HOME/webapps/. For example, if you
+want your application to be called 'MyWiki', just create a directory
+called 'MyWiki', then extract all files from the war files into that
+directory, preserving the directory structure.
+
+Edit the WEB-INF/jspwiki.properties file to your liking. The only
+thing you need to set is the directory where you want your wiki pages
+to be stored. I recommend a directory that is regularly backed up.
+
+Unzip the contents of jspwiki-corepages.zip into your newly created
+directory. You can find the rest of the documentation in the
+JSPWiki-doc.zip file.
+
+(Re)start tomcat.
+
+Point your browser at http://<where your Tomcat is installed>/MyWiki/.
+You should see the Main Wiki page. See the next section if you want
+to edit the pages =).
+
+
+Installation with Windows
+-------------------------
+
+If you are using a version of Microsoft Windows, you'll find that
+getting RCS up and running may be a bit problematic, and thus we
+recommend the VersioningFileProvider.
+
+All JSPWiki documentation is in the web; please see
+http://doc.jspwiki.org/2.8/wiki/WindowsInstall
+
+Upgrading from previous versions
+--------------------------------
+
+Please read ReleaseNotes and the UPGRADING document.
+
+All JSPWiki documentation is in the web; please see
+http://doc.jspwiki.org/2.8/
+
+
+Configuring JSPWiki
+-------------------
+
+All configuration information is kept in WEB_INF/jspwiki.properties.
+The file is pretty well documented, so I recommend you read it through
+first.
+
+There are also some auxiliary configuration files, such as filters.xml.
+
+Also, there is a far more detailed documentation in the web:
+
+http://doc.jspwiki.org/2.8/
+
+
+Where to go next aka. where is the rest of the documentation?
+-------------------------------------------------------------
+
+The rest of the documentation is at
+
+http://doc.jspwiki.org/2.8/
+
+
+
+Contact
+-------
+
+JSPWiki authors can be contacted on the jspwiki-users mailing list.
+You can see the instructions on http://www.jspwiki.org/wiki/JSPWikiMailingList.
+
+The mailing list should also be your primary place to ask support questions.
+There are many wise and knowledgeable people on that list.
Added: incubator/jspwiki/branches/MVN3_BRANCH/ReleaseNotes
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/MVN3_BRANCH/ReleaseNotes?rev=1469599&view=auto
==============================================================================
--- incubator/jspwiki/branches/MVN3_BRANCH/ReleaseNotes (added)
+++ incubator/jspwiki/branches/MVN3_BRANCH/ReleaseNotes Thu Apr 18 22:24:22 2013
@@ -0,0 +1,185 @@
+
+Apache JSPWiki 2.9.1-incubating - Release Notes
+===============================================
+
+ 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.
+
+The license file can be found in LICENSE.
+
+
+Welcome to the stable version of Apache JSPWiki 2.9.1-incubating!
+
+Apache JSPWiki 2.9.1-incubating is the second JSPWiki which is not only released
+completely under the Apache License 2.0, but which is also an official Apache
+release from within the Apache Incubator. This version is mainly a manteinance
+release.
+
+Details are available in the ChangeLog file or via our issue tracker.
+
+Please report any issues at https://issues.apache.org/jira/browse/JSPWIKI
+
+
+
+Apache JSPWiki 2.9.0-incubating - Release Notes
+===============================================
+
+ 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.
+
+The license file can be found in LICENSE.
+
+
+Welcome to the stable version of Apache JSPWiki 2.9.0-incubating!
+
+Apache JSPWiki 2.9.0-incubating is the first JSPWiki which is not only released
+completely under the Apache License 2.0, but which is also an official Apache
+release from within the Apache Incubator.
+
+
+Please report any issues at https://issues.apache.org/jira/browse/JSPWIKI
+
+
+UPDATES SINCE 2.8.4
+===================
+
+Details are available in the ChangeLog file or via our issue tracker.
+
+Highlights include:
+
+* The java packages have been renamed from com.ecyrd.jspwiki to org.apache.wiki.
+
+* Support external properties in WikiEngine (idea from John McKinney)
+ You can now override individual properties in jspwiki.properties using
+ standard Java System properties.
+
+* Extended the list of file suffixes indexable for the integrated Lucene search
+ engine. We now do ".txt", ".ini", ".xml", ".html", "htm", ".mm",
+ ".htm", ".xhtml", ".java", ".c", ".cpp", ".php", ".asm", ".sh",
+ ".properties", ".kml", ".gpx", ".loc"
+
+
+UPDATES SINCE 2.8.3
+===================
+
+The full list is available in the ChangeLog file. Highlights include
+
+* Improvements in JCR Export
+
+* Numerous minor bug fixes
+
+
+UPDATES SINCE 2.8.2
+===================
+
+The full list is available in the ChangeLog file. Highlights include
+
+* Improved logging
+
+* JDK6 compilation support
+
+* Brazilian Portuguese translation, thanks to Paulo Amaral
+
+* Addition of new PageViewPlugin
+
+* Numerous bugfixes, esp. in sorting.
+
+
+NEW FEATURES SINCE 2.6.x
+========================
+
+* JSPWiki now requires JDK 1.5 to run.
+
+* Simplified Chinese, Dutch, Italian and Russian localizations added!
+
+* There is no more need for JAAS files! Hooray! This has
+ been replaced with custom jspwiki properties. Please see
+ the UPGRADING document.
+
+* Massive improvements to the default template, like
+ section editing.
+
+* Sneak preview in the default editor
+
+* WikiWizard is removed (it is LGPL), but FCK integration is available,
+ and WikiWizard can still be installed as a separate package.
+
+* German, Finnish, Spanish, Simplified Chinese and Dutch language corepages
+
+* Support for the UniversalEditButton (http://universaleditbutton.org/).
+
+* Password hashes are now salted. This means you can't share the passwords
+ if you have JSPWiki 2.6 instances, as the passwords are upgraded
+ transparently.
+
+The full log of any issues fixed can be found at:
+
+https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12310732&styleName=Html&version=12312864
+
+Please also see http://www.jspwiki.org/wiki/NewIn2.8
+
+UPGRADE NOTES
+=============
+
+Please see the UPGRADING document in this same directory.
+
+
+EXPERIMENTAL FEATURES
+=====================
+
+There are some features in this release which could mostly be considered
+experimental at best. The following ones are known to work only
+partially:
+
+* WebDAV support. This is known to be broken on pretty many levels...
+
+* Admin interface. Check out /admin/Admin.jsp.
+
+KNOWN PROBLEMS
+==============
+
+* WebDAV does not yet support the new authentication/permissions scheme.
+ Therefore, if you have very sensitive data in your wiki, you might not want
+ to enable it.
+
+* Not all old plugins work. Specifically any plugins, which construct
+ new WikiPages will fail because of the constructor has been changed.
+
+* The PageFilter API was changed in 2.6
+
+* Our documentation simply sucks at this point. Please forgive us,
+ and point where those fixes are needed. We will improve upon
+ based your input.
+
+* The ShortURLConstructor does not work reliably. Please use
+ ShortViewURLConstructor, or Apache mod_rewrite.
+
+* Running with a security manager isn't yet supported (see JSPWIKI-129).
Added: incubator/jspwiki/branches/MVN3_BRANCH/UPGRADING
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/MVN3_BRANCH/UPGRADING?rev=1469599&view=auto
==============================================================================
--- incubator/jspwiki/branches/MVN3_BRANCH/UPGRADING (added)
+++ incubator/jspwiki/branches/MVN3_BRANCH/UPGRADING Thu Apr 18 22:24:22 2013
@@ -0,0 +1,415 @@
+
+Apache JSPWiki 2.9.0-incubating - Upgrading Notes
+=================================================
+
+ 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.
+
+The license file can be found in LICENSE.
+
+
+
+Upgrading JSPWiki to 2.9.1
+--------------------------
+
+1. Beginning with JSPWiki-2.9.1-svn-3, generics have been added to WikiPlugin's execute() signature,
+which now looks like:
+
+String execute( WikiContext context, Map<String, String> params ) throws PluginException;
+
+Internally this Map was always constructed and expected to be used as <String, String>, except for
+the special _bounds parameter, which was constructed internally as an int[pos, end]. This parameter
+is built now as a String and has the form of "pos|end". Other than that, this change of signature
+shouldn't affect your custom plugins.
+
+2. JSPWiki API
+
+The package org.apache.wiki.api aims to provide an API to give access to JSPWiki internals. Check
+doc/2.10-API.txt to see its packages, classes affected and to be removed when 2.10, etc.
+
+3. RCS Support deprecated
+
+2.9.1 will be the last JSPWiki version to support RCS as a Provider.
+In the next JSPWiki version, RCS support will be removed (JSPWIKI-758).
+
+
+Upgrading JSPWiki from 2.8.x to 2.9.0
+-------------------------------------
+
+1. Shut down your web container
+
+2. Backup your old configuration files:
+ * jspwiki.properties
+ * filters.xml
+ * web.xml
+
+3. Backup any modifications or customizations you may have done
+
+4. Unzip JSPWiki.war to a new directory
+
+5. JSPWiki's Java package names have changed from com.ecyrd.jspwiki to
+ org.apache.wiki.
+
+ In case your backed up files do contain the old package names or are, in
+ case of binaries, built upon previous versions of JSPWiki, you will most
+ probably have to adapt these files to the new package names.
+
+ NOTE: The mandatory files jspwiki.properties and web.xml are affected, you
+ will have to patch them!
+
+ Finished patching, copy the patched files and any further of your old
+ modified files on top of the newly installed copy of JSPWiki.
+
+6. Replace your old installed copy with the new version.
+
+7. Empty any temporary directories your web container might have
+ (e.g. $CATALINA_HOME/work and $CATALINA_HOME/temp)
+
+8. Restart your web container
+
+There is no need to empty the JSPWiki work directory or modify
+any preferences or settings (apart from the package name change in 5.).
+
+If you've deployed JSPWiki already as a WAR file, then you can
+just reinstall JSPWiki.war using the new version. Just make
+sure you have backed up and adapted your configuration files first!
+
+
+Upgrading JSPWiki from older versions to any version of 2.8
+-----------------------------------------------------------
+
+This file documents the steps necessary to upgrade JSPWiki 2.8 from 2.6. This
+document was written for two audiences:
+
+a. Deployers -- system administrators who want to upgrade JSPWiki , but who have
+not created custom JSPs, plugins, or developed against JSPWiki APIs
+
+b. Developers -- persons who have integrated their code with JSPWiki public APIs.
+
+Detailed instructions for both groups follow.
+
+
+UPGRADE INSTRUCTIONS FOR DEPLOYERS
+----------------------------------
+
+1. Required Steps
+2. Suggested Steps
+3. Backwards Incompatibilities
+
+1. Required Steps
+ --------------
+
+ A. Preparing the web container
+
+ -> If you are using Tomcat, delete the $CATALINA_HOME/temp and
+ $CATALINA_HOME/work directories before upgrading.
+
+ B. Replacing JSPs and web resources
+
+ -> If you are upgrading from 2.4, you should replace all of the top-level
+ JSPs (relative to the webroot) with the new ones from 2.6. You
+ should also copy the contents of the 2.8 release's /scripts,
+ /templates, and /images directories.
+
+ -> If you are upgrading from 2.6, you should copy the contents of
+ the /scripts, /templates and /images directories. You do not need
+ to copy the top-level JSPs (relative to the webroot), because these
+ are identical to those in 2.6.
+
+ C. Upgrading jspwiki.properties
+
+ -> You must upgrade jspwiki.properties. JSPWiki 2.8 adds several
+ new properties to it. We recommend you use the 2.8 version of
+ jspwiki.properties as a base, and copy your existing
+ settings into it line-by-line.
+
+ You should also add these properties, although they will default to
+ sensible values if you do not:
+ jspwiki.allowCreationOfEmptyPages
+ jspwiki.userdatabase.uid
+ jspwiki.userdatabase.lockExpiry
+ jspwiki.userdatabase.attributes
+
+ -> In jspwiki.properties, 'jspwiki.baseURL' is now a mandatory attribute,
+ and you MUST set it to the URL that resolves to your JSPWiki webapp.
+ Be careful if you use a localhost address (http://localhost/ or
+ http://127.0.0.1/): this will cause some unwanted side effects
+ if your wiki is accessed from any other computer than where the
+ wiki is running. Example:
+ jspwiki.baseURL = http://www.jspwiki.org/wiki/
+
+ Note that the trailing slash is REQUIRED.
+
+ D. Upgrading WEB-INF resources and libraries
+
+ -> If you are upgrading from JSPWiki 2.4, we recommend that you use the 2.8
+ version of WEB-INF/web.xml as a base, and copy any customizations into
+ it line by line. JSPWiki 2.6 added JSON/AJAX features and JavaMail resource
+ declarations, which you will get if you use the new web.xml file.
+
+ -> Replace the old WEB-INF/jspwiki.tld and WEB-INF/lib/JSPWiki.jar with the
+ new versions. If you are upgrading from 2.4, you must also add
+ WEB-INF/jstl.fmt.tld.
+
+ -> If you are upgrading from 2.4 or 2.6, add the following WEB-INF/lib files
+ from the new version to your existing WEB-INF:
+ commons-fileupload-1.2.1.jar, commons-io-1.4.jar
+
+ -> If you are upgrading from 2.4, you should upgrade the following WEB-INF/lib
+ files from the new version to your existing WEB-INF:
+ commons-lang-2.0.jar, freshcookies-security-0.54.jar,
+ log4j-1.2.14.jar, xmlrpc.jar
+
+ (You should remove any older versions of these jars from WEB-INF/lib.)
+
+ -> Remove the following files from your existing WEB-INF/lib:
+ jug-asl-2.0.0.jar, multipartrequest.jar
+
+ E. Upgrading security features
+
+ -> JSPWiki now wires up its own JAAS login process, and no longer
+ interferes with existing JAAS login stacks. The JAAS configuration
+ options that were previously set in WEB-INF/jspwiki.jaas are now
+ set in jspwiki.properties. You should make the following changes to
+ jspwiki.properties in accordance with your preferred container
+ login configuration (package names omitted for brevity):
+
+ Old jspwiki.jaas values (2.4/2.6) Equivalent jspwiki.properties values
+ --------------------------------------------------------------------------------
+ CookieAuthenticationLoginModule SUFFICIENT jspwiki.cookieAuthentication = true
+ CookieAuthenticationLoginModule (omitted) jspwiki.cookieAuthentication = false
+ CookieAssertionLoginModule SUFFICIENT jspwiki.cookieAssertions = true
+ CookieAssertionLoginModule (omitted) jspwiki.cookieAssertions = false
+ AnonymousLoginModule (any value) n/a (it is always turned on)
+
+ For cookie authentication, you might also want to change the
+ jspwiki.cookieAuthentication.expiry value, which defaults to 14 days.
+
+ -> If you specified a third-party JAAS LoginModule for custom authentication,
+ (for example: com.foo.login.MyLoginModule REQUIRED), you must specify this
+ in jspwiki.properties as follows:
+ jspwiki.loginModule.class = com.foo.login.MyLoginModule
+
+ If this property is not set, JSPWiki will default (as before) to the
+ UserDatabaseLoginModule implementation.
+
+ Note that parameters passed to your custom LoginModule are now expressed in
+ jspwiki.properties also, as key/value pairs, rather than in the JAAS config
+ file. The parameter names and values will be loaded to a Map and passed to
+ the LoginModule as the 'options' parameter when its initialize() method
+ is called. The default UserDatabaseLoginModule class does not need any options.
+ jspwiki.loginModule.options.param1 = value1
+ jspwiki.loginModule.options.param2 = value2
+
+ If you have developed a custom LoginModule, you should also read the
+ DEVELOPERS section of this document for additional information.
+
+ -> If you are upgrading from JSPWiki 2.4, you should consider basing your
+ security policy (WEB-INF/jspwiki.policy) on the version supplied in 2.8,
+ because of the fact that JAR-signing is no longer required. The overall granting
+ structure is also more compact and readable. We recommend you use the 2.8
+ version of jspwiki.policy as a base, and copy your existing policy into it
+ line-by-line. Note: If you would prefer to retain your existing policy
+ (but upgrade it), you should remove the 'keystore jspwiki' line, the initial
+ 'grant signedby "jspwiki"' block that grants Java permissions to JSPWiki,
+ and all 'signedBy "jspwiki"' references.
+
+ -> If you use the JDBCUserDatabase for storage of user profiles, you must
+ add the following columns to your users table:
+
+ column name type
+ --------------------------------------------------------------------------------------------
+ uid varchar (100)
+ lockExpiry timestamp
+ attributes longvarchar (or other large text/memo field)
+
+ The primary key should also be changed to the 'uid' column. The column names
+ can be re-mapped in jspwiki.properties similar to other JDBC columns.
+ We do not yet have an upgrade DDL script for these new columns.
+
+2. Suggested Steps
+ ---------------
+
+ -> If you are running JBOSS, you may safely delete the following entries in
+ your login-config.xml:
+ <application-policy name="JSPWiki-container">
+ <application-policy name="JSPWiki-custom">
+
+ -> If you are running Tomcat and have configured JAAS, you may safely remove
+ the following system property from CATALINA_OPTS:
+ java.security.auth.login.config
+
+ -> If you are upgrading from JSPWiki 2.4, you may safely delete the Java keystore
+ file (stored at WEB-INF/jspwki.jks). JSPWiki JARs do not need to be signed in 2.6
+ and higher.
+
+ -> If you are upgrading from JSPWiki 2.4, you may safely delete WEB-INF/oscache.properties.
+
+3. Backwards Incompatibilities
+ ---------------------------
+
+ -> Vote.jsp and the vote plugin are removed in 2.8.
+
+4. Notes
+--------
+
+ -> The method for storing passwords in UserDatabases has changed. We now
+ use salted SHA-1 hashes. These are transparently upgraded on the fly
+ as users log in.
+
+ -> User profiles now have a unique identifier associated with them. These
+ are stored by the XML and JDBC UserDatabase implementations. UIDs are
+ Strings. They are transparently added to any profiles that do
+ not have them, on the fly, as users log in. The UID property is not
+ widely used yet, but we expect it to be useful for security logging
+ in future releases of JSPWiki.
+
+ You can migrate your existing UserDatabase with a conversion utility
+ available at http://www.jspwiki.org/wiki/UserDatabaseConversion
+
+
+UPGRADE INSTRUCTIONS FOR DEVELOPERS
+-----------------------------------
+
+1. Required Steps
+2. Suggested Steps
+3. Backwards Incompatibilities
+
+1. Required Steps
+ --------------
+JSPWiki 2.8 requires at least Java 5, so make sure you have that available.
+
+
+2. Suggested Steps
+ ---------------
+(to be written)
+
+
+3. Backwards Incompatibilities
+ ---------------------------
+
+ This section describes the changes to JSPWiki's API in version 2.8 compared to the previous
+ release (2.6). Only public API changes are documented here. For a complete list of changes,
+ including those to protected and private methods and fields, see doc/API Changes from 2.4.
+
+ These changes are derived from the output of JarJarDiff, a component of the
+ "DependencyFinder" package (not bundled with JSPWiki). If you have it installed, you
+ can generate a full API diff report against any version of JSPWiki by running the Ant
+ target "api-diff".
+
+ -> The following interfaces have changed slightly, and may introduce
+ compatibility problems if you do not fix them in your custom classes.
+ These interfaces are NOT generally implemented by third parties, so
+ this probably will not affect you:
+
+ -> com.ecyrd.jspwiki.auth.user.UserDatabase
+ - removed boolean isSharedWithContainer()
+ -> com.ecyrd.jspwiki.auth.user.UserProfile
+ - implements java.io.Serializable
+ - added java.util.Date getLockExpiry()
+ - added long getUid()
+ - added boolean isLocked()
+ - added setLockExpiry(java.util.Date)
+ - added void setUid(long)
+
+ -> com.ecyrd.jspwiki.workflow.Step
+ - extends java.io.Serializable
+ - method getMessageArguments() now returns Serializable[] rather than Object[]
+
+ All classes in JSPWiki that implement these interfaces changed also. In
+ particular, your Task and Decision subclasses will need to be modified
+ (slightly) to acommodate the changes to the Step interface.
+
+ -> The UserDatabase implementations (e.g., JDBCUserDatabase and XMLUserDatabase)
+ have been enhanced to persist the additional properties for the
+ UserProfile interface. If you have implemented your own UserDatabase class,
+ you should examine either of these to see how these new properties
+ should be persisted. In addition, UserDatabase no longer supports any
+ "shared with container" methods or behaviors.
+
+ -> Many of the Comparator classes now use the Java 5 idiom, rather than
+ the old-style boolean.compare(Object).
+
+ -> The following public fields were removed or made private:
+
+ com.ecyrd.jspwiki.PropertyReader.PARAM_VAR_DECLARATION, PARAM_VAR_DECLARATION
+ com.ecyrd.jspwiki.TranslatorReader.ATTACHMENT, EDIT, READ
+ com.ecyrd.jspwiki.auth.AuthenticationManager.LOGIN_CONTAINER, LOGIN_CUSTOM
+ com.ecyrd.jspwiki.auth.user.JDBCUserDatabase.DEFAULT_DB_HASH_PREFIX, PROP_DB_HASH_PREFIX
+ com.ecyrd.jspwiki.filters.PingWeblogsComFilter.m_pingURL
+ com.ecyrd.jspwiki.forms.FormInfo.m_action, m_error, m_handler, m_hide, m_name
+ m_result, m_status, m_submission
+ com.ecyrd.jspwiki.modules.ModuleManager.LOAD_INCOMPATIBLE_MODULES
+ com.ecyrd.jspwiki.parser.JSPWikiMarkupParser.CHARACTER, ELEMENT, IGNORE
+ com.ecyrd.jspwiki.plugin.BugReportHandler.DEFAULT_DATEFORMAT, DESCRIPTION,
+ MAPPINGS, PAGE, TITLE, VERSION
+ com.ecyrd.jspwiki.plugin.CurrentTimePlugin.DEFAULT_FORMAT
+ com.ecyrd.jspwiki.plugin.Denounce.PARAM_LINK, PARAM_LINK, PROPERTYFILE,
+ PROP_AGENTPATTERN, PROP_DENOUNCETEXT, PROP_HOSTPATTERN, PROP_REFERERPATTERN
+ com.ecyrd.jspwiki.plugin.Image.PARAM_ALIGN, PARAM_ALT, PARAM_BORDER,
+ PARAM_CAPTION, PARAM_CLASS, PARAM_HEIGHT, PARAM_LINK, PARAM_SRC,
+ PARAM_STYLE, PARAM_TARGET, PARAM_WIDTH
+ com.ecyrd.jspwiki.plugin.IndexPlugin.INITIALS_COLOR
+ com.ecyrd.jspwiki.plugin.InsertPage.PARAM_CLASS, PARAM_DEFAULT, PARAM_MAXLENGTH,
+ PARAM_PAGENAME, PARAM_SECTION, PARAM_STYLE
+ com.ecyrd.jspwiki.plugin.PluginManager.DEFAULT_FORMS_PACKAGE
+ com.ecyrd.jspwiki.plugin.WeblogArchivePlugin.PARAM_PAGE
+ com.ecyrd.jspwiki.plugin.WeblogEntryPlugin.MAX_BLOG_ENTRIES, PARAM_ENTRYTEXT
+ com.ecyrd.jspwiki.plugin.WeblogPlugin.DEFAULT_DAYS, DEFAULT_PAGEFORMAT,
+ PARAM_ALLOWCOMMENTS, PARAM_DAYS, PARAM_ENTRYFORMAT, PARAM_MAXENTRIES,
+ PARAM_PAGE, PARAM_STARTDATE
+ com.ecyrd.jspwiki.search.SearchManager.PROP_USE_LUCENE
+ com.ecyrd.jspwiki.tags.CheckLockTag.LOCKED, NOTLOCKED, OWNED
+ com.ecyrd.jspwiki.tags.CheckVersionTag.FIRST, LATEST, NOTFIRST, NOTLATEST
+ com.ecyrd.jspwiki.ui.admin.beans.SearchManagerBean.METHODS
+ com.ecyrd.jspwiki.util.MailUtil.PROP_MAIL_AUTH
+
+ -> The following public fields were deprecated, but not removed:
+ -> com.ecyrd.jspwiki.auth.AuthenticationManager.PROP_SECURITY
+
+ -> Workflow classes narrow their scope in several cases from Objects to Serializable,
+ either as parameters or return types:
+ -> com.ecyrd.jspwiki.workflow.AbstractStep.getMessageArguments()
+ now returns ava.io.Serializable[]
+ -> com.ecyrd.jspwiki.workflow.Fact.getValue() now returns java.io.Serializable
+ -> com.ecyrd.jspwiki.workflow.Workflow.getMessageArguments()
+ now returns ava.io.Serializable[]
+
+ -> Class com.ecyrd.jspwiki.TranslatorReader was deprecated, and its constructor was
+ removed so that it can no longer be instantiated. It is retained strictly for
+ reverse compatibility.
+
+ -> Class PageRenamer was moved to package com.ecyrd.jspwiki.content and completely rewritten
+ because of licensing issues
+
+ -> Class com.ecyrd.jspwiki.WikiSession method getLoginContext() was removed.
+
+ -> Because of the changes under the covers to how JAAS works in 2.8, the following
+ methods in SecurityVerifier were removed:
+ -> isJaasConfigured()
+ -> isJaasConfiguredAtStartup()
+ -> jaasConfiguration()
+
+ -> For security reasons, class com.ecyrd.jspwiki.auth.permissions.PermissionFactory
+ was made final, and its contructor was made private to prevent direct instantiation.
+
+ -> For security reasons, class com.ecyrd.jspwiki.auth.user.DefaultUserProfile
+ was made final.
+
+ -> Class com.ecyrd.jspwiki.rpc.RPCManager's constructor is now protected.
+
+ -> Class com.ecyrd.jspwiki.plugin.BugReportHandler had it's public parameter names changed to PARAM_xxx
\ No newline at end of file