# Index

A B C D E F G H I L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

acl() - Method in class org.apache.wiki.api.spi.AclsDSL
  Creates a new `Acl` instance.
acl() - Method in interface org.apache.wiki.api.spi.AclsSPI
  Creates a new `Acl` instance.
Acl - Interface in org.apache.wiki.api.core
  Defines an access control list (ACL) for wiki pages.
aclEntries() - Method in interface org.apache.wiki.api.core.Acl
  Returns an enumeration of the entries in this ACL.
AclEntry - Interface in org.apache.wiki.api.core
  Represents one entry in an Access Control List (ACL).
acls() - Static method in class org.apache.wiki.api.spi.Wiki
  Access to `AclsSPI` operations.
AclsDSL - Class in org.apache.wiki.api.spi
AclsSPI - Interface in org.apache.wiki.api.spi
  SPI used to locate and provide `Acl` and `AclEntry` instances.
adapt(Class<E>) - Method in interface org.apache.wiki.api.core.Engine
  Adapt Engine to a concrete type.
addEntry(AclEntry) - Method in interface org.apache.wiki.api.core.Acl
  Adds an ACL entry to this ACL.
addMessage(String) - Method in interface org.apache.wiki.api.core.Session
  Adds a message to the generic list of messages associated with the session.
addMessage(String, String) - Method in interface org.apache.wiki.api.core.Session
  Adds a message to the specific set of messages associated with the session.
addPermission(Permission) - Method in interface org.apache.wiki.api.core.AclEntry
  Adds the specified permission to this ACL entry.
addWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.api.core.Engine
  Registers a WikiEventListener with this instance.
ALIAS - Static variable in interface org.apache.wiki.api.core.Page
  A special variable name for storing a page alias.
ANONYMOUS - Static variable in interface org.apache.wiki.api.core.Session
  An anonymous user's session status.
antiCsrfToken() - Method in interface org.apache.wiki.api.core.Session
  Returns the CSRF protection Token associated with this wiki session.
APPNAME - Static variable in class org.apache.wiki.api.Release
  This is the default application name.
args - Variable in exception org.apache.wiki.api.exceptions.WikiI18nException
  arguments needed to construct the i18n message associated with the exception.
ASSERTED - Static variable in interface org.apache.wiki.api.core.Session
  An asserted user's session status.
attachment(Engine, String, String) - Method in class org.apache.wiki.api.spi.ContentsDSL
  Creates a new `Attachment`.
attachment(Engine, String, String) - Method in interface org.apache.wiki.api.spi.ContentsSPI
  Creates a new `Attachment`.
Attachment - Interface in org.apache.wiki.api.core
  Describes an attachment.
AttachmentProvider - Interface in org.apache.wiki.api.providers
  Defines an attachment provider - a class which is capable of saving binary data as attachments.
ATTR_CONTEXT - Static variable in interface org.apache.wiki.api.core.Context
AUTHENTICATED - Static variable in interface org.apache.wiki.api.core.Session
  An authenticated user's session status.
AUTHOR - Static variable in interface org.apache.wiki.api.core.Page
  A special variable name for storing the author.

## B

BasePageFilter - Class in org.apache.wiki.api.filters
  Provides a base implementation of a PageFilter.
BasePageFilter() - Constructor for class org.apache.wiki.api.filters.BasePageFilter
BUILD - Static variable in class org.apache.wiki.api.Release
  The build number/identifier.

## C

CHANGENOTE - Static variable in interface org.apache.wiki.api.core.Page
  A special variable name for storing a changenote.
checkPermission(Permission) - Method in interface org.apache.wiki.api.core.AclEntry
  Checks if the specified permission is part of the permission set in this entry.
clearMessages() - Method in interface org.apache.wiki.api.core.Session
  Clears all messages associated with this session.
clearMessages(String) - Method in interface org.apache.wiki.api.core.Session
  Clears all messages associated with a session topic.
client() - Method in interface org.apache.wiki.api.events.CustomWikiEventListener
  Returns the object of the events' source.
clone() - Method in interface org.apache.wiki.api.core.Context
clone() - Method in interface org.apache.wiki.api.core.Page
Command - Interface in org.apache.wiki.api.core
  Represents a logical "unit of work" that includes a request context, JSP, URLPattern, content template and (optionally) a target and required security permission.
contents() - Static method in class org.apache.wiki.api.spi.Wiki
  Access to `ContentsSPI` operations.
ContentsDSL - Class in org.apache.wiki.api.spi
ContentsSPI - Interface in org.apache.wiki.api.spi
  SPI used to locate and provide `Page` and `Attachment` instances.
context() - Static method in class org.apache.wiki.api.spi.Wiki
  Access to `ContextSPI` operations.
Context - Interface in org.apache.wiki.api.core
  Provides state information throughout the processing of a page.
ContextDSL - Class in org.apache.wiki.api.spi
ContextEnum - Enum Class in org.apache.wiki.api.core
ContextSPI - Interface in org.apache.wiki.api.spi
  SPI used to locate and provide `Context` instances.
CORE_PLUGINS_RESOURCEBUNDLE - Static variable in interface org.apache.wiki.api.plugin.Plugin
  Name of the default plugin resource bundle.
create(Engine, HttpServletRequest, String) - Method in class org.apache.wiki.api.spi.ContextDSL
  Creates a new Context from a supplied HTTP request, using a default wiki context.
