All Classes and Interfaces
Class
Description
Abstract, immutable Command implementation class.
Provides a simple directory based repository for Wiki pages.
A simple filter which filters only those filenames which correspond to the
file extension used.
Abstract JAAS
LoginModulethat implements
base functionality.This is a base class for all plugins using referral things.
Provides definitions for RPC handler routines.
Abstract superclass that provides a complete implementation of most Step methods; subclasses need only implement
AbstractStep.execute(Context) and
AbstractStep.getActor().Abstract UserDatabase class that provides convenience methods for finding profiles, building Principal collections and hashing passwords.
Deprecated.
Deprecated.
use
AclEntry insteadImplementation of a JSPWiki AclEntry.
JSPWiki implementation of an Access Control List.
Specifies how to parse and return ACLs from wiki pages.
Describes an administrative bean.
Just provides iteration support for AdminBeanIteratorTag
Provides an iterator for all AdminBeans of a given type.
Helpful utilities for the Ajax functions.
Placeholder class for all Commands.
Permission to perform all operations on a given wiki.
A collection of AllPermission objects.
Logs in a user based solely on IP address; no other authentication is
performed.
Handles incoming requests for the Atom API.
Provides an Atom 1.0 standard feed, with enclosures.
Describes an attachment.
Provides facilities for handling attachments.
This is the chief JSPWiki attachment management servlet.
Just provides the TEI data for AttachmentsIteratorTag.
Iterates through the list of attachments one has.
Manages authentication activities for a Engine: user login, logout, and credential refreshes.
Manages all access control and authorization; determines what authenticated users are allowed to do.
Interface for service providers of authorization information.
Callback for requesting and supplying an Authorizer required by a
LoginModule.
Writes the author name of the current page, including a link to that page, if that page exists.
Superclass for all JSPWiki managers for modules (plugins, etc.).
Writes the jspwiki baseURL.
Provides basic, versioning attachments.
Returns only those directories that contain attachments.
Accepts only files that are actual versions, no control files.
Interface for the search providers that handle searching the Wiki
Implement a "breadcrumb" (most recently visited) trail.
Extends the LinkedList class to provide a fixed-size queue implementation
Provides a handler for bug reports.
Provides a caching attachment provider.
Provides a caching page provider.
Provides a nice calendar.
A companion to CheckLogTag.
Checks whether the page is locked for editing.
Includes body, if the request context matches.
Does a version check on the page.
A simple renderer that just renders all the text() nodes from the DOM tree.
Resolves special pages, JSPs and Commands on behalf of a Engine.
Writes a comment link.
Returns the app name.
Default implementation for
ContentsSPIIs used as a "super include" tag, which can include the proper context
based on the wikicontext.
Default implementation for
ContextSPIA seriously better diff provider, which highlights changes word-by-word using CSS.
Logs in a user based on assertion of a name supplied in a cookie.
Logs in a user based on a cookie stored in the user's computer.
Sets or gets Cookie values.
An AdminBean which manages the JSPWiki core operations.
Provides a page-specific counter, it is reset every time a page is rendered, so it is not usable as a hitcounter.
Provides the Implementation for mixed mode creole: If you activate this filter, it will translate all markup that was saved as creole
markup to JSPWiki markup.
Implements DOM-to-Creole rendering.
Translates Creole markp to JSPWiki markup.
Outputs the hidden
CsrfProtectionFilter.ANTICSRF_PARAM.Just displays the current date and time.
Override added to ensure attribute values including ampersands and quotes still get escaped even if
disable-output-escaping processing instruction (meant to keep rest of HTML string as-is) set.
AbstractStep subclass that asks an actor Principal to choose an Outcome on behalf of an owner (also a Principal).
Keeps a queue of pending Decisions that need to be acted on by named Principals.
Exception thrown when an activity -- that would otherwise complete silently --
cannot complete because a workflow
Decision is required.Default implementation that parses Acls from wiki page markup.
Provides a manager class for all AdminBeans within JSPWiki.
Default implementation for
AttachmentManager.Default implementation for
AuthenticationManager
Default implementation for
AuthorizationManagerDefault implementation for
CommandResolverLoad, initialize and delegate to the DiffProvider that will actually do the work.
Defines an editor manager.
Manages the page filters.
Facade class for storing, retrieving and managing wiki groups on behalf of AuthorizationManager, JSPs and other presentation-layer
classes.
Manages all internationalization in JSPWiki.
Manages the WikiPages.
Provides page renaming functionality.
Manages plugin classes.
Contains information about a bunch of plugins.
Manages progressing items.
Keeps track of wikipage references:
What pages a given page refers to
What pages refer to a given page
This is a quick'n'dirty approach without any finesse in storage and searching algorithms; we trust java.util.*.
This class provides a facade towards the differing rendering routines.
Default implementation for
RSSGenerator.Manages searching the Wiki.
Default implementation for
TasksManager.This class takes care of managing JSPWiki templates.
Implements the default URL constructor using links directly to the JSP pages.
Default implementation for
UserManager.Implements the JSON API for usermanager.
Default implementation for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.
Manages variables.
Monitor class that tracks running Workflows.
Denounces a link by removing it from any search engine.
Load, initialize and delegate to the DiffProvider that will actually do the work.
Writes a diff link.
Provides an SPI for creating a diff between two page versions.
If there is no diff provider set, this provider will work instead.
This is a database that gets used if nothing else is available.
Exception indicating that an identical user already exists in the user database.
A DynamicAttachment is an attachment which does not really exist, but is created dynamically by a JSPWiki component.
Provides the data for an attachment.
Writes an edit link.
Describes an editor.
Just provides the TEI data for EditorIteratorTag.
Iterates through editors.
Defines an editor manager.
Creates an editor component with all the necessary parts
to get it working.
Default implementation for
EngineSPIRepresents an entry, that is, an unit of change, in a Feed.
This DiffProvider allows external command line tools to be used to generate the diff.
Represents a contextual artifact, which can be any serializable object, useful for making
a Decision.
If a provider implements this interface, then CachingProvider
will never attempt to search on its own; it will always pass any searches
through to the actual provider.
Represents an abstract feed.
Outputs links to all the site feeds and APIs this Wiki/blog supports.
Provides a simple directory based repository for Wiki pages.
Closes a WikiForm.
A FormHandler performs logic based on input from an HTTP FORM, transmitted through a JSPWiki WikiPlugin
(see Form.java).
Container for carrying HTTP FORM information between Plugin invocations in the Session.
Creates a simple input text field.
Opens a WikiForm.
Creates a Form select field.
FormSet is a companion WikiPlugin for Form.
Creates a Form text area element.
Provides a generic HTTP handler interface.
Groups are a specialized type of ad-hoc role used by the wiki system.
Defines Commands for viewing, editing and deleting wiki groups.
Defines an interface for loading, persisting and storing wiki groups.
Facade class for storing, retrieving and managing wiki groups on behalf of AuthorizationManager, JSPs and other presentation-layer
classes.
Permission to perform an operation on a group in a given wiki.
Immutable Principal that represents a Group.
Prints the groups managed by this wiki, separated by commas.
Includes body if page has attachments.
This class is used to store the headings in a manner which
allow the building of a Table Of Contents.
Provides a listener interface for headings.
Just provides the TEI data for HistoryIteratorTag.
Iterates through tags.
Callback for requesting and supplying a HttpServletRequest required by a
LoginModule.
If there have been no search results, then outputs the body text.
The IfPlugin allows parts of a WikiPage to be executed conditionally, and is intended as a flexible way
of customizing a page depending on certain conditions.
Provides an image plugin for better control than is possible with a simple image inclusion.
This tag is used to include any programmatic includes into the
output stream.
Includes an another JSP page, making sure that we actually pass the WikiContext correctly.
A Plugin that creates an index of pages according to a certain pattern.
Provides basic validation services for HTTP parameters.
Writes difference between two pages using a HTML table.
Inserts page contents.
Renders WikiPage content.
Manages JSPWiki installation on behalf of
admin/Install.jsp.This is a simple interface which is implemented by a number of JSPWiki
components to signal that they should not be included in things like
module listings and so on.
Denotes something really serious going on inside Wiki.
Manages all internationalization in JSPWiki.
Iterates through tags.
Implementation of GroupDatabase that persists
Group objects to a JDBC
DataSource, as might typically be provided by a web container.
Implementation of UserDatabase that persists
DefaultUserProfile
objects to a JDBC DataSource, as might typically be provided by a web
container.Parses JSPWiki-style markup into a WikiDocument DOM tree.
Just a simple class collecting all the links that come in.
Parses JSPWiki-style "augmented" link markup into a Link object
containing the link text, link reference, and any optional link
attributes (as JDOM Attributes).
Inner class serving as a struct containing the parsed
components of a link.
Link parsing operations.
Provides a generic link tag for all kinds of linking purposes.
Writes a link to a parent of a Wiki page.
Writes a link to a Wiki page.
This is a plugin for the administrator: It allows him to see in a single glance who is editing what.
Interface for the search providers that handle searching the Wiki
Provides an abstract class for the parser instances.
Returns or clears the current messages associated with the user's wiki
session.
Provides handlers for all RPC routines of the MetaWeblog API.
Writes the version number of the next version of the page.
Exception thrown when an attempt is made to find an Outcome that does not exist.
Includes the body in case there is no such page available.
Thrown in some error situations where a WikiPrincipal object does not exist.
Indicates that an non-existing version was specified.
Outputs an image with the supplied text as the title which is shown as a tooltip by
most browsers.
Resolution of a workflow Step, such as "approve," "deny," "hold," "task error," or other potential resolutions.
Defines Commands for editing, renaming, and viewing wiki pages.
Writes the modification date of the page, formatted
as specified in the attribute "format".
Fires WikiPageEvents for page events.
Includes the body in case the set page does exist.
Writes a link to the Wiki PageInfo.
Describes a lock acquired by an user on a page.
Returns the currently requested page name.
Permission to perform an operation on a single page or collection of pages in
a given wiki.
Provides page renaming functionality.
Returns the currently requested page or attachment size.
Wrapper class for managing and using the PageNameComparator.
Compares the lastModified date of its arguments.
Includes the body, if the current page is of proper type.
Writes the version of the current page.
This plugin counts the number of times a page has been viewed.
Parameters: count=yes|no show=none|count|list entries=maximum number of list entries to be returned min=minimum page count to be listed max=maximum page count to be listed sort=name|count Default values:
Parameters: count=yes|no show=none|count|list entries=maximum number of list entries to be returned min=minimum page count to be listed max=maximum page count to be listed sort=name|count Default values:
show=none sort=nameInterface to be implemented by any tag that wishes to contain
a wiki:param tag for passing dynamic name-value pairs.
ParamTag submits name-value pairs to the first enclosing
ParamHandler instance.
Returns the parent of the currently requested page.
This is an exception which gets thrown whenever the parser cannot parse the parsing things.
Provides a factory for Permission objects.
Tells whether the user in the current wiki context possesses a particular
permission.
A very dumb class that pings weblogs.com on each save.
This class is still experimental.
Stores the contents of a plugin in a WikiDocument DOM tree.
Inserts any Wiki plugin.
Represents an object which is used to store user preferences.
Is used to choose between the different date formats that JSPWiki supports.
Handles the page pre-save actions.
Outputs the version number of the previous version of this page.
Wrapper class for container-managed or externally-provided principals.
This class is an example of how to have a simple filter.
Provides access to an progress item.
Manages progressing items.
Deprecated.
- use
QueryItem insteadReturns the Recent Changes in the wiki being a date-sorted list of page names.
Defines Commands for redirections to off-site special pages.
Keeps track of wikipage references:
What pages a given page refers to
What pages refer to a given page
When a page is added or edited, its references are parsed, a Collection is received, and we crudely replace anything previous with
this new Collection.
Displays the pages referring to the current page.
Displays the pages referring to the current page.
Lists all pages containing links to Undefined Pages (pages containing dead links).
This class provides a facade towards the differing rendering routines.
If the provider detects that someone has modified the repository
externally, it should throw this exception.
Provides easy access to TemplateManager.addResourceRequest().
A lightweight, immutable Principal that represents a built-in wiki role such
as Anonymous, Asserted and Authenticated.
Provides handlers for all RPC routines.
Provides handlers for all RPC routines.
Handles all incoming servlet requests for XML-RPC calls.
Provides an implementation of an RSS 1.0 feed.
Represents an RSS 2.0 feed (with enclosures).
The master class for generating different kinds of Feeds (including RSS1.0, 2.0 and Atom).
Writes an image link to a JSPWiki RSS file.
Runs the RSS generation thread.
Handles the actual profile save action.
Handles the actual page save and post-save actions.
The "Search" plugin allows you to access the JSPWiki search routines and show the displays in an array on your page.
Manages searching the Wiki.
The SearchManagerBean is a simple AdminBean interface to the SearchManager.
SearchMatcher performs the task of matching a search query to a page's contents.
Interface for the search providers that handle searching the Wiki
Deprecated.
- use
SearchResult insteadSimple class that decides which search results are more important than others.
Just provides the TEI data for IteratorTag.
Iterates through Search result results.
Outputs the size of the search results list, if it contains any items.
Includes the body content, if there are any search results.
Helper class for verifying JSPWiki's security configuration.
Manages Sessions for different Engines.
Default implementation for
SessionSPIDisplays information about active wiki sessions.
Calculate pagination string.
Provides a way to do short URLs of the form /wiki/PageName.
A specific URL constructor that returns easy-to-grok URLs for VIEW and ATTACH contexts, but goes through JSP pages otherwise.
Provides an easy-to-use interface for JSPWiki AdminBeans, which also
are JMX MBeans.
Decision subclass that includes two available Outcomes:
Outcome.DECISION_APPROVE or Outcome.DECISION_DENY.A simple MBean which does not require an interface class unlike
the StandardMBean class.
Decision subclass used for notifications that includes only one available Outcome:
Outcome.DECISION_ACKNOWLEDGE.This is Herb, the JSPWiki spamfilter that can also do choke modifications.
Provides hidden input fields which are checked by the
SpamFilter.Defines an interface for transforming strings within a Wiki context.
System users associated with workflow Task steps.
Generates tabbed page section: container for the Tab tag.
Provides a table of contents.
Generates single tabbed page layout.
AbstractStep subclass that executes instructions, uninterrupted, and results in an Outcome.
Manager responsible of creation of the different JSPWiki
Steps.Returns the currently used template.
This class takes care of managing JSPWiki templates.
This is the JSPWiki 'traditional' diff.
Converts the body text into HTML content.
Simple utility that shows you a sorted list of property differences between
the 'default en' and a given i18n file.
Plugin that enumerates the pages in the wiki that have not yet been defined.
Represents a Principal, typically read from an ACL, that cannot
be resolved based on the current state of the user database, group
manager, and built-in role definitions.
Plugin for displaying pages that are not linked to in other pages.
Writes a link to the upload page.
Provides an interface through which JSPWiki constructs URLs.
Includes the content if an user check validates.
Defines an interface for loading, persisting and storing users.
Callback for requesting and supplying a wiki UserDatabase.
Logs in a user based on a username, password, and static password file
location.
Provides a facade for obtaining user information.
Returns the current user name, or empty, if the user has not been validated.
Class for representing wiki user information, such as the login name, full
name, wiki name, and e-mail address.
Returns user profile attributes, or empty strings if the user has not been
validated.
Stores the contents of a WikiVariable in a WikiDocument DOM tree.
Manages variables.
Returns the value of an Wiki variable.
Provides a simple directory based repository for Wiki pages.
This is a provider interface which providers can implement, if they
support fast checks of versions.
A watchdog needs something to watch.
WatchDog is a general system watchdog.
Extends the
Authorizer interface by including a delegate method for
HttpServletRequest.isUserInRole(String).Authorizes users by delegating role membership checks to the servlet container.
Handles logins made from within JSPWiki.
Logs in a user by extracting authentication data from an Http servlet
session.
Creates a list of all weblog entries on a monthly basis.
Builds a simple weblog.
Builds a simple weblog.
This provides a simple ajax servlet for handling /ajax/ requests.
An interface for a servlet that wants to use Ajax functionality.
Abstract Thread subclass that operates in the background; when it detects the
WikiEngineEvent.SHUTDOWN event,
it terminates itself.This is a class that provides the same services as the WikiTagBase, but this time it
works for the BodyTagSupport base class.
Handles logins made from inside the wiki application, rather than via the web container.
Defines Commands for wiki-wide operations such as creating groups, editing preferences and profiles, and logging in/out.
Provides state information throughout the processing of a page.
Stores the DOM tree of a rendered WikiPage.
Main implementation for
Engine.Callback for requesting and supplying the WikiEngine object required by a LoginModule.
This class is still experimental.
This filter goes through the generated page response prior and places requested resources at the appropriate inclusion markers.
Root class for different internal wiki links.
A WikiModule describes whatever JSPWiki plugin there is: it can be a plugin, an editor, a filter, etc.
Simple wrapper class for the Wiki page attributes.
Permission to perform an global wiki operation, such as self-registering
or creating new pages.
A lightweight, immutable Principal class.
Provides an interface to the basic rendering engine.
Servlet request wrapper that encapsulates an incoming HTTP request and overrides its security methods so that the request returns
JSPWiki-specific values.
Any wiki RPC handler should implement this so that they can be properly initialized and recognized by JSPWiki.
Indicates an authentication or authorization
error or exception.
This provides a master servlet for dealing with short urls.
Filter that verifies that the
Engine is running, and sets the authentication status for the user's
Session.Default implementation for
Session.Base class for JSPWiki tags.
Sequence of
Step objects linked together.Factory class that creates common Workflow instances such as a standard approval workflow.
Monitor class that tracks running Workflows.
Implements a WikiRenderer that outputs XHTML in a format that is suitable for use by a WYSIWYG XHTML editor.
Implements a WikiRenderer that outputs XHTML.
GroupDatabase implementation for loading, persisting and storing wiki groups,
using an XML file for persistence.
Manages
DefaultUserProfile objects using XML files for persistence.
Aclinstead