| Package Name | Comment |
| org.incava.util.diff | |
| org.jamwiki |
The org.jamwiki package contains the core interfaces and classes needed for JAMWiki to function. In particular, the WikiBase class is a singleton class that is instantiated at wiki startup to hold core data structures used in interacting with the database and performing searches.
|
| org.jamwiki.authentication |
Provides classes that implement and extend Acegi Security System functionality to provide support for authentication and access control in JAMWiki. By default JAMWiki will use the Acegi configuration file /WEB-INF/applicationContext-acegi-security.xml, but that can be changed by modifying the contextConfigLocation parameter in the /WEB-INF/web.xml file.
Note that while some JAMWiki classes extend the base Acegi classes, it is generally preferable to use the Acegi classes when available, and future JAMWiki releases will eliminate custom code and move towards standard usage of Acegi.
|
| org.jamwiki.db |
Provides classes needed for all database interaction. This class contains an implementation of the {@link org.jamwiki.DataHandler} for storing and retrieving Wiki data from the database. Note that database-specific SQL is stored in properties file which include /WEB-INF/classes/sql.ansi.properties, and these SQL files are loaded by a database-specific implementation of the {@link org.jamwiki.db.QueryHandler} interface.
|
| org.jamwiki.ldap |
Provides classes used for integrating with LDAP. This class contains an implementation of the {@link org.jamwiki.UserHandler} interface that is suitable for integrating with LDAP.
|
| org.jamwiki.mail |
Provides classes to implement email support. These classes are currently unused.
|
| org.jamwiki.model |
Provides basic objects for use on the Wiki, including WikiUser, Topic, TopicVersion, etc.
|
| org.jamwiki.parser |
The org.jamwiki.parser package contains the interfaces, abstract classes, and utility classes needed to implement a parser for JAMWiki. Custom parsers can be easily created by extending the {@link org.jamwiki.parser.AbstractParser} class. In addition, to make JAMWiki aware of any new parsers an entry for the parser must be added to the parsers section of the /WEB-INF/classes/jamwiki-configuration.xml file.
|
| org.jamwiki.parser.bliki |
Provides an alternative parser for JAMWiki, developed for the Bliki BlogWiki.
|
| org.jamwiki.parser.jflex |
The org.jamwiki.parsers.jflex package contains the default JAMWiki parser and supporting classes, implementing the Mediawiki Wiki syntax. The {@link JAMWikiPostProcessor}, {@link JAMWikiPreProcessor}, {@link JAMWikiProcessor} and {@link JAMWikiSpliceProcessor} parser files are all automatically generated using the JFlex Parser lexer engine.
|
| org.jamwiki.search |
Provides a framework for implementing JAMWiki search. An implementation using the Lucene search engine is currently the default (and only) JAMWiki search engine.
|
| org.jamwiki.servlets |
Provides classes that work with the Spring Framework to process HTTP requests and to then redirect appropriately. To create a new Wiki page the following steps should be followed:
- Modify the
/WEB-INF/jamwiki-servlet.xml file to add a mapping and a servlet handler.
- The mapping is the URL pattern. For example
<prop key="/**/Special:MyPage">MyHandler</prop>.
- The handler links the mapping with a servlet. For example:
<bean id="MyHandler" class="org.jamwiki.servlets.MyServlet" />.
- Make sure JAMWiki recognizes the page as an existing special page by adding a pseudotopic entry to
/WEB-INF/classes/jamwiki-configuration.xml.
- Create the servlet specified in the
jamwiki-servlet.xml file (org.jamwiki.servlets.MyServlet). The servlet should extend {@link org.jamwiki.servlets.JAMWikiServlet}.
- Create a JSP for the page display. Within your servlet the {@link org.jamwiki.servlets.WikiPageInfo#setContentJsp} method should be called to link the new JSP page with your servlet.
|
| org.jamwiki.taglib |
A collection of JSP tags offering JAMWiki-specific functionality.
|
| org.jamwiki.utils |
Provides various general utility classes including encryption, caching, and logging.
|