create(Engine, HttpServletRequest, String) - Method in interface org.apache.wiki.api.spi.ContextSPI
  Creates a new Context from a supplied HTTP request, using a default wiki context.
create(Engine, HttpServletRequest, Command) - Method in class org.apache.wiki.api.spi.ContextDSL
  Creates a new Context for the given Engine, Command and HttpServletRequest.
create(Engine, HttpServletRequest, Command) - Method in interface org.apache.wiki.api.spi.ContextSPI
  Creates a new Context for the given Engine, Command and HttpServletRequest.
create(Engine, HttpServletRequest, Page) - Method in class org.apache.wiki.api.spi.ContextDSL
  Creates a new Context for the given Engine, Page and HttpServletRequest.
create(Engine, HttpServletRequest, Page) - Method in interface org.apache.wiki.api.spi.ContextSPI
  Creates a new Context for the given Engine, Page and HttpServletRequest.
create(Engine, Page) - Method in class org.apache.wiki.api.spi.ContextDSL
  Create a new Context for the given Page.
create(Engine, Page) - Method in interface org.apache.wiki.api.spi.ContextSPI
  Create a new Context for the given Page.
CustomWikiEventListener<T> - Interface in org.apache.wiki.api.events

## D

decodeName(String) - Method in interface org.apache.wiki.api.core.Engine
  Decodes a URL-encoded request back to regular life.
deepClone() - Method in interface org.apache.wiki.api.core.Context
  Creates a deep clone of the Context.
DEFAULT_INLINEPATTERN - Static variable in interface org.apache.wiki.api.core.Engine
  The default inlining pattern.
DEFAULT_TEMPLATE_NAME - Static variable in interface org.apache.wiki.api.core.Engine
  The name used for the default template.
deleteAttachment(Attachment) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Removes an entire page from the repository.
deletePage(String) - Method in interface org.apache.wiki.api.providers.PageProvider
  Removes an entire page from the repository.
deleteVersion(String, int) - Method in interface org.apache.wiki.api.providers.PageProvider
  Removes a specific version from the repository.
deleteVersion(Attachment) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Removes a specific version from the repository.
DESCRIPTION - Static variable in interface org.apache.wiki.api.core.Page
  "Summary" is a short summary of the page.
destroy(Engine) - Method in interface org.apache.wiki.api.filters.PageFilter
  Called for every filter, e.g. on wiki engine shutdown.
doPrivileged(Session, PrivilegedAction<?>) - Static method in interface org.apache.wiki.api.core.Session
  Wrapper for `Subject.doAsPrivileged(Subject, PrivilegedAction, java.security.AccessControlContext)` that executes an action with the privileges possessed by a Session's Subject.

## E

encodeName(String) - Method in interface org.apache.wiki.api.core.Engine
  Turns a WikiName into something that can be called through using an URL.
engine() - Static method in class org.apache.wiki.api.spi.Wiki
  Access to `EngineSPI` operations.
Engine - Interface in org.apache.wiki.api.core
  Provides Wiki services to the JSP page.
EngineDSL - Class in org.apache.wiki.api.spi
EngineLifecycleExtension - Interface in org.apache.wiki.api.engine
  SPI used to notify JSPWiki extensions about `Engine`'s initialization & shutdown, without having to deep dive on `Engine`'s internals.
EngineSPI - Interface in org.apache.wiki.api.spi
  SPI used to locate and provide `Engine` instances.
entry() - Method in class org.apache.wiki.api.spi.AclsDSL
  Creates a new `AclEntry` instance.
entry() - Method in interface org.apache.wiki.api.spi.AclsSPI
  Creates a new `AclEntry` instance.
execute(Context, Map<String, String>) - Method in interface org.apache.wiki.api.plugin.Plugin
  This is the main entry point for any plugin.
executeParse(Context) - Method in interface org.apache.wiki.api.plugin.PluginElement
  Executes the executeParse() method.
executeParser(PluginElement, Context, Map<String, String>) - Method in interface org.apache.wiki.api.plugin.ParserStagePlugin
  Method which is executed during parsing.

## F

FilterException - Exception in org.apache.wiki.api.exceptions
  A generic PageFilter exception.
FilterException(String) - Constructor for exception org.apache.wiki.api.exceptions.FilterException
  Constructs an exception.
find(ServletConfig) - Method in class org.apache.wiki.api.spi.EngineDSL
  Locate, or build if necessary, a configured `Engine` instance.
find(ServletConfig, Properties) - Method in class org.apache.wiki.api.spi.EngineDSL
  Locate, or build if necessary, a configured `Engine` instance.
find(ServletContext, Properties) - Method in class org.apache.wiki.api.spi.EngineDSL
  Locate, or build if necessary, a configured `Engine` instance.
find(ServletContext, Properties) - Method in interface org.apache.wiki.api.spi.EngineSPI
  Locate, or build if necessary, a configured `Engine` instance.
find(Engine, HttpServletRequest) - Method in class org.apache.wiki.api.spi.SessionDSL
  Returns the Session object associated with the current HTTP request.
find(Engine, HttpServletRequest) - Method in interface org.apache.wiki.api.spi.SessionSPI
  Returns the Session object associated with the current HTTP request.
