JSPWiki

Package Specification

Related Documentation

Attachment management, uploading and downloading.

Package Specification

This package manages the JSPWiki attachment subsystem. It consists of three basic components:

• AttachmentServlet - the servlet which allows both uploading and downloading servlets.
• AttachmentManager - The JSPWiki Manager component which manages the storage of attachments.
• Attachment - A special kind of a {@link com.ecyrd.jspwiki.WikiPage} which stores a handle to the attachment data.

Attachments can either be static (i.e. real data, stored somewhere on a filesystem), or dynamic, which means that they're generated on the fly by a {@link com.ecyrd.jspwiki.attachment.DynamicAttachmentProvider}.

Related Documentation

Package Specification

Related Documentation

Package Specification

Related Documentation

Package Specification

This package contains utility classes for using the JSON-RPC AJAX library. The JSON-RPC library is available from http://oss.metaparadigm.com/jsonrpc/.

Related Documentation

Package specification

This package contains a diverse set of JSP tags which are used in the template pages.

Managing tag pooling

A typical problem for many tag developers is that many web containers pool tags, i.e. the tag is not released after doEndTag(), but put into a pool, from which it can be invoked again. This is highly efficient, as you don't need to instantiate the tag again.

The problem, however, is that when your tag is put back into the pool, it still retains all the internal references, i.e. none of the member fields are cleared. This means there can be dangling references to things which will take a lot of memory. In JSPWiki's case, the WikiContext is a good example: it can actually contain quite a lot of stuff accumulated during it's life time, and therefore it's important for memory use that all references are cleared.

Unfortunately, the "easy" solution of implementing your custom release handler in Tag.release() does not help, since it is called only when the tag is truly and completely released from the pool. So, as long as the tag sits in the pool, release() is not called, and your references keep on dangling like wet spaghetti off the balcony.

Neither can you trust e.g. doEndTag() being called every time, since e.g. if there is an exception, doEndTag() is never called.

The correct way to do reference cleaning is to implement the {@link javax.servlet.jsp.tagext.TryCatchFinally} interface, where the doFinally() method is called every time the tag has been finished with and prior to it being put back into the pool. Most JSPWiki base tag classes {@link com.ecyrd.jspwiki.tags.IteratorTag} and {@link com.ecyrd.jspwiki.tags.WikiTagBase} implement the TryCatchFinally interface, which means that any class subclassed from them also allows has those methods.

Check out the javadocs for the tags for more info!

Related documentation

Package specification

The classes which are not directly related to the JSP tags, yet do control some aspect of the web interface, have been collected here.

Related documentation

Package specification

Since JSPWiki 2.6, a new administration interface has been added under /admin/Admin.jsp. This interface is based on AdminBeans, a particular kind of bean which is used by JSPWiki to generate a HTML interface.

The AdminBeans can also be JMX beans, which means that it is possible to control them from a regular management application. However, instead of just using a constructed HTML user interface, the AdminBeans may have full control over the HTML they emit.

Related documentation

Package Specification

The ProgressManager is a JSPWiki manager which holds items that can track progress of some other program.

Related Documentation

Provides the URL generation routines.

Package Specification

JSPWiki generates URLs using the URLConstructor classes in this interface. It's possible to create your own URLs simply by installing your own URLConstructor.

Related Documentation

Package Specification

Related Documentation