You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by aj...@apache.org on 2008/02/13 07:37:24 UTC
svn commit: r627282 [1/4] -
/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/
Author: ajaquith
Date: Tue Feb 12 22:37:23 2008
New Revision: 627282
URL: http://svn.apache.org/viewvc?rev=627282&view=rev
Log: (empty)
Added:
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/ (with props)
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/.cvsignore
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/AAA_Release_Notes.txt
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Compiling.txt
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Java 5 changes
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Apache
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.HttpUnit
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.JWebUnit
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Log4j
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.OpenSymphony
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.SilkIconSet.txt (with props)
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Stripes.txt
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.XPP
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.akismet
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.cos
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.freshcookies-security
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.hsqldb
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.jaxen
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.sandler
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/aaa-diagram.graffle
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/aaa-diagram.pdf (with props)
incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/web test plan.txt
Propchange: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Tue Feb 12 22:37:23 2008
@@ -0,0 +1 @@
+javadoc
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/.cvsignore
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/.cvsignore?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/.cvsignore (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/.cvsignore Tue Feb 12 22:37:23 2008
@@ -0,0 +1,2 @@
+javadoc
+andy
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/AAA_Release_Notes.txt
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/AAA_Release_Notes.txt?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/AAA_Release_Notes.txt (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/AAA_Release_Notes.txt Tue Feb 12 22:37:23 2008
@@ -0,0 +1,87 @@
+Hi everybody---
+
+An experimental JSPWiki branch with the new AAA subsystem is nearing alpha status.
+
+Background
+----------
+Less than 60 days ago, a bunch of us in this fine list bashed out a set of requirements for a new system for authenticating and authorizing users. Although there are too many requirements to list here, some of the primary features include:
+- Continued support for JSPWiki's custom authentication system
+- Full support for container-based authentication and authorization, including container-style roles
+- Flexible, ad hoc "groups"
+- Wiki-based ACLs
+- Customizable security policies, with simple and sensible defaults
+- New user database for "persistent" user identities
+- Support for standard Java security technologies; notably, J2SE security policies and JAAS authentication
+
+Development needs
+-----------------
+I need help getting the preceding list of requirements implemented...
+2.7 Access restrictions on searches not implemented yet.
+2.9 Hard-coded "super user" needs to be re-implemented
+ and coded into AuthenticationManager.
+3.3 Groups names are checked at creation time to make
+ sure they aren't the same as a built-in role, but
+ there should be logic in the JSP pages that tells
+ the user they can't do that...
+3.8-3.11 Requirements not implemented yet (these are "nice
+ to have" features anyway)
+4.10 Page restore operation restores previous
+ ACL, not current ACL
+6.9 Password re-set not implemented yet (nice-to-have)
+7.1 Embedding permission checks within core wiki classes
+ (e.g., WikiEngine) NOT implemented yet. Examples:
+ - WikiPage.setAcl should check for 'edit'
+7.5 Need to sanity-check configuration files (e.g.,
+ jspwiki.policy) to ensure they implement a common
+ number of use cases that should "just work."
+7.6 No user-facing documentation at the moment...
+
+Deployment considerations
+-------------------------
+JSPWiki now installs default JAAS and J2SE security policies
+at startup. See the jspwiki.policy and jspwiki.jaas files
+for more details on how to customize these configurations
+if you don't like the defaults.
+
+Bugs, limitations and errata
+----------------------------
+- Need a CreateGroup.jsp page **badly**
+- Ant build script (build.xml) now automatically signs
+ the jspwiki.jar file after it builds. It will attempt
+ to create a new .jks key file for you if it can't find
+ one where it expects (etc/). If will also copy this key
+ file to WEB-INF when building the WAR.
+- There are some funky cookie/user profile issues that persist
+ during logout operations. This could cause funnny
+ things to happen when editing preferences or registering.
+ This will get solved very soon... but not tonight.
+- Container-managed authentication has been tested
+ and debugged. It works.
+- User preferences has been split into the traditional
+ "master" JSP with the business logic, and a separate
+ *Content.jsp file.
+- User registration now lives in a JSP separate from
+ user preferences. The explanation for this is complex,
+ but it boils down to the impossibility of guaranteeing
+ session state (anonymous, asserted, authenticated).
+ Since the UI is subtly different in all of these cases,
+ it made sense to break the two functions apart.
+- UserCheck and UserProfile tags have significant
+ enhancements that should make template-writing much
+ easier, with a dramatic reduction in scriptlet code.
+- Changes to the AAA model ***will*** break your
+ custom template's scriptlet code unless you change
+ JSPs to use the new API calls, in particular
+ AuthorizationManager.checkPermission(). A migration guide
+ for template developers would be great!
+- Container-based authentication has been unit-tested
+ but not system-tested, so it might not work.
+ But it should...
+- Requirement 1.10 might not be practical. I didn't
+ attempt to implement it.
+- Groups are implemented as wiki pages named Group*
+ rather than as subpages of GroupConfiguration
+- UserPreferences.jsp needs a decent stylesheet...
+
+Requirements
+------------
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Compiling.txt
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Compiling.txt?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Compiling.txt (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Compiling.txt Tue Feb 12 22:37:23 2008
@@ -0,0 +1,72 @@
+
+Since you have the source, you'll probably want to know how to compile
+it.
+
+Some of JSPWiki is in the form of JSP pages, so you don't need to
+compile them: the JSP container will take care of that. However,
+there are a bunch of Java files, which you'll want to compile.
+
+Requirements
+============
+
+You'll need the following programs:
+
+- J2SDK 1.4 (I use the one from Sun Microsystems; I haven't tested any
+ others.)
+- Jakarta Ant 1.5 (available from http://jakarta.apache.org/ant)
+- servlet API 2.2 (servlet.jar, available from Sun.)
+- JUnit 3.7 (from www.junit.org, required for running tests)
+
+
+Building
+========
+
+Ant is the build system.
+
+Everything should Just Compile, when you say 'ant', assuming you have
+everything in your path. Most notably, you'll probably have to copy
+the servlet.jar into either your $JAVA_HOME/jre/lib/ext, or to
+JSPWiki/lib.
+
+There are few targets:
+
+ant dist : builds a full distribution.
+ant javadoc: builds the javadocs into doc/javadoc
+ant compile: just the basic compile, thankyouverymuch
+ant tests : runs JUnit tests.
+ant jar : builds the JSPWiki.jar into build/
+
+You can customize your compilation by changing the contents of the
+build.properties -file, or better yet, make your own compilation
+script where you override the build.properties-property. For example,
+to use your own build.properties-file called "my.properties", make a
+small shell script and call it "my_build.sh":
+
+#!/bin/sh
+ant -Dbuild.properties=/path/to/my.properties
+
+
+
+Directory structure
+===================
+
+'src' contains the source code (under com/ecyrd/jspwiki).
+
+'src/webdocs' contains all the files that are published in the final
+webapps directory, including all of the deployment files under
+WEB-INF.
+
+'src/wikipages' contains a number of ready-made Wikipages. Feel free
+to use them.
+
+'tests' contains a number of tests which you can run by saying 'ant
+tests'. If any of them fail, you know you've broken something.
+
+'etc' contains all configuration files.
+
+'lib' contains all libraries that are required to run JSPWiki. Note,
+however, that to keep the archive size down, I haven't included them
+in the source distribution. You may need to copy them by hand from
+somewhere, or the binary distribution.
+
+
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Java 5 changes
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Java%205%20changes?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Java 5 changes (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/Java 5 changes Tue Feb 12 22:37:23 2008
@@ -0,0 +1,347 @@
+Eclipse... Software Update
+New Remote Site:
+Name: Findbugs
+URL: http://findbugs.cs.umd.edu/eclipse
+
+Name: CheckStyle Eclipse Plug-in
+URL: http://eclipse-cs.sourceforge.net/update
+
+Class Hierarchy
+---------------
+WikiContext is the all-singing, all-dancing "request context" class in JSPWiki. It encapsulates the idea of "doing a wiki activity": viewing a page, editing a group, commenting, etc. In Stripes parlance, these are what you'd call "ActionBeans."
+
+WikiContext was originally conceived to encompass everything and everything you might want to do to a wiki page. In JSPWiki 2.4 and higher, WikiContext got overloaded with lots of activities that have nothing to do with pages, like creating groups and registering.
+
+It has been clear for a while that WikiContext needed to split itself into multiple classes and interfaces. The most logical thing to do is make WikiContext the general class or interface actions that deal exclusively with pages. Therefore: WikiContext becomes an abstract subclass of AbstractActionBean.
+
+Note that because WikiContext becomes abstract, we need to change all of the direct instantiations of WikiContext. So, what I've done is created a WikiContext subclass (a Stripes ActionBean, in fact) called ViewActionBean that is for the "view page" context.
+
+The new class hierarchy for WikiContext and related types, for 3.0, looks like this:
+
+ WikiActionBean extends ActionBean [Stripes]
+
+ AbstractActionBean implements WikiActionBean
+ |
+ +--WikiContext extends AbstractActionBean
+ | |
+ | +--ViewActionBean extends WikiContext
+ | +--EditActionBean extends WikiContext
+ ... ... ...
+ +--GroupActionBean extends AbstractActionBean
+ |
+ +--UserPreferencesActionBean extends AbstractActionBean
+ ...
+
+[NOTE: it would be nice if we could deprecate "WikiContext" in favor of, for example, "PageActionBean" to clearly denote that it's about page activities. Maybe PageActionBean becomes the interface, and we start coding to that...]
+
+The new class structure means that techniques for creating WikiContexts will change. Old instantiations of WikiContext looked like this:
+
+WikiContext dummyContext = new WikiContext( m_engine, m_context.getPage() );
+
+WikiContext dummyContext = new WikiActionBean( m_engine, m_context.getPage() );
+
+In 3.0, if you want to create a new ViewActionBean you can do it via the zero-arg constructor [WikiContext context = new ViewActionBean()] -- although you must immedidately also call setActionBeanContext() and set the ActionBeanContext's WikiEngine reference. It's much easier, instead, to call the factory method WikiActionBeanFactory.newActionBean( WikiPage page), which does it for you (see below).
+
+Other significant changes to WikiContext:
+
+- The setRequestContext() method disappears (it was only used in like 5 places anyway), because the WikiContext subclasses *are* the contexts. getReqeustContext() merely looks up a special JSPWiki class-level annotation that specifies the context. (For example: @WikiRequestContext("view"))
+
+- WikiContext.getCommand() goes away, as do the other Command-related methods. Command interface is eliminated. It was a pretty dodgy idea to begin with.
+
+- getLocale(). Not used in JSPs or core code. Because Stripes takes care of a lot of this, it's not needed.
+
+- hasAccess()/requiredPermission(). This are handled by our own Stripes interceptor/controller (WikiInterceptor) in combination with event-level annotations. So these methods should absolutely be eliminated.
+
+WikiActionBean Security
+-----------------------
+In 2.4, security permissions were added to WikiContexts. Each WikiContext could specify what Permission a user needed to access that context by causing the method requiredPermission() to return a value. This worked well, although it required each WikiContext type ("view","edit" etc.) to figure out a way to express the Permission through code. This, in part, was what let to the disaster that is the Command class.
+
+In 3.0, Permissions are much more flexible because they are annotation-driven. Moreover, they are specified at the method level, NOT at the class (WikiContext) level. Because WikiContext (and its subclasses) implement ActionBean, this is another way of saying, "Permissions annotate methods that do things." For example, consider ViewActionBean, which is a WikiContext subclass that displays a wiki page. Its default event is the "view()" method, which simply forwards control to itself and causes the page to display. Here's the method signature:
+
+ @DefaultHandler
+ @HandlesEvent("view")
+ @EventPermission(permissionClass=PagePermission.class, target="${page.qualifiedName}", actions=PagePermission.VIEW_ACTION)
+ public Resolution view() { ... }
+
+Note the @EventPermission annotation. It defines the Permission class and its target and actions. The "permissionClass" attribute tells use that the Permission class this method needs is "PagePermission". Note also the JSTL-style syntax in the target and actions attributes -- these allow JSTL-access to bean properties for the instantiated ViewActionBean. In this case, "page" is the bean attribute that returns the value of this ViewActionBean's getPage() method. The nested syntax "page.qualifiedName" is equivalent to getPage().getQualifiedName(). Neat, huh?
+
+i18n
+----
+Switching to Stripes for URL building (via URLBuilder) causes UTF-8 strings to be created by the getURL methods:
+
+So:
+<a class="wikipage" href="/Wiki.jsp?page=%C4itiSy%F6%D6ljy%E4">ÃitiSyöÃljyä</a>
+
+becomes:
+<a class="wikipage" href="/Wiki.jsp?page=%C3%84itiSy%C3%B6%C3%96ljy%C3%A4">ÃitiSyöÃljyä</a>
+
+
+Migration to Stripes tags:
+
+stripes:form. must change accept-charset to acceptcharset
+
+WikiTagBase extents StripesTagSupport in 3.0, not TagSupport. That means we needed to create a few methods that are in TagSupport but aren't in StripesTagSupport. Easily done...
+
+Also, the method TagSupport.findAncestorWithClass which is used by TabTag needs to be replaced by StripesTagSupport.getParentTag (without need for classcast).
+
+
+Thoughts on URLConstructor
+--------------------------
+http://tuckey.org/urlrewrite/manual/3.0/
+
+Looks like we could rewrite everything!
+
+For inbound requests: if UrlRewrite is the first servlet filter it will translate correctly coming in. Thus: /wiki/Page1 might forward to /wiki/Wiki.jsp?page=Page1.
+
+For outbound responses: UrlRewrite needs to be the last thing that manipulates the URL. For outbound URLs, you can generate a useful URL by calling HttpServletResponse.encodeURL(String), where the parameter is the URL you want to re-write.
+
+ --> Note: this means WikiServlet goes away (the destroy logic goes to WikiServletFilter for now)
+
+Making things a little tricker: Stripes Resolutions also generate their own URLS. This is done by creating a new RedirectResolution(WikiActionBean), where the WikiActionBean is the "url" you want to redirect to. Add parameters as necessary.
+
+To tie all of this together:
+
+Some classes currently call the URLConstructor directly. Mostly, this is WikiContext and WikiEngine (about 22 references in the JSPWiki core classes, plus 2 in the JSPs). However, most classes get their URLs by calling WikiContext.getViewURL(), getRedirectURL(), and getURL()/getURL() -- 73 references within the core, and 23 references in the templates. These probably should not be changed for compatibility's sake. However, we could easily cause these WikiContext/WikiEngine references to URLContructor instead to use Resolution.getURL + response.encodeURL().
+
+Thus: to get a proper URL from inside a method that takes a WikiContext we'd do this:
+
+// Create a new resolution and add the page parameter to it
+Resolution resolution = new RedirectResolution(ViewActionBean.class);
+resolution.addParameter("page", page.getName();
+
+// Get the response from the WikiContext (its superclass returns the ActionBeanContext, which has it)
+HttpServletResponse response = context.getContext().getResponse();
+
+// Now, encode the URL (passing it up the chain until it hits the UrlRewrite filter)
+String url = response.encodeURL( resolution.getURL() );
+
+A better example, this time with UrlBuilder:
+
+ // Make Stripes URL
+ String groupUrl = ViewGroupActionBean.class.getAnnotation(UrlBinding.class).value();
+ UrlBuilder urlBuilder = new UrlBuilder( groupUrl, true );
+ urlBuilder.addParameter("group", name);
+ String url = urlBuilder.toString();
+
+ // Make re-written URL
+ String rewriteUrl = context.getContext().getResponse().encodeURL( url );
+
+
+--> Note: this means we need to replace WikiEngine.getURL() calls with equivalent calls to UrlBuilder + response.encodeUrl()
+
+WikiEngine.getURL goes away completely. Now, we need to get the ActionBeanContext in order to generate an URL.
+
+
+ContentTemplates, JSPs, URLPatterns and RequestContexts
+-------------------------------------------------------
+In 2.4 we welded ContentTemplates, JSPs and RequestContexts together in the Command class. This helped unify some things, but it really doesn't fit in with Stripes all that well. Frankly, specifying a content template is really in the domain of JSP markup, and shouldn't be in classes. The URLPatterns are there because we need them for the URLConstructor. But if we delegate URL construction to Stripes and UrlRewrite, then we don't need this anymore. RequestContexts are still useful because we need to look up ActionBeans (e.g., WikiContexts) that way. We should still allow them, but deprecate them.
+
+General behaviors need to change in the JSP layer so that instead of looking up a URL and then calling redirect directly, we need instead to obtain RedirectResolutions.
+
+Stashing variables in PageContexts
+----------------------------------
+WikiTagBase chokes hard when it can't find a WikiContext associated with the the PageContext. That's because there's an expectation that the top-level JSP will stash the right context. In the new world WikiContexts are supplanted by ActionBeans. Do the page-specific tags need guaranteed access to a WikiContext? Hmm.... how can we stick one in there upstream? Do we name specific beans PAGE_BEAN, GROUP_BEAN, etc. or do push/pop operations
+
+Contract ought to be: top-level JSP *guarantees* that it will inject a WikiActionBean, with a well-known name ACTIONBEAN ("wikiActionBean"), into request scope. WikiTagBase should first look for the well-known ActionBean, then iterate through the stored attributes and grab the first value it finds of type ActionBean. If an ActionBean can't be found, throw a WikiException. (Like what we do now.)
+
+Thus: by convention, top-level JSPs MUST add a tag similar to this to the top of their pages if they want the bean recognized later by WikiTagBase:
+
+<stripes:useActionBean beanclass="com.ecyrd.jspwiki.action.____ActionBean"/>
+
+The first JSP to to use the useActionBean class will, by definition, cause the ACTIONBEAN request attribute to be set with this name binding. WikiTagBase's m_actionBean will obtain this value.
+
+Note: redefining m_context as m_actionBean (with type change to WikiActionBean) makes 32 out of 70 JSP tags fail to compile because they expect a getPage() method. We will need to supply guidance on how to migrate tags.
+
+In JSPs, the fact that the WikiActionBean for the page is bound as 'wikiActionBean' means that JSTL markup can access this parameter directly. It also means that we can *probably* get rid of the WikiContext.getContext() static method. In fact, we probably should. But for now, it's best to leave it but redefine the return type so that it's a WikiActionBean. That will break a few things.
+
+Dead Code
+---------
+WikiEngine.getRedirectURL(). Not used anywhere in the new code, and only once in the old Wiki.jsp. Eliminated.
+
+WikiEngine.createContext(). Better to use WikiActionBeanFactory.find...
+
+WikiEngine.getSpecialPageReference(). Used exactly once, in NewBlogEntry.jsp. Eliminated.
+
+WikiTagBase now guarantees that the protected field m_page will be set if it's a WikiContext This eliminates lots of classcasting.
+
+Things I haven't solved yet
+---------------------------
+Stopwatch from Wiki.jsp
+WatchDog from Wiki.jsp
+
+API Changes
+-----------
+VariableManager.getValue method sigs widened to WikiActionBean (from WikiContext to WikiActionBean)
+
+ContentTag's default content page is Beanclass name - "ActionBean" + "Content.jsp"
+
+WikiSession/ActionBeanContext
+-----------------------------
+Stripes ActionBeanContext wraps the request/response objects and provides information about the servlet context. It is created anew for each request, I think. So it's not suitable for "merging" with WikiSession.
+
+WikiContext getLocale(). Not used in JSPs or core code. Because Stripes takes care of a lot of this, it's not needed.
+
+WikiContext hasAccess(). Really, this should be handled by the stripes interceptor/controller. So these methods should absolutely be eliminated.
+
+
+
+
+WikiActionBean Contract
+-----------------------
+WikiActionBeans are the core action class in JSPWiki 3.0. All WikiActionBeans are expected to adhere to the following contract:
+- must have a zero-argument constructor
+- must set the ActionBeanContext immediately after instantiation (setContext)
+- must set the associated ActionBeanContext's WikiEngine immediately after instantiation (setWikiEngine)
+
+WikiActionBeans can be created in four ways:
+1) Injection by UseActionBeanTag due to <stripes:useActionBean> tag in JSP. This is the preferred way because it can be done with little effort, and only requires single line at effort, and only requires single line at the top of a top-level JSP:
+
+<stripes:useActionBean beanclass="com.ecyrd.jspwiki.action.____ActionBean"/>
+
+Technically, the WikiActionBean is looked up by Stripes' configured ActionResolver (by default, the AnnotatedClassActionResolver); the bean itself is instantiated using its zero-argument constructor. Stripes guarantees that the following things happen after instantiation, as part of its ActionBeanResolution lifecycle stage:
+- The WikiActionBean's setActionBeanContext() method is called (by AnnotatedClassActionResolver); this causes a reference to a new WikiActionBeanContext to be set in the WikiActionBean
+- The WikiActionBeanContext's setServletContext() method is called (by UseActionBeanTag); this sets an internal reference to the WikiEngine
+- The WikiActionBeanContext's setRequest/setResponse methods are called (by DefaultActionBeanContextFactory). This will also retrieve and set a reference to the user's WikiSession
+
+Thus, when <stripes:useActionBean> is used in a JSP, the WikiActionBean in question is guaranteed to have a non-null, valid WikiActionBeanContext associated with it. This WikiActionBeanContext, in turn, is guaranteed to return non-null results for its getResponse/getRequest/getServletContext methods, as well as its getWikiEngine and getWikiSession methods.
+
+2) Injection by DispatcherServlet due to POST/GET to /dispatcher, /action/* or *.action URLs. This method appears to be used, in particular, by generated Stripes form elements. It is rare that a user would actually specify one of these URLs directly.
+
+As with the previous method, the WikiActionBean is looked up by Stripes' configured ActionResolver. The same guarantees apply: after resolution and instantiation, the WikiActionBean will have a non-null, valid WikiActionBeanContext, and that the WikiActionBeanContext will return non-null results for getResponse/getRequest/getServletContext/getWikiEngine/getWikiSession.
+
+In addition to these activities, in cases 1) and 2), after the ActionBeanResolution stage completes, JSPWiki's custom WikiInterceptor executes. It will do two things:
+
+- Stash the resolved WikiActionBean into the HTTP request's ACTIONBEAN attribute (see above)
+
+- Check for proper access by calling the the bean's requiredPermission() method and checking that the user has that permission (null means "allowed"). If not, a RedirectResolution is returned that directs the user to the login page and appends all request parameters. (Note: we should make it check for authentication; if the user is already logged in, it should redirect to a "forbidden" page.
+
+These two techniques are the preferred ways to create WikiActionBeans. There are two other, less preferred, ways:
+
+3) WikiActionBeanFactory.newActionBean(HttpServletRequest,HttpServletResponse,Class<? extends WikiActionBean>).
+
+In this case, JSPWiki does things a little differently than how Stripes does it, but the result is the same. Like Stripes, it will instantiate a new WikiActionBean and associate it with a new WikiActionBeanContext.
+
+4) WikiActionBeanFactory.newActionBean( HttpServletRequest request, WikiPage page) and
+WikiActionBeanFactory.newActionBean( WikiPage page).
+
+Both of these methods instantiate ViewActionBeans and associate a WikiActionContext with the bean. The WikiActionContext's setWikiEngine and setServletContext methods are called after instantiation. If an HttpServletRequest was supplied, it is associated with the WikiActionContext.
+
+Thus, when the createContext() methods are used, the resulting ViewActionBean is guaranteed to have a non-null, valid WikiActionBeanContext associated with it. This WikiActionBeanContext, in turn, is guaranteed to return non-null results for its getServletContext/getWikiEngine methods. Its getRequest() method may or may not be null.
+
+WikiTagBase
+-----------
+WikiTagBase changes slightly to support Stripes. Instead of extending import javax.servlet.jsp.tagext.TagSupport, it now extends StripesTagSupport. However, StripesTagSupport does not supply the methods setId/GetId. So, we've had to implement these.
+
+WikiActionBeanFactory
+---------------------
+newActionBean() This method performs a similar role to the <stripes:useActionBean> tag, in the sense that it will instantiate an arbitrary WikiActionBean class and, in the case of WikiContext subclasses, bind a WikiPage to it. However, it lacks some of the capabilities the JSP tag possesses. For example, although this method will correctly identity the page requested by the user (by inspecting request parameters), it will not do anything special if the page is a "special page." If special page resolution and redirection is required, use the <stripes:useActionBean> JSP tag instead.
+
+
+Eclipse Tools Notes
+-------------------
+TestEngine: Because of its use of Stripes mock objects, TestEngine needs to be able to find the various implementations provided in JSPWiki. Therefore, it is extremely sensitive to changes in the build path. In particular, the mock servlet filter used by TestEngine hard-wires in the relative location build for finding ActionBeans. This is the directory (relative to the project root) that the Ant build scripts use for placing generated Java class files. The Eclipse project configuration must configure itself the same way. To run unit tests in Eclipse, the build directory absolutely must place generated class files in this directory, rather than the Eclipse default of classes. If unit tests do not run in Eclipse for some reason, this is the likeliest culprit.
+Use JVM args -Xmx1024m
+
+URL Rewriting
+-------------
+http://tuckey.org/urlrewrite/manual/3.0/
+
+Bugs Bugs Bugs
+--------------
+JSPWikiMarkupParserTest.testAttachmentLink
+
+Expected
+This should be an <a class="attachment" href="/attach/Test/TestAtt.txt">attachment link</a><a href="/PageInfo.jsp?page=Test/TestAtt.txt"><img src="/images/attachment_small.png" border="0" alt="(info)" /></a>
+
+Actual
+This should be an <a class="attachment" href="/attach/?page=Test/TestAtt.txt">attachment link</a><a href="/PageInfo.jsp?page=Test/TestAtt.txt"><img src="/None.jsp?page=images/attachment_small.png" border="0" alt="(info)" /></a>
+
+Solution: hacked WikiConext so that getUrl() special-cases the AttachActionBean and NoneActionBean output
+
+UndefinedPagesPluginTest.testSimpleUndefined
+
+Expected
+<a class="createpage" href="/Edit.jsp?page=Foobar%202" title="Create "Foobar 2"">Foobar 2</a><br />
+
+Actual
+<a class="createpage" href="/Edit.jsp?page=Foobar%202" title="Create "Foobar 2"">Foobar 2</a><br /><a class="createpage" href="/Edit.jsp?page=Page1000" title="Create "Page1000"">Page 1000</a><br /><a class="createpage" href="/Edit.jsp?page=Page1001" title="Create "Page1001"">Page 1001</a><br /><a class="createpage" href="/Edit.jsp?page=Page1002" title="Create "Page1002"">Page 1002</a><br /><a class="createpage" href="/Edit.jsp?page=Page1003" title="Create "Page1003"">Page 1003</a><br />
+
+Testing issues
+--------------
+Both tests needed to be changed because Stripes encodes in UTF-8.
+
+JSPWikiMarkupParserTest.testCCLinkWithScandics()
+ Old value of 'page': %C4itiSy%F6%D6ljy%E4
+ New value: %C3%84itiSy%C3%B6%C3%96ljy%C3%A4
+
+JSPWikiMarkupParserTest.testScandicPagename1()
+ Old value of 'page': %C5%E4Test
+ New value: %C3%85%C3%A4Test
+
+GroupsTest:
+Discovered Groups plugin has this line in it:
+
+String rewriteUrl = context.getContext().getResponse().encodeURL( url );
+
+...but the test ran without being in a MockServletContext. Thus, its parent WikiActionBeanContext had no associated response! Plugin test should *always* test inside a mock object.
+
+Also, in TestEngine I had to override all of the getHTML methods so that the manufactured WikiContext had properly injected requests and responses.
+
+GroupsPlugin right now does not generate Groups.jsp links, but Group.action links. Maybe it should generate .jsp links?
+
+
+JSP Tier changes
+----------------
+All of the non-top-level JSPs that shouldn't be directly instantiated are moved to /WEB-INF/jsp/layout.
+
+Some changes:
+JSPs don't need this any more: <fmt:setBundle basename="templates.default"/>
+...because we set a context parameter in web.xml.
+
+Scriptlet code in JSPs that needs to obtain a reference to the WikiEngine can simply use ${wikiEngine}.
+
+Good practice: whenever useActionBean is used in a JSP, author should always set the 'var' attribute so that downstream JSPs can use the variables.
+
+WikiInterceptor will attempt to set the current WikiActionBean and WikiPage into page scope. These are available as ${wikiPage}. It will also set ${wikiEngine} and ${wikiSession}. These are set in request scope.
+
+Migration: this means...
+<%
+ WikiContext c = WikiContext.findContext(pageContext);
+ WikiPage wikipage = c.getPage();
+%>
+...can simply be replaced by ${wikiPage}.
+
+
+
+BUG: LinkTag didn't always init its m_containedParameters map. (So, I fixed it...)
+
+2.6 commonheader.jsp
+ 'JsonUrl' : '<%= WikiContext.findContext(pageContext).getURL( WikiContext.NONE, "JSON-RPC" ) %>'
+3.0
+ 'JsonUrl' : 'JSON-RPC'
+
+JSP Locale Support
+Because Stripes automatically sets the locale, there is no need to use methods like this:
+LocaleSupport.getLocalizedMessage(pageContext, "attach.tab")
+
+Instead, you can simply use:
+<fmt:message key="attach.tab"/>
+
+
+Stripes layout system
+---------------------
+This is replaced:
+ <wiki:Content/>
+by
+
+
+Scriptlet code (e.g., PageTab.jsp)
+
+ WikiContext c = WikiContext.findContext( pageContext );
+
+Replaced by
+
+ WikiContext c = (WikiContext)WikiInterceptor.findActionBean();
+
+Wiki:Tab needs to be able to evaluate attribute contents... now it doesn't...
+
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE Tue Feb 12 22:37:23 2008
@@ -0,0 +1,504 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the library's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ <signature of Ty Coon>, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
+
+
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Apache
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Apache?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Apache (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.Apache Tue Feb 12 22:37:23 2008
@@ -0,0 +1,269 @@
+
+JSPWiki distribution contains the Apache XML-RPC library, which is
+distributed according to the Apache Software License. The license is
+included below for your enjoyment.
+
+--snip--
+
+/*
+ * The Apache Software License, Version 1.1
+ *
+ *
+ * Copyright (c) 2001 The Apache Software Foundation. All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ * if any, must include the following acknowledgment:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgment may appear in the software itself,
+ * if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "XML-RPC" and "Apache Software Foundation" must
+ * not be used to endorse or promote products derived from this
+ * software without prior written permission. For written
+ * permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache",
+ * nor may "Apache" appear in their name, without prior written
+ * permission of the Apache Software Foundation.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+JSPWiki distribution also contains the Google's Javascript code prettifier,
+which is distributed according to the Apache Software License. The license is
+included below for your enjoyment.
+See also http://google-code-prettify.googlecode.com/svn/trunk/README.html.
+
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.HttpUnit
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.HttpUnit?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.HttpUnit (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.HttpUnit Tue Feb 12 22:37:23 2008
@@ -0,0 +1,20 @@
+The following copyright and permission notice is included for httpunit:
+
+/*********************************************************************************************************************
+* Copyright (c) 2000-2002, Russell Gold
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+* documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+* to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions
+* of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+* THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+* DEALINGS IN THE SOFTWARE.
+*
+*******************************************************************************************************************/
Added: incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.JWebUnit
URL: http://svn.apache.org/viewvc/incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.JWebUnit?rev=627282&view=auto
==============================================================================
--- incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.JWebUnit (added)
+++ incubator/jspwiki/branches/JSPWIKI_STRIPES_BRANCH/doc/LICENSE.JWebUnit Tue Feb 12 22:37:23 2008
@@ -0,0 +1,38 @@
+The following copyright and permission notice applies to all aspects (source, tests, etc.) of jWebUnit:
+
+/********************************************************************************
+ * jWebUnit, simplified web testing API for HttpUnit
+ * Copyright (c) 2001, ThoughtWorks, Inc.
+ * 651 W Washington Ave. Suite 500
+ * Chicago, IL 60661 USA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * + Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * + Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following
+ * disclaimer in the documentation and/or other materials provided
+ * with the distribution.
+ *
+ * + Neither the name of ThoughtWorks, Inc., jWebUnit, nor the
+ * names of its contributors may be used to endorse or promote
+ * products derived from this software without specific prior
+ * written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ ********************************************************************************/