findAttachments(QueryItem[]) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Finds attachments based on the query.
findConfigFile(String) - Method in interface org.apache.wiki.api.core.Engine
  Looks up and obtains a configuration file inside the WEB-INF folder of a wiki webapp.
findContext(PageContext) - Static method in interface org.apache.wiki.api.core.Context
  This method can be used to find the WikiContext programmatically from a JSP PageContext.
findPages(QueryItem[]) - Method in interface org.apache.wiki.api.providers.PageProvider
  Finds pages based on the query.
findPrincipals(Permission) - Method in interface org.apache.wiki.api.core.Acl
  Returns all Principal objects assigned a given Permission in the access control list.
FORBIDDEN - Static variable in class org.apache.wiki.api.search.QueryItem
  The word may NOT be in the pages

## G

getAcl() - Method in interface org.apache.wiki.api.core.Page
  Returns the Acl for this page.
getAclEntry(Principal) - Method in interface org.apache.wiki.api.core.Acl
  Returns an AclEntry for a supplied Principal, or `null` if the Principal does not have a matching AclEntry.
getAllChangedSince(Date) - Method in interface org.apache.wiki.api.providers.PageProvider
  Gets a list of recent changes.
getAllInlinedImagePatterns() - Method in interface org.apache.wiki.api.core.Engine
  Returns a collection of all image types that get inlined.
getAllInterWikiLinks() - Method in interface org.apache.wiki.api.core.Engine
  Returns a collection of all supported InterWiki links.
getAllPages() - Method in interface org.apache.wiki.api.providers.PageProvider
  Returns all pages.
getApplicationName() - Method in interface org.apache.wiki.api.core.Engine
  Returns the name of the application.
getArgs() - Method in exception org.apache.wiki.api.exceptions.WikiI18nException
  getter.
getAttachmentData(Attachment) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Get attachment data.
getAttachmentInfo(Page, String, int) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Returns info about an attachment.
getAttribute(String) - Method in interface org.apache.wiki.api.core.Engine
  Gets an attribute from the engine.
getAttribute(String) - Method in interface org.apache.wiki.api.core.Page
  A WikiPage may have a number of attributes, which might or might not be available.
getAttributes() - Method in interface org.apache.wiki.api.core.Page
  Returns the full attributes Map, in case external code needs to iterate through the attributes.
getAuthor() - Method in interface org.apache.wiki.api.core.Page
  Returns author name, or null, if no author has been defined.
getBaseURL() - Method in interface org.apache.wiki.api.core.Engine
  Returns the base URL, telling where this Wiki actually lives.
getBooleanWikiProperty(String, boolean) - Method in interface org.apache.wiki.api.core.Context
  This is just a simple helper method which will first check the context if there is already an override in place, and if there is not, it will then check the given properties.
getCommand() - Method in interface org.apache.wiki.api.core.Context
  Returns the Command associated with this Context.
getContentEncoding() - Method in interface org.apache.wiki.api.core.Engine
  Returns the IANA name of the character set encoding we're supposed to be using right now.
getContentTemplate() - Method in interface org.apache.wiki.api.core.Command
  Returns the content template associated with a Command, such as `PreferencesContent.jsp`.
getContentTemplate() - Method in enum class org.apache.wiki.api.core.ContextEnum
getContexts() - Method in interface org.apache.wiki.api.search.SearchResult
  Collection of XHTML fragments representing some contexts in which the match was made (a.k.a., "snippets").
getCurrentUser() - Method in interface org.apache.wiki.api.core.Context
  Convenience method that gets the current user.
getDisplayName(Locale) - Method in interface org.apache.wiki.api.plugin.Plugin
  Provides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom plugin
getEngine() - Method in interface org.apache.wiki.api.core.Context
  Returns the handling engine.
getFileName() - Method in interface org.apache.wiki.api.core.Attachment
  Returns the file name of the attachment.
getFinalPageName(String) - Method in interface org.apache.wiki.api.core.Engine
  Returns the correct page name, or null, if no such page can be found.
getFrontPage() - Method in interface org.apache.wiki.api.core.Engine
  Returns the default front page, if no page is used.
getGlobalRSSURL() - Method in interface org.apache.wiki.api.core.Engine
  Returns the URL of the global RSS file.
getHttpParameter(String) - Method in interface org.apache.wiki.api.core.Context
  This method will safely return any HTTP parameters that might have been defined.
getHttpRequest() - Method in interface org.apache.wiki.api.core.Context
  If the request did originate from an HTTP request, then the HTTP request can be fetched here.
getInterWikiURL(String) - Method in interface org.apache.wiki.api.core.Engine
  Returns an URL to some other Wiki that we know.
getJSP() - Method in interface org.apache.wiki.api.core.Command
  Returns the JSP associated with the Command.
getLastModified() - Method in interface org.apache.wiki.api.core.Page
  Returns the date when this page was last modified.
getLocale() - Method in interface org.apache.wiki.api.core.Session
  Returns a cached Locale object for this user.
getLoginPrincipal() - Method in interface org.apache.wiki.api.core.Session
  Returns the Principal used to log in to an authenticated session.
getManager(Class<T>) - Method in interface org.apache.wiki.api.core.Engine
  Retrieves the object instantiated by the Engine matching the requested type.
