# All Classes

All Classes Interface Summary Class Summary Enum Summary Exception Summary
Acl: Defines an access control list (ACL) for wiki pages.
AclEntry: Represents one entry in an Access Control List (ACL).
AclsDSL
AclsSPI: SPI used to locate and provide `Acl` and `AclEntry` instances.
Attachment: Describes an attachment.
AttachmentProvider: Defines an attachment provider - a class which is capable of saving binary data as attachments.
BasePageFilter: Provides a base implementation of a PageFilter.
Command: Represents a logical "unit of work" that includes a request context, JSP, URLPattern, content template and (optionally) a target and required security permission.
ContentsDSL
ContentsSPI: SPI used to locate and provide `Page` and `Attachment` instances.
Context: Provides state information throughout the processing of a page.
ContextDSL
ContextEnum
ContextSPI: SPI used to locate and provide `Context` instances.
CustomWikiEventListener<T>
Engine: Provides Wiki services to the JSP page.
EngineDSL
EngineLifecycleExtension: SPI used to notify JSPWiki extensions about `Engine`'s initialization & shutdown, without having to deep dive on `Engine`'s internals.
EngineSPI: SPI used to locate and provide `Engine` instances.
FilterException: A generic PageFilter exception.
Initializable: Marker interface for Engine's components that can be initialized.
InitializablePlugin: If a plugin defines this interface, it is called exactly once prior to the actual execute() routine.
NoRequiredPropertyException: Marks an erroneous jspwiki.properties file.
NoSuchVariableException: Marks that no such variable was located.
Page
PageFilter: Provides a definition for a page filter.
PageProvider: Each Wiki page provider should implement this interface.
ParserStagePlugin: Implements a Plugin interface for the parser stage.
Plugin: Defines an interface for plugins.
PluginElement: Exposes the contents of a plugin in a WikiDocument DOM tree.
PluginException: Provides a generic PluginException.
ProviderException: This exception represents the superclass of all exceptions that providers may throw.
QueryItem: This simple class just fulfils the role of a container for searches.
RedirectException: This exception may be thrown if a filter wants to reject something and redirect the user elsewhere.
Release: Contains release and version information.
RenderApi: Rendering routines that all JSPWiki public API implementations should provide.
SearchResult: Defines a search result.
Session: Represents a long-running wiki session, with an associated user Principal, user Subject, and authentication status.
SessionDSL: SPI used to locate and provide `Session` instances.
SessionSPI: SPI used to locate and provide `Session` instances.
Wiki
WikiException: A generic Wiki exception.
WikiI18nException: A generic Wiki exception, meant to carry key & args to construct i18n messages to show meaningful messages to end-user.
WikiProvider: A generic Wiki provider for all sorts of things that the Wiki can store.