| 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.
|
| Java Source File Name | Type | Comment |
| AdminServlet.java | Class | Used to provide administrative functions including changing Wiki
configuration settings and refreshing internal Wiki objects. |
| CategoryServlet.java | Class | Used for display a list of all categories that are currently in use for a
virtual wiki. |
| ContributionsServlet.java | Class | Used to generate a list of all edits made by a user. |
| DiffServlet.java | Class | Used to display a diff between two versions of a topic. |
| EditServlet.java | Class | Used to process topic edits including saving an edit, preview, resolving
conflicts and dealing with spam. |
| ExportServlet.java | Class | This servlet is not currently functional, but is meant to provide
capability for exporting topic information in XML format. |
| HistoryServlet.java | Class | Used to display the edit history information for a topic. |
| ImportServlet.java | Class | Used to import an XML file (in MediaWiki format), creating or updating a
topic as a result. |
| ImportTiddlyWikiServlet.java | Class | Used to import an HTML file (in TiddlyWiki format), creating or updating a
topic as a result. |
| ItemsServlet.java | Class | Used to build Special: pages that display lists of topics on the Wiki, such
as when displaying lists of all existing images or topics. |
| JAMWikiFilter.java | Class | Perform filtering of all Wiki page requests, including setting the
character encoding to UTF-8 and verifying that no setup or upgrade is
required. |
| JAMWikiListener.java | Class | A ServletContextListener that will do necessary initialization
& cleanup when the Servlet Context is initialized & destroyed. |
| JAMWikiLocaleInterceptor.java | Class | This method extends the Spring LocaleChangeInterceptor to
search for and use a locale key in either the session or the request if one
can be found. |
| JAMWikiServlet.java | Class | Provides the infrastructure that is common to all JAMWiki servlets. |
| LinkToServlet.java | Class | Used to display all topics that contain links to the current topic. |
| LoginServlet.java | Class | Used to handle requests or redirects to the login page. |
| ManageServlet.java | Class | Used to provide capability for deleting, undeleting, and protecting topics. |
| MoveServlet.java | Class | Used to handle moving a topic to a new name. |
| PrintableServlet.java | Class | Used to display a print-friendly version of a topic. |
| RecentChangesFeedServlet.java | Class | Provides an RSS or Atom feed for recent changes. |
| RecentChangesServlet.java | Class | Used to display a summary of edits made, ordered chronologically. |
| RegisterServlet.java | Class | Used to process new user account setup. |
| RolesServlet.java | Class | |
| SearchServlet.java | Class | Used to display search results. |
| ServletUtil.java | Class | Utility methods useful when processing JAMWiki servlet requests. |
| ServletUtilTest.java | Class | |
| SetupServlet.java | Class | Used to handle JAMWiki setup, including setting and validating JAMWiki
configuration values. |
| SpecialPagesServlet.java | Class | Used to generate an index of all Special: pages on the wiki. |
| StylesheetServlet.java | Class | Used to generate the jamwiki.css stylesheet. |
| TopicServlet.java | Class | Used to display a JAMWiki topic. |
| TranslationServlet.java | Class | Used to provide admins with the ability to create and edit JAMWiki message
keys. |
| UpgradeServlet.java | Class | Used to automatically handle JAMWiki upgrades, including configuration and
data modifications. |
| UploadServlet.java | Class | Used to handle file uploads. |
| WatchlistServlet.java | Class | Used to handle updating and viewing a user's watchlist. |
| WikiPageInfo.java | Class | The WikiPageInfo class provides an object containing common
data used for generating wiki page display. |
| WikiPageInfoTest.java | Class | |
| XMLTopicFactory.java | Class | The purpose of this class is to load MediaWiki XML-file to the JAMWiki. |
| XMLTopicFactoryTest.java | Class | |