getManagers(Class<T>) - Method in interface org.apache.wiki.api.core.Engine
  Retrieves the objects instantiated by the Engine that can be assigned to the requested type.
getMessages() - Method in interface org.apache.wiki.api.core.Session
  Returns all generic messages associated with this session.
getMessages(String) - Method in interface org.apache.wiki.api.core.Session
  Returns all messages associated with a session topic.
getName() - Method in interface org.apache.wiki.api.core.Command
  Returns the human-friendly name for this command.
getName() - Method in interface org.apache.wiki.api.core.Page
  Returns the name of the page.
getPage() - Method in interface org.apache.wiki.api.core.Context
  Returns the WikiPage that is being handled.
getPage() - Method in interface org.apache.wiki.api.search.SearchResult
  Return the page.
getPageCount() - Method in interface org.apache.wiki.api.providers.PageProvider
  Gets the number of pages.
getPageInfo(String, int) - Method in interface org.apache.wiki.api.providers.PageProvider
  Returns info about the page.
getPageText(String, int) - Method in interface org.apache.wiki.api.providers.PageProvider
  Gets a specific version out of the repository.
getParameter(String) - Method in interface org.apache.wiki.api.plugin.PluginElement
  Returns a parameter value from the parameter map.
getParameters() - Method in interface org.apache.wiki.api.plugin.PluginElement
  Returns the parameter map given in the constructor.
getParentName() - Method in interface org.apache.wiki.api.core.Attachment
  Returns the name of the parent of this Attachment, i.e. the page which contains this attachment.
getPluginName() - Method in interface org.apache.wiki.api.plugin.PluginElement
  Returns the name of the plugin invoked by the DOM element.
getPluginSearchPath() - Method in interface org.apache.wiki.api.core.Engine
  Returns plugins' search path.
getPrincipal() - Method in interface org.apache.wiki.api.core.AclEntry
  Returns the principal for which permissions are granted by this ACL entry.
getPrincipals() - Method in interface org.apache.wiki.api.core.Session
  Returns all user Principals associated with this session.
getProviderInfo() - Method in interface org.apache.wiki.api.providers.WikiProvider
  Return a valid HTML string for information.
getRealPage() - Method in interface org.apache.wiki.api.core.Context
  Gets a reference to the real WikiPage whose content is currently being rendered.
getRedirect() - Method in exception org.apache.wiki.api.exceptions.RedirectException
  Get the URI for redirection.
getRedirectURL() - Method in interface org.apache.wiki.api.core.Context
  Figure out to which WikiPage we are really going to.
getRemoteAddress() - Method in interface org.apache.wiki.api.core.Session
  returns the remote address of the user login session, usually an ip address
getRequestContext() - Method in interface org.apache.wiki.api.core.Command
  Returns the name of the request context (e.g.
getRequestContext() - Method in enum class org.apache.wiki.api.core.ContextEnum
getRoles() - Method in interface org.apache.wiki.api.core.Session
  Returns an array of Principal objects that represents the groups and roles that the user associated with a Session possesses.
getRootPath() - Method in interface org.apache.wiki.api.core.Engine
  Returns the root path.
getRootThrowable() - Method in exception org.apache.wiki.api.exceptions.PluginException
  Return the original exception.
getScore() - Method in interface org.apache.wiki.api.search.SearchResult
  Returns the score.
getServletContext() - Method in interface org.apache.wiki.api.core.Engine
  Returns the ServletContext that this particular Engine was initialized with.
getSize() - Method in interface org.apache.wiki.api.core.Page
  Returns the size of the page.
getSnipExample() - Method in interface org.apache.wiki.api.plugin.Plugin
  Provides the ability for a plugin to provide a suggestion or template for execution within a wiki page.
getSpecialPageReference(String) - Method in interface org.apache.wiki.api.core.Engine
  If the page is a special page, then returns a direct URL to that page.
getStartTime() - Method in interface org.apache.wiki.api.core.Engine
  Returns the moment when this engine was started.
getStatus() - Method in interface org.apache.wiki.api.core.Session
  Returns the status of the wiki session as a text string.
getSubject() - Method in interface org.apache.wiki.api.core.Session
  Returns the `Subject` associated to the session.
getTarget() - Method in interface org.apache.wiki.api.core.Command
  Returns the target associated with a Command, if it was created with one.
getTemplate() - Method in interface org.apache.wiki.api.core.Context
  Gets the template that is to be used throughout this request.
getTemplateDir() - Method in interface org.apache.wiki.api.core.Engine
  Returns the current template directory.
getText() - Method in interface org.apache.wiki.api.plugin.PluginElement
  The main invocation for the plugin.
getURL(String, String) - Method in interface org.apache.wiki.api.core.Context
  Creates a URL for the given request context.
getURL(String, String, String) - Method in interface org.apache.wiki.api.core.Context
  Returns a URL from a page.
getURL(String, String, String) - Method in interface org.apache.wiki.api.core.Engine
  Returns an URL if a WikiContext is not available.
getUrlPattern() - Method in enum class org.apache.wiki.api.core.ContextEnum
getURLPattern() - Method in interface org.apache.wiki.api.core.Command
  Returns the URL pattern associated with this Command.
getUserPrincipal() - Method in interface org.apache.wiki.api.core.Session
  Returns the primary user Principal associated with this session.
getValue() - Method in interface org.apache.wiki.api.plugin.PluginElement
  Returns the rendered plugin.
getVariable(String) - Method in interface org.apache.wiki.api.core.Context
  Gets a previously set variable.
getVersion() - Method in interface org.apache.wiki.api.core.Page
  Returns the version that this WikiPage instance represents.
getVersionHistory(String) - Method in interface org.apache.wiki.api.providers.PageProvider
  Returns version history.
getVersionHistory(Attachment) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Returns version history.
getVersionString() - Static method in class org.apache.wiki.api.Release
  This method is useful for templates, because hopefully it will not be inlined, and thus any change to version number does not need recompiling the pages.
getViewURL(String) - Method in interface org.apache.wiki.api.core.Context
  A shortcut to generate a VIEW url.
getWiki() - Method in interface org.apache.wiki.api.core.Page
  Returns the wiki name for this page
getWikiProperties() - Method in interface org.apache.wiki.api.core.Engine
  Returns the set of properties that the Engine was initialized with.
getWikiSession() - Method in interface org.apache.wiki.api.core.Context
  Returns the Session associated with the context.
getWorkDir() - Method in interface org.apache.wiki.api.core.Engine
  Returns the JSPWiki working directory set with "jspwiki.workDir".
GROUP_DELETE - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
GROUP_EDIT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
GROUP_VIEW - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
guest(Engine) - Method in class org.apache.wiki.api.spi.SessionDSL
  Creates a new "guest" session containing a single user Principal `org.apache.wiki.auth.WikiPrincipal#GUEST`, plus the role principals `Role#ALL` and `Role#ANONYMOUS`.
guest(Engine) - Method in interface org.apache.wiki.api.spi.SessionSPI
  Creates a new "guest" session containing a single user Principal `org.apache.wiki.auth.WikiPrincipal#GUEST`, plus the role principals `Role#ALL` and `Role#ANONYMOUS`.

## H

hasAdminPermissions() - Method in interface org.apache.wiki.api.core.Context
  Returns true, if the current user has administrative permissions (i.e. the omnipotent AllPermission).
hasMetadata() - Method in interface org.apache.wiki.api.core.Page
  Returns `true` if the page has valid metadata; that is, it has been parsed.
hasPrincipal(Principal) - Method in interface org.apache.wiki.api.core.Session
  Returns `true` if the Session's Subject possess a supplied Principal.

## I

init(ServletContext) - Static method in class org.apache.wiki.api.spi.Wiki
Initializable - Interface in org.apache.wiki.api.engine
  Marker interface for Engine's components that can be initialized.
InitializablePlugin - Interface in org.apache.wiki.api.plugin
  If a plugin defines this interface, it is called exactly once prior to the actual execute() routine.
initialize(Properties) - Method in interface org.apache.wiki.api.core.Engine
  Sets up the application's running `Engine`.
initialize(Engine) - Method in interface org.apache.wiki.api.plugin.InitializablePlugin
  Called whenever the plugin is being instantiated for the first time.
initialize(Engine, Properties) - Method in interface org.apache.wiki.api.engine.Initializable
  Initializes this Engine component.
initialize(Engine, Properties) - Method in class org.apache.wiki.api.filters.BasePageFilter
  If you override this, you should call super.initialize() first.
initialize(Engine, Properties) - Method in interface org.apache.wiki.api.filters.PageFilter
  Is called whenever the a new PageFilter is instantiated and reset.
initialize(Engine, Properties) - Method in interface org.apache.wiki.api.providers.WikiProvider
  Initializes the page provider.
invalidate() - Method in interface org.apache.wiki.api.core.Session
  Invalidates the Session and resets its Subject's Principals to the equivalent of a "guest session".
invalidateMetadata() - Method in interface org.apache.wiki.api.core.Page
  This method will remove all metadata from the page.
invoke(Context) - Method in interface org.apache.wiki.api.plugin.PluginElement
  Performs plugin invocation and return its contents.
isAnonymous() - Method in interface org.apache.wiki.api.core.Session
  Determines whether the current session is anonymous.
isAsserted() - Method in interface org.apache.wiki.api.core.Session
  Returns `true` if the user is considered asserted via a session cookie; that is, the Subject contains the Principal Role.ASSERTED.
isAuthenticated() - Method in interface org.apache.wiki.api.core.Session
  Returns the authentication status of the user's session.
isCacheable() - Method in interface org.apache.wiki.api.core.Attachment
  Returns true, if this attachment can be cached by the user agent.
isConfigured() - Method in interface org.apache.wiki.api.core.Engine
  check if the Engine has been configured.
isEmpty() - Method in interface org.apache.wiki.api.core.Acl
  Returns `true`, if this Acl is empty.
isNewerOrEqual(String) - Static method in class org.apache.wiki.api.Release
  Returns true, if this version of JSPWiki is newer or equal than what is requested.
isOlderOrEqual(String) - Static method in class org.apache.wiki.api.Release
  Returns true, if this version of JSPWiki is older or equal than what is requested.

## L

LATEST_VERSION - Static variable in interface org.apache.wiki.api.providers.WikiProvider
  Passing this to any method should get the latest version
listAllChanged(Date) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Lists changed attachments since given date.
listAttachments(Page) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Lists all attachments attached to a page.
LISTENERS - Static variable in interface org.apache.wiki.api.events.CustomWikiEventListener
  `WikiEventListener`s are stored on a `List< WeaKReference >` so we use this List to strong reference custom event listeners.

## M

m_engine - Variable in class org.apache.wiki.api.filters.BasePageFilter
main(String[]) - Static method in class org.apache.wiki.api.Release
  Executing this class directly from command line prints out the current version.
MINORREVISION - Static variable in class org.apache.wiki.api.Release
  The minor revision.
moveAttachmentsForPage(String, String) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Move all the attachments for a given page so that they are attached to a new page.
movePage(String, String) - Method in interface org.apache.wiki.api.providers.PageProvider
  Move a page

## N

NoRequiredPropertyException - Exception in org.apache.wiki.api.exceptions
  Marks an erroneous jspwiki.properties file.
NoRequiredPropertyException(String, String) - Constructor for exception org.apache.wiki.api.exceptions.NoRequiredPropertyException
  Constructs an exception.
NoSuchVariableException - Exception in org.apache.wiki.api.exceptions
  Marks that no such variable was located.
NoSuchVariableException(String) - Constructor for exception org.apache.wiki.api.exceptions.NoSuchVariableException
  Constructs an exception.

## O

onInit(Properties) - Method in interface org.apache.wiki.api.engine.EngineLifecycleExtension
  Called before `Engine` initialization, after the wiki properties have been sought out.
onShutdown(Engine, Properties) - Method in interface org.apache.wiki.api.engine.EngineLifecycleExtension
  Called before `Engine` shutdown.
onStart(Engine, Properties) - Method in interface org.apache.wiki.api.engine.EngineLifecycleExtension
  Called after `Engine` initialization.
org.apache.wiki.api - package org.apache.wiki.api
  JSPWiki's API package.
org.apache.wiki.api.core - package org.apache.wiki.api.core
  JSPWiki's central API.
org.apache.wiki.api.engine - package org.apache.wiki.api.engine
  JSPWiki's Engine's component related classes.
org.apache.wiki.api.events - package org.apache.wiki.api.events
  JSPWiki's Engine events component related classes.
org.apache.wiki.api.exceptions - package org.apache.wiki.api.exceptions
  JSPWiki's API exceptions package.
org.apache.wiki.api.filters - package org.apache.wiki.api.filters
  Filter's API package of JSPWiki.
org.apache.wiki.api.plugin - package org.apache.wiki.api.plugin
  Plugin's API package of JSPWiki.
org.apache.wiki.api.providers - package org.apache.wiki.api.providers
  Page Providers' API package of JSPWiki.
org.apache.wiki.api.search - package org.apache.wiki.api.search
  Search's API package of JSPWiki.
org.apache.wiki.api.spi - package org.apache.wiki.api.spi
  JSPWiki's SPI package.

## P

page(Engine, String) - Method in class org.apache.wiki.api.spi.ContentsDSL
  Creates a `Page` instance.
page(Engine, String) - Method in interface org.apache.wiki.api.spi.ContentsSPI
  Creates a `Page` instance.
Page - Interface in org.apache.wiki.api.core
PAGE_ATTACH - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_COMMENT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_CONFLICT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_DELETE - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_DIFF - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_EDIT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_INFO - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_NONE - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_PREVIEW - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_RENAME - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_RSS - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_UPLOAD - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
PAGE_VIEW - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
pageExists(String) - Method in interface org.apache.wiki.api.providers.PageProvider
  Return true, if page exists.
pageExists(String, int) - Method in interface org.apache.wiki.api.providers.PageProvider
  Return true, if page with a particular version exists.
PageFilter - Interface in org.apache.wiki.api.filters
  Provides a definition for a page filter.
PageProvider - Interface in org.apache.wiki.api.providers
  Each Wiki page provider should implement this interface.
ParserStagePlugin - Interface in org.apache.wiki.api.plugin
  Implements a Plugin interface for the parser stage.
permissions() - Method in interface org.apache.wiki.api.core.AclEntry
  Returns an enumeration of the permissions in this ACL entry.
Plugin - Interface in org.apache.wiki.api.plugin
  Defines an interface for plugins.
PluginElement - Interface in org.apache.wiki.api.plugin
  Exposes the contents of a plugin in a WikiDocument DOM tree.
PluginException - Exception in org.apache.wiki.api.exceptions
  Provides a generic PluginException.
PluginException(String) - Constructor for exception org.apache.wiki.api.exceptions.PluginException
  Create a PluginException.
PluginException(String, Throwable) - Constructor for exception org.apache.wiki.api.exceptions.PluginException
  Create a PluginException with the given original exception wrapped.
postSave(Context, String) - Method in interface org.apache.wiki.api.filters.PageFilter
  This method is called after the page has been successfully saved.
postTranslate(Context, String) - Method in interface org.apache.wiki.api.filters.PageFilter
  This method is called after a page has been fed through the translation process, so anything you are seeing here is translated content.
PREFS_COOKIE_NAME - Static variable in interface org.apache.wiki.api.core.Engine
  The name of the cookie that gets stored to the user browser.
preSave(Context, String) - Method in interface org.apache.wiki.api.filters.PageFilter
  This method is called before the page has been saved to the PageProvider.
preTranslate(Context, String) - Method in interface org.apache.wiki.api.filters.PageFilter
  This method is called whenever a page has been loaded from the provider, but not yet been sent through the markup-translation process.
PROP_ACL_MANAGER_IMPL - Static variable in interface org.apache.wiki.api.core.Engine
  The name of the property containing the ACLManager implementing class.
PROP_ALLOW_CREATION_OF_EMPTY_PAGES - Static variable in interface org.apache.wiki.api.core.Engine
  If this property is set to false, we don't allow the creation of empty pages
PROP_APPNAME - Static variable in interface org.apache.wiki.api.core.Engine
  Property for application name
PROP_ENCODING - Static variable in interface org.apache.wiki.api.core.Engine
  Define the used encoding.
PROP_FRONTPAGE - Static variable in interface org.apache.wiki.api.core.Engine
  Property name for the default front page.
PROP_INLINEIMAGEPTRN - Static variable in interface org.apache.wiki.api.core.Engine
  This property defines the inline image pattern.
PROP_INTERWIKIREF - Static variable in interface org.apache.wiki.api.core.Engine
  Property start for any interwiki reference.
PROP_MATCHPLURALS - Static variable in interface org.apache.wiki.api.core.Engine
  Property name for the "match english plurals" -hack.
PROP_NO_FILTER_ENCODING - Static variable in interface org.apache.wiki.api.core.Engine
  Do not use encoding in WikiJSPFilter, default is false for most servers.
PROP_REF_MANAGER_IMPL - Static variable in interface org.apache.wiki.api.core.Engine
  The name of the property containing the ReferenceManager implementing class.
PROP_SEARCHPATH - Static variable in interface org.apache.wiki.api.core.Engine
  The property name defining which packages will be searched for plugin classes.
PROP_STORAGEDIR - Static variable in interface org.apache.wiki.api.providers.AttachmentProvider
  Property that supplies the directory used to store attachments.
PROP_STOREUSERNAME - Static variable in interface org.apache.wiki.api.core.Engine
  If true, then the user name will be stored with the page data.
PROP_TEMPLATEDIR - Static variable in interface org.apache.wiki.api.core.Engine
  Property name for the template that is used.
PROP_URLCONSTRUCTOR - Static variable in interface org.apache.wiki.api.core.Engine
  Property name for setting the url generator instance
PROP_USE_2_X_ACL_LOGIC - Static variable in interface org.apache.wiki.api.core.Engine
  see JSPWIKI-130
PROP_WORKDIR - Static variable in interface org.apache.wiki.api.core.Engine
  Property name for where the jspwiki work directory should be.
ProviderException - Exception in org.apache.wiki.api.exceptions
  This exception represents the superclass of all exceptions that providers may throw.
ProviderException(String) - Constructor for exception org.apache.wiki.api.exceptions.ProviderException
  Creates a ProviderException.
putAttachmentData(Attachment, InputStream) - Method in interface org.apache.wiki.api.providers.AttachmentProvider
  Put new attachment data.
putPageText(Page, String) - Method in interface org.apache.wiki.api.providers.PageProvider
  Attempts to save the page text for page "page".

## Q

QueryItem - Class in org.apache.wiki.api.search
  This simple class just fulfils the role of a container for searches.
QueryItem() - Constructor for class org.apache.wiki.api.search.QueryItem

## R

REDIRECT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
REDIRECT - Static variable in interface org.apache.wiki.api.core.Page
  A special variable name for storing a redirect note
RedirectException - Exception in org.apache.wiki.api.exceptions
  This exception may be thrown if a filter wants to reject something and redirect the user elsewhere.
RedirectException(String, String) - Constructor for exception org.apache.wiki.api.exceptions.RedirectException
  Constructs a new RedirectException.
Release - Class in org.apache.wiki.api
  Contains release and version information.
remove(Engine, HttpServletRequest) - Method in class org.apache.wiki.api.spi.SessionDSL
  Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
remove(Engine, HttpServletRequest) - Method in interface org.apache.wiki.api.spi.SessionSPI
  Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
removeAttribute(String) - Method in interface org.apache.wiki.api.core.Engine
  Removes an attribute.
removeAttribute(String) - Method in interface org.apache.wiki.api.core.Page
  Removes an attribute from the page, if it exists.
removeEntry(AclEntry) - Method in interface org.apache.wiki.api.core.Acl
  Removes an ACL entry from this ACL.
removePermission(Permission) - Method in interface org.apache.wiki.api.core.AclEntry
  Removes the specified permission from this ACL entry.
removeWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.api.core.Engine
  Un-registers a WikiEventListener with this instance.
RenderApi - Interface in org.apache.wiki.api.engine
  Rendering routines that all JSPWiki public API implementations should provide.
REQUESTED - Static variable in class org.apache.wiki.api.search.QueryItem
  The word should be in the pages, but the search engine may use its own discretion.
REQUIRED - Static variable in class org.apache.wiki.api.search.QueryItem
  The word is required to be in the pages
requiredPermission() - Method in interface org.apache.wiki.api.core.Command
  Returns the Permission required to successfully execute this Command.
REVISION - Static variable in class org.apache.wiki.api.Release
  The JSPWiki revision.

## S

SearchResult - Interface in org.apache.wiki.api.search
  Defines a search result.
session() - Static method in class org.apache.wiki.api.spi.Wiki
  Access to `SessionSPI` operations.
Session - Interface in org.apache.wiki.api.core
  Represents a long-running wiki session, with an associated user Principal, user Subject, and authentication status.
SessionDSL - Class in org.apache.wiki.api.spi
  SPI used to locate and provide `Session` instances.
SessionSPI - Interface in org.apache.wiki.api.spi
  SPI used to locate and provide `Session` instances.
setAcl(Acl) - Method in interface org.apache.wiki.api.core.Page
  Sets the Acl for this page.
setAttribute(String, Object) - Method in interface org.apache.wiki.api.core.Engine
  Adds an attribute to the engine for the duration of this engine.
setAttribute(String, Object) - Method in interface org.apache.wiki.api.core.Page
  Sets an metadata attribute.
setAuthor(String) - Method in interface org.apache.wiki.api.core.Page
  Sets the author of the page.
setCacheable(boolean) - Method in interface org.apache.wiki.api.core.Attachment
  Sets this attachment to be cacheable or not.
setFileName(String) - Method in interface org.apache.wiki.api.core.Attachment
  Sets the file name of this attachment.
setHasMetadata() - Method in interface org.apache.wiki.api.core.Page
  Sets the metadata flag to true.
setLastModified(Date) - Method in interface org.apache.wiki.api.core.Page
  Sets the last modification date.
setPage(Page) - Method in interface org.apache.wiki.api.core.Context
  Sets the WikiPage that is being handled.
setPrincipal(Principal) - Method in interface org.apache.wiki.api.core.AclEntry
  Specifies the principal for which permissions are granted or denied by this ACL entry.
setRealPage(Page) - Method in interface org.apache.wiki.api.core.Context
  Sets a reference to the real WikiPage whose content is currently being rendered.
setRequestContext(String) - Method in interface org.apache.wiki.api.core.Context
  Sets the request context.
setSize(long) - Method in interface org.apache.wiki.api.core.Page
  Sets the size.
setTemplate(String) - Method in interface org.apache.wiki.api.core.Context
  Sets the template to be used for this request.
setVariable(String, Object) - Method in interface org.apache.wiki.api.core.Context
  Sets a variable.
setVersion(int) - Method in interface org.apache.wiki.api.core.Page
  Sets the page version.
shutdown() - Method in interface org.apache.wiki.api.core.Engine
  Signals that the `Engine` will be shut down by the servlet container.
start(Properties) - Method in interface org.apache.wiki.api.core.Engine
  Initializes the `Engine`, notifying all the `EngineLifecycleExtension`s.
stop() - Method in interface org.apache.wiki.api.core.Engine
  Shuts down the `Engine`, notifying all the `EngineLifecycleExtension`s.

## T

targetedCommand(Object) - Method in interface org.apache.wiki.api.core.Command
  Creates and returns a targeted Command by combining a target, such as a WikiPage or GroupPrincipal into the existing Command.
textToHTML(Context, String) - Method in interface org.apache.wiki.api.engine.RenderApi
  Converts raw page data to HTML.
type - Variable in class org.apache.wiki.api.search.QueryItem
  The type of the word.

## V

valueOf(String) - Static method in enum class org.apache.wiki.api.core.ContextEnum
  Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.apache.wiki.api.core.ContextEnum
  Returns an array containing the constants of this enum class, in the order they are declared.
VAR_EXECUTE_PLUGINS - Static variable in interface org.apache.wiki.api.core.Context
  Variable name which tells whether plugins should be executed or not.
VAR_WYSIWYG_EDITOR_MODE - Static variable in interface org.apache.wiki.api.core.Context
  Name of the variable which is set to Boolean.TRUE or Boolean.FALSE depending on whether WYSIWYG is currently in effect.
VERSION - Static variable in class org.apache.wiki.api.Release
  The JSPWiki major version.
VERSTR - Static variable in class org.apache.wiki.api.Release
  This is the generic version string you should use when printing out the version.
VIEWCOUNT - Static variable in interface org.apache.wiki.api.core.Page
  A special variable name for storing a viewcount.

## W

Wiki - Class in org.apache.wiki.api.spi
Wiki() - Constructor for class org.apache.wiki.api.spi.Wiki
WIKI_ADMIN - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_CREATE_GROUP - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_ERROR - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_FIND - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_INSTALL - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_LOGIN - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_LOGOUT - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_MESSAGE - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_PREFS - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WIKI_WORKFLOW - Enum constant in enum class org.apache.wiki.api.core.ContextEnum
WikiException - Exception in org.apache.wiki.api.exceptions
  A generic Wiki exception.
WikiException(String) - Constructor for exception org.apache.wiki.api.exceptions.WikiException
  Constructs an exception.
WikiException(String, Throwable) - Constructor for exception org.apache.wiki.api.exceptions.WikiException
  Constructs an exception with a supplied cause.
WikiI18nException - Exception in org.apache.wiki.api.exceptions
  A generic Wiki exception, meant to carry key & args to construct i18n messages to show meaningful messages to end-user.
WikiI18nException(String, Object...) - Constructor for exception org.apache.wiki.api.exceptions.WikiI18nException
  Constructs an exception.
WikiProvider - Interface in org.apache.wiki.api.providers
  A generic Wiki provider for all sorts of things that the Wiki can store.
word - Variable in class org.apache.wiki.api.search.QueryItem
  The word that is being searched

A B C D E F G H I L M N O P Q R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form