Index

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

A

abort() - Method in class org.apache.wiki.auth.login.AbstractLoginModule

Aborts the login; called if the LoginContext's overall authentication failed.

abort(Context) - Method in class org.apache.wiki.workflow.Workflow

Aborts the Workflow by setting the current Step's Outcome to Outcome.STEP_ABORT, and the Workflow's overall state to Workflow.ABORTED.

ABORTED - Static variable in class org.apache.wiki.workflow.Workflow

State value: Workflow aborted before completion.

AbstractCommand - Class in org.apache.wiki.ui

Abstract, immutable Command implementation class.

AbstractCommand(String, String, String, Object) - Constructor for class org.apache.wiki.ui.AbstractCommand

Constructs a new Command with a specified wiki context, URL pattern, content template and target.

AbstractFileProvider - Class in org.apache.wiki.providers

Provides a simple directory based repository for Wiki pages.

AbstractFileProvider() - Constructor for class org.apache.wiki.providers.AbstractFileProvider

AbstractFileProvider.WikiFileFilter - Class in org.apache.wiki.providers

A simple filter which filters only those filenames which correspond to the file extension used.

AbstractLoginModule - Class in org.apache.wiki.auth.login

Abstract JAAS LoginModulethat implements base functionality.

AbstractLoginModule() - Constructor for class org.apache.wiki.auth.login.AbstractLoginModule

AbstractReferralPlugin - Class in org.apache.wiki.plugin

This is a base class for all plugins using referral things.

AbstractReferralPlugin() - Constructor for class org.apache.wiki.plugin.AbstractReferralPlugin

AbstractRPCHandler - Class in org.apache.wiki.xmlrpc

Provides definitions for RPC handler routines.

AbstractRPCHandler() - Constructor for class org.apache.wiki.xmlrpc.AbstractRPCHandler

AbstractStep - Class in org.apache.wiki.workflow

Abstract superclass that provides a complete implementation of most Step methods; subclasses need only implement AbstractStep.execute(Context) and AbstractStep.getActor().

AbstractStep(int, Map<String, Serializable>, String) - Constructor for class org.apache.wiki.workflow.AbstractStep

Constructs a new Step belonging to a specified Workflow and having a specified message key.

AbstractStep(String) - Constructor for class org.apache.wiki.workflow.AbstractStep

Protected constructor that creates a new Step with a specified message key.

AbstractUserDatabase - Class in org.apache.wiki.auth.user

Abstract UserDatabase class that provides convenience methods for finding profiles, building Principal collections and hashing passwords.

AbstractUserDatabase() - Constructor for class org.apache.wiki.auth.user.AbstractUserDatabase

accept(File, String) - Method in class org.apache.wiki.providers.AbstractFileProvider.WikiFileFilter

accept(File, String) - Method in class org.apache.wiki.providers.BasicAttachmentProvider.AttachmentFilter

accept(File, String) - Method in class org.apache.wiki.providers.BasicAttachmentProvider.AttachmentVersionFilter

acknowledge(Context) - Method in class org.apache.wiki.workflow.SimpleNotification

Convenience method that simply calls Decision.decide(Outcome, Context) with the value Outcome.DECISION_ACKNOWLEDGE.

acl() - Method in class org.apache.wiki.spi.AclsSPIDefaultImpl

Acl - Interface in org.apache.wiki.auth.acl

Deprecated.

use Acl instead

ACL_PATTERN - Static variable in class org.apache.wiki.auth.acl.DefaultAclManager

Identifies ACL strings in wiki text; the first group is the action (view, edit) and the second is the list of Principals separated by commas.

aclEntries() - Method in class org.apache.wiki.auth.acl.AclImpl

AclEntry - Interface in org.apache.wiki.auth.acl

Deprecated.

use AclEntry instead

AclEntryImpl - Class in org.apache.wiki.auth.acl

Implementation of a JSPWiki AclEntry.

AclEntryImpl() - Constructor for class org.apache.wiki.auth.acl.AclEntryImpl

Constructs a new AclEntryImpl instance.

AclImpl - Class in org.apache.wiki.auth.acl

JSPWiki implementation of an Access Control List.

AclImpl() - Constructor for class org.apache.wiki.auth.acl.AclImpl

Constructs a new AclImpl instance.

AclManager - Interface in org.apache.wiki.auth.acl

Specifies how to parse and return ACLs from wiki pages.

AclsSPIDefaultImpl - Class in org.apache.wiki.spi

AclsSPIDefaultImpl() - Constructor for class org.apache.wiki.spi.AclsSPIDefaultImpl

actionPerformed(WikiEvent) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

actionPerformed(WikiEvent) - Method in class org.apache.wiki.pages.DefaultPageManager

Listens for WikiSecurityEvent.PROFILE_NAME_CHANGED events.

actionPerformed(WikiEvent) - Method in class org.apache.wiki.plugin.PageViewPlugin.PageViewManager

Inspect wiki events for shutdown.

actionPerformed(WikiEvent) - Method in class org.apache.wiki.references.DefaultReferenceManager

actionPerformed(WikiEvent) - Method in class org.apache.wiki.render.DefaultRenderingManager

actionPerformed(WikiEvent) - Method in class org.apache.wiki.search.DefaultSearchManager

actionPerformed(WikiEvent) - Method in interface org.apache.wiki.ui.admin.AdminBeanManager

Unregisters AdminBeans upon SHUTDOWN event.

actionPerformed(WikiEvent) - Method in class org.apache.wiki.ui.admin.DefaultAdminBeanManager

actionPerformed(WikiEvent) - Method in class org.apache.wiki.WikiBackgroundThread

Listens for WikiEngineEvent.SHUTDOWN and, if detected, marks the thread for death.

actionPerformed(WikiEvent) - Method in class org.apache.wiki.WikiSession

Listens for WikiEvents generated by source objects such as the GroupManager, UserManager or AuthenticationManager.

actionPerformed(WikiEvent) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Listens for WorkflowEvent objects emitted by Workflows.

add(Permission) - Method in class org.apache.wiki.auth.permissions.AllPermissionCollection

Adds an AllPermission object to this AllPermissionCollection.

add(Principal) - Method in class org.apache.wiki.auth.authorize.Group

Adds a Principal to the group.

add(Decision) - Method in class org.apache.wiki.workflow.DecisionQueue

Adds a Decision to the DecisionQueue; also sets the Decision's unique identifier.

add(Workflow) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Protected helper method that adds a newly created Workflow to the cache, and sets its workflowManager and Id properties if not set.

addAttachmentLinkHook(StringTransmutator) - Method in class org.apache.wiki.parser.MarkupParser

Adds a hook for processing attachment links.

addAttribute(Attribute) - Method in class org.apache.wiki.parser.LinkParser.Link

Adds another attribute to the link.

addCustomProperties(Page, Properties) - Method in class org.apache.wiki.providers.AbstractFileProvider

By default all page attributes that start with "@" are returned as custom properties.

addEntry(AclEntry) - Method in class org.apache.wiki.auth.acl.AclImpl

addEntry(AclEntry) - Method in interface org.apache.wiki.auth.acl.Acl

Deprecated.

use Acl.addEntry(org.apache.wiki.api.core.AclEntry) instead.

addEntry(Entry) - Method in class org.apache.wiki.rss.Feed

Adds a new Entry to the Feed, at the end of the list.

addError(String) - Method in class org.apache.wiki.workflow.AbstractStep

Protected helper method that adds a String representing an error message to the Step's cached errors list.

addExternalLinkHook(StringTransmutator) - Method in class org.apache.wiki.parser.MarkupParser

Adds a hook for processing external links.

addFact(Fact) - Method in class org.apache.wiki.workflow.Decision

Appends a Fact to the list of Facts associated with this Decision.

addHeadingListener(HeadingListener) - Method in class org.apache.wiki.parser.MarkupParser

Adds a HeadingListener to the parser chain.

addLinkTransmutator(StringTransmutator) - Method in class org.apache.wiki.parser.MarkupParser

Adds a hook for processing link texts.

addLocalLinkHook(StringTransmutator) - Method in class org.apache.wiki.parser.MarkupParser

Adds a hook for processing local links.

addMessage(String) - Method in class org.apache.wiki.WikiSession

addMessage(String, String) - Method in class org.apache.wiki.WikiSession

addMessageArgument(Serializable) - Method in class org.apache.wiki.workflow.Workflow

Appends a message argument object to the array returned by Workflow.getMessageArguments().

addPageFilter(PageFilter, int) - Method in class org.apache.wiki.filters.DefaultFilterManager

Adds a page filter to the queue.

addPageFilter(PageFilter, int) - Method in interface org.apache.wiki.filters.FilterManager

Adds a page filter to the queue.

addPermission(Permission) - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Adds the specified permission to this ACL entry.

addResourceRequest(Context, String, String) - Static method in interface org.apache.wiki.ui.TemplateManager

Adds a resource request to the current request context.

addSubmission(Map<String, String>) - Method in class org.apache.wiki.forms.FormInfo

Adds the given values into the handler parameter map.

addSuccessor(Outcome, Step) - Method in class org.apache.wiki.workflow.AbstractStep

Adds a successor Step to this one, which will be triggered by a supplied Outcome.

addSuccessor(Outcome, Step) - Method in interface org.apache.wiki.workflow.Step

Adds a successor Step to this one, which will be triggered by a supplied Outcome.

addToDecisionQueue(Decision) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

addWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.AuthenticationManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.AuthorizationManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultUserManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.SessionMonitor

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.UserManager

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.filters.PageEventFilter

Registers a WikiEventListener with this instance.

addWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.WikiEngine

ADMIN - Static variable in class org.apache.wiki.ui.WikiCommand

ADMIN - Static variable in class org.apache.wiki.WikiContext

User is doing administrative things.

ADMIN_GROUP - Static variable in class org.apache.wiki.ui.Installer

ADMIN_ID - Static variable in class org.apache.wiki.ui.Installer

ADMIN_NAME - Static variable in class org.apache.wiki.ui.Installer

AdminBean - Interface in org.apache.wiki.ui.admin

Describes an administrative bean.

AdminBeanIteratorInfo - Class in org.apache.wiki.tags

Just provides iteration support for AdminBeanIteratorTag

AdminBeanIteratorInfo() - Constructor for class org.apache.wiki.tags.AdminBeanIteratorInfo

AdminBeanIteratorTag - Class in org.apache.wiki.tags

Provides an iterator for all AdminBeans of a given type.

AdminBeanIteratorTag() - Constructor for class org.apache.wiki.tags.AdminBeanIteratorTag

AdminBeanManager - Interface in org.apache.wiki.ui.admin

adminExists() - Method in class org.apache.wiki.ui.Installer

Returns true if the administrative user had been created previously.

AJAX_ACTION_PAGES - Static variable in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

AJAX_ACTION_SUGGESTIONS - Static variable in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

AjaxUtil - Class in org.apache.wiki.ajax

Helpful utilities for the Ajax functions.

AjaxUtil() - Constructor for class org.apache.wiki.ajax.AjaxUtil

ALL - Static variable in class org.apache.wiki.auth.authorize.Role

All users, regardless of authentication status

ALL_ITEMS - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Magic value for rendering all items.

AllCommands - Interface in org.apache.wiki.ui

Placeholder class for all Commands.

allowedByLocalPolicy(Principal[], Permission) - Method in interface org.apache.wiki.auth.AuthorizationManager

Checks to see if the local security policy allows a particular static Permission.

allowedByLocalPolicy(Principal[], Permission) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Checks to see if the local security policy allows a particular static Permission.

allowsCookieAssertions() - Method in interface org.apache.wiki.auth.AuthenticationManager

Determines whether this Engine allows users to assert identities using cookies instead of passwords.

allowsCookieAssertions() - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Determines whether this Engine allows users to assert identities using cookies instead of passwords.

allowsCookieAuthentication() - Method in interface org.apache.wiki.auth.AuthenticationManager

Determines whether this Engine allows users to authenticate using cookies instead of passwords.

allowsCookieAuthentication() - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Determines whether this Engine allows users to authenticate using cookies instead of passwords.

AllPermission - Class in org.apache.wiki.auth.permissions

Permission to perform all operations on a given wiki.

AllPermission(String) - Constructor for class org.apache.wiki.auth.permissions.AllPermission

Creates a new AllPermission for the given wikis.

AllPermissionCollection - Class in org.apache.wiki.auth.permissions

A collection of AllPermission objects.

AllPermissionCollection() - Constructor for class org.apache.wiki.auth.permissions.AllPermissionCollection

ALTERNATING_SPACE_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

ANCHOR - Static variable in class org.apache.wiki.tags.WikiLinkTag

ANONYMOUS - Static variable in class org.apache.wiki.auth.authorize.Role

If the user hasn't supplied a name

AnonymousLoginModule - Class in org.apache.wiki.auth.login

Logs in a user based solely on IP address; no other authentication is performed.

AnonymousLoginModule() - Constructor for class org.apache.wiki.auth.login.AnonymousLoginModule

antiCsrfToken() - Method in class org.apache.wiki.WikiSession

APP_NAME - Static variable in class org.apache.wiki.ui.Installer

applyColumnsStyle(String) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

ASSERTED - Static variable in class org.apache.wiki.auth.authorize.Role

If the user has supplied a cookie with a username

ATOM - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent Atom feeds.

AtomAPIServlet - Class in org.apache.wiki.rpc.atom

Handles incoming requests for the Atom API.

AtomAPIServlet() - Constructor for class org.apache.wiki.rpc.atom.AtomAPIServlet

AtomFeed - Class in org.apache.wiki.rss

Provides an Atom 1.0 standard feed, with enclosures.

AtomFeed(Context) - Constructor for class org.apache.wiki.rss.AtomFeed

Create a new AtomFeed for a given WikiContext.

ATTACH - Static variable in class org.apache.wiki.ui.PageCommand

ATTACH - Static variable in class org.apache.wiki.WikiContext

User is downloading an attachment.

attachment(Engine, String, String) - Method in class org.apache.wiki.spi.ContentsSPIDefaultImpl

Attachment - Class in org.apache.wiki.attachment

Describes an attachment.

Attachment(Engine, String, String) - Constructor for class org.apache.wiki.attachment.Attachment

Creates a new attachment.

Attachment(WikiEngine, String, String) - Constructor for class org.apache.wiki.attachment.Attachment

Deprecated.

kept for compatibility with page/attachment providers not using public API. Use Attachment(Engine, String, String) instead.

ATTACHMENT - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

AttachmentFilter() - Constructor for class org.apache.wiki.providers.BasicAttachmentProvider.AttachmentFilter

AttachmentManager - Interface in org.apache.wiki.attachment

Provides facilities for handling attachments.

attachmentsEnabled() - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns true, if attachments are enabled and running.

attachmentsEnabled() - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns true, if attachments are enabled and running.

AttachmentServlet - Class in org.apache.wiki.attachment

This is the chief JSPWiki attachment management servlet.

AttachmentServlet() - Constructor for class org.apache.wiki.attachment.AttachmentServlet

AttachmentsIteratorInfo - Class in org.apache.wiki.tags

Just provides the TEI data for AttachmentsIteratorTag.

AttachmentsIteratorInfo() - Constructor for class org.apache.wiki.tags.AttachmentsIteratorInfo

AttachmentsIteratorTag - Class in org.apache.wiki.tags

Iterates through the list of attachments one has.

AttachmentsIteratorTag() - Constructor for class org.apache.wiki.tags.AttachmentsIteratorTag

AttachmentVersionFilter() - Constructor for class org.apache.wiki.providers.BasicAttachmentProvider.AttachmentVersionFilter

ATTDIR_EXTENSION - Static variable in class org.apache.wiki.providers.BasicAttachmentProvider

The default extension for the attachment directory.

ATTR_EDITEDTEXT - Static variable in interface org.apache.wiki.ui.EditorManager

Known attribute name for storing the user edited text inside a session or a page context

ATTR_ISWEBLOG - Static variable in class org.apache.wiki.plugin.WeblogPlugin

The attribute which is stashed to the WikiPage attributes to check if a page is a weblog or not.

ATTR_NEWVERSION - Static variable in class org.apache.wiki.tags.InsertDiffTag

Attribute which is used to store the new page content to the Page Context

ATTR_OLDVERSION - Static variable in class org.apache.wiki.tags.InsertDiffTag

Attribute which is used to store the old page content to the Page Context

ATTR_RECURSE - Static variable in class org.apache.wiki.plugin.InsertPage

This attribute is stashed in the WikiContext to make sure that we don't have circular references.

attributeCount() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns the number of attributes on this link.

attributeEscapedEntitiesFilter(Writer, FormatStack, String) - Method in class org.apache.wiki.render.CustomXMLOutputProcessor

AUTHENTICATED - Static variable in class org.apache.wiki.auth.authorize.Role

If the user has authenticated with the Container or UserDatabase

AuthenticationManager - Interface in org.apache.wiki.auth

Manages authentication activities for a Engine: user login, logout, and credential refreshes.

AuthorizationManager - Interface in org.apache.wiki.auth

Manages all access control and authorization; determines what authenticated users are allowed to do.

Authorizer - Interface in org.apache.wiki.auth

Interface for service providers of authorization information.

AuthorizerCallback - Class in org.apache.wiki.auth.login

Callback for requesting and supplying an Authorizer required by a LoginModule.

AuthorizerCallback() - Constructor for class org.apache.wiki.auth.login.AuthorizerCallback

AuthorTag - Class in org.apache.wiki.tags

Writes the author name of the current page, including a link to that page, if that page exists.

AuthorTag() - Constructor for class org.apache.wiki.tags.AuthorTag

B

backgroundTask() - Method in class org.apache.wiki.rss.RSSThread

Runs the RSS generator thread.

backgroundTask() - Method in class org.apache.wiki.WikiBackgroundThread

Abstract method that performs the actual work for this background thread; subclasses must implement this method.

BaseModuleManager - Class in org.apache.wiki.modules

Superclass for all JSPWiki managers for modules (plugins, etc.).

BaseModuleManager(Engine) - Constructor for class org.apache.wiki.modules.BaseModuleManager

Constructs the ModuleManager.

BaseURLTag - Class in org.apache.wiki.tags

Writes the jspwiki baseURL.

BaseURLTag() - Constructor for class org.apache.wiki.tags.BaseURLTag

BasicAttachmentProvider - Class in org.apache.wiki.providers

Provides basic, versioning attachments.

BasicAttachmentProvider() - Constructor for class org.apache.wiki.providers.BasicAttachmentProvider

BasicAttachmentProvider.AttachmentFilter - Class in org.apache.wiki.providers

Returns only those directories that contain attachments.

BasicAttachmentProvider.AttachmentVersionFilter - Class in org.apache.wiki.providers

Accepts only files that are actual versions, no control files.

BasicSearchProvider - Class in org.apache.wiki.search

Interface for the search providers that handle searching the Wiki

BasicSearchProvider() - Constructor for class org.apache.wiki.search.BasicSearchProvider

beautifyTitle(String) - Method in class org.apache.wiki.render.DefaultRenderingManager

Beautifies the title of the page by appending spaces in suitable places, if the user has so decreed in the properties when constructing this Engine.

beautifyTitle(String) - Method in interface org.apache.wiki.render.RenderingManager

Beautifies the title of the page by appending spaces in suitable places, if the user has so decreed in the properties when constructing this Engine.

beautifyTitleNoBreak(String) - Method in class org.apache.wiki.render.DefaultRenderingManager

Beautifies the title of the page by appending non-breaking spaces in suitable places.

beautifyTitleNoBreak(String) - Method in interface org.apache.wiki.render.RenderingManager

Beautifies the title of the page by appending non-breaking spaces in suitable places.

BLANK - Static variable in class org.apache.wiki.tags.UserProfileTag

BreadcrumbsTag - Class in org.apache.wiki.tags

Implement a "breadcrumb" (most recently visited) trail.

BreadcrumbsTag() - Constructor for class org.apache.wiki.tags.BreadcrumbsTag

BreadcrumbsTag.FixedQueue - Class in org.apache.wiki.tags

Extends the LinkedList class to provide a fixed-size queue implementation

BREADCRUMBTRAIL_KEY - Static variable in class org.apache.wiki.tags.BreadcrumbsTag

The name of the session attribute representing the breadcrumbtrail

BugReportHandler - Class in org.apache.wiki.plugin

Provides a handler for bug reports.

BugReportHandler() - Constructor for class org.apache.wiki.plugin.BugReportHandler

buildApprovalWorkflow(Principal, String, Step, String, Fact[], Step, String) - Method in class org.apache.wiki.workflow.WorkflowBuilder

Builds an approval workflow that requests approval from a named user, Group or Role before running a Task.

buildPreSaveWikiPageTask(String) - Method in class org.apache.wiki.tasks.DefaultTasksManager

Builds a pre-save WikiPage task.

buildPreSaveWikiPageTask(String) - Method in interface org.apache.wiki.tasks.TasksManager

Builds a pre-save WikiPage task.

buildSaveUserProfileTask(Locale) - Method in class org.apache.wiki.tasks.DefaultTasksManager

Builds a save user profile task.

buildSaveUserProfileTask(Locale) - Method in interface org.apache.wiki.tasks.TasksManager

Builds a save user profile task.

buildSaveWikiPageTask() - Method in class org.apache.wiki.tasks.DefaultTasksManager

Builds a save WikiPage task.

buildSaveWikiPageTask() - Method in interface org.apache.wiki.tasks.TasksManager

Builds a save WikiPage task.

C

CachingAttachmentProvider - Class in org.apache.wiki.providers

Provides a caching attachment provider.

CachingAttachmentProvider() - Constructor for class org.apache.wiki.providers.CachingAttachmentProvider

CachingProvider - Class in org.apache.wiki.providers

Provides a caching page provider.

CachingProvider() - Constructor for class org.apache.wiki.providers.CachingProvider

CalendarTag - Class in org.apache.wiki.tags

Provides a nice calendar.

CalendarTag() - Constructor for class org.apache.wiki.tags.CalendarTag

callMutatorChain(Collection<StringTransmutator>, String) - Method in class org.apache.wiki.parser.JSPWikiMarkupParser

Calls a transmutator chain.

CHANGE_END_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

CHANGE_START_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

changeAcl(Page, Principal[], Principal) - Method in class org.apache.wiki.pages.DefaultPageManager

For a single wiki page, replaces all Acl entries matching a supplied array of Principals with a new Principal.

CHARACTER - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

The token is a plain character.

checkCompatibility(WikiModuleInfo) - Method in class org.apache.wiki.modules.BaseModuleManager

Returns true, if the given module is compatible with this version of JSPWiki.

checkCompatibility(WikiModuleInfo) - Method in interface org.apache.wiki.modules.ModuleManager

Returns true, if the given module is compatible with this version of JSPWiki.

checkGroupName(Context, String) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Checks if a String is blank or a restricted Group name, and if it is, appends an error to the Session's message list.

checkGroupName(Context, String) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Checks if a String is blank or a restricted Group name, and if it is, appends an error to the Session's message list.

checkHash(Context, PageContext) - Static method in class org.apache.wiki.filters.SpamFilter

This method checks if the hash value is still valid, i.e. if it exists at all.

CheckLockInfo - Class in org.apache.wiki.tags

A companion to CheckLogTag.

CheckLockInfo() - Constructor for class org.apache.wiki.tags.CheckLockInfo

CheckLockTag - Class in org.apache.wiki.tags

Checks whether the page is locked for editing.

CheckLockTag() - Constructor for class org.apache.wiki.tags.CheckLockTag

checkPermission(Permission) - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Checks if the specified permission is part of the permission set in this entry.

checkPermission(Permission) - Method in class org.apache.wiki.xmlrpc.AbstractRPCHandler

Checks whether the current user has permission to perform the RPC action; throws an exception if not allowed by AuthorizationManager.

checkPermission(Session, Permission) - Method in interface org.apache.wiki.auth.AuthorizationManager

Returns true or false, depending on whether a Permission is allowed for the Subject associated with a supplied Session.

checkPermission(Session, Permission) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Returns true or false, depending on whether a Permission is allowed for the Subject associated with a supplied Session.

CheckRequestContextTag - Class in org.apache.wiki.tags

Includes body, if the request context matches.

CheckRequestContextTag() - Constructor for class org.apache.wiki.tags.CheckRequestContextTag

checkStaticPermission(Session, Permission) - Method in interface org.apache.wiki.auth.AuthorizationManager

Determines whether a Subject possesses a given "static" Permission as defined in the security policy file.

checkStaticPermission(Session, Permission) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Determines whether a Subject possesses a given "static" Permission as defined in the security policy file.

CheckVersionTag - Class in org.apache.wiki.tags

Does a version check on the page.

CheckVersionTag() - Constructor for class org.apache.wiki.tags.CheckVersionTag

CLASS_ATTACHMENT - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for attachments.

CLASS_EDITPAGE - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for edit page links.

CLASS_EXTERNAL - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for external links.

CLASS_FOOTNOTE - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for footnote links.

CLASS_FOOTNOTE_REF - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for footnote links.

CLASS_INTERWIKI - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for interwiki page links.

CLASS_TYPES - Static variable in class org.apache.wiki.parser.MarkupParser

CLASS_WIKIPAGE - Static variable in class org.apache.wiki.parser.MarkupParser

The value for anchor element class attributes when used for wiki page (normal) links.

cleanLink(String) - Static method in class org.apache.wiki.parser.MarkupParser

Cleans a Wiki name.

CleanTextRenderer - Class in org.apache.wiki.render

A simple renderer that just renders all the text() nodes from the DOM tree.

CleanTextRenderer(Context, WikiDocument) - Constructor for class org.apache.wiki.render.CleanTextRenderer

Create a renderer.

cleanup() - Method in class org.apache.wiki.workflow.Workflow

Clears the attribute map and sets the current step field to null.

clear() - Method in class org.apache.wiki.auth.authorize.Group

Clears all Principals from the group list.

clearList() - Method in class org.apache.wiki.tags.IteratorTag

Clears the iterator away.

clearLoginCookie(Engine, HttpServletRequest, HttpServletResponse) - Static method in class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

Clears away the login cookie, and removes the uid-username mapping file as well.

clearMessages() - Method in class org.apache.wiki.WikiSession

clearMessages(String) - Method in class org.apache.wiki.WikiSession

clearPageEntries(String) - Method in class org.apache.wiki.references.DefaultReferenceManager

Clears the references to a certain page, so it's no longer in the map.

clearPageEntries(String) - Method in interface org.apache.wiki.references.ReferenceManager

Clears the references to a certain page so it's no longer in the map.

clearUserCookie(HttpServletResponse) - Static method in class org.apache.wiki.auth.login.CookieAssertionLoginModule

Removes the user cookie from the response.

clone() - Method in class org.apache.wiki.WikiContext

Returns a shallow clone of the WikiContext.

clone() - Method in class org.apache.wiki.WikiPage

Creates a deep clone of a WikiPage.

CommandResolver - Interface in org.apache.wiki.ui

Resolves special pages, JSPs and Commands on behalf of a Engine.

COMMENT - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the comment permission.

COMMENT - Static variable in class org.apache.wiki.ui.PageCommand

COMMENT - Static variable in class org.apache.wiki.WikiContext

User is commenting something.

COMMENT_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the comment permission.

CommentLinkTag - Class in org.apache.wiki.tags

Writes a comment link.

CommentLinkTag() - Constructor for class org.apache.wiki.tags.CommentLinkTag

commit() - Method in class org.apache.wiki.auth.login.AbstractLoginModule

Commits the login.

COMPARATOR - Static variable in class org.apache.wiki.auth.WikiPrincipal

Static instance of Comparator that allows Principals to be sorted.

compare(String, String) - Method in class org.apache.wiki.pages.PageSorter

Compare two page names (String version).

compare(Page, Page) - Method in class org.apache.wiki.pages.PageTimeComparator

compare(SearchResult, SearchResult) - Method in class org.apache.wiki.search.SearchResultComparator

Compares two SearchResult objects, returning the one that scored higher.

compareTo(Principal) - Method in class org.apache.wiki.auth.WikiPrincipal

Allows comparisons to any other Principal objects.

compareTo(Page) - Method in class org.apache.wiki.WikiPage

Compares a page with another by name using the defined PageNameComparator.

compareTo(WikiModuleInfo) - Method in class org.apache.wiki.modules.WikiModuleInfo

complete() - Method in class org.apache.wiki.workflow.Workflow

Protected helper method that changes the Workflow's state to Workflow.COMPLETED and sets the current Step to null.

COMPLETED - Static variable in class org.apache.wiki.workflow.Workflow

State value: Workflow completed all Steps without errors.

CONFLICT - Static variable in class org.apache.wiki.ui.PageCommand

CONFLICT - Static variable in class org.apache.wiki.WikiContext

User has an internal conflict, and does quite not know what to do.

containerForModuleDetail(Element) - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

containerRoleTable() - Method in class org.apache.wiki.auth.SecurityVerifier

Formats and returns an HTML table containing the roles the web container is aware of, and whether each role maps to particular JSPs.

ContentEncodingTag - Class in org.apache.wiki.tags

Returns the app name.

ContentEncodingTag() - Constructor for class org.apache.wiki.tags.ContentEncodingTag

ContentsSPIDefaultImpl - Class in org.apache.wiki.spi

Default implementation for ContentsSPI

ContentsSPIDefaultImpl() - Constructor for class org.apache.wiki.spi.ContentsSPIDefaultImpl

ContentTag - Class in org.apache.wiki.tags

Is used as a "super include" tag, which can include the proper context based on the wikicontext.

ContentTag() - Constructor for class org.apache.wiki.tags.ContentTag

ContextSPIDefaultImpl - Class in org.apache.wiki.spi

Default implementation for ContextSPI

ContextSPIDefaultImpl() - Constructor for class org.apache.wiki.spi.ContextSPIDefaultImpl

ContextualDiffProvider - Class in org.apache.wiki.diff

A seriously better diff provider, which highlights changes word-by-word using CSS.

ContextualDiffProvider() - Constructor for class org.apache.wiki.diff.ContextualDiffProvider

Constructs this provider.

COOKIE_DIR - Static variable in class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

The directory name under which the cookies are stored.

COOKIE_USER_PREFS_NAME - Static variable in class org.apache.wiki.preferences.Preferences

CookieAssertionLoginModule - Class in org.apache.wiki.auth.login

Logs in a user based on assertion of a name supplied in a cookie.

CookieAssertionLoginModule() - Constructor for class org.apache.wiki.auth.login.CookieAssertionLoginModule

CookieAuthenticationLoginModule - Class in org.apache.wiki.auth.login

Logs in a user based on a cookie stored in the user's computer.

CookieAuthenticationLoginModule() - Constructor for class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

CookieTag - Class in org.apache.wiki.tags

Sets or gets Cookie values.

CookieTag() - Constructor for class org.apache.wiki.tags.CookieTag

CORE - Static variable in interface org.apache.wiki.ui.admin.AdminBean

CORE_BUNDLE - Static variable in interface org.apache.wiki.i18n.InternationalizationManager

The name of the ResourceBundle which contains any and all JSPWiki core resource strings.

CoreBean - Class in org.apache.wiki.ui.admin.beans

An AdminBean which manages the JSPWiki core operations.

CoreBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.CoreBean

Counter - Class in org.apache.wiki.plugin

Provides a page-specific counter, it is reset every time a page is rendered, so it is not usable as a hitcounter.

Counter() - Constructor for class org.apache.wiki.plugin.Counter

create(Engine, HttpServletRequest, String) - Method in class org.apache.wiki.spi.ContextSPIDefaultImpl

create(Engine, HttpServletRequest, Command) - Method in class org.apache.wiki.spi.ContextSPIDefaultImpl

create(Engine, HttpServletRequest, Page) - Method in class org.apache.wiki.spi.ContextSPIDefaultImpl

create(Engine, Page) - Method in class org.apache.wiki.spi.ContextSPIDefaultImpl

CREATE_GROUP - Static variable in class org.apache.wiki.ui.WikiCommand

CREATE_GROUP - Static variable in class org.apache.wiki.WikiContext

User wishes to create a new group

CREATE_GROUPS - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

A static instance of the createGroups permission.

CREATE_GROUPS_ACTION - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Name of the action for createGroups permission.

CREATE_PAGES - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

A static instance of the createPages permission.

CREATE_PAGES_ACTION - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Name of the action for createPages permission.

createAdministrator() - Method in class org.apache.wiki.ui.Installer

Creates an administrative user and returns the new password.

CREATED - Static variable in class org.apache.wiki.ui.progress.ProgressItem

Status: The PI is created.

CREATED - Static variable in class org.apache.wiki.workflow.Workflow

State value: Workflow instantiated, but not started.

CreoleFilter - Class in org.apache.wiki.filters

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.

CreoleFilter() - Constructor for class org.apache.wiki.filters.CreoleFilter

CreoleRenderer - Class in org.apache.wiki.render

Implements DOM-to-Creole rendering.

CreoleRenderer(Context, WikiDocument) - Constructor for class org.apache.wiki.render.CreoleRenderer

Creates a new Creole Renderer.

CreoleToJSPWikiTranslator - Class in org.apache.wiki.parser

Translates Creole markp to JSPWiki markup.

CreoleToJSPWikiTranslator() - Constructor for class org.apache.wiki.parser.CreoleToJSPWikiTranslator

CsrfProtectionTag - Class in org.apache.wiki.tags

Outputs the hidden CsrfProtectionFilter.ANTICSRF_PARAM.

CsrfProtectionTag() - Constructor for class org.apache.wiki.tags.CsrfProtectionTag

CurrentTimePlugin - Class in org.apache.wiki.plugin

Just displays the current date and time.

CurrentTimePlugin() - Constructor for class org.apache.wiki.plugin.CurrentTimePlugin

CustomXMLOutputProcessor - Class in org.apache.wiki.render

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.

CustomXMLOutputProcessor() - Constructor for class org.apache.wiki.render.CustomXMLOutputProcessor

D

DATE - Enum constant in enum org.apache.wiki.preferences.Preferences.TimeFormat

A date format, no time.

DATETIME - Enum constant in enum org.apache.wiki.preferences.Preferences.TimeFormat

A date+time format.

decide(Decision, Outcome, Context) - Method in class org.apache.wiki.workflow.DecisionQueue

Attempts to complete a Decision by calling Decision.decide(Outcome, Context).

decide(Outcome, Context) - Method in class org.apache.wiki.workflow.Decision

Sets this Decision's outcome, and restarts the parent Workflow if it is in the Workflow.WAITING state and this Decision is its currently active Step.

Decision - Class in org.apache.wiki.workflow

AbstractStep subclass that asks an actor Principal to choose an Outcome on behalf of an owner (also a Principal).

Decision(int, Map<String, Serializable>, String, Principal, Outcome) - Constructor for class org.apache.wiki.workflow.Decision

Constructs a new Decision for a required "actor" Principal, having a default Outcome.

DECISION_ACKNOWLEDGE - Static variable in class org.apache.wiki.workflow.Outcome

Acknowlege the Decision.

DECISION_APPROVE - Static variable in class org.apache.wiki.workflow.Outcome

Approve the Decision (and complete the step).

DECISION_DENY - Static variable in class org.apache.wiki.workflow.Outcome

Deny the Decision (and complete the step).

DECISION_HOLD - Static variable in class org.apache.wiki.workflow.Outcome

Put the Decision on hold (and pause the step).

DECISION_REASSIGN - Static variable in class org.apache.wiki.workflow.Outcome

Reassign the Decision to another actor (and pause the step).

DecisionQueue - Class in org.apache.wiki.workflow

Keeps a queue of pending Decisions that need to be acted on by named Principals.

DecisionQueue() - Constructor for class org.apache.wiki.workflow.DecisionQueue

Constructs a new DecisionQueue.

DecisionRequiredException - Exception in org.apache.wiki.workflow

Exception thrown when an activity -- that would otherwise complete silently -- cannot complete because a workflow Decision is required.

DecisionRequiredException(String) - Constructor for exception org.apache.wiki.workflow.DecisionRequiredException

Constructs a new exception.

decisions() - Method in class org.apache.wiki.workflow.DecisionQueue

Protected method that returns all pending Decisions in the queue, in order of submission.

decodeName(String) - Method in class org.apache.wiki.WikiEngine

deepClone() - Method in class org.apache.wiki.WikiContext

Creates a deep clone of the WikiContext.

deepHashCode() - Method in class org.apache.wiki.references.DefaultReferenceManager

This 'deepHashCode' can be used to determine if there were any modifications made to the underlying to and by maps of the ReferenceManager.

DEF_TEMPLATE - Static variable in interface org.apache.wiki.i18n.InternationalizationManager

The name of the ResourceBundle which contains any and all JSPWiki default templates resource strings.

DEFAULT_AUTHORIZER - Static variable in interface org.apache.wiki.auth.AuthorizationManager

The default external Authorizer is the WebContainerAuthorizer

DEFAULT_DATE_FORMAT - Static variable in class org.apache.wiki.plugin.RecentChangesPlugin

DEFAULT_DATEFORMAT - Static variable in class org.apache.wiki.plugin.WeblogPlugin

The default date format used in the blog entry page names.

DEFAULT_DB_ATTRIBUTES - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_CREATED - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_EMAIL - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_FULL_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_JNDI_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_LOCK_EXPIRY - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_LOGIN_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_MODIFIED - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_PASSWORD - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_ROLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_ROLE_TABLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_TABLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_UID - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_DB_WIKI_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

DEFAULT_ENCODING - Static variable in class org.apache.wiki.providers.AbstractFileProvider

The default encoding.

DEFAULT_FORMAT - Static variable in class org.apache.wiki.tags.PageDateTag

DEFAULT_GROUPDB_CREATED - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores the the group creation timestamps.

DEFAULT_GROUPDB_CREATOR - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores group creator names.

DEFAULT_GROUPDB_DATASOURCE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores the JNDI name of the DataSource.

DEFAULT_GROUPDB_MEMBER - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores group member names.

DEFAULT_GROUPDB_MEMBER_TABLE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores the names of group members.

DEFAULT_GROUPDB_MODIFIED - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores group last-modified timestamps.

DEFAULT_GROUPDB_MODIFIER - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores names of users who last modified groups.

DEFAULT_GROUPDB_NAME - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default column name that stores the group names.

DEFAULT_GROUPDB_TABLE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Default table name for the table that stores groups.

DEFAULT_MAX_PROPKEYLENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

DEFAULT_MAX_PROPLIMIT - Static variable in class org.apache.wiki.providers.AbstractFileProvider

DEFAULT_MAX_PROPVALUELENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

DEFAULT_MAX_RESULTS - Static variable in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

DEFAULT_NAME - Static variable in class org.apache.wiki.plugin.Counter

DEFAULT_NOTE_IMAGE - Static variable in class org.apache.wiki.plugin.Note

The default name for the note.

DEFAULT_PACKAGE - Static variable in interface org.apache.wiki.plugin.PluginManager

This is the default package to try in case the instantiation fails.

DEFAULT_POLICY - Static variable in interface org.apache.wiki.auth.AuthorizationManager

Name of the default security policy file, in WEB-INF.

DEFAULT_SEARCHPROVIDER - Static variable in interface org.apache.wiki.search.SearchManager

DEFAULT_SETNAME - Static variable in class org.apache.wiki.plugin.Search

The default name of the result set.

DEFAULT_TEMPLATE - Static variable in interface org.apache.wiki.ui.TemplateManager

The name of the default template.

DEFAULT_TIME_FORMAT - Static variable in class org.apache.wiki.plugin.RecentChangesPlugin

DEFAULT_XMLFILE - Static variable in interface org.apache.wiki.filters.FilterManager

Default location for the filter XML property file.

DefaultAclManager - Class in org.apache.wiki.auth.acl

Default implementation that parses Acls from wiki page markup.

DefaultAclManager() - Constructor for class org.apache.wiki.auth.acl.DefaultAclManager

DefaultAdminBeanManager - Class in org.apache.wiki.ui.admin

Provides a manager class for all AdminBeans within JSPWiki.

DefaultAdminBeanManager(Engine) - Constructor for class org.apache.wiki.ui.admin.DefaultAdminBeanManager

DefaultAttachmentManager - Class in org.apache.wiki.attachment

Default implementation for AttachmentManager.

DefaultAttachmentManager(Engine, Properties) - Constructor for class org.apache.wiki.attachment.DefaultAttachmentManager

Creates a new AttachmentManager.

DefaultAuthenticationManager - Class in org.apache.wiki.auth

Default implementation for AuthenticationManager

DefaultAuthenticationManager() - Constructor for class org.apache.wiki.auth.DefaultAuthenticationManager

DefaultAuthorizationManager - Class in org.apache.wiki.auth

Default implementation for AuthorizationManager

DefaultAuthorizationManager() - Constructor for class org.apache.wiki.auth.DefaultAuthorizationManager

Constructs a new DefaultAuthorizationManager instance.

DefaultCommandResolver - Class in org.apache.wiki.ui

Default implementation for CommandResolver

DefaultCommandResolver(Engine, Properties) - Constructor for class org.apache.wiki.ui.DefaultCommandResolver

Constructs a CommandResolver for a given Engine.

DefaultDifferenceManager - Class in org.apache.wiki.diff

Load, initialize and delegate to the DiffProvider that will actually do the work.

DefaultDifferenceManager(Engine, Properties) - Constructor for class org.apache.wiki.diff.DefaultDifferenceManager

Creates a new DifferenceManager for the given engine.

DefaultEditorManager - Class in org.apache.wiki.ui

Defines an editor manager.

DefaultEditorManager(Engine) - Constructor for class org.apache.wiki.ui.DefaultEditorManager

DefaultFilterManager - Class in org.apache.wiki.filters

Manages the page filters.

DefaultFilterManager(Engine, Properties) - Constructor for class org.apache.wiki.filters.DefaultFilterManager

Constructs a new FilterManager object.

DefaultGroupManager - Class in org.apache.wiki.auth.authorize

Facade class for storing, retrieving and managing wiki groups on behalf of AuthorizationManager, JSPs and other presentation-layer classes.

DefaultGroupManager() - Constructor for class org.apache.wiki.auth.authorize.DefaultGroupManager

DefaultInternationalizationManager - Class in org.apache.wiki.i18n

Manages all internationalization in JSPWiki.

DefaultInternationalizationManager(Engine) - Constructor for class org.apache.wiki.i18n.DefaultInternationalizationManager

Constructs a new InternationalizationManager.

DefaultPageManager - Class in org.apache.wiki.pages

Manages the WikiPages.

DefaultPageManager(Engine, Properties) - Constructor for class org.apache.wiki.pages.DefaultPageManager

Creates a new PageManager.

DefaultPageRenamer - Class in org.apache.wiki.content

Provides page renaming functionality.

DefaultPageRenamer() - Constructor for class org.apache.wiki.content.DefaultPageRenamer

DefaultPluginManager - Class in org.apache.wiki.plugin

Manages plugin classes.

DefaultPluginManager(Engine, Properties) - Constructor for class org.apache.wiki.plugin.DefaultPluginManager

Create a new PluginManager.

DefaultPluginManager.WikiPluginInfo - Class in org.apache.wiki.plugin

Contains information about a bunch of plugins.

DefaultProgressManager - Class in org.apache.wiki.ui.progress

Manages progressing items.

DefaultProgressManager() - Constructor for class org.apache.wiki.ui.progress.DefaultProgressManager

Creates a new ProgressManager.

DefaultProgressManager.JSONTracker - Class in org.apache.wiki.ui.progress

Provides access to a progress indicator, assuming you know the ID.

DefaultReferenceManager - Class in org.apache.wiki.references

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.*.

DefaultReferenceManager(Engine) - Constructor for class org.apache.wiki.references.DefaultReferenceManager

Builds a new ReferenceManager.

DefaultRenderingManager - Class in org.apache.wiki.render

This class provides a facade towards the differing rendering routines.

DefaultRenderingManager() - Constructor for class org.apache.wiki.render.DefaultRenderingManager

DefaultRSSGenerator - Class in org.apache.wiki.rss

Default implementation for RSSGenerator.

DefaultRSSGenerator(Engine, Properties) - Constructor for class org.apache.wiki.rss.DefaultRSSGenerator

Builds the RSS generator for a given Engine.

DefaultSearchManager - Class in org.apache.wiki.search

Manages searching the Wiki.

DefaultSearchManager(Engine, Properties) - Constructor for class org.apache.wiki.search.DefaultSearchManager

Creates a new SearchManager.

DefaultSearchManager.JSONSearch - Class in org.apache.wiki.search

Provides a JSON AJAX API to the JSPWiki Search Engine.

DefaultTasksManager - Class in org.apache.wiki.tasks

Default implementation for TasksManager.

DefaultTasksManager() - Constructor for class org.apache.wiki.tasks.DefaultTasksManager

DefaultTemplateManager - Class in org.apache.wiki.ui

This class takes care of managing JSPWiki templates.

DefaultTemplateManager(Engine, Properties) - Constructor for class org.apache.wiki.ui.DefaultTemplateManager

Creates a new TemplateManager.

DefaultURLConstructor - Class in org.apache.wiki.url

Implements the default URL constructor using links directly to the JSP pages.

DefaultURLConstructor() - Constructor for class org.apache.wiki.url.DefaultURLConstructor

DefaultUserManager - Class in org.apache.wiki.auth

Default implementation for UserManager.

DefaultUserManager() - Constructor for class org.apache.wiki.auth.DefaultUserManager

DefaultUserManager.JSONUserModule - Class in org.apache.wiki.auth

Implements the JSON API for usermanager.

DefaultUserProfile - Class in org.apache.wiki.auth.user

Default implementation for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.

DefaultVariableManager - Class in org.apache.wiki.variables

Manages variables.

DefaultVariableManager(Properties) - Constructor for class org.apache.wiki.variables.DefaultVariableManager

Creates a VariableManager object using the property list given.

DefaultWorkflowManager - Class in org.apache.wiki.workflow

Monitor class that tracks running Workflows.

DefaultWorkflowManager() - Constructor for class org.apache.wiki.workflow.DefaultWorkflowManager

Constructs a new WorkflowManager, with an empty workflow cache.

delete(Group) - Method in interface org.apache.wiki.auth.authorize.GroupDatabase

Looks up and deletes a Group from the group database.

delete(Group) - Method in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Looks up and deletes a Group from the group database.

delete(Group) - Method in class org.apache.wiki.auth.authorize.XMLGroupDatabase

Looks up and deletes a Group from the group database.

DELETE - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Convenience constant that denotes GroupPermission( "*:*, "delete" ).

DELETE - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the delete permission.

DELETE - Static variable in class org.apache.wiki.ui.PageCommand

DELETE - Static variable in class org.apache.wiki.WikiContext

User is deleting a page or an attachment.

DELETE_ACTION - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Action for deleting a group or collection of groups.

DELETE_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the delete permission.

DELETE_GROUP - Static variable in class org.apache.wiki.ui.GroupCommand

GroupCommand for deleting a group.

DELETE_GROUP - Static variable in class org.apache.wiki.WikiContext

User is deleting an existing group.

deleteAttachment(Attachment) - Method in interface org.apache.wiki.attachment.AttachmentManager

Deletes all versions of the given attachment.

deleteAttachment(Attachment) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Deletes all versions of the given attachment.

deleteAttachment(Attachment) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

deleteAttachment(Attachment) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

deleteByLoginName(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op.

deleteByLoginName(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

Looks up and deletes the first UserProfile in the user database that matches a profile having a given login name.

deleteByLoginName(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and deletes the first UserProfile in the user database that matches a profile having a given login name.

deleteByLoginName(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and deletes the first UserProfile in the user database that matches a profile having a given login name.

deletePage(String) - Method in class org.apache.wiki.pages.DefaultPageManager

Deletes a page or an attachment completely, including all versions.

deletePage(String) - Method in interface org.apache.wiki.pages.PageManager

Deletes a page or an attachment completely, including all versions.

deletePage(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

deletePage(String) - Method in class org.apache.wiki.providers.CachingProvider

deletePage(String) - Method in class org.apache.wiki.providers.FileSystemProvider

deletePage(String) - Method in class org.apache.wiki.providers.VersioningFileProvider

Removes the relevant page directory under "OLD" -directory as well, but does not remove any extra subdirectories from it.

deletePage(Page) - Method in class org.apache.wiki.pages.DefaultPageManager

Deletes an entire page, all versions, all traces.

deletePage(Page) - Method in interface org.apache.wiki.pages.PageManager

Deletes an entire page, all versions, all traces.

deleteVersion(String, int) - Method in class org.apache.wiki.providers.AbstractFileProvider

deleteVersion(String, int) - Method in class org.apache.wiki.providers.CachingProvider

deleteVersion(String, int) - Method in class org.apache.wiki.providers.VersioningFileProvider

Deleting versions has never really worked, JSPWiki assumes that version histories are "not gappy".

deleteVersion(Attachment) - Method in interface org.apache.wiki.attachment.AttachmentManager

Deletes the given attachment version.

deleteVersion(Attachment) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Deletes the given attachment version.

deleteVersion(Attachment) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

deleteVersion(Attachment) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

deleteVersion(Page) - Method in class org.apache.wiki.pages.DefaultPageManager

Deletes only a specific version of a WikiPage.

deleteVersion(Page) - Method in interface org.apache.wiki.pages.PageManager

Deletes only a specific version of a WikiPage.

DELETION_END_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

DELETION_START_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

Denounce - Class in org.apache.wiki.plugin

Denounces a link by removing it from any search engine.

Denounce() - Constructor for class org.apache.wiki.plugin.Denounce

destroy() - Method in class org.apache.wiki.filters.DefaultFilterManager

Notifies PageFilters to clean up their ressources.

destroy() - Method in interface org.apache.wiki.filters.FilterManager

Notifies PageFilters to clean up their resources.

destroy() - Method in class org.apache.wiki.ui.WikiServletFilter

Destroys the WikiServletFilter.

destroy() - Method in class org.apache.wiki.WikiServlet

Destroys the WikiServlet; called by the servlet container when shutting down the webapp.

detectDuplicates(String) - Method in class org.apache.wiki.TranslationsCheck

diff(String, String) - Method in class org.apache.wiki.TranslationsCheck

DIFF - Static variable in class org.apache.wiki.ui.PageCommand

DIFF - Static variable in class org.apache.wiki.WikiContext

User is viewing a DIFF between the two versions of the page.

DIFF_END - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

DIFF_START - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

DifferenceManager - Interface in org.apache.wiki.diff

Load, initialize and delegate to the DiffProvider that will actually do the work.

DiffLinkTag - Class in org.apache.wiki.tags

Writes a diff link.

DiffLinkTag() - Constructor for class org.apache.wiki.tags.DiffLinkTag

DiffProvider - Interface in org.apache.wiki.diff

Provides an SPI for creating a diff between two page versions.

DiffProvider.NullDiffProvider - Class in org.apache.wiki.diff

If there is no diff provider set, this provider will work instead.

DIR_EXTENSION - Static variable in class org.apache.wiki.providers.BasicAttachmentProvider

The default extension for the page attachment directory name.

DIRECTORY - Static variable in interface org.apache.wiki.ui.TemplateManager

The default directory for the properties.

disable() - Method in class org.apache.wiki.WatchDog

Is used to disable a WatchDog.

disableAccessRules() - Method in class org.apache.wiki.parser.MarkupParser

Disables access rule parsing.

doAfterBody() - Method in class org.apache.wiki.tags.AttachmentsIteratorTag

doAfterBody() - Method in class org.apache.wiki.tags.HistoryIteratorTag

doAfterBody() - Method in class org.apache.wiki.tags.IteratorTag

doAfterBody() - Method in class org.apache.wiki.tags.PluginTag

doAfterBody() - Method in class org.apache.wiki.tags.SearchResultIteratorTag

doAfterBody() - Method in class org.apache.wiki.tags.TabbedSectionTag

The tabbed section iterates 3 time through the underlying Tab tags - first it identifies the default tab (displayed by default) - second it generates the tabmenu markup (displays all tab-titles) - finally it generates the content of each tab.

doAfterBody() - Method in class org.apache.wiki.tags.TranslateTag

doCatch(Throwable) - Method in class org.apache.wiki.tags.IteratorTag

In case your tag throws an exception at any point, you can override this method and implement a custom exception handler.

doCatch(Throwable) - Method in class org.apache.wiki.tags.WikiBodyTag

doCatch(Throwable) - Method in class org.apache.wiki.tags.WikiTagBase

doDelete(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.rpc.atom.AtomAPIServlet

doEndTag() - Method in class org.apache.wiki.tags.ContentTag

doEndTag() - Method in class org.apache.wiki.tags.CookieTag

doEndTag() - Method in class org.apache.wiki.tags.EditorTag

doEndTag() - Method in class org.apache.wiki.tags.IncludeTag

doEndTag() - Method in class org.apache.wiki.tags.IteratorTag

doEndTag() - Method in class org.apache.wiki.tags.LinkTag

doEndTag() - Method in class org.apache.wiki.tags.ParamTag

doEndTag() - Method in class org.apache.wiki.tags.PluginTag

doEndTag() - Method in class org.apache.wiki.tags.SearchResultIteratorTag

doEndTag() - Method in class org.apache.wiki.tags.TabbedSectionTag

doEndTag() - Method in class org.apache.wiki.tags.TabTag

doEndTag() - Method in class org.apache.wiki.tags.WikiLinkTag

doEndTag() - Method in class org.apache.wiki.tags.WikiTagBase

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.wiki.ui.WikiJSPFilter

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.wiki.ui.WikiServletFilter

Checks that the Engine is running ok, wraps the current HTTP request, and sets the correct authentication state for the users's Session.

doFinally() - Method in class org.apache.wiki.tags.IteratorTag

Executed after the tag has been finished.

doFinally() - Method in class org.apache.wiki.tags.TabTag

doFinally() - Method in class org.apache.wiki.tags.WikiBodyTag

doFinally() - Method in class org.apache.wiki.tags.WikiTagBase

doFullLuceneReindex() - Method in class org.apache.wiki.search.LuceneSearchProvider

Performs a full Lucene reindex, if necessary.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Calls WikiAjaxDispatcherServlet.performAction(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.attachment.AttachmentServlet

Serves a GET with two parameters: 'wikiname' specifying the wikiname of the attachment, 'version' specifying the version indicator.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.rpc.atom.AtomAPIServlet

Handles HTTP GET.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.WikiServlet

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.xmlrpc.RPCServlet

Handles HTTP GET.

doGet(Context) - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

By default, this method creates a blob of HTML, listing all the attributes which can be read or written to.

doGet(Context) - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

doGet(Context) - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

doGet(Context) - Method in class org.apache.wiki.ui.admin.SimpleAdminBean

By default, this method creates a blob of HTML, listing all the attributes which can be read or written to.

doGet(Context) - Method in class org.apache.wiki.ui.admin.WikiFormAdminBean

doGet(Context) - Method in interface org.apache.wiki.ui.GenericHTTPHandler

Return basic HTML.

doInitBody() - Method in class org.apache.wiki.tags.LinkTag

doJAASLogin(Class<? extends LoginModule>, CallbackHandler, Map<String, String>) - Method in interface org.apache.wiki.auth.AuthenticationManager

Instantiates and executes a single JAAS LoginModule, and returns a Set of Principals that results from a successful login.

doJAASLogin(Class<? extends LoginModule>, CallbackHandler, Map<String, String>) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Instantiates and executes a single JAAS LoginModule, and returns a Set of Principals that results from a successful login.

doOptions(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.attachment.AttachmentServlet

Implements the OPTIONS method.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Calls WikiAjaxDispatcherServlet.performAction(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.attachment.AttachmentServlet

Grabs mime/multipart data and stores it into the temporary area.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.rpc.atom.AtomAPIServlet

Implements the PostURI of the Atom spec.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.WikiServlet

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.xmlrpc.RPCServlet

Handle HTTP POST.

doPost(Context) - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

doPost(Context) - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

doPost(Context) - Method in class org.apache.wiki.ui.admin.beans.UserBean

doPost(Context) - Method in class org.apache.wiki.ui.admin.SimpleAdminBean

Not implemented yet.

doPost(Context) - Method in interface org.apache.wiki.ui.GenericHTTPHandler

Handles a POST response.

doPostSaveFiltering(Context, String) - Method in class org.apache.wiki.filters.DefaultFilterManager

Does the page filtering after the page has been saved.

doPostSaveFiltering(Context, String) - Method in interface org.apache.wiki.filters.FilterManager

Does the page filtering after the page has been saved.

doPostTranslateFiltering(Context, String) - Method in class org.apache.wiki.filters.DefaultFilterManager

Does the filtering after HTML translation.

doPostTranslateFiltering(Context, String) - Method in interface org.apache.wiki.filters.FilterManager

Does the filtering after HTML translation.

doPreSaveFiltering(Context, String) - Method in class org.apache.wiki.filters.DefaultFilterManager

Does the filtering before a save to the page repository.

doPreSaveFiltering(Context, String) - Method in interface org.apache.wiki.filters.FilterManager

Does the filtering before a save to the page repository.

doPreTranslateFiltering(Context, String) - Method in class org.apache.wiki.filters.DefaultFilterManager

Does the filtering before a translation.

doPreTranslateFiltering(Context, String) - Method in interface org.apache.wiki.filters.FilterManager

Does the filtering before a translation.

doPut(HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.rpc.atom.AtomAPIServlet

doReplacement(String, String) - Method in class org.apache.wiki.url.DefaultURLConstructor

Does replacement of some particular variables.

doStartTag() - Method in class org.apache.wiki.tags.AttachmentsIteratorTag

doStartTag() - Method in class org.apache.wiki.tags.EditorIteratorTag

doStartTag() - Method in class org.apache.wiki.tags.HistoryIteratorTag

doStartTag() - Method in class org.apache.wiki.tags.IteratorTag

doStartTag() - Method in class org.apache.wiki.tags.SearchResultIteratorTag

doStartTag() - Method in class org.apache.wiki.tags.TabbedSectionTag

doStartTag() - Method in class org.apache.wiki.tags.WikiBodyTag

doStartTag() - Method in class org.apache.wiki.tags.WikiTagBase

doWikiStartTag() - Method in class org.apache.wiki.tags.AuthorTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.BaseURLTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.BreadcrumbsTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CalendarTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CheckLockTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CheckRequestContextTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CheckVersionTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CommentLinkTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.ContentEncodingTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.ContentTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.CsrfProtectionTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.DiffLinkTag

doWikiStartTag() - Method in class org.apache.wiki.tags.EditLinkTag

doWikiStartTag() - Method in class org.apache.wiki.tags.EditorTag

doWikiStartTag() - Method in class org.apache.wiki.tags.FeedDiscoveryTag

doWikiStartTag() - Method in class org.apache.wiki.tags.HasAttachmentsTag

doWikiStartTag() - Method in class org.apache.wiki.tags.IfNoSearchResultsTag

doWikiStartTag() - Method in class org.apache.wiki.tags.IncludeResourcesTag

doWikiStartTag() - Method in class org.apache.wiki.tags.IncludeTag

doWikiStartTag() - Method in class org.apache.wiki.tags.InsertDiffTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.InsertPageTag

doWikiStartTag() - Method in class org.apache.wiki.tags.LinkTag

doWikiStartTag() - Method in class org.apache.wiki.tags.LinkToParentTag

doWikiStartTag() - Method in class org.apache.wiki.tags.LinkToTag

doWikiStartTag() - Method in class org.apache.wiki.tags.MessagesTag

doWikiStartTag() - Method in class org.apache.wiki.tags.NextVersionTag

doWikiStartTag() - Method in class org.apache.wiki.tags.NoSuchPageTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageDateTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageExistsTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageInfoLinkTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageNameTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageSizeTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageTypeTag

doWikiStartTag() - Method in class org.apache.wiki.tags.PageVersionTag

doWikiStartTag() - Method in class org.apache.wiki.tags.ParentPageNameTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.PermissionTag

Initializes the tag.

doWikiStartTag() - Method in class org.apache.wiki.tags.PluginTag

A local stub for doing tags.

doWikiStartTag() - Method in class org.apache.wiki.tags.PreviousVersionTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.RequestResourceTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.RSSImageLinkTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.SearchResultsSizeTag

doWikiStartTag() - Method in class org.apache.wiki.tags.SearchResultsTag

doWikiStartTag() - Method in class org.apache.wiki.tags.SetPaginationTag

doWikiStartTag() - Method in class org.apache.wiki.tags.SpamFilterInputsTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.TabTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.TemplateDirTag

doWikiStartTag() - Method in class org.apache.wiki.tags.UploadLinkTag

doWikiStartTag() - Method in class org.apache.wiki.tags.UserCheckTag

This method is allowed to do pretty much whatever he wants.

doWikiStartTag() - Method in class org.apache.wiki.tags.UserNameTag

doWikiStartTag() - Method in class org.apache.wiki.tags.UserProfileTag

doWikiStartTag() - Method in class org.apache.wiki.tags.VariableTag

doWikiStartTag() - Method in class org.apache.wiki.tags.WikiBodyTag

A local stub for doing tags.

doWikiStartTag() - Method in class org.apache.wiki.tags.WikiTagBase

This method is allowed to do pretty much whatever he wants.

DummyUserDatabase - Class in org.apache.wiki.auth.user

This is a database that gets used if nothing else is available.

DummyUserDatabase() - Constructor for class org.apache.wiki.auth.user.DummyUserDatabase

DuplicateUserException - Exception in org.apache.wiki.auth.user

Exception indicating that an identical user already exists in the user database.

DuplicateUserException(String) - Constructor for exception org.apache.wiki.auth.user.DuplicateUserException

DuplicateUserException(String, Object...) - Constructor for exception org.apache.wiki.auth.user.DuplicateUserException

DynamicAttachment - Class in org.apache.wiki.attachment

A DynamicAttachment is an attachment which does not really exist, but is created dynamically by a JSPWiki component.

DynamicAttachment(Engine, String, String, DynamicAttachmentProvider) - Constructor for class org.apache.wiki.attachment.DynamicAttachment

Creates a DynamicAttachment.

DynamicAttachmentProvider - Interface in org.apache.wiki.attachment

Provides the data for an attachment.

E

EDIT - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Convenience constant that denotes GroupPermission( "*:*, "edit" ).

EDIT - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the edit permission.

EDIT - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

EDIT - Static variable in class org.apache.wiki.ui.PageCommand

EDIT - Static variable in class org.apache.wiki.WikiContext

The EDIT context - the user is editing the page.

EDIT_ACTION - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Action for editing a group or collection of groups.

EDIT_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the edit permission.

EDIT_GROUP - Static variable in class org.apache.wiki.ui.GroupCommand

GroupCommand for editing a group.

EDIT_GROUP - Static variable in class org.apache.wiki.WikiContext

User is editing an existing group.

EDIT_PREFERENCES - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

A static instance of the editPreferences permission.

EDIT_PREFERENCES_ACTION - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Name of the action for editPreferences permission.

EDIT_PROFILE - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

A static instance of the editProfile permission.

EDIT_PROFILE_ACTION - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Name of the action for editProfile permission.

EditLinkTag - Class in org.apache.wiki.tags

Writes an edit link.

EditLinkTag() - Constructor for class org.apache.wiki.tags.EditLinkTag

Editor - Class in org.apache.wiki.ui

Describes an editor.

Editor(Context, String) - Constructor for class org.apache.wiki.ui.Editor

EDITOR - Static variable in interface org.apache.wiki.ui.admin.AdminBean

EDITOR_PLAIN - Static variable in interface org.apache.wiki.ui.EditorManager

Known name for the plain wikimarkup editor.

EDITOR_PREVIEW - Static variable in interface org.apache.wiki.ui.EditorManager

Known name for the preview editor component.

EditorIteratorInfo - Class in org.apache.wiki.tags

Just provides the TEI data for EditorIteratorTag.

EditorIteratorInfo() - Constructor for class org.apache.wiki.tags.EditorIteratorInfo

EditorIteratorTag - Class in org.apache.wiki.tags

Iterates through editors.

EditorIteratorTag() - Constructor for class org.apache.wiki.tags.EditorIteratorTag

EditorManager - Interface in org.apache.wiki.ui

Defines an editor manager.

EditorTag - Class in org.apache.wiki.tags

Creates an editor component with all the necessary parts to get it working.

EditorTag() - Constructor for class org.apache.wiki.tags.EditorTag

ELEMENT - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

The token is a wikimarkup element.

elements() - Method in class org.apache.wiki.auth.permissions.AllPermissionCollection

Returns an enumeration of all AllPermission objects stored in this collection.

ELIDED_HEAD_INDICATOR_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

ELIDED_TAIL_INDICATOR_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

EMAIL - Static variable in class org.apache.wiki.ui.InputValidator

Input validator for e-mail addresses.

EMPTY - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

EMPTY_MAP - Static variable in class org.apache.wiki.auth.DefaultAuthenticationManager

Empty Map passed to JAAS DefaultAuthenticationManager.doJAASLogin(Class, CallbackHandler, Map) method.

enable() - Method in class org.apache.wiki.WatchDog

Can be used to enable the WatchDog.

enableImageInlining(boolean) - Method in class org.apache.wiki.parser.MarkupParser

Use this to turn on or off image inlining.

enablePlugins(boolean) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Enables or disables plugin execution.

enablePlugins(boolean) - Method in interface org.apache.wiki.plugin.PluginManager

Enables or disables plugin execution.

encodeName(String) - Method in class org.apache.wiki.WikiEngine

encodeWikiPage(Page) - Method in class org.apache.wiki.xmlrpc.AbstractRPCHandler

encodeWikiPage(Page) - Method in class org.apache.wiki.xmlrpc.RPCHandler

Encodes a single wiki page info into a Hashtable.

encodeWikiPage(Page) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

Encodes a single wiki page info into a Hashtable.

EngineSPIDefaultImpl - Class in org.apache.wiki.spi

Default implementation for EngineSPI

EngineSPIDefaultImpl() - Constructor for class org.apache.wiki.spi.EngineSPIDefaultImpl

enterState(String) - Method in class org.apache.wiki.WatchDog

Enters a watched state with no expectation of the expected completion time.

enterState(String, int) - Method in class org.apache.wiki.WatchDog

Enters a watched state which has an expected completion time.

entries() - Method in interface org.apache.wiki.auth.acl.Acl

Deprecated.

use Acl.aclEntries() instead.

entry() - Method in class org.apache.wiki.spi.AclsSPIDefaultImpl

Entry - Class in org.apache.wiki.rss

Represents an entry, that is, an unit of change, in a Feed.

Entry() - Constructor for class org.apache.wiki.rss.Entry

equals(Object) - Method in class org.apache.wiki.auth.acl.UnresolvedPrincipal

An unresolved principal is equal to another unresolved principal if their names match.

equals(Object) - Method in class org.apache.wiki.auth.authorize.Group

Two DefaultGroups are equal if they contain identical member Principals and have the same name.

equals(Object) - Method in class org.apache.wiki.auth.authorize.Role

Two Role objects are considered equal if their names are identical.

equals(Object) - Method in class org.apache.wiki.auth.GroupPrincipal

Two GroupPrincipals are equal if their names are equal.

equals(Object) - Method in class org.apache.wiki.auth.login.PrincipalWrapper

Two PrincipalWrapper objects are equal if their internally-wrapped principals are also equal.

equals(Object) - Method in class org.apache.wiki.auth.permissions.AllPermission

Two AllPermission objects are considered equal if their wikis are equal.

equals(Object) - Method in class org.apache.wiki.auth.permissions.GroupPermission

Two PagePermission objects are considered equal if their actions (after normalization), wiki and target are equal.

equals(Object) - Method in class org.apache.wiki.auth.permissions.PagePermission

Two PagePermission objects are considered equal if their actions (after normalization), wiki and target are equal.

equals(Object) - Method in class org.apache.wiki.auth.permissions.WikiPermission

Two WikiPermission objects are considered equal if their wikis and actions (after normalization) are equal.

equals(Object) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

equals(Object) - Method in class org.apache.wiki.auth.WikiPrincipal

Two WikiPrincipals are considered equal if their names are equal (case-sensitive).

equals(Object) - Method in class org.apache.wiki.modules.WikiModuleInfo

The WikiModuleInfo is equal to another WikiModuleInfo, if the name is equal.

equals(Object) - Method in class org.apache.wiki.pages.PageSorter

equals(Object) - Method in class org.apache.wiki.WikiPage

A page is equal to another page if its name and version are equal.

equals(Object) - Method in class org.apache.wiki.workflow.Fact

Two Facts are considered equal if their message keys and value objects are equal.

equals(Object) - Method in class org.apache.wiki.workflow.Outcome

Two Outcome objects are equal if their message keys are equal.

ERR_NOPAGE - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

Error code: no such page.

ERR_NOPERMISSION - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

ERROR - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message prefix for errors.

ERROR - Static variable in class org.apache.wiki.forms.FormInfo

State: There was an error.

ERROR - Static variable in class org.apache.wiki.ui.WikiCommand

ERROR - Static variable in class org.apache.wiki.WikiContext

An error has been encountered and the user needs to be informed.

ERROR_DB - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for user database errors.

ERROR_GROUPS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for group database errors.

ERROR_JAAS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for JAAS errors.

ERROR_POLICY - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for policy errors.

ERROR_ROLES - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for role-checking errors.

execute(Context) - Method in class org.apache.wiki.tasks.auth.SaveUserProfileTask

Saves the user profile to the user database.

execute(Context) - Method in class org.apache.wiki.tasks.pages.PreSaveWikiPageTask

Executes the processing for this Step and returns an Outcome indicating if it succeeded (Outcome.STEP_COMPLETE or Outcome.STEP_ABORT).

execute(Context) - Method in class org.apache.wiki.tasks.pages.SaveWikiPageTask

Executes the processing for this Step and returns an Outcome indicating if it succeeded (Outcome.STEP_COMPLETE or Outcome.STEP_ABORT).

execute(Context) - Method in class org.apache.wiki.workflow.AbstractStep

Executes the processing for this Step and returns an Outcome indicating if it succeeded (Outcome.STEP_COMPLETE or Outcome.STEP_ABORT).

execute(Context) - Method in class org.apache.wiki.workflow.Decision

Default implementation that always returns Outcome.STEP_CONTINUE if the current Outcome isn't a completion (which will be true if the Decision.decide(Outcome, Context) method hasn't been executed yet.

execute(Context) - Method in interface org.apache.wiki.workflow.Step

Executes the processing for this Step and returns an Outcome indicating if it succeeded (Outcome.STEP_COMPLETE or Outcome.STEP_ABORT).

execute(Context, String) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Parses a plugin.

execute(Context, String) - Method in interface org.apache.wiki.plugin.PluginManager

Parses a plugin.

execute(Context, String, Map<String, String>) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Executes a plugin class in the given context.

execute(Context, String, Map<String, String>) - Method in interface org.apache.wiki.plugin.PluginManager

Executes a plugin class in the given context.

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormClose

Builds a Form close tag.

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormInput

Generates a dynamic form element on the WikiPage.

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormOpen

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormOutput

Executes the FormHandler specified in a Form 'output' plugin, using entries provided in the HttpRequest as FormHandler parameters.

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormSelect

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormSet

execute(Context, Map<String, String>) - Method in class org.apache.wiki.forms.FormTextarea

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.BugReportHandler

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Counter

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.CurrentTimePlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Denounce

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Groups

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.IfPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Image

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.IndexPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.InsertPage

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.ListLocksPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Note

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.PageViewPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.PageViewPlugin.PageViewManager

Count a page hit, present a pages' counter or output a list of page counts.

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.RecentChangesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.ReferredPagesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.ReferringPagesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.ReferringUndefinedPagesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.SampleAjaxPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.Search

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.SessionsPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.TableOfContents

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.UndefinedPagesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.UnusedPagesPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.WeblogArchivePlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.WeblogEntryPlugin

execute(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.WeblogPlugin

EXECUTED - Static variable in class org.apache.wiki.forms.FormInfo

State: Form is executed.

executeParse(Context) - Method in class org.apache.wiki.parser.PluginContent

executeParser(PluginElement, Context, Map<String, String>) - Method in class org.apache.wiki.plugin.WeblogPlugin

Mark us as being a real weblog.

executeUpload(Context, InputStream, String, String, String, String, long) - Method in class org.apache.wiki.attachment.AttachmentServlet

exitState() - Method in class org.apache.wiki.WatchDog

Exits a state entered with enterState().

exitState(String) - Method in class org.apache.wiki.WatchDog

Exits a particular state entered with enterState().

expandVariables(Context, String) - Method in class org.apache.wiki.variables.DefaultVariableManager

This method does in-place expansion of any variables.

expandVariables(Context, String) - Method in interface org.apache.wiki.variables.VariableManager

This method does in-place expansion of any variables.

EXTERNAL - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

ExternalDiffProvider - Class in org.apache.wiki.diff

This DiffProvider allows external command line tools to be used to generate the diff.

ExternalDiffProvider() - Constructor for class org.apache.wiki.diff.ExternalDiffProvider

Creates a new ExternalDiffProvider.

extractCommandFromPath(HttpServletRequest) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Extracts a Command based on the JSP path of an HTTP request.

extractMembers(String) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Extracts carriage-return separated members into a Set of String objects.

extractPageFromParameter(String, HttpServletRequest) - Method in interface org.apache.wiki.ui.CommandResolver

Determines the correct wiki page based on a supplied request context and HTTP request.

extractPageFromParameter(String, HttpServletRequest) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Determines the correct wiki page based on a supplied request context and HTTP request.

F

Fact - Class in org.apache.wiki.workflow

Represents a contextual artifact, which can be any serializable object, useful for making a Decision.

Fact(String, Serializable) - Constructor for class org.apache.wiki.workflow.Fact

Constructs a new Fact with a supplied message key and value.

FastSearch - Interface in org.apache.wiki.providers

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.

Feed - Class in org.apache.wiki.rss

Represents an abstract feed.

Feed(Context) - Constructor for class org.apache.wiki.rss.Feed

Create a new Feed for a particular WikiContext.

FeedDiscoveryTag - Class in org.apache.wiki.tags

Outputs links to all the site feeds and APIs this Wiki/blog supports.

FeedDiscoveryTag() - Constructor for class org.apache.wiki.tags.FeedDiscoveryTag

FILE_EXT - Static variable in class org.apache.wiki.providers.AbstractFileProvider

All files should have this extension to be recognized as JSPWiki files.

FileSystemProvider - Class in org.apache.wiki.providers

Provides a simple directory based repository for Wiki pages.

FileSystemProvider() - Constructor for class org.apache.wiki.providers.FileSystemProvider

filterAndSortCollection(Collection<String>) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

Filters and sorts a collection according to the include and exclude parameters.

FilterBean - Class in org.apache.wiki.ui.admin.beans

FilterBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.FilterBean

filterCollection(Collection<String>) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

Filters a collection according to the include and exclude parameters.

FilterManager - Interface in org.apache.wiki.filters

filterWikiPageCollection(Collection<Page>) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

find(String) - Method in class org.apache.wiki.auth.SessionMonitor

Looks up the wiki session associated with a user's Http session and adds it to the session cache.

find(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up and returns the first UserProfile in the user database that whose login name, full name, or wiki name matches the supplied string.

find(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that whose login name, full name, or wiki name matches the supplied string.

find(HttpSession) - Method in class org.apache.wiki.auth.SessionMonitor

Looks up the wiki session associated with a user's Http session and adds it to the session cache.

find(ServletContext, Properties) - Method in class org.apache.wiki.spi.EngineSPIDefaultImpl

find(Engine, HttpServletRequest) - Method in class org.apache.wiki.spi.SessionSPIDefaultImpl

FIND - Static variable in class org.apache.wiki.ui.WikiCommand

FIND - Static variable in class org.apache.wiki.WikiContext

User is searching for content.

findAttachments(QueryItem[]) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

findAttachments(QueryItem[]) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

findBean(String) - Method in interface org.apache.wiki.ui.admin.AdminBeanManager

Locates a bean based on the AdminBean.getId() out of all the registered beans.

findBean(String) - Method in class org.apache.wiki.ui.admin.DefaultAdminBeanManager

findBlogEntries(Engine, String, Date, Date) - Method in class org.apache.wiki.plugin.WeblogPlugin

Attempts to locate all pages that correspond to the blog entry pattern.

findBy(String, String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

findByEmail(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given e-mail address.

findByEmail(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

findByEmail(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

findByEmail(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given e-mail address.

findByEmail(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given e-mail address.

findByFullName(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given full name.

findByFullName(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

findByFullName(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

findByFullName(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given full name.

findByFullName(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given full name.

findByLoginName(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given login name.

findByLoginName(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

findByLoginName(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

findByLoginName(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given login name.

findByLoginName(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given login name.

findByUid(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

findByUid(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

findByUid(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given unique ID (uid).

findByUid(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given unique ID (uid).

findByWikiName(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given wiki name.

findByWikiName(String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

findByWikiName(String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

findByWikiName(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given wiki name.

findByWikiName(String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Looks up and returns the first UserProfile in the user database that matches a profile having a given wiki name.

findCommand(String) - Static method in interface org.apache.wiki.ui.CommandResolver

Attempts to locate a wiki command for a supplied request context.

findCommand(HttpServletRequest, String) - Method in interface org.apache.wiki.ui.CommandResolver

Attempts to locate a Command for a supplied wiki context and HTTP request, incorporating the correct WikiPage into the command if required.

findCommand(HttpServletRequest, String) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Attempts to locate a Command for a supplied wiki context and HTTP request, incorporating the correct WikiPage into the command if required.

findCommand(Engine, HttpServletRequest, Page) - Static method in class org.apache.wiki.WikiContext

Looks up and returns a PageCommand based on a supplied WikiPage and HTTP request.

findContext(PageContext) - Static method in class org.apache.wiki.WikiContext

Deprecated.

use Context.findContext(PageContext) instead.

findCreated() - Method in class org.apache.wiki.references.DefaultReferenceManager

Returns a list of all pages that the ReferenceManager knows about.

findCreated() - Method in interface org.apache.wiki.references.ReferenceManager

Returns a list of all pages that the ReferenceManager knows about.

findJSP(PageContext, String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

A utility method for finding a JSP page.

findJSP(PageContext, String) - Method in interface org.apache.wiki.ui.TemplateManager

A utility method for finding a JSP page.

findJSP(PageContext, String, String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

Attempts to locate a resource under the given template.

findJSP(PageContext, String, String) - Method in interface org.apache.wiki.ui.TemplateManager

Attempts to locate a resource under the given template.

findPage(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

Finds a Wiki page from the page repository.

findPages(String, int, Context) - Method in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

Performs a full search of pages.

findPages(String, int, Context) - Method in class org.apache.wiki.search.LuceneSearchProvider

Searches pages using a particular combination of flags.

findPages(String, Context) - Method in class org.apache.wiki.search.BasicSearchProvider

Search for pages matching a search query.

findPages(String, Context) - Method in class org.apache.wiki.search.LuceneSearchProvider

Search for pages matching a search query.

findPages(String, Context) - Method in interface org.apache.wiki.search.SearchManager

Sends a search to the current search provider.

findPages(String, Context) - Method in interface org.apache.wiki.search.SearchProvider

Search for pages matching a search query.

findPages(QueryItem[]) - Method in class org.apache.wiki.providers.AbstractFileProvider

Iterates through all WikiPages, matches them against the given query, and returns a Collection of SearchResult objects.

findPages(QueryItem[]) - Method in class org.apache.wiki.providers.CachingProvider

findPrincipals(Permission) - Method in class org.apache.wiki.auth.acl.AclImpl

findReferredBy(String) - Method in class org.apache.wiki.references.DefaultReferenceManager

Returns all pages that refer to this page.

findReferredBy(String) - Method in interface org.apache.wiki.references.ReferenceManager

Returns all pages that refer to this page.

findReferrers(String) - Method in class org.apache.wiki.references.DefaultReferenceManager

Find all pages that refer to this page.

findReferrers(String) - Method in interface org.apache.wiki.references.ReferenceManager

Find all pages that refer to this page.

findRefersTo(String) - Method in class org.apache.wiki.references.DefaultReferenceManager

Returns all pages that this page refers to.

findRefersTo(String) - Method in interface org.apache.wiki.references.ReferenceManager

Returns all pages that this page refers to.

findResource(Context, String, String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

Attempts to locate a resource under the given template.

findResource(Context, String, String) - Method in interface org.apache.wiki.ui.TemplateManager

Attempts to locate a resource under the given template.

findRole(String) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Looks up and returns a role Principal matching a given String.

findRole(String) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Looks up and returns a Role Principal matching a given String.

findRole(String) - Method in interface org.apache.wiki.auth.Authorizer

Looks up and returns a role Principal matching a given String.

findServletByName(String) - Method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Find the WikiAjaxServlet given the servletAlias that it was registered with.

findUncreated() - Method in class org.apache.wiki.references.DefaultReferenceManager

Finds all references to non-existant pages.

findUncreated() - Method in interface org.apache.wiki.references.ReferenceManager

Finds all references to non-existant pages.

findUnreferenced() - Method in class org.apache.wiki.references.DefaultReferenceManager

Finds all unreferenced pages.

findUnreferenced() - Method in interface org.apache.wiki.references.ReferenceManager

Finds all unreferenced pages.

FINISHED - Static variable in class org.apache.wiki.ui.progress.ProgressItem

Status: The PI is finished.

fireEvent(int) - Method in class org.apache.wiki.WikiEngine

Fires a WikiEngineEvent to all registered listeners.

fireEvent(int, Object) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Fires a WikiSecurityEvent of the provided type, Principal and target Object to all registered listeners.

fireEvent(int, String) - Method in class org.apache.wiki.pages.DefaultPageManager

Fires a WikiPageEvent of the provided type and page name to all registered listeners.

fireEvent(int, String) - Method in class org.apache.wiki.ui.WikiJSPFilter

Fires a WikiPageEvent of the provided type and page name to all registered listeners of the current Engine.

fireEvent(int, Principal, Object) - Method in interface org.apache.wiki.auth.AuthenticationManager

Fires a WikiSecurityEvent of the provided type, Principal and target Object to all registered listeners.

fireEvent(int, Principal, Object) - Method in interface org.apache.wiki.auth.AuthorizationManager

Fires a WikiSecurityEvent of the provided type, user, and permission to all registered listeners.

fireEvent(int, Principal, Session) - Method in class org.apache.wiki.auth.SessionMonitor

Fires a WikiSecurityEvent to all registered listeners.

fireEvent(int, Context) - Method in class org.apache.wiki.filters.DefaultFilterManager

Fires a WikiPageEvent of the provided type and WikiContext.

fireEvent(int, Context) - Method in class org.apache.wiki.filters.PageEventFilter

Fires a WikiPageEvent of the provided type and page name to all registered listeners.

fireEvent(int, Session, Object) - Method in interface org.apache.wiki.auth.UserManager

Fires a WikiSecurityEvent of the provided type, Principal and target Object to all registered listeners.

firePageEvent(int, String) - Method in class org.apache.wiki.WikiEngine

Fires a WikiPageEvent to all registered listeners.

firePageRenameEvent(String, String) - Method in class org.apache.wiki.content.DefaultPageRenamer

Fires a WikiPageRenameEvent to all registered listeners.

firePageRenameEvent(String, String) - Method in interface org.apache.wiki.content.PageRenamer

Fires a WikiPageRenameEvent to all registered listeners.

FLAG_CONTEXTS - Static variable in class org.apache.wiki.search.LuceneSearchProvider

Create contexts also.

forceDownload(String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Check if attachement link should force a download iso opening the attachment in the browser.

forceDownload(String) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Check if attachement link should force a download iso opening the attachment in the browser.

FORM_VALUES_CARRIER - Static variable in class org.apache.wiki.forms.FormElement

The submit servlet may decide to store a FormInfo with user-entered form values in the Session.

format(String) - Static method in class org.apache.wiki.rss.Feed

Does the required formatting and entity replacement for XML.

format(String) - Static method in interface org.apache.wiki.rss.RSSGenerator

Does the required formatting and entity replacement for XML.

FormClose - Class in org.apache.wiki.forms

Closes a WikiForm.

FormClose() - Constructor for class org.apache.wiki.forms.FormClose

FormElement - Class in org.apache.wiki.forms

FormElement() - Constructor for class org.apache.wiki.forms.FormElement

FormHandler - Interface in org.apache.wiki.forms

A FormHandler performs logic based on input from an HTTP FORM, transmitted through a JSPWiki WikiPlugin (see Form.java).

FormInfo - Class in org.apache.wiki.forms

Container for carrying HTTP FORM information between Plugin invocations in the Session.

FormInfo() - Constructor for class org.apache.wiki.forms.FormInfo

Creates a new FormInfo with status == OK.

FormInput - Class in org.apache.wiki.forms

Creates a simple input text field.

FormInput() - Constructor for class org.apache.wiki.forms.FormInput

FormOpen - Class in org.apache.wiki.forms

Opens a WikiForm.

FormOpen() - Constructor for class org.apache.wiki.forms.FormOpen

FormOutput - Class in org.apache.wiki.forms

FormOutput() - Constructor for class org.apache.wiki.forms.FormOutput

FormSelect - Class in org.apache.wiki.forms

Creates a Form select field.

FormSelect() - Constructor for class org.apache.wiki.forms.FormSelect

FormSet - Class in org.apache.wiki.forms

FormSet is a companion WikiPlugin for Form.

FormSet() - Constructor for class org.apache.wiki.forms.FormSet

FormTextarea - Class in org.apache.wiki.forms

Creates a Form text area element.

FormTextarea() - Constructor for class org.apache.wiki.forms.FormTextarea

forName(String) - Static method in class org.apache.wiki.workflow.Outcome

Returns a named Outcome.

FULL_NAME - Static variable in class org.apache.wiki.auth.WikiPrincipal

WikiPrincipal type denoting a user's full name.

G

generate() - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Generates the RSS resource.

generate() - Method in interface org.apache.wiki.rss.RSSGenerator

Generates the RSS resource.

generateBlogRSS(Context, List<Page>, Feed) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).

generateBlogRSS(Context, List<Page>, Feed) - Method in interface org.apache.wiki.rss.RSSGenerator

Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).

generateFeed(Context, List<Page>, String, String) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Generates a feed based on a context and list of changes.

generateFeed(Context, List<Page>, String, String) - Method in interface org.apache.wiki.rss.RSSGenerator

Generates a feed based on a context and list of changes.

generateFullWikiRSS(Context, Feed) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Generates an RSS feed for the entire wiki.

generateFullWikiRSS(Context, Feed) - Method in interface org.apache.wiki.rss.RSSGenerator

Generates an RSS feed for the entire wiki.

generateUid(UserDatabase) - Static method in class org.apache.wiki.auth.user.AbstractUserDatabase

Generates a new random user identifier (uid) that is guaranteed to be unique.

generateWikiPageRSS(Context, List<Page>, Feed) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).

generateWikiPageRSS(Context, List<Page>, Feed) - Method in interface org.apache.wiki.rss.RSSGenerator

Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).

GenericHTTPHandler - Interface in org.apache.wiki.ui

Provides a generic HTTP handler interface.

get() - Static method in interface org.apache.wiki.ui.AllCommands

Returns a defensively-created array of all static Commands.

get(String) - Method in interface org.apache.wiki.i18n.InternationalizationManager

Returns a String from the CORE_BUNDLE using English as the default locale.

get(String, Locale, String) - Method in interface org.apache.wiki.i18n.InternationalizationManager

If you are too lazy to open your own bundle, use this method to get a string simply from a bundle.

get(String, Locale, String, Object...) - Method in interface org.apache.wiki.i18n.InternationalizationManager

Obtain a parameterized String from the bundle.

getAcl() - Method in class org.apache.wiki.WikiPage

Returns the Acl for this page.

getAclEntry(Principal) - Method in class org.apache.wiki.auth.acl.AclImpl

getAclManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( AclManager.class ) instead.

getAcquisitionTime() - Method in class org.apache.wiki.pages.PageLock

Returns the timestamp on which this lock was acquired.

getAction() - Method in class org.apache.wiki.forms.FormInfo

Get the action set in FormInfo.setAction(String).

getActions() - Method in class org.apache.wiki.auth.permissions.AllPermission

No-op; always returns null

getActions() - Method in class org.apache.wiki.auth.permissions.GroupPermission

Returns the actions for this permission: “view”, “edit”, or “delete”.

getActions() - Method in class org.apache.wiki.auth.permissions.PagePermission

Returns the actions for this permission: "view", "edit", "comment", "modify", "upload" or "delete".

getActions() - Method in class org.apache.wiki.auth.permissions.WikiPermission

Returns the actions for this permission: "createGroups", "createPages", "editPreferences", "editProfile", or "login".

getActiveLocks() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns a list of currently applicable locks.

getActiveLocks() - Method in interface org.apache.wiki.pages.PageManager

Returns a list of currently applicable locks.

getActor() - Method in class org.apache.wiki.workflow.AbstractStep

The Principal responsible for completing this Step, such as a system user or actor assigned to a Decision.

getActor() - Method in class org.apache.wiki.workflow.Decision

The Principal responsible for completing this Step, such as a system user or actor assigned to a Decision.

getActor() - Method in interface org.apache.wiki.workflow.Step

The Principal responsible for completing this Step, such as a system user or actor assigned to a Decision.

getActor() - Method in class org.apache.wiki.workflow.Task

Returns SystemPrincipal.SYSTEM_USER.

getActorDecisions(Session) - Method in class org.apache.wiki.workflow.DecisionQueue

Returns a Collection representing the current Decisions that pertain to a users's Session.

getAdminBeanClass() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the AdminBean class which is supposed to manage this module.

getAdminBeanManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( AdminBeanManager.class ) instead.

getAjaxAlias() - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Returns the ajax alias name for this object.

getAlias() - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Returns the alias name for this object.

getAllAttachments() - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns a collection of Attachments, containing each and every attachment that is in this Wiki.

getAllAttachments() - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns a collection of Attachments, containing each and every attachment that is in this Wiki.

getAllBeans() - Method in interface org.apache.wiki.ui.admin.AdminBeanManager

Lists all administration beans which are currently known and instantiated.

getAllBeans() - Method in class org.apache.wiki.ui.admin.DefaultAdminBeanManager

getAllChangedSince(Date) - Method in class org.apache.wiki.providers.AbstractFileProvider

Does not work.

getAllChangedSince(Date) - Method in class org.apache.wiki.providers.CachingProvider

getAllInlinedImagePatterns() - Method in class org.apache.wiki.WikiEngine

getAllInterWikiLinks() - Method in class org.apache.wiki.WikiEngine

getAllPages() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns all pages in some random order.

getAllPages() - Method in interface org.apache.wiki.pages.PageManager

Returns all pages in some random order.

getAllPages() - Method in class org.apache.wiki.providers.AbstractFileProvider

getAllPages() - Method in class org.apache.wiki.providers.CachingProvider

getAllPages() - Method in class org.apache.wiki.providers.VersioningFileProvider

getAllPages() - Method in class org.apache.wiki.xmlrpc.RPCHandler

getAllPages() - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getApplicationName() - Method in class org.apache.wiki.WikiEngine

getApplicationName() - Method in class org.apache.wiki.xmlrpc.RPCHandler

getApplicationName() - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getApprover(String) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Looks up and resolves the actor who approves a Decision for a particular Workflow, based on the Workflow's message key.

getApprover(String) - Method in interface org.apache.wiki.workflow.WorkflowManager

Looks up and resolves the actor who approves a Decision for a particular Workflow, based on the Workflow's message key.

getAttachmentContent(String, int) - Method in class org.apache.wiki.search.LuceneSearchProvider

Fetches the attachment content from the repository.

getAttachmentContent(Attachment) - Method in class org.apache.wiki.search.LuceneSearchProvider

getAttachmentData(Attachment) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

getAttachmentData(Attachment) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

getAttachmentData(Context, Attachment) - Method in interface org.apache.wiki.attachment.DynamicAttachmentProvider

Returns a stream of data for this attachment.

getAttachmentInfo(String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Gets info on a particular attachment, latest version.

getAttachmentInfo(String, int) - Method in interface org.apache.wiki.attachment.AttachmentManager

Gets info on a particular attachment with the given version.

getAttachmentInfo(Context, String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Figures out the full attachment name from the context and attachment name.

getAttachmentInfo(Context, String, int) - Method in interface org.apache.wiki.attachment.AttachmentManager

Figures out the full attachment name from the context and attachment name.

getAttachmentInfo(Context, String, int) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Figures out the full attachment name from the context and attachment name.

getAttachmentInfo(Page, String, int) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

getAttachmentInfo(Page, String, int) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

getAttachmentInfoName(Context, String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Figures out the full attachment name from the context and attachment name.

getAttachmentInfoName(Context, String) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Figures out the full attachment name from the context and attachment name.

getAttachmentManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( AttachmentManager.class ) instead.

getAttachmentStream(Attachment) - Method in interface org.apache.wiki.attachment.AttachmentManager

Finds a (real) attachment from the repository as an InputStream.

getAttachmentStream(Context, Attachment) - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns an attachment stream using the particular WikiContext.

getAttachmentStream(Context, Attachment) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns an attachment stream using the particular WikiContext.

getAttribute(String) - Method in class org.apache.wiki.management.SimpleMBean

Gets an attribute using reflection from the MBean.

getAttribute(String) - Method in class org.apache.wiki.WikiEngine

getAttribute(String) - Method in class org.apache.wiki.WikiPage

A WikiPage may have a number of attributes, which might or might not be available.

getAttribute(String) - Method in class org.apache.wiki.workflow.Workflow

Retrieves a named Object associated with this Workflow.

getAttributeNames() - Method in class org.apache.wiki.management.SimpleMBean

This method must return a list of attributes which are exposed by the SimpleMBean.

getAttributeNames() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getAttributeNames() - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

This method must return a list of attributes which are exposed by the SimpleMBean.

getAttributeNames() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getAttributeNames() - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

getAttributeNames() - Method in class org.apache.wiki.ui.admin.beans.UserBean

getAttributes() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the attributes associated with this profile as a Map of key/value pairs.

getAttributes() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the attributes associated with this profile as a Map of key/value pairs.

getAttributes() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns an Iterator over the list of JDOM Attributes.

getAttributes() - Method in class org.apache.wiki.WikiPage

Returns the full attributes Map, in case external code needs to iterate through the attributes.

getAttributes() - Method in class org.apache.wiki.workflow.Workflow

Retrieves workflow's attributes.

getAttributes(String[]) - Method in class org.apache.wiki.management.SimpleMBean

Gets multiple attributes at the same time.

getAuthenticationManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( AuthenticationManager.class ) instead.

getAuthor() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the name of the author of this plugin (if defined).

getAuthor() - Method in class org.apache.wiki.rss.Entry

Return the author set by setAuthor().

getAuthor() - Method in class org.apache.wiki.WikiPage

Returns author name, or null, if no author has been defined.

getAuthorizationManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( AuthorizationManager.class ) instead.

getAuthorizer() - Method in interface org.apache.wiki.auth.AuthorizationManager

Returns the current external Authorizer in use.

getAuthorizer() - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Returns the current external Authorizer in use.

getAuthorizer() - Method in class org.apache.wiki.auth.login.AuthorizerCallback

Returns the authorizer.

getAuthorUrl() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the url of the author of this plugin (if defined).

getAvailableOutcomes() - Method in class org.apache.wiki.workflow.AbstractStep

Returns a Collection of available outcomes, such as "approve", "deny" or "reassign", in the order in which they were added via Step.addSuccessor(Outcome, Step).

getAvailableOutcomes() - Method in interface org.apache.wiki.workflow.Step

Returns a Collection of available outcomes, such as "approve", "deny" or "reassign", in the order in which they were added via Step.addSuccessor(Outcome, Step).

getBaseURL() - Method in class org.apache.wiki.WikiEngine

getBooleanWikiProperty(String, boolean) - Method in class org.apache.wiki.WikiContext

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.

getBotFieldName() - Static method in class org.apache.wiki.filters.SpamFilter

Returns a static string which can be used to detect spambots which just wildly fill in all the fields.

getBuilder(Engine) - Static method in class org.apache.wiki.workflow.WorkflowBuilder

Returns the WorkflowBuilder instance for a Engine.

getBundle(String, Locale) - Method in interface org.apache.wiki.i18n.InternationalizationManager

Finds a resource bundle.

getBundle(Context, String) - Static method in class org.apache.wiki.preferences.Preferences

Locates the i18n ResourceBundle given.

getCategories(String, String, String) - Method in class org.apache.wiki.xmlrpc.MetaWeblogHandler

JSPWiki does not support categories, therefore JSPWiki always returns an empty list for categories.

getChannelDescription() - Method in class org.apache.wiki.rss.Feed

getChannelLanguage() - Method in class org.apache.wiki.rss.Feed

getChannelTitle() - Method in class org.apache.wiki.rss.Feed

getChecked() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getClassName() - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Returns the full class name of this object.

getCommand() - Method in class org.apache.wiki.WikiContext

Returns the Command associated with this WikiContext.

getCommandResolver() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( CommandResolver.class ) instead.

getCompletedWorkflows() - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns a collection of finished workflows; that is, those that have aborted or completed.

getCompletedWorkflows() - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns a collection of finished workflows; that is, those that have aborted or completed.

getContent() - Method in class org.apache.wiki.rss.Entry

Return the content set by Entry.setContent(String).

getContentEncoding() - Method in class org.apache.wiki.WikiEngine

getContentTemplate() - Method in class org.apache.wiki.ui.AbstractCommand

getContentTemplate() - Method in class org.apache.wiki.WikiContext

getContentType(String) - Static method in interface org.apache.wiki.rss.RSSGenerator

Returns the content type of this RSS feed.

getContext() - Method in class org.apache.wiki.parser.WikiDocument

Returns the wiki context for this document.

getContext() - Method in class org.apache.wiki.tags.CheckRequestContextTag

Returns the context.

getContexts() - Method in class org.apache.wiki.search.SearchMatcher.SearchResultImpl

Returns an empty array, since BasicSearchProvider does not support context matching.

getCreated() - Method in class org.apache.wiki.auth.authorize.Group

Returns the creation date.

getCreated() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the creation date

getCreated() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the creation date.

getCreator() - Method in class org.apache.wiki.auth.authorize.Group

Returns the creator of this Group.

getCurrentActor() - Method in class org.apache.wiki.workflow.Workflow

Returns the actor Principal responsible for the current Step.

getCurrentLock(Page) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the current lock owner of a page.

getCurrentLock(Page) - Method in interface org.apache.wiki.pages.PageManager

Returns the current lock owner of a page.

getCurrentProvider() - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns the current attachment provider.

getCurrentProvider() - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns the current attachment provider.

getCurrentProvider() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the provider name.

getCurrentProvider() - Method in interface org.apache.wiki.pages.PageManager

Returns the provider name.

getCurrentState() - Method in class org.apache.wiki.workflow.Workflow

Returns the workflow state: Workflow.CREATED, Workflow.RUNNING, Workflow.WAITING, Workflow.COMPLETED or Workflow.ABORTED.

getCurrentStep() - Method in class org.apache.wiki.workflow.Workflow

Returns the current Step, or null if the workflow has not started or already completed.

getCurrentUser() - Method in class org.apache.wiki.WikiContext

Convenience method that gets the current user.

getCurrentWatchDog(Engine) - Static method in class org.apache.wiki.WatchDog

Returns the current watchdog for the current thread.

getCustomProperties(Page, Properties) - Method in class org.apache.wiki.providers.AbstractFileProvider

Get custom properties using AbstractFileProvider.addCustomProperties(Page, Properties), validate them using AbstractFileProvider.validateCustomPageProperties(Properties) and add them to default properties provided

getDateFormat(Context, Preferences.TimeFormat) - Static method in class org.apache.wiki.preferences.Preferences

Get SimpleTimeFormat according to user browser locale and preferred time formats.

getDecisionQueue() - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns the DecisionQueue associated with this WorkflowManager

getDecisionQueue() - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns the DecisionQueue associated with this WorkflowManager

getDefaultOutcome() - Method in class org.apache.wiki.workflow.Decision

Returns the default or suggested outcome, which must be one of those returned by AbstractStep.getAvailableOutcomes().

getDescription() - Method in class org.apache.wiki.management.SimpleMBean

Customization hook: Override this to get a description for your MBean.

getDescription() - Method in class org.apache.wiki.modules.WikiModuleInfo

The description of what this module does.

getDiff(Context, int, int) - Method in class org.apache.wiki.diff.DefaultDifferenceManager

Returns a diff of two versions of a page.

getDiff(Context, int, int) - Method in interface org.apache.wiki.diff.DifferenceManager

Returns a diff of two versions of a page.

getDifferenceManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( DifferenceManager.class ) instead.

getDynamicAttachment(String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Finds a DynamicAttachment.

getDynamicAttachment(String) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Finds a DynamicAttachment.

getEditedText(PageContext) - Static method in interface org.apache.wiki.ui.EditorManager

Convenience function which examines the current context and attempts to figure out whether the edited text is in the HTTP request parameters or somewhere in the session.

getEditorList() - Method in class org.apache.wiki.ui.DefaultEditorManager

Returns a list of editors as Strings of editor names.

getEditorList() - Method in interface org.apache.wiki.ui.EditorManager

Returns a list of editors as Strings of editor names.

getEditorManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( EditorManager.class ) instead.

getEditorName(Context) - Method in class org.apache.wiki.ui.DefaultEditorManager

Returns an editor for the current context.

getEditorName(Context) - Method in interface org.apache.wiki.ui.EditorManager

Returns an editor for the current context.

getEditorPath(Context) - Method in class org.apache.wiki.ui.DefaultEditorManager

Convenience method for getting the path to the editor JSP file.

getEditorPath(Context) - Method in interface org.apache.wiki.ui.EditorManager

Convenience method for getting the path to the editor JSP file.

getEmail() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the user's e-mail address.

getEmail() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the user's e-mail address.

getEndTime() - Method in class org.apache.wiki.workflow.AbstractStep

The end time for this Step.

getEndTime() - Method in interface org.apache.wiki.workflow.Step

The end time for this Step.

getEndTime() - Method in class org.apache.wiki.workflow.Workflow

The end time for this Workflow, expressed as a system time number.

getEngine() - Method in class org.apache.wiki.auth.login.WikiEngineCallback

Returns the engine.

getEngine() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the Engine to which this PageManager belongs to.

getEngine() - Method in class org.apache.wiki.search.LuceneSearchProvider

Returns the handling engine.

getEngine() - Method in class org.apache.wiki.WikiBackgroundThread

Returns the Engine that created this background thread.

getEngine() - Method in class org.apache.wiki.WikiContext

Returns the handling engine.

getEngine() - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Protected helper method that returns the associated Engine

getEntry(Principal) - Method in interface org.apache.wiki.auth.acl.Acl

Deprecated.

use Acl.getAclEntry(Principal) instead.

getError() - Method in class org.apache.wiki.forms.FormInfo

Return the error.

getErrors() - Method in class org.apache.wiki.workflow.AbstractStep

Returns a List of error strings generated by this Step.

getErrors() - Method in interface org.apache.wiki.workflow.Step

Returns a List of error strings generated by this Step.

getExpiryTime() - Method in class org.apache.wiki.pages.PageLock

Returns the timestamp on which this lock will expire.

getExternalWiki() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns the name of the wiki if this is an interwiki link.

getExternalWikiPage() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns the wikiname part of an interwiki link.

getFacts() - Method in class org.apache.wiki.workflow.Decision

Returns the Facts associated with this Decision, in the order in which they were added.

getFeedURL() - Method in class org.apache.wiki.rss.Feed

getFileExtension(String) - Static method in class org.apache.wiki.providers.BasicAttachmentProvider

Returns the file extension.

getFileName() - Method in class org.apache.wiki.attachment.Attachment

Returns the file name of the attachment.

getFilterList() - Method in class org.apache.wiki.filters.DefaultFilterManager

Returns the list of filters currently installed.

getFilterList() - Method in interface org.apache.wiki.filters.FilterManager

Returns the list of filters currently installed.

getFilterManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( FilterManager.class ) instead.

getFinalPageName(String) - Method in interface org.apache.wiki.ui.CommandResolver

Returns the correct page name, or null, if no such page can be found.

getFinalPageName(String) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Returns the correct page name, or null, if no such page can be found.

getFinalPageName(String) - Method in class org.apache.wiki.WikiEngine

getForm(Context) - Method in class org.apache.wiki.ui.admin.WikiFormAdminBean

getFormat() - Method in class org.apache.wiki.tags.PageDateTag

getFormInfo(Context) - Method in class org.apache.wiki.forms.FormElement

Attempts to retrieve information on the currently handled form from the Context.

getForwardPage(HttpServletRequest) - Method in class org.apache.wiki.url.DefaultURLConstructor

This method is not needed for the DefaultURLConstructor.

getForwardPage(HttpServletRequest) - Method in class org.apache.wiki.url.ShortURLConstructor

This method is not needed for the DefaultURLConstructor.

getForwardPage(HttpServletRequest) - Method in class org.apache.wiki.url.ShortViewURLConstructor

Since we're only called from WikiServlet, where we get the VIEW requests, we can safely return this.

getForwardPage(HttpServletRequest) - Method in interface org.apache.wiki.url.URLConstructor

Returns information which JSP page should continue handling this type of request.

getFrontPage() - Method in class org.apache.wiki.WikiEngine

getFullname() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the user's full name.

getFullname() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the user's full name.

getGlobalRSSURL() - Method in class org.apache.wiki.WikiEngine

getGroup() - Method in class org.apache.wiki.auth.permissions.GroupPermission

Returns the name of the wiki group represented by this permission.

getGroup(String) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Returns the Group matching a given name.

getGroup(String) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Returns the Group matching a given name.

getGroupDatabase() - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Returns the current external GroupDatabase in use.

getGroupDatabase() - Method in interface org.apache.wiki.auth.authorize.GroupManager

Returns the current external GroupDatabase in use.

getGroupManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( GroupManager.class ) instead.

getHandler() - Method in class org.apache.wiki.forms.FormInfo

Return the name of the handler class.

getHash(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Private method that calculates the salted SHA-1 or SHA-256 hash of a given String.

getHashFieldName(HttpServletRequest) - Static method in class org.apache.wiki.filters.SpamFilter

Returns the name of the hash field to be used in this request.

getHistory() - Method in class org.apache.wiki.workflow.Workflow

Returns a Step history for this Workflow as a List, chronologically, from the first Step to the currently executing one.

getHTML(String) - Method in interface org.apache.wiki.render.RenderingManager

Returns the converted HTML of the page.

getHTML(String, int) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns the converted HTML of the page's specific version.

getHTML(String, int) - Method in interface org.apache.wiki.render.RenderingManager

Returns the converted HTML of the page's specific version.

getHTML(Context, String) - Method in interface org.apache.wiki.render.RenderingManager

Convenience method for rendering, using the default parser and renderer.

getHTML(Context, Page) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns the converted HTML of the page using a different context than the default context.

getHTML(Context, Page) - Method in interface org.apache.wiki.render.RenderingManager

Returns the converted HTML of the page using a different context than the default context.

getHTML(Context, WikiDocument) - Method in class org.apache.wiki.render.DefaultRenderingManager

Simply renders a WikiDocument to a String.

getHTML(Context, WikiDocument) - Method in interface org.apache.wiki.render.RenderingManager

Simply renders a WikiDocument to a String.

getHtmlTemplate() - Method in class org.apache.wiki.modules.WikiModuleInfo

Return the location of the html template for this module.

getHttpParameter(String) - Method in class org.apache.wiki.WikiContext

This method will safely return any HTTP parameters that might have been defined.

getHttpRequest() - Method in class org.apache.wiki.WikiContext

If the request did originate from an HTTP request, then the HTTP request can be fetched here.

getId() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getId() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getId() - Method in class org.apache.wiki.ui.admin.SimpleAdminBean

By default, this method returns the class name of the bean.

getId() - Method in interface org.apache.wiki.ui.GenericHTTPHandler

Get an identifier for this particular AdminBean.

getId() - Method in class org.apache.wiki.workflow.Decision

Returns the unique identifier for this Decision.

getId() - Method in class org.apache.wiki.workflow.Workflow

Returns the unique identifier for this Workflow.

getIncludeText(String) - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Returns a text for IncludeResources.

getInlineImagePatterns() - Method in class org.apache.wiki.parser.MarkupParser

getInstance(ServletConfig) - Static method in class org.apache.wiki.WikiEngine

Gets a WikiEngine related to this servlet.

getInstance(ServletConfig, Properties) - Static method in class org.apache.wiki.WikiEngine

Gets a WikiEngine related to the servlet.

getInstance(ServletContext, Properties) - Static method in class org.apache.wiki.WikiEngine

Gets a WikiEngine related to the servlet.

getInstance(Engine) - Static method in class org.apache.wiki.auth.SessionMonitor

Returns the instance of the SessionMonitor for this wiki.

getInternationalizationManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( InternationalizationManager.class ) instead.

getInterWikiURL(String) - Method in class org.apache.wiki.WikiEngine

getJSLocalizedStrings(Context) - Static method in interface org.apache.wiki.ui.TemplateManager

Extract all i18n strings in the javascript domain.

getJSP() - Method in class org.apache.wiki.ui.AbstractCommand

getJSP() - Method in class org.apache.wiki.WikiContext

getJSPFriendlyName() - Method in class org.apache.wiki.ui.AbstractCommand

Returns the "friendly name" for this command's JSP, namely a beatified version of the JSP's name without the .jsp suffix.

getLastModified() - Method in class org.apache.wiki.auth.authorize.Group

Returns the last-modified date.

getLastModified() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the last-modified date.

getLastModified() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the last-modified date.

getLastModified() - Method in class org.apache.wiki.WikiPage

Returns the date when this page was last modified.

getLinks() - Method in class org.apache.wiki.LinkCollector

Returns a List of Strings representing links.

getLocale() - Method in class org.apache.wiki.WikiSession

getLocale(Context) - Static method in class org.apache.wiki.preferences.Preferences

Get Locale according to user-preference settings or the user browser locale

getLocker() - Method in class org.apache.wiki.pages.PageLock

Returns the locker name.

getLockExpiry() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the date/time of expiration of the profile's lock, if it has been previously locked via UserProfile.setLockExpiry(Date) and the lock is still active.

getLockExpiry() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the date/time of expiration of the profile's lock, if it has been previously locked via UserProfile.setLockExpiry(Date) and the lock is still active.

getLoginName() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the user's login name.

getLoginName() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the user's login name.

getLoginPrincipal() - Method in class org.apache.wiki.WikiSession

getLoginPrincipal(Set<Principal>) - Method in interface org.apache.wiki.auth.AuthenticationManager

Returns the first Principal in a set that isn't a Role or GroupPrincipal.

getManager(Class<T>) - Method in class org.apache.wiki.WikiEngine

getManagers(Class<T>) - Method in class org.apache.wiki.WikiEngine

getMarker(Context, String) - Static method in interface org.apache.wiki.ui.TemplateManager

Returns the include resources marker for a given type.

getMaxpages() - Method in class org.apache.wiki.tags.BreadcrumbsTag

Returns the maxpages.

getMaxVersion() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the maximum version of JSPWiki that this module supports.

getMBeanInfo() - Method in class org.apache.wiki.management.SimpleMBean

Return the MBeanInfo structure.

getMessageArguments() - Method in class org.apache.wiki.workflow.Workflow

Returns an array of message arguments, used by MessageFormat to create localized messages.

getMessageKey() - Method in class org.apache.wiki.workflow.AbstractStep

Message key for human-friendly name of this Step, including any parameter substitutions.

getMessageKey() - Method in class org.apache.wiki.workflow.Fact

Returns this Fact's name, as represented an i18n message key.

getMessageKey() - Method in class org.apache.wiki.workflow.Outcome

The i18n key for this outcome, which is prefixed by outcome..

getMessageKey() - Method in interface org.apache.wiki.workflow.Step

Message key for human-friendly name of this Step, including any parameter substitutions.

getMessageKey() - Method in class org.apache.wiki.workflow.Workflow

Returns an i18n message key for the name of this workflow; for example, workflow.saveWikiPage.

getMessages() - Method in class org.apache.wiki.WikiSession

getMessages(String) - Method in class org.apache.wiki.WikiSession

getMethodNames() - Method in class org.apache.wiki.management.SimpleMBean

This method must return a list of operations which are to be exposed by the SimpleMBean.

getMethodNames() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getMethodNames() - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

This method must return a list of operations which are to be exposed by the SimpleMBean.

getMethodNames() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getMethodNames() - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

getMethodNames() - Method in class org.apache.wiki.ui.admin.beans.UserBean

getMimeType(ServletContext, String) - Method in class org.apache.wiki.rss.Feed

A helper method for figuring out the MIME type for an enclosure.

getMinVersion() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the minimum version of JSPWiki that this module supports.

getModifier() - Method in class org.apache.wiki.auth.authorize.Group

Returns the name of the user who last modified this group.

getModuleInfo(String) - Method in class org.apache.wiki.filters.DefaultFilterManager

Returns the WikiModuleInfo information about the provided moduleName.

getModuleInfo(String) - Method in interface org.apache.wiki.modules.ModuleManager

Returns the WikiModuleInfo information about the provided moduleName.

getModuleInfo(String) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Returns the WikiModuleInfo information about the provided moduleName.

getModuleInfo(String) - Method in class org.apache.wiki.ui.DefaultEditorManager

Returns the WikiModuleInfo information about the provided moduleName.

getModuleInfo(String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

Returns the WikiModuleInfo information about the provided moduleName.

getModuleUrl() - Method in class org.apache.wiki.modules.WikiModuleInfo

The URL for this getting more information about this module.

getModuleVersion() - Method in class org.apache.wiki.modules.WikiModuleInfo

The current version of the implemented module

getName() - Method in class org.apache.wiki.auth.acl.UnresolvedPrincipal

Returns the name of the principal.

getName() - Method in class org.apache.wiki.auth.authorize.Group

The name of the group.

getName() - Method in class org.apache.wiki.auth.authorize.Role

Returns the name of the Principal.

getName() - Method in class org.apache.wiki.auth.GroupPrincipal

Returns the name of the group principal.

getName() - Method in class org.apache.wiki.auth.login.PrincipalWrapper

Returns the name of the wrapped principal.

getName() - Method in class org.apache.wiki.auth.WikiPrincipal

Returns the wiki name of the Principal.

getName() - Method in class org.apache.wiki.forms.FormInfo

Return the name of the form.

getName() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the common name for this particular module.

getName() - Method in class org.apache.wiki.ui.AbstractCommand

getName() - Method in class org.apache.wiki.ui.Editor

getName() - Method in class org.apache.wiki.ui.GroupCommand

Returns the name of the command, which will either be the target (if specified), or the "friendly name" for the JSP.

getName() - Method in class org.apache.wiki.ui.PageCommand

getName() - Method in class org.apache.wiki.ui.RedirectCommand

getName() - Method in class org.apache.wiki.ui.WikiCommand

Always returns the "friendly" JSP name.

getName() - Method in interface org.apache.wiki.Watchable

Returns a human-readable name of this Watchable.

getName() - Method in class org.apache.wiki.WikiContext

Returns the target of this wiki context: a page, group name or JSP.

getName() - Method in class org.apache.wiki.WikiPage

Returns the name of the page.

getName() - Method in class org.apache.wiki.workflow.SystemPrincipal

getNewEntryPage(Engine, String) - Method in class org.apache.wiki.plugin.WeblogEntryPlugin

Returns a new page name for entries.

getNewProgressIdentifier() - Method in class org.apache.wiki.ui.progress.DefaultProgressManager

You can use this to get an unique process identifier.

getNewProgressIdentifier() - Method in interface org.apache.wiki.ui.progress.ProgressManager

You can use this to get an unique process identifier.

getNewVersion() - Method in class org.apache.wiki.tags.DiffLinkTag

getNextPathPart(String, String) - Static method in class org.apache.wiki.ajax.AjaxUtil

Given a requestUri path, find the next uri "fragment" after the "/lastPart/" one.

getOutcome() - Method in class org.apache.wiki.workflow.AbstractStep

Returns the Outcome of this Step's processing; by default, Outcome.STEP_CONTINUE.

getOutcome() - Method in interface org.apache.wiki.workflow.Step

Returns the Outcome of this Step's processing; by default, Outcome.STEP_CONTINUE.

getOwner() - Method in class org.apache.wiki.workflow.Workflow

The owner Principal on whose behalf this Workflow is being executed; that is, the user who created the workflow.

getOwnerWorkflows(Session) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns the current workflows a wiki session owns.

getOwnerWorkflows(Session) - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns the current workflows a wiki session owns.

getPage() - Method in class org.apache.wiki.auth.permissions.PagePermission

Returns the name of the wiki page represented by this permission.

getPage() - Method in class org.apache.wiki.pages.PageLock

Returns the name of the page which is locked.

getPage() - Method in class org.apache.wiki.parser.WikiDocument

Return the WikiPage for whom this WikiDocument exists.

getPage() - Method in class org.apache.wiki.rss.Entry

Returns the page set by Entry.setPage(Page).

getPage() - Method in class org.apache.wiki.search.SearchMatcher.SearchResultImpl

Returns Wikipage for this result.

getPage() - Method in interface org.apache.wiki.search.SearchResult

Deprecated.

Return the page.

getPage() - Method in class org.apache.wiki.tags.IncludeTag

getPage() - Method in class org.apache.wiki.tags.InsertDiffTag

Gets the page name.

getPage() - Method in class org.apache.wiki.tags.InsertPageTag

getPage() - Method in class org.apache.wiki.tags.NoSuchPageTag

getPage() - Method in class org.apache.wiki.tags.WikiLinkTag

getPage() - Method in class org.apache.wiki.WikiContext

Returns the page that is being handled.

getPage(String) - Method in class org.apache.wiki.pages.DefaultPageManager

Finds the corresponding WikiPage object based on the page name.

getPage(String) - Method in interface org.apache.wiki.pages.PageManager

Finds the corresponding WikiPage object based on the page name.

getPage(String) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPage(String) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getPage(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Finds the corresponding WikiPage object base on the page name and version.

getPage(String, int) - Method in interface org.apache.wiki.pages.PageManager

Finds the corresponding WikiPage object base on the page name and version.

getPageCount() - Method in class org.apache.wiki.providers.AbstractFileProvider

getPageCount() - Method in class org.apache.wiki.providers.CachingProvider

getPageData() - Method in class org.apache.wiki.parser.WikiDocument

Returns the wikimarkup used to render this document.

getPageHTML(String) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPageHTML(String) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getPageHTMLVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPageHTMLVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getPageInfo(String) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPageInfo(String) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getPageInfo(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Finds a WikiPage object describing a particular page and version.

getPageInfo(String, int) - Method in interface org.apache.wiki.pages.PageManager

Finds a WikiPage object describing a particular page and version.

getPageInfo(String, int) - Method in class org.apache.wiki.providers.AbstractFileProvider

Always returns the latest version, since FileSystemProvider does not support versioning.

getPageInfo(String, int) - Method in class org.apache.wiki.providers.CachingProvider

getPageInfo(String, int) - Method in class org.apache.wiki.providers.FileSystemProvider

Always returns the latest version, since FileSystemProvider does not support versioning.

getPageInfo(String, int) - Method in class org.apache.wiki.providers.VersioningFileProvider

Always returns the latest version, since FileSystemProvider does not support versioning.

getPageInfoVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPageInfoVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getPageManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( PageManager.class ) instead.

getPageName() - Method in exception org.apache.wiki.providers.RepositoryModifiedException

Return the page name given in the constructor.

getPagePermission(String, String) - Static method in class org.apache.wiki.auth.permissions.PermissionFactory

Get a permission object for a WikiPage and a set of actions.

getPagePermission(Page, String) - Static method in class org.apache.wiki.auth.permissions.PermissionFactory

Get a permission object for a WikiPage and a set of actions.

getPageRenamer() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( PageRenamer.class ) instead.

getPages() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

Return the page count in the Wiki.

getPagesDescription() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getPageSorter() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the configured PageSorter.

getPageSorter() - Method in interface org.apache.wiki.pages.PageManager

Returns the configured PageSorter.

getPageText(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Fetches the page text from the repository.

getPageText(String, int) - Method in interface org.apache.wiki.pages.PageManager

Fetches the page text from the repository.

getPageText(String, int) - Method in class org.apache.wiki.providers.AbstractFileProvider

This implementation just returns the current version, as filesystem does not provide versioning information for now.

getPageText(String, int) - Method in class org.apache.wiki.providers.CachingProvider

getPageText(String, int) - Method in class org.apache.wiki.providers.VersioningFileProvider

This implementation just returns the current version, as filesystem does not provide versioning information for now.

getPageVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getPageVersion(String, int) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getParameter(String) - Method in class org.apache.wiki.parser.PluginContent

getParameters() - Method in class org.apache.wiki.parser.PluginContent

getParentName() - Method in class org.apache.wiki.attachment.Attachment

Returns the name of the parent of this Attachment, i.e. the page which contains this attachment.

getParser(Context, String) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns the wiki Parser

getParser(Context, String) - Method in interface org.apache.wiki.render.RenderingManager

Returns the wiki Parser

getPassword() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the user password for use with custom authentication.

getPassword() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the user password for use with custom authentication.

getPermissions(Page) - Method in interface org.apache.wiki.auth.acl.AclManager

Returns the access control list for the page.

getPermissions(Page) - Method in class org.apache.wiki.auth.acl.DefaultAclManager

Returns the access control list for the page.

getPluginManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( PluginManager.class ) instead.

getPluginName() - Method in class org.apache.wiki.parser.PluginContent

getPluginPattern() - Method in class org.apache.wiki.plugin.DefaultPluginManager

Returns plugin insert pattern.

getPluginPattern() - Method in interface org.apache.wiki.plugin.PluginManager

Returns plugin insert pattern.

getPosition() - Method in class org.apache.wiki.parser.MarkupParser

Return the current position in the reader stream.

getPreference(PageContext, String) - Static method in class org.apache.wiki.preferences.Preferences

Returns a preference value programmatically.

getPreference(Context, String) - Static method in class org.apache.wiki.preferences.Preferences

Returns a preference value programmatically.

getPreviousStep() - Method in class org.apache.wiki.workflow.Workflow

Convenience method that returns the predecessor of the current Step.

getPrincipal() - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Returns the principal for which permissions are granted by this ACL entry.

getPrincipal() - Method in class org.apache.wiki.auth.authorize.Group

Returns the GroupPrincipal that represents this Group.

getPrincipal() - Method in class org.apache.wiki.auth.login.PrincipalWrapper

Returns the wrapped Principal used to construct this instance.

getPrincipals() - Method in class org.apache.wiki.WikiSession

getPrincipals(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Looks up the Principals representing a user from the user database.

getPrincipals(String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Looks up the Principals representing a user from the user database.

getProgress() - Method in class org.apache.wiki.ui.progress.ProgressItem

Returns the progress in percents.

getProgress(String) - Method in class org.apache.wiki.ui.progress.DefaultProgressManager

Get the progress in percents.

getProgress(String) - Method in class org.apache.wiki.ui.progress.DefaultProgressManager.JSONTracker

Returns upload progress in percents so far.

getProgress(String) - Method in interface org.apache.wiki.ui.progress.ProgressManager

Get the progress in percents.

getProgressManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( ProgressManager.class ) instead.

getPropertiesList() - Method in class org.apache.wiki.ui.Installer

Returns the properties as a "key=value" string separated by newlines

getPropertiesPath() - Method in class org.apache.wiki.ui.Installer

getProperty(String) - Method in class org.apache.wiki.ui.Installer

Returns a property from the Engine's properties.

getProvider() - Method in class org.apache.wiki.attachment.DynamicAttachment

Returns the provider which is used to generate this attachment.

getProvider() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the page provider currently in use.

getProvider() - Method in interface org.apache.wiki.pages.PageManager

Returns the page provider currently in use.

getProviderDescription() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns a human-readable description of the current provider.

getProviderDescription() - Method in interface org.apache.wiki.pages.PageManager

Returns a human-readable description of the current provider.

getProviderInfo() - Method in class org.apache.wiki.diff.ContextualDiffProvider

getProviderInfo() - Method in class org.apache.wiki.diff.DiffProvider.NullDiffProvider

getProviderInfo() - Method in class org.apache.wiki.diff.ExternalDiffProvider

getProviderInfo() - Method in class org.apache.wiki.diff.TraditionalDiffProvider

getProviderInfo() - Method in class org.apache.wiki.providers.AbstractFileProvider

getProviderInfo() - Method in class org.apache.wiki.providers.BasicAttachmentProvider

getProviderInfo() - Method in class org.apache.wiki.providers.CachingAttachmentProvider

Gets the provider class name, and cache statistics (misscount and hitcount of the attachment cache).

getProviderInfo() - Method in class org.apache.wiki.providers.CachingProvider

Gets the provider class name, and cache statistics (misscount and hitcount of page cache and history cache).

getProviderInfo() - Method in class org.apache.wiki.providers.VersioningFileProvider

getProviderInfo() - Method in class org.apache.wiki.search.BasicSearchProvider

getProviderInfo() - Method in class org.apache.wiki.search.LuceneSearchProvider

getPureText(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the pure text of a page, no conversions.

getPureText(String, int) - Method in interface org.apache.wiki.pages.PageManager

Returns the pure text of a page, no conversions.

getPureText(Page) - Method in interface org.apache.wiki.pages.PageManager

Returns the pure text of a page, no conversions.

getRealPage() - Method in class org.apache.wiki.WikiContext

Gets a reference to the real page whose content is currently being rendered.

getRealProvider() - Method in class org.apache.wiki.providers.CachingAttachmentProvider

Returns the WikiAttachmentProvider that this caching provider delegates to.

getRealProvider() - Method in class org.apache.wiki.providers.CachingProvider

Returns the actual used provider.

getRecentChanges() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns a Collection of WikiPages, sorted in time order of last change (i.e. first object is the most recently changed).

getRecentChanges() - Method in interface org.apache.wiki.pages.PageManager

Returns a Collection of WikiPages, sorted in time order of last change (i.e. first object is the most recently changed).

getRecentChanges(Date) - Method in class org.apache.wiki.xmlrpc.AbstractRPCHandler

getRecentChanges(Date) - Method in class org.apache.wiki.xmlrpc.RPCHandler

getRecentChanges(Date) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

getRecentPosts(String, String, String, int) - Method in class org.apache.wiki.xmlrpc.MetaWeblogHandler

Returns a list of the recent posts to this weblog.

getRedirectURL() - Method in class org.apache.wiki.WikiContext

Figure out to which page we are really going to.

getReference() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns the link reference, or the link text if null.

getReferenceManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( ReferenceManager.class ) instead.

getReferredBy() - Method in class org.apache.wiki.references.DefaultReferenceManager

Returns the referred-by list.

getRefersTo() - Method in class org.apache.wiki.references.DefaultReferenceManager

Returns the refers-to list.

getRemoteUser() - Method in class org.apache.wiki.ui.WikiRequestWrapper

Returns the remote user for the HTTP request, taking into account both container and JSPWiki custom authentication status.

getRenderedDocument(Context, String) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns a cached document, if one is found.

getRenderedDocument(Context, String) - Method in interface org.apache.wiki.render.RenderingManager

Returns a cached document, if one is found.

getRenderer(Context, WikiDocument) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns a WikiRenderer instance, initialized with the given context and doc.

getRenderer(Context, WikiDocument) - Method in interface org.apache.wiki.render.RenderingManager

Returns a WikiRenderer instance, initialized with the given context and doc.

getRenderingManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( RenderingManager.class ) instead.

getRequest() - Method in class org.apache.wiki.auth.login.HttpRequestCallback

Returns the request object.

getRequestContext() - Method in class org.apache.wiki.ui.AbstractCommand

getRequestContext() - Method in class org.apache.wiki.WikiContext

Returns the request context.

getResource() - Method in class org.apache.wiki.tags.RequestResourceTag

Returns the resource that is to be added.

getResourceRequests(Context, String) - Static method in interface org.apache.wiki.ui.TemplateManager

Returns resource requests for a particular type.

getResourceTypes(Context) - Static method in interface org.apache.wiki.ui.TemplateManager

Returns all those types that have been requested so far.

getResult() - Method in class org.apache.wiki.forms.FormInfo

Return the result.

getRoles() - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Returns an array of role Principals this Authorizer knows about.

getRoles() - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Returns an array of role Principals this Authorizer knows about.

getRoles() - Method in interface org.apache.wiki.auth.Authorizer

Returns an array of role Principals this Authorizer knows about.

getRoles() - Method in class org.apache.wiki.WikiSession

getRoles(Document) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Protected method that extracts the roles from JSPWiki's web application deployment descriptor.

getRootPath() - Method in class org.apache.wiki.WikiEngine

getRPCVersionSupported() - Method in class org.apache.wiki.xmlrpc.AbstractRPCHandler

Returns the current supported JSPWiki XML-RPC API.

getRssFile() - Method in class org.apache.wiki.rss.DefaultRSSGenerator

returns the rss file.

getRssFile() - Method in interface org.apache.wiki.rss.RSSGenerator

returns the rss file.

getRSSGenerator() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( RSSGenerator.class ) instead.

getScore() - Method in class org.apache.wiki.search.SearchMatcher.SearchResultImpl

Returns a score for this match.

getScriptLocation() - Method in class org.apache.wiki.modules.WikiModuleInfo

Return the location of the script for this module.

getSearchEngine() - Method in class org.apache.wiki.search.DefaultSearchManager

Returns the SearchProvider used.

getSearchEngine() - Method in interface org.apache.wiki.search.SearchManager

Returns the SearchProvider used.

getSearchManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( SearchManager.class ) instead.

getSeparator() - Method in class org.apache.wiki.tags.BreadcrumbsTag

Get the separator string.

getServletContext() - Method in class org.apache.wiki.WikiEngine

getServletMapping() - Method in interface org.apache.wiki.ajax.WikiAjaxServlet

getServletMapping() - Method in class org.apache.wiki.auth.DefaultUserManager.JSONUserModule

getServletMapping() - Method in class org.apache.wiki.plugin.SampleAjaxPlugin

getServletMapping() - Method in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

getServletMapping() - Method in class org.apache.wiki.ui.progress.DefaultProgressManager.JSONTracker

getServletName(String) - Method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Get the ServletName from the requestURI "/ajax/", using AjaxUtil.getNextPathPart(java.lang.String, java.lang.String).

getSiteName(Context) - Static method in class org.apache.wiki.rss.Feed

Figure out a site name for a feed.

getSize() - Method in class org.apache.wiki.WikiPage

Returns the size of the page.

getSpamHash(Page, HttpServletRequest) - Static method in class org.apache.wiki.filters.SpamFilter

This method is used to calculate an unique code when submitting the page to detect edit conflicts.

getSpecialPageReference(String) - Method in interface org.apache.wiki.ui.CommandResolver

If the page is a special page, this method returns a direct URL to that page; otherwise, it returns null.

getSpecialPageReference(String) - Method in class org.apache.wiki.ui.DefaultCommandResolver

If the page is a special page, this method returns a direct URL to that page; otherwise, it returns null.

getSpecialPageReference(String) - Method in class org.apache.wiki.WikiEngine

getStartTime() - Method in class org.apache.wiki.WikiEngine

getStartTime() - Method in class org.apache.wiki.workflow.AbstractStep

The start time for this Step.

getStartTime() - Method in interface org.apache.wiki.workflow.Step

The start time for this Step.

getStartTime() - Method in class org.apache.wiki.workflow.Workflow

The start time for this Workflow, expressed as a system time number.

getState() - Method in class org.apache.wiki.ui.progress.ProgressItem

Get the state of the ProgressItem.

getStatus() - Method in class org.apache.wiki.forms.FormInfo

Return the status.

getStatus() - Method in class org.apache.wiki.tags.UserCheckTag

Get the status as defined above.

getStatus() - Method in class org.apache.wiki.WikiSession

getString() - Method in class org.apache.wiki.render.CleanTextRenderer

Renders and returns the end result.

getString() - Method in class org.apache.wiki.render.CreoleRenderer

Renders and returns the end result.

getString() - Method in class org.apache.wiki.render.WikiRenderer

Renders and returns the end result.

getString() - Method in class org.apache.wiki.render.WysiwygEditingRenderer

Renders and returns the end result.

getString() - Method in class org.apache.wiki.render.XHTMLRenderer

Renders and returns the end result.

getString() - Method in class org.apache.wiki.rss.AtomFeed

Returns the XML for the feed contents in a String format.

getString() - Method in class org.apache.wiki.rss.Feed

Returns the XML for the feed contents in a String format.

getString() - Method in class org.apache.wiki.rss.RSS10Feed

Returns the XML for the feed contents in a String format.

getString() - Method in class org.apache.wiki.rss.RSS20Feed

Returns the XML for the feed contents in a String format.

getStylesheetLocation() - Method in class org.apache.wiki.modules.WikiModuleInfo

Returns the style sheet location for this module.

getSubject() - Method in class org.apache.wiki.WikiSession

getSubmission() - Method in class org.apache.wiki.forms.FormInfo

Returns parameter name-value pairs for a Form handler WikiPlugin.

getSuccessor() - Method in class org.apache.wiki.workflow.Task

Identifies the next Step after this Task finishes successfully.

getSuccessor(Outcome) - Method in class org.apache.wiki.workflow.AbstractStep

Identifies the next Step for a particular Outcome; if there is no next Step for this Outcome, this method returns null.

getSuccessor(Outcome) - Method in interface org.apache.wiki.workflow.Step

Identifies the next Step for a particular Outcome; if there is no next Step for this Outcome, this method returns null.

getSuggestions(String, int) - Method in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

Provides a list of suggestions to use for a page name.

getTarget() - Method in class org.apache.wiki.ui.AbstractCommand

getTarget() - Method in class org.apache.wiki.WikiContext

getTasksManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( TaskManager.class ) instead.

getTemplate() - Method in class org.apache.wiki.tags.WikiLinkTag

getTemplate() - Method in class org.apache.wiki.WikiContext

Gets the template that is to be used throughout this request.

getTemplateDir() - Method in class org.apache.wiki.WikiEngine

getTemplateManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( TemplateManager.class ) instead.

getText() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns the link text.

getText() - Method in class org.apache.wiki.parser.PluginContent

getText() - Method in class org.apache.wiki.parser.VariableContent

Returns exactly getValue().

getText(String) - Method in interface org.apache.wiki.pages.PageManager

Returns the un-HTMLized text of the latest version of a page.

getText(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the un-HTMLized text of the given version of a page.

getText(String, int) - Method in interface org.apache.wiki.pages.PageManager

Returns the un-HTMLized text of the given version of a page.

getText(Page) - Method in interface org.apache.wiki.pages.PageManager

Returns the un-HTMLized text of the given version of a page in the given context.

getTextResource(String) - Method in class org.apache.wiki.modules.WikiModuleInfo

Attempts to locate a resource from a JAR file and returns it as a string.

getTimeLeft() - Method in class org.apache.wiki.pages.PageLock

Returns the amount of time left in minutes, rounded up to the nearest minute (so you get a zero only at the last minute).

getTitle() - Method in class org.apache.wiki.rss.Entry

Returns the title.

getTitle() - Method in class org.apache.wiki.tags.RSSImageLinkTag

Returns the title.

getTitle() - Method in interface org.apache.wiki.ui.admin.AdminBean

Return a human-readable title for this AdminBean.

getTitle() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getTitle() - Method in class org.apache.wiki.ui.admin.beans.FilterBean

Return a human-readable title for this AdminBean.

getTitle() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getTitle() - Method in class org.apache.wiki.ui.admin.beans.PluginBean

Return a human-readable title for this AdminBean.

getTitle() - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

getTitle() - Method in class org.apache.wiki.ui.admin.beans.UserBean

getTotalPageCount() - Method in class org.apache.wiki.pages.DefaultPageManager

Returns the total count of all pages in the repository.

getTotalPageCount() - Method in interface org.apache.wiki.pages.PageManager

Returns the total count of all pages in the repository.

getType() - Method in class org.apache.wiki.auth.WikiPrincipal

Returns the Principal "type": WikiPrincipal.LOGIN_NAME, WikiPrincipal.FULL_NAME, WikiPrincipal.WIKI_NAME or WikiPrincipal.WIKI_NAME

getType() - Method in class org.apache.wiki.tags.RequestResourceTag

Get the resource type.

getType() - Method in interface org.apache.wiki.ui.admin.AdminBean

Returns a type (UNKNOWN, EDITOR, etc).

getType() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getType() - Method in class org.apache.wiki.ui.admin.beans.FilterBean

Returns a type (UNKNOWN, EDITOR, etc).

getType() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

getType() - Method in class org.apache.wiki.ui.admin.beans.PluginBean

Returns a type (UNKNOWN, EDITOR, etc).

getType() - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

getType() - Method in class org.apache.wiki.ui.admin.beans.UserBean

getTypeFromString(String) - Method in interface org.apache.wiki.ui.admin.AdminBeanManager

Returns the type identifier for a string type.

getTypeFromString(String) - Method in class org.apache.wiki.ui.admin.DefaultAdminBeanManager

Returns the type identifier for a string type.

getUid() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the unique identifier for the user profile.

getUid() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the unique identifier for the user profile.

getURL() - Method in class org.apache.wiki.rss.Entry

Return the URL set by setURL().

getURL(String, String) - Method in class org.apache.wiki.WikiContext

Creates a URL for the given request context.

getURL(String, String, String) - Method in class org.apache.wiki.WikiContext

Returns a URL from a page.

getURL(String, String, String) - Method in class org.apache.wiki.WikiEngine

getURLConstructor() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( URLConstructor.class ) instead.

getURLPattern() - Method in class org.apache.wiki.ui.AbstractCommand

getURLPattern() - Method in class org.apache.wiki.WikiContext

getURLPattern(String, String) - Static method in class org.apache.wiki.url.DefaultURLConstructor

Returns the URL pattern for a supplied wiki request context.

getUserCookie(HttpServletRequest) - Static method in class org.apache.wiki.auth.login.CookieAssertionLoginModule

Returns the username cookie value.

getUserDatabase() - Method in class org.apache.wiki.auth.DefaultUserManager

Returns the UserDatabase employed by this Engine.

getUserDatabase() - Method in class org.apache.wiki.auth.login.UserDatabaseCallback

Returns the user database object.

getUserDatabase() - Method in interface org.apache.wiki.auth.UserManager

Returns the UserDatabase employed by this Engine.

getUserInfo(String) - Method in class org.apache.wiki.auth.DefaultUserManager.JSONUserModule

Directly returns the UserProfile object attached to an uid.

getUserManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( UserManager.class ) instead.

getUserPrincipal() - Method in class org.apache.wiki.ui.WikiRequestWrapper

Returns the user principal for the HTTP request, taking into account both container and JSPWiki custom authentication status.

getUserPrincipal() - Method in class org.apache.wiki.WikiSession

getUserProfile(Session) - Method in class org.apache.wiki.auth.DefaultUserManager

Retrieves the UserProfile for the user in a session.

getUserProfile(Session) - Method in interface org.apache.wiki.auth.UserManager

Retrieves the UserProfile for the user in a session.

getValue() - Method in class org.apache.wiki.parser.PluginContent

getValue() - Method in class org.apache.wiki.parser.VariableContent

Evaluates the variable and returns the contents.

getValue() - Method in class org.apache.wiki.workflow.Fact

Returns this Fact's value.

getValue(Context, String) - Method in class org.apache.wiki.variables.DefaultVariableManager

Returns a value of the named variable.

getValue(Context, String) - Method in interface org.apache.wiki.variables.VariableManager

Returns a value of the named variable.

getValue(Context, String, String) - Method in class org.apache.wiki.variables.DefaultVariableManager

Returns the value of a named variable.

getValue(Context, String, String) - Method in interface org.apache.wiki.variables.VariableManager

Returns the value of a named variable.

getVar() - Method in class org.apache.wiki.tags.VariableTag

getVariable(String) - Method in class org.apache.wiki.WikiContext

Gets a previously set variable.

getVariable(Context, String) - Method in class org.apache.wiki.variables.DefaultVariableManager

Shortcut to getValue().

getVariable(Context, String) - Method in interface org.apache.wiki.variables.VariableManager

Shortcut to getValue().

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.AdminBeanIteratorInfo

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.AttachmentsIteratorInfo

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.CheckLockInfo

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.EditorIteratorInfo

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.HistoryIteratorInfo

getVariableInfo(TagData) - Method in class org.apache.wiki.tags.SearchResultIteratorInfo

getVariableManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( VariableManager.class ) instead.

getVersion() - Method in class org.apache.wiki.tags.DiffLinkTag

getVersion() - Method in class org.apache.wiki.tags.LinkTag

getVersion() - Method in class org.apache.wiki.tags.LinkToTag

getVersion() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getVersion() - Method in class org.apache.wiki.WikiPage

Returns the version that this WikiPage instance represents.

getVersionDescription() - Method in class org.apache.wiki.ui.admin.beans.CoreBean

getVersionHistory(String) - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns a list of versions of the attachment.

getVersionHistory(String) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns a list of versions of the attachment.

getVersionHistory(String) - Method in class org.apache.wiki.pages.DefaultPageManager

Gets a version history of page.

getVersionHistory(String) - Method in interface org.apache.wiki.pages.PageManager

Gets a version history of page.

getVersionHistory(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

The FileSystemProvider provides only one version.

getVersionHistory(String) - Method in class org.apache.wiki.providers.CachingProvider

getVersionHistory(String) - Method in class org.apache.wiki.providers.VersioningFileProvider

The FileSystemProvider provides only one version.

getVersionHistory(Attachment) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

getVersionHistory(Attachment) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

getViewURL(String) - Method in class org.apache.wiki.WikiContext

A shortcut to generate a VIEW url.

getWebXml() - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Returns an Document representing JSPWiki's web application deployment descriptor.

getWiki() - Method in class org.apache.wiki.auth.authorize.Group

Returns the wiki name.

getWiki() - Method in class org.apache.wiki.auth.permissions.AllPermission

Returns the name of the wiki containing the page represented by this permission; may return the wildcard string.

getWiki() - Method in class org.apache.wiki.auth.permissions.GroupPermission

Returns the name of the wiki containing the group represented by this permission; may return the wildcard string.

getWiki() - Method in class org.apache.wiki.auth.permissions.PagePermission

Returns the name of the wiki containing the page represented by this permission; may return the wildcard string.

getWiki() - Method in class org.apache.wiki.auth.permissions.WikiPermission

Returns the name of the wiki containing the page represented by this permission; may return the wildcard string.

getWiki() - Method in class org.apache.wiki.WikiPage

Returns the wiki name for this page

getWikiContext(ServletRequest) - Method in class org.apache.wiki.ui.WikiServletFilter

Figures out the wiki context from the request.

getWikiName() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns the user's wiki name.

getWikiName() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns the user's wiki name, based on the full name with all whitespace removed.

getWikiNames() - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op.

getWikiNames() - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

Returns all WikiNames that are stored in the UserDatabase as an array of WikiPrincipal objects.

getWikiNames() - Method in interface org.apache.wiki.auth.user.UserDatabase

Returns all WikiNames that are stored in the UserDatabase as an array of Principal objects.

getWikiNames() - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Returns all WikiNames that are stored in the UserDatabase as an array of Principal objects.

getWikiProperties() - Method in class org.apache.wiki.WikiEngine

getWikiSession() - Method in class org.apache.wiki.WikiContext

Returns the Session associated with the context.

getWikiSession(Engine, HttpServletRequest) - Static method in class org.apache.wiki.WikiSession

Static factory method that returns the Session object associated with the current HTTP request.

getWorkDir() - Method in class org.apache.wiki.WikiEngine

getWorkflowContext() - Method in class org.apache.wiki.workflow.AbstractStep

getWorkflowId() - Method in class org.apache.wiki.workflow.AbstractStep

getWorkflowManager() - Method in class org.apache.wiki.WikiEngine

Deprecated.

use getManager( WorkflowManager.class ) instead.

getWorkflows() - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns a collection of the currently active workflows.

getWorkflows() - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns a collection of the currently active workflows.

getWorkflowsAsMap() - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns a map of the currently active workflows.

getWorkflowsAsMap() - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns a map of the currently active workflows.

getWysiwygRenderer(Context, WikiDocument) - Method in class org.apache.wiki.render.DefaultRenderingManager

Returns a WikiRenderer instance meant for WYSIWYG editing, initialized with the given context and doc.

getWysiwygRenderer(Context, WikiDocument) - Method in interface org.apache.wiki.render.RenderingManager

Returns a WikiRenderer instance meant for WYSIWYG editing, initialized with the given context and doc.

Group - Class in org.apache.wiki.auth.authorize

Groups are a specialized type of ad-hoc role used by the wiki system.

Group(String, String) - Constructor for class org.apache.wiki.auth.authorize.Group

Protected constructor to prevent direct instantiation except by other package members.

GroupCommand - Class in org.apache.wiki.ui

Defines Commands for viewing, editing and deleting wiki groups.

GroupDatabase - Interface in org.apache.wiki.auth.authorize

Defines an interface for loading, persisting and storing wiki groups.

GroupManager - Interface in org.apache.wiki.auth.authorize

Facade class for storing, retrieving and managing wiki groups on behalf of AuthorizationManager, JSPs and other presentation-layer classes.

GroupPermission - Class in org.apache.wiki.auth.permissions

Permission to perform an operation on a group in a given wiki.

GroupPermission(String, String) - Constructor for class org.apache.wiki.auth.permissions.GroupPermission

Creates a new GroupPermission for a specified group and set of actions.

GroupPrincipal - Class in org.apache.wiki.auth

Immutable Principal that represents a Group.

GroupPrincipal(String) - Constructor for class org.apache.wiki.auth.GroupPrincipal

Constructs a new GroupPrincipal object with a supplied name.

groups() - Method in interface org.apache.wiki.auth.authorize.GroupDatabase

Returns all wiki groups that are stored in the GroupDatabase as an array of Group objects.

groups() - Method in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Returns all wiki groups that are stored in the GroupDatabase as an array of Group objects.

groups() - Method in class org.apache.wiki.auth.authorize.XMLGroupDatabase

Returns all wiki groups that are stored in the GroupDatabase as an array of Group objects.

Groups - Class in org.apache.wiki.plugin

Prints the groups managed by this wiki, separated by commas.

Groups() - Constructor for class org.apache.wiki.plugin.Groups

guest(Engine) - Method in class org.apache.wiki.spi.SessionSPIDefaultImpl

GUEST - Static variable in class org.apache.wiki.auth.WikiPrincipal

Represents an anonymous user.

guestSession(Engine) - Static method in class org.apache.wiki.WikiSession

Static factory method that creates a new "guest" session containing a single user Principal WikiPrincipal.GUEST, plus the role principals Role.ALL and Role.ANONYMOUS.

H

handle(Callback[]) - Method in class org.apache.wiki.auth.login.WebContainerCallbackHandler

handle(Callback[]) - Method in class org.apache.wiki.auth.login.WikiCallbackHandler

handlePost(Context, HttpServletRequest, HttpServletResponse) - Method in class org.apache.wiki.ui.admin.WikiFormAdminBean

handleResponse(Context, Map<?, ?>) - Method in class org.apache.wiki.ui.admin.WikiFormAdminBean

HANDLERPARAM_PREFIX - Static variable in class org.apache.wiki.forms.FormElement

In order to make the form-to-handler parameter transfer easier, we prefix all user-specified FORM element names with HANDLERPARAM_PREFIX the HTML output.

hasAccess(Context, HttpServletResponse) - Method in interface org.apache.wiki.auth.AuthorizationManager

Checks whether the current user has access to the wiki context, by obtaining the required Permission (Command.requiredPermission()) and delegating the access check to AuthorizationManager.checkPermission(Session, Permission).

hasAccess(Context, HttpServletResponse, boolean) - Method in interface org.apache.wiki.auth.AuthorizationManager

Checks whether the current user has access to the wiki context (and optionally redirects if not), by obtaining the required Permission (Command.requiredPermission()) and delegating the access check to AuthorizationManager.checkPermission(Session, Permission).

hasAccess(Context, HttpServletResponse, boolean) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Checks whether the current user has access to the wiki context (and optionally redirects if not), by obtaining the required Permission (Command.requiredPermission()) and delegating the access check to AuthorizationManager.checkPermission(Session, Permission).

hasAdminPermissions() - Method in class org.apache.wiki.WikiContext

Returns true, if the current user has administrative permissions (i.e. the omnipotent AllPermission).

hasAttachments(Page) - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns true, if the page has any attachments at all.

HasAttachmentsTag - Class in org.apache.wiki.tags

Includes body if page has attachments.

HasAttachmentsTag() - Constructor for class org.apache.wiki.tags.HasAttachmentsTag

hashCode() - Method in class org.apache.wiki.auth.acl.UnresolvedPrincipal

The hashCode of this object is equal to the hash code of its name.

hashCode() - Method in class org.apache.wiki.auth.authorize.Group

The hashcode is calculated as a XOR sum over all members of the Group.

hashCode() - Method in class org.apache.wiki.auth.authorize.Role

Returns a unique hashcode for the Role.

hashCode() - Method in class org.apache.wiki.auth.GroupPrincipal

Returns the hashcode for this object.

hashCode() - Method in class org.apache.wiki.auth.login.PrincipalWrapper

The hashcode is based on the hashcode of the wrapped principal.

hashCode() - Method in class org.apache.wiki.auth.permissions.AllPermission

Returns the hash code for this WikiPermission.

hashCode() - Method in class org.apache.wiki.auth.permissions.GroupPermission

Returns the hash code for this GroupPermission.

hashCode() - Method in class org.apache.wiki.auth.permissions.PagePermission

Returns the hash code for this PagePermission.

hashCode() - Method in class org.apache.wiki.auth.permissions.WikiPermission

Returns the hash code for this WikiPermission.

hashCode() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

hashCode() - Method in class org.apache.wiki.auth.WikiPrincipal

The hashCode() returned for the WikiPrincipal is the same as for its name.

hashCode() - Method in class org.apache.wiki.modules.WikiModuleInfo

hashCode() - Method in class org.apache.wiki.WikiPage

hashCode() - Method in class org.apache.wiki.workflow.Fact

hashCode() - Method in class org.apache.wiki.workflow.Outcome

The hashcode of an Outcome is identical to the hashcode of its message key, multiplied by 2 if it is a "completion" Outcome.

HASHLINK - Static variable in class org.apache.wiki.parser.MarkupParser

hasMetadata() - Method in class org.apache.wiki.WikiPage

Returns true if the page has valid metadata; that is, it has been parsed.

hasPrincipal(Principal) - Method in class org.apache.wiki.WikiSession

hasReference() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns true, if there is a reference.

hasRoleOrPrincipal(Session, Principal) - Method in interface org.apache.wiki.auth.AuthorizationManager

Determines if the Subject associated with a supplied Session contains a desired user Principal or built-in Role principal, OR is a member a Group or external Role.

hasRoleOrPrincipal(Session, Principal) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Determines if the Subject associated with a supplied Session contains a desired user Principal or built-in Role principal, OR is a member a Group or external Role.

heading() - Method in class org.apache.wiki.ui.admin.beans.FilterBean

html blob describing the values of each WikiModuleInfo inspected.

heading() - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

html blob describing the values of each WikiModuleInfo inspected.

heading() - Method in class org.apache.wiki.ui.admin.beans.PluginBean

html blob describing the values of each WikiModuleInfo inspected.

Heading - Class in org.apache.wiki.parser

This class is used to store the headings in a manner which allow the building of a Table Of Contents.

Heading() - Constructor for class org.apache.wiki.parser.Heading

HEADING_LARGE - Static variable in class org.apache.wiki.parser.Heading

Defines a large heading.

HEADING_MEDIUM - Static variable in class org.apache.wiki.parser.Heading

Defines a medium-size heading.

HEADING_SMALL - Static variable in class org.apache.wiki.parser.Heading

Defines a small heading.

headingAdded(Context, Heading) - Method in interface org.apache.wiki.parser.HeadingListener

Is called whenever a heading is encountered in the stream.

headingAdded(Context, Heading) - Method in class org.apache.wiki.plugin.TableOfContents

Is called whenever a heading is encountered in the stream.

HeadingListener - Interface in org.apache.wiki.parser

Provides a listener interface for headings.

hide() - Method in class org.apache.wiki.forms.FormInfo

Returns true, if the form is supposed to be hidden.

HIDE_SUCCESS - Static variable in class org.apache.wiki.forms.FormElement

Show values.

HistoryIteratorInfo - Class in org.apache.wiki.tags

Just provides the TEI data for HistoryIteratorTag.

HistoryIteratorInfo() - Constructor for class org.apache.wiki.tags.HistoryIteratorInfo

HistoryIteratorTag - Class in org.apache.wiki.tags

Iterates through tags.

HistoryIteratorTag() - Constructor for class org.apache.wiki.tags.HistoryIteratorTag

HTML - Static variable in class org.apache.wiki.tags.InsertPageTag

HttpRequestCallback - Class in org.apache.wiki.auth.login

Callback for requesting and supplying a HttpServletRequest required by a LoginModule.

HttpRequestCallback() - Constructor for class org.apache.wiki.auth.login.HttpRequestCallback

I

I18NDEFAULT_LOCALE - Static variable in interface org.apache.wiki.ui.TemplateManager

I18N string to mark the default locale

I18NRESOURCE_EN - Static variable in interface org.apache.wiki.ui.TemplateManager

The default (en) RESOURCE name and id.

I18NRESOURCE_EN_ID - Static variable in interface org.apache.wiki.ui.TemplateManager

I18NRESOURCE_PREFIX - Static variable in interface org.apache.wiki.ui.TemplateManager

Location of I18N Resource bundles, and path prefix and suffixes

I18NRESOURCE_SUFFIX - Static variable in interface org.apache.wiki.ui.TemplateManager

I18NSERVER_TIMEZONE - Static variable in interface org.apache.wiki.ui.TemplateManager

I18N string to mark the server timezone

ID - Static variable in class org.apache.wiki.ui.InputValidator

ID_NOT_SET - Static variable in class org.apache.wiki.workflow.Workflow

ID value: the workflow ID has not been set.

ifInclude(Context, Map<String, String>) - Static method in class org.apache.wiki.plugin.IfPlugin

Returns a boolean result based on processing the WikiContext and parameter Map as according to the rules stated in the IfPlugin documentation.

IfNoSearchResultsTag - Class in org.apache.wiki.tags

If there have been no search results, then outputs the body text.

IfNoSearchResultsTag() - Constructor for class org.apache.wiki.tags.IfNoSearchResultsTag

IfPlugin - Class in org.apache.wiki.plugin

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.

IfPlugin() - Constructor for class org.apache.wiki.plugin.IfPlugin

IGNORE - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

The token is to be ignored.

Image - Class in org.apache.wiki.plugin

Provides an image plugin for better control than is possible with a simple image inclusion.

Image() - Constructor for class org.apache.wiki.plugin.Image

IMAGE - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

IMAGELINK - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

IMAGEWIKILINK - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

implies(Permission) - Method in class org.apache.wiki.auth.permissions.AllPermission

WikiPermission can only imply other WikiPermissions; no other permission types are implied.

implies(Permission) - Method in class org.apache.wiki.auth.permissions.AllPermissionCollection

Iterates through the AllPermission objects stored by this AllPermissionCollection and determines if any of them imply a supplied Permission.

implies(Permission) - Method in class org.apache.wiki.auth.permissions.GroupPermission

GroupPermissions can only imply other GroupPermissions; no other permission types are implied.

implies(Permission) - Method in class org.apache.wiki.auth.permissions.PagePermission

PagePermission can only imply other PagePermissions; no other permission types are implied.

implies(Permission) - Method in class org.apache.wiki.auth.permissions.WikiPermission

WikiPermission can only imply other WikiPermissions; no other permission types are implied.

IncludeResourcesTag - Class in org.apache.wiki.tags

This tag is used to include any programmatic includes into the output stream.

IncludeResourcesTag() - Constructor for class org.apache.wiki.tags.IncludeResourcesTag

IncludeTag - Class in org.apache.wiki.tags

Includes an another JSP page, making sure that we actually pass the WikiContext correctly.

IncludeTag() - Constructor for class org.apache.wiki.tags.IncludeTag

IndexPlugin - Class in org.apache.wiki.plugin

A Plugin that creates an index of pages according to a certain pattern.

IndexPlugin() - Constructor for class org.apache.wiki.plugin.IndexPlugin

INFO - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message prefix for information messages.

INFO - Static variable in class org.apache.wiki.ui.PageCommand

INFO - Static variable in class org.apache.wiki.WikiContext

User is viewing page history.

INFO_DB - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for user database information messages.

INFO_GROUPS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for group database information messages.

INFO_JAAS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for JAAS information messages.

INFO_POLICY - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for policy information messages.

INFO_ROLES - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for role-checking information messages.

init(FilterConfig) - Method in class org.apache.wiki.ui.WikiJSPFilter

Initializes the WikiServletFilter.

init(FilterConfig) - Method in class org.apache.wiki.ui.WikiServletFilter

Initializes the WikiServletFilter.

init(ServletConfig) - Method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

This sets the AjaxPath to "/ajax/" as configured in "jspwiki.ajax.url.prefix".

init(ServletConfig) - Method in class org.apache.wiki.attachment.AttachmentServlet

Initializes the servlet from Engine properties.

init(ServletConfig) - Method in class org.apache.wiki.rpc.atom.AtomAPIServlet

init(ServletConfig) - Method in class org.apache.wiki.WikiServlet

init(ServletConfig) - Method in class org.apache.wiki.xmlrpc.RPCServlet

Initializes the servlet.

initHandler(String, String) - Method in class org.apache.wiki.xmlrpc.RPCServlet

initialize() - Method in interface org.apache.wiki.ui.admin.AdminBeanManager

initialize() - Method in class org.apache.wiki.ui.admin.DefaultAdminBeanManager

initialize(Collection<Page>) - Method in class org.apache.wiki.references.DefaultReferenceManager

Initializes the entire reference manager with the initial set of pages from the collection.

initialize(Collection<Page>) - Method in interface org.apache.wiki.references.ReferenceManager

Initializes the entire reference manager with the initial set of pages from the collection.

initialize(Properties) - Method in class org.apache.wiki.filters.DefaultFilterManager

Initializes the filters from an XML file.

initialize(Properties) - Method in class org.apache.wiki.pages.PageSorter

Called by Engine to initialise this instance.

initialize(Properties) - Method in class org.apache.wiki.WikiEngine

Does all the real initialization.

initialize(Subject, CallbackHandler, Map<String, ?>, Map<String, ?>) - Method in class org.apache.wiki.auth.login.AbstractLoginModule

Initializes the LoginModule with a given Subject, callback handler, options and shared state.

initialize(Context) - Method in class org.apache.wiki.xmlrpc.AbstractRPCHandler

initialize(Context) - Method in class org.apache.wiki.xmlrpc.MetaWeblogHandler

initialize(Context) - Method in interface org.apache.wiki.xmlrpc.WikiRPCHandler

initialize(Context, Map<String, String>) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

initialize(Engine) - Method in class org.apache.wiki.plugin.PageViewPlugin

Initialize the PageViewPlugin and its singleton.

initialize(Engine) - Method in class org.apache.wiki.plugin.PageViewPlugin.PageViewManager

Initialize the page view manager.

initialize(Engine) - Method in interface org.apache.wiki.ui.admin.AdminBean

initialize(Engine) - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

initialize(Engine) - Method in class org.apache.wiki.ui.admin.SimpleAdminBean

Initialize the AdminBean by setting up a Engine instance internally.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.acl.DefaultAclManager

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Initializes the authorizer.

initialize(Engine, Properties) - Method in interface org.apache.wiki.auth.authorize.GroupDatabase

Initializes the group database based on values from a Properties object.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Initializes the group database based on values from a Properties object.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Initializes the authorizer for.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.authorize.XMLGroupDatabase

Initializes the group database based on values from a Properties object.

initialize(Engine, Properties) - Method in interface org.apache.wiki.auth.Authorizer

Initializes the authorizer.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Expects to find property 'jspwiki.authorizer' with a valid Authorizer implementation name to take care of role lookup operations.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.DefaultUserManager

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Initializes the user database based on values from a Properties object.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

initialize(Engine, Properties) - Method in interface org.apache.wiki.auth.user.UserDatabase

Initializes the user database based on values from a Properties object.

initialize(Engine, Properties) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Initializes the user database based on values from a Properties object.

initialize(Engine, Properties) - Method in class org.apache.wiki.diff.ContextualDiffProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.diff.DiffProvider.NullDiffProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.diff.ExternalDiffProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.diff.TraditionalDiffProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.filters.CreoleFilter

initialize(Engine, Properties) - Method in class org.apache.wiki.filters.PageEventFilter

Called whenever a new PageFilter is instantiated and reset.

initialize(Engine, Properties) - Method in class org.apache.wiki.filters.PingWeblogsComFilter

initialize(Engine, Properties) - Method in class org.apache.wiki.filters.SpamFilter

initialize(Engine, Properties) - Method in class org.apache.wiki.providers.AbstractFileProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.providers.CachingProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.providers.VersioningFileProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.render.DefaultRenderingManager

Checks for cache size settings, initializes the document cache.

initialize(Engine, Properties) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Start the RSS generator & generator thread

initialize(Engine, Properties) - Method in class org.apache.wiki.search.BasicSearchProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.search.DefaultSearchManager

initialize(Engine, Properties) - Method in class org.apache.wiki.search.LuceneSearchProvider

initialize(Engine, Properties) - Method in class org.apache.wiki.ui.DefaultEditorManager

Initializes the EditorManager.

initialize(Engine, Properties) - Method in class org.apache.wiki.url.DefaultURLConstructor

initialize(Engine, Properties) - Method in class org.apache.wiki.url.ShortURLConstructor

initialize(Engine, Properties) - Method in class org.apache.wiki.url.ShortViewURLConstructor

initialize(Engine, Properties) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Any properties that begin with WorkflowManager.PROPERTY_APPROVER_PREFIX will be assumed to be Decisions that require approval.

initializeFromXML(Element) - Method in class org.apache.wiki.modules.WikiModuleInfo

Initializes the ModuleInfo from some standard XML elements which are under the given element.

initializeFromXML(Element) - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Initializes the ModuleInfo from some standard XML elements which are under the given element.

initInlineImagePatterns() - Method in class org.apache.wiki.parser.MarkupParser

initReferenceManager() - Method in class org.apache.wiki.WikiEngine

Initializes the reference manager.

initTag() - Method in class org.apache.wiki.tags.BreadcrumbsTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.CalendarTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.CheckLockTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.CheckRequestContextTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.CheckVersionTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.DiffLinkTag

initTag() - Method in class org.apache.wiki.tags.EditLinkTag

initTag() - Method in class org.apache.wiki.tags.IncludeResourcesTag

initTag() - Method in class org.apache.wiki.tags.IncludeTag

initTag() - Method in class org.apache.wiki.tags.InsertDiffTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.InsertPageTag

initTag() - Method in class org.apache.wiki.tags.LinkTag

initTag() - Method in class org.apache.wiki.tags.LinkToTag

initTag() - Method in class org.apache.wiki.tags.MessagesTag

initTag() - Method in class org.apache.wiki.tags.NoSuchPageTag

initTag() - Method in class org.apache.wiki.tags.PageDateTag

initTag() - Method in class org.apache.wiki.tags.PageTypeTag

initTag() - Method in class org.apache.wiki.tags.PermissionTag

Initializes the tag.

initTag() - Method in class org.apache.wiki.tags.RequestResourceTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.RSSImageLinkTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.SetPaginationTag

initTag() - Method in class org.apache.wiki.tags.UserCheckTag

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

initTag() - Method in class org.apache.wiki.tags.UserProfileTag

initTag() - Method in class org.apache.wiki.tags.VariableTag

initTag() - Method in class org.apache.wiki.tags.WikiLinkTag

initTag() - Method in class org.apache.wiki.tags.WikiTagBase

This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.

injectGroupPrincipals() - Method in class org.apache.wiki.WikiSession

Injects GroupPrincipal objects into the user's Principal set based on the groups the user belongs to.

injectUserProfilePrincipals() - Method in class org.apache.wiki.WikiSession

Adds Principal objects to the Subject that correspond to the logged-in user's profile attributes for the wiki name, full name and login name.

InputValidator - Class in org.apache.wiki.ui

Provides basic validation services for HTTP parameters.

InputValidator(String, Context) - Constructor for class org.apache.wiki.ui.InputValidator

Constructs a new input validator for a specific form and wiki session.

InsertDiffTag - Class in org.apache.wiki.tags

Writes difference between two pages using a HTML table.

InsertDiffTag() - Constructor for class org.apache.wiki.tags.InsertDiffTag

insertInputFields(PageContext) - Static method in class org.apache.wiki.filters.SpamFilter

This helper method adds all the input fields to your editor that the SpamFilter requires to check for spam.

INSERTION_END_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

INSERTION_START_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

InsertPage - Class in org.apache.wiki.plugin

Inserts page contents.

InsertPage() - Constructor for class org.apache.wiki.plugin.InsertPage

InsertPageTag - Class in org.apache.wiki.tags

Renders WikiPage content.

InsertPageTag() - Constructor for class org.apache.wiki.tags.InsertPageTag

INSTALL - Static variable in class org.apache.wiki.ui.WikiCommand

INSTALL - Static variable in class org.apache.wiki.WikiContext

User is administering JSPWiki (Install, SecurityConfig).

INSTALL_ERROR - Static variable in class org.apache.wiki.ui.Installer

INSTALL_INFO - Static variable in class org.apache.wiki.ui.Installer

INSTALL_WARNING - Static variable in class org.apache.wiki.ui.Installer

Installer - Class in org.apache.wiki.ui

Manages JSPWiki installation on behalf of admin/Install.jsp.

Installer(HttpServletRequest, ServletConfig) - Constructor for class org.apache.wiki.ui.Installer

InternalModule - Interface in org.apache.wiki.modules

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.

InternalWikiException - Exception in org.apache.wiki

Denotes something really serious going on inside Wiki.

InternalWikiException(String) - Constructor for exception org.apache.wiki.InternalWikiException

Create a new InternalWikiException.

InternalWikiException(String, Throwable) - Constructor for exception org.apache.wiki.InternalWikiException

InternalWikiException(Throwable) - Constructor for exception org.apache.wiki.InternalWikiException

InternationalizationManager - Interface in org.apache.wiki.i18n

Manages all internationalization in JSPWiki.

INTERWIKI - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

interWikiLinkAt(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true, if this Link represents an InterWiki link (of the form wiki:page).

invalidate() - Method in class org.apache.wiki.WikiSession

invalidateMetadata() - Method in class org.apache.wiki.WikiPage

This method will remove all metadata from the page.

invoke(String, Object[], String[]) - Method in class org.apache.wiki.management.SimpleMBean

Invokes a particular method.

invoke(Context) - Method in class org.apache.wiki.parser.PluginContent

isAborted() - Method in class org.apache.wiki.workflow.Workflow

Returns true if the workflow had been previously aborted.

isAccessRule(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true, if the link in question is an access rule.

isAlive() - Method in interface org.apache.wiki.Watchable

Returns true, if this Watchable is still alive and can be watched; otherwise false.

isAnonymous() - Method in class org.apache.wiki.WikiSession

isAsserted() - Method in class org.apache.wiki.WikiSession

isAuthenticated() - Method in class org.apache.wiki.WikiSession

isBlank(String) - Static method in class org.apache.wiki.ui.InputValidator

Returns true if a supplied string is null or blank

isBuiltInRole(Role) - Static method in class org.apache.wiki.auth.authorize.Role

Returns true if a supplied Role is a built-in Role: Role.ALL, Role.ANONYMOUS, Role.ASSERTED, or Role.AUTHENTICATED.

isCacheable() - Method in class org.apache.wiki.attachment.Attachment

Returns true, if this attachment can be cached by the user agent.

isCompleted() - Method in class org.apache.wiki.workflow.AbstractStep

Determines whether the Step is completed; if not, it is by definition awaiting action by the owner or in process.

isCompleted() - Method in interface org.apache.wiki.workflow.Step

Determines whether the Step is completed; if not, it is by definition awaiting action by the owner or in process.

isCompleted() - Method in class org.apache.wiki.workflow.Workflow

Determines whether this Workflow is completed; that is, if it has no additional Steps to perform.

isCompletion() - Method in class org.apache.wiki.workflow.Outcome

Returns true if this Outcome represents a completion condition for a Step.

isConfigured() - Method in class org.apache.wiki.WikiEngine

isConstrained(String, Role) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Protected method that identifies whether a particular webapp URL is constrained to a particular Role.

isContainerAuthenticated() - Method in interface org.apache.wiki.auth.AuthenticationManager

Returns true if this Engine uses container-managed authentication.

isContainerAuthenticated() - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Returns true if this Engine uses container-managed authentication.

isContainerAuthorized() - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Returns true if the web container is configured to protect certain JSPWiki resources by requiring authentication.

isEmpty() - Method in class org.apache.wiki.auth.acl.AclImpl

isEnabled() - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Returns true if RSS generation is enabled.

isEnabled() - Method in interface org.apache.wiki.rss.RSSGenerator

Returns true if RSS generation is enabled.

isEnabled() - Method in class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

isExpired() - Method in class org.apache.wiki.pages.PageLock

isExternalLink(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Figures out if a link is an off-site link.

isImageInlining() - Method in class org.apache.wiki.parser.MarkupParser

isImageLink(String, boolean, List<Pattern>) - Method in class org.apache.wiki.parser.LinkParsingOperations

Matches the given link to the list of image name patterns to determine whether it should be treated as an inline image or not.

isInGroup(Group) - Method in class org.apache.wiki.WikiSession

Returns true if one of this WikiSession's user Principals can be shown to belong to a particular wiki group.

isInterwikiLink() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns true, if this Link represents an InterWiki link (of the form wiki:page).

isInterWikiLink(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true, if this Link represents an InterWiki link (of the form wiki:page).

isLocked() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns true if the profile is currently locked (disabled); false otherwise.

isLocked() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns true if the profile is currently locked (disabled); false otherwise.

isMember(Principal) - Method in class org.apache.wiki.auth.authorize.Group

Returns true if a Principal is a member of the group.

isMetadata(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true if the link is a metadata link.

isNew() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns true if the user profile is new.

isNew() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns true if the profile has never been saved before.

isParseAccessRules() - Method in class org.apache.wiki.parser.MarkupParser

isPluginLink(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true if the link is really command to insert a plugin.

isReadOnly() - Method in class org.apache.wiki.auth.permissions.AllPermissionCollection

isReassignable() - Method in class org.apache.wiki.workflow.Decision

Returns true if the Decision can be reassigned to another actor.

isReassignable() - Method in class org.apache.wiki.workflow.SimpleNotification

Notifications cannot be re-assigned, so this method always returns false.

isReservedName(String) - Static method in class org.apache.wiki.auth.authorize.Role

Returns true if the supplied name is identical to the name of a built-in Role; that is, the value returned by getName() for built-in Roles Role.ALL, Role.ANONYMOUS, Role.ASSERTED, or Role.AUTHENTICATED.

isRolePrincipal(Principal) - Static method in interface org.apache.wiki.auth.AuthenticationManager

Determines whether the supplied Principal is a "role principal".

isSecurityPolicyConfigured() - Method in class org.apache.wiki.auth.SecurityVerifier

Returns true if the Java security policy is configured correctly, and it verifies as valid.

isSelected() - Method in class org.apache.wiki.ui.Editor

Convenience method which returns XHTML for an option element.

isSelected(String) - Method in class org.apache.wiki.ui.Editor

isSelected(String, String) - Method in class org.apache.wiki.ui.Editor

isSpace(char) - Static method in class org.apache.wiki.parser.LinkParser

Returns true if char c is a member of S (space) [XML 1.1 production 3].

isSpace(String) - Static method in class org.apache.wiki.parser.LinkParser

Returns true if the String s is completely composed of whitespace.

isStarted() - Method in class org.apache.wiki.workflow.AbstractStep

Determines whether the Step has started.

isStarted() - Method in interface org.apache.wiki.workflow.Step

Determines whether the Step has started.

isStarted() - Method in class org.apache.wiki.workflow.Workflow

Determines whether this Workflow has started; that is, its Workflow.start(Context) method has been executed.

isStateFindDefaultTab() - Method in class org.apache.wiki.tags.TabbedSectionTag

Returns true, if the tab system is currently trying to figure out which is the default tab.

isStateGenerateTabBody() - Method in class org.apache.wiki.tags.TabbedSectionTag

Returns true, if the tab system is currently generating the tab body.

isStateGenerateTabMenu() - Method in class org.apache.wiki.tags.TabbedSectionTag

Returns true, if the tab system is currently generating the tab menu.

isStateStackNotEmpty() - Method in class org.apache.wiki.WatchDog

helper to see if the associated stateStack is not empty.

isUserInRole(String) - Method in class org.apache.wiki.ui.WikiRequestWrapper

Determines whether the current user possesses a supplied role, taking into account both container and JSPWIki custom authentication status.

isUserInRole(HttpServletRequest, Principal) - Method in interface org.apache.wiki.auth.authorize.WebAuthorizer

Determines whether a user associated with an HTTP request possesses a particular role.

isUserInRole(HttpServletRequest, Principal) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Determines whether a user associated with an HTTP request possesses a particular role.

isUserInRole(Session, Principal) - Method in interface org.apache.wiki.auth.AuthorizationManager

Determines if the Subject associated with a supplied Session contains a desired Role or GroupPrincipal.

isUserInRole(Session, Principal) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Determines whether the Subject associated with a WikiSession is in a particular role.

isUserInRole(Session, Principal) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Determines whether the Subject associated with a Session is in a particular role.

isUserInRole(Session, Principal) - Method in interface org.apache.wiki.auth.Authorizer

Determines whether the Subject associated with a WikiSession is in a particular role.

isUserPrincipal(Principal) - Static method in interface org.apache.wiki.auth.AuthenticationManager

Determines whether the supplied Principal is a "user principal".

isValidUserProfile(Context, UserProfile) - Method in class org.apache.wiki.filters.SpamFilter

Checks whether the UserProfile matches certain checks.

isVariableLink(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true if the link is really command to insert a variable.

isWatchableAlive() - Method in class org.apache.wiki.WatchDog

helper to see if the associated watchable is alive.

items - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

IteratorTag - Class in org.apache.wiki.tags

Iterates through tags.

IteratorTag() - Constructor for class org.apache.wiki.tags.IteratorTag

J

JDBCGroupDatabase - Class in org.apache.wiki.auth.authorize

Implementation of GroupDatabase that persists Group objects to a JDBC DataSource, as might typically be provided by a web container.

JDBCGroupDatabase() - Constructor for class org.apache.wiki.auth.authorize.JDBCGroupDatabase

JDBCUserDatabase - Class in org.apache.wiki.auth.user

Implementation of UserDatabase that persists DefaultUserProfile objects to a JDBC DataSource, as might typically be provided by a web container.

JDBCUserDatabase() - Constructor for class org.apache.wiki.auth.user.JDBCUserDatabase

JSON_PROGRESSTRACKER - Static variable in interface org.apache.wiki.ui.progress.ProgressManager

JSON_SEARCH - Static variable in interface org.apache.wiki.search.SearchManager

The name of the JSON object that manages search.

JSON_USERS - Static variable in interface org.apache.wiki.auth.UserManager

JSONSearch() - Constructor for class org.apache.wiki.search.DefaultSearchManager.JSONSearch

JSONTracker() - Constructor for class org.apache.wiki.ui.progress.DefaultProgressManager.JSONTracker

JSONUserModule(DefaultUserManager) - Constructor for class org.apache.wiki.auth.DefaultUserManager.JSONUserModule

Create a new JSONUserModule.

JSPWikiMarkupParser - Class in org.apache.wiki.parser

Parses JSPWiki-style markup into a WikiDocument DOM tree.

JSPWikiMarkupParser(Context, Reader) - Constructor for class org.apache.wiki.parser.JSPWikiMarkupParser

Creates a markup parser.

L

LINE_BREAK_HTML - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

Link(String) - Constructor for class org.apache.wiki.parser.LinkParser.Link

Create a new Link with text but no reference.

Link(String, String) - Constructor for class org.apache.wiki.parser.LinkParser.Link

Create a new link with a given text and hyperlink (reference).

LINK_EXTERNAL - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

Link to an external resource.

LINK_INLINE - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

This is an inlined image.

LINK_LOCAL - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

Link to a local wiki page.

LinkCollector - Class in org.apache.wiki

Just a simple class collecting all the links that come in.

LinkCollector() - Constructor for class org.apache.wiki.LinkCollector

linkExists(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns true, if the link name exists; otherwise it returns false.

linkIfExists(String) - Method in class org.apache.wiki.parser.LinkParsingOperations

Returns link name, if it exists; otherwise it returns null.

LinkParser - Class in org.apache.wiki.parser

Parses JSPWiki-style "augmented" link markup into a Link object containing the link text, link reference, and any optional link attributes (as JDOM Attributes).

LinkParser() - Constructor for class org.apache.wiki.parser.LinkParser

LinkParser.Link - Class in org.apache.wiki.parser

Inner class serving as a struct containing the parsed components of a link.

LinkParsingOperations - Class in org.apache.wiki.parser

Link parsing operations.

LinkParsingOperations(Context) - Constructor for class org.apache.wiki.parser.LinkParsingOperations

LINKS_SOURCE - Static variable in class org.apache.wiki.render.WikiRenderer

LINKS_TRANSLATION - Static variable in class org.apache.wiki.render.WikiRenderer

LinkTag - Class in org.apache.wiki.tags

Provides a generic link tag for all kinds of linking purposes.

LinkTag() - Constructor for class org.apache.wiki.tags.LinkTag

LinkToParentTag - Class in org.apache.wiki.tags

Writes a link to a parent of a Wiki page.

LinkToParentTag() - Constructor for class org.apache.wiki.tags.LinkToParentTag

LinkToTag - Class in org.apache.wiki.tags

Writes a link to a Wiki page.

LinkToTag() - Constructor for class org.apache.wiki.tags.LinkToTag

listAllChanged(Date) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

listAllChanged(Date) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

listAttachments(Page) - Method in interface org.apache.wiki.attachment.AttachmentManager

Returns the list of attachments associated with a given wiki page.

listAttachments(Page) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Returns the list of attachments associated with a given wiki page.

listAttachments(Page) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

listAttachments(Page) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

listLanguages(PageContext) - Method in interface org.apache.wiki.ui.TemplateManager

List all installed i18n language properties by classpath searching for files like : templates/default_*.properties templates/default.properties

listLinks(String) - Method in class org.apache.wiki.xmlrpc.RPCHandler

listLinks(String) - Method in class org.apache.wiki.xmlrpc.RPCHandlerUTF8

ListLocksPlugin - Class in org.apache.wiki.plugin

This is a plugin for the administrator: It allows him to see in a single glance who is editing what.

ListLocksPlugin() - Constructor for class org.apache.wiki.plugin.ListLocksPlugin

listSkins(PageContext, String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

Lists the skins available under this template.

listSkins(PageContext, String) - Method in interface org.apache.wiki.ui.TemplateManager

Lists the skins available under this template.

listTimeFormats(PageContext) - Method in class org.apache.wiki.ui.DefaultTemplateManager

List all available timeformats, read from the jspwiki.properties

listTimeFormats(PageContext) - Method in interface org.apache.wiki.ui.TemplateManager

List all available timeformats, read from the jspwiki.properties

listTimeZones(PageContext) - Method in interface org.apache.wiki.ui.TemplateManager

List all timezones, with special marker for server timezone

listWikiNames() - Method in class org.apache.wiki.auth.DefaultUserManager

A helper method for returning all of the known WikiNames in this system.

listWikiNames() - Method in interface org.apache.wiki.auth.UserManager

A helper method for returning all of the known WikiNames in this system.

LOCAL - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

LocalEntityResolver() - Constructor for class org.apache.wiki.auth.authorize.WebContainerAuthorizer.LocalEntityResolver

LOCALREF - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

lockPage(Page, String) - Method in class org.apache.wiki.pages.DefaultPageManager

Locks page for editing.

lockPage(Page, String) - Method in interface org.apache.wiki.pages.PageManager

Locks page for editing.

LOG - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

LOG - Static variable in class org.apache.wiki.auth.login.AnonymousLoginModule

LOG - Static variable in class org.apache.wiki.auth.login.WebContainerLoginModule

LOG - Static variable in class org.apache.wiki.auth.user.AbstractUserDatabase

LOG - Static variable in class org.apache.wiki.search.LuceneSearchProvider

login() - Method in class org.apache.wiki.auth.login.AbstractLoginModule

Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.

login() - Method in class org.apache.wiki.auth.login.AnonymousLoginModule

Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.

login() - Method in class org.apache.wiki.auth.login.CookieAssertionLoginModule

Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.

login() - Method in class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

Logs in the user by calling back to the registered CallbackHandler with a series of callbacks.

login() - Method in class org.apache.wiki.auth.login.UserDatabaseLoginModule

login() - Method in class org.apache.wiki.auth.login.WebContainerLoginModule

Logs in the user.

login(HttpServletRequest) - Method in interface org.apache.wiki.auth.AuthenticationManager

Logs in the user by attempting to populate a Session Subject from a web servlet request by examining the request for the presence of container credentials and user cookies.

login(HttpServletRequest) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Logs in the user by attempting to populate a Session Subject from a web servlet request by examining the request for the presence of container credentials and user cookies.

login(Session, HttpServletRequest, String, String) - Method in interface org.apache.wiki.auth.AuthenticationManager

Attempts to perform a Session login for the given username/password combination using JSPWiki's custom authentication mode.

login(Session, HttpServletRequest, String, String) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Attempts to perform a Session login for the given username/password combination using JSPWiki's custom authentication mode.

LOGIN - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

A static instance of the login permission.

LOGIN - Static variable in class org.apache.wiki.ui.WikiCommand

LOGIN - Static variable in class org.apache.wiki.WikiContext

User is preparing for a login/authentication.

LOGIN_ACTION - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Name of the action for login permission.

LOGIN_NAME - Static variable in class org.apache.wiki.auth.WikiPrincipal

WikiPrincipal type denoting a user's login name.

logout() - Method in class org.apache.wiki.auth.login.AbstractLoginModule

Logs the user out.

logout(HttpServletRequest) - Method in interface org.apache.wiki.auth.AuthenticationManager

Logs the user out by retrieving the Session associated with the HttpServletRequest and unbinding all of the Subject's Principals, except for Role.ALL, Role.ANONYMOUS. is a cheap-and-cheerful way to do it without invoking JAAS LoginModules.

logout(HttpServletRequest) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Logs the user out by retrieving the Session associated with the HttpServletRequest and unbinding all of the Subject's Principals, except for Role.ALL, Role.ANONYMOUS. is a cheap-and-cheerful way to do it without invoking JAAS LoginModules.

LOGOUT - Static variable in class org.apache.wiki.ui.WikiCommand

LOGOUT - Static variable in class org.apache.wiki.WikiContext

User is preparing to log out.

LUCENE_ATTACHMENTS - Static variable in class org.apache.wiki.search.LuceneSearchProvider

LUCENE_AUTHOR - Static variable in class org.apache.wiki.search.LuceneSearchProvider

LUCENE_ID - Static variable in class org.apache.wiki.search.LuceneSearchProvider

LUCENE_PAGE_CONTENTS - Static variable in class org.apache.wiki.search.LuceneSearchProvider

LUCENE_PAGE_KEYWORDS - Static variable in class org.apache.wiki.search.LuceneSearchProvider

LUCENE_PAGE_NAME - Static variable in class org.apache.wiki.search.LuceneSearchProvider

luceneIndexPage(Page, String, IndexWriter) - Method in class org.apache.wiki.search.LuceneSearchProvider

Indexes page using the given IndexWriter.

LuceneSearchProvider - Class in org.apache.wiki.search

Interface for the search providers that handle searching the Wiki

LuceneSearchProvider() - Constructor for class org.apache.wiki.search.LuceneSearchProvider

M

m_accesskey - Variable in class org.apache.wiki.tags.EditLinkTag

m_accesskey - Variable in class org.apache.wiki.tags.LinkToTag

m_accesskey - Variable in class org.apache.wiki.tags.PageInfoLinkTag

m_adminBeanClass - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_after - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_attachmentLinkMutatorChain - Variable in class org.apache.wiki.parser.MarkupParser

m_author - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_authorUrl - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_beanInfo - Variable in class org.apache.wiki.management.SimpleMBean

m_before - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_channelDescription - Variable in class org.apache.wiki.rss.Feed

m_channelLanguage - Variable in class org.apache.wiki.rss.Feed

m_channelTitle - Variable in class org.apache.wiki.rss.Feed

m_containerAuthorized - Variable in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Lazily-initialized boolean flag indicating whether the web container protects JSPWiki resources.

m_containerRoles - Variable in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

A lazily-initialized array of Roles that the container knows about.

m_context - Variable in class org.apache.wiki.parser.MarkupParser

m_context - Variable in class org.apache.wiki.render.WikiRenderer

m_context - Variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

m_dateFormat - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_dateLastModified - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_description - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_document - Variable in class org.apache.wiki.render.WikiRenderer

m_emitChangeNextPreviousHyperlinks - Variable in class org.apache.wiki.diff.ContextualDiffProvider

m_encoding - Variable in class org.apache.wiki.providers.AbstractFileProvider

m_engine - Variable in class org.apache.wiki.auth.authorize.DefaultGroupManager

m_engine - Variable in class org.apache.wiki.auth.authorize.WebContainerAuthorizer

m_engine - Variable in class org.apache.wiki.modules.BaseModuleManager

m_engine - Variable in class org.apache.wiki.parser.MarkupParser

m_engine - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_engine - Variable in class org.apache.wiki.providers.AbstractFileProvider

m_engine - Variable in class org.apache.wiki.ui.admin.SimpleAdminBean

Provides access to a Engine instance to which this AdminBean belongs to.

m_engine - Variable in class org.apache.wiki.ui.WikiServletFilter

m_engine - Variable in class org.apache.wiki.url.DefaultURLConstructor

m_engine - Variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

m_entries - Variable in class org.apache.wiki.rss.Feed

m_exclude - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_externalLinkMutatorChain - Variable in class org.apache.wiki.parser.MarkupParser

m_feedURL - Variable in class org.apache.wiki.rss.Feed

m_format - Variable in class org.apache.wiki.tags.AuthorTag

m_format - Variable in class org.apache.wiki.tags.WikiLinkTag

m_groupListener - Variable in class org.apache.wiki.auth.authorize.DefaultGroupManager

m_handler - Variable in class org.apache.wiki.auth.login.AbstractLoginModule

m_headingListenerChain - Variable in class org.apache.wiki.parser.MarkupParser

m_htmlTemplate - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_in - Variable in class org.apache.wiki.parser.MarkupParser

m_include - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_inlineImagePatterns - Variable in class org.apache.wiki.parser.MarkupParser

Keeps image regexp Patterns

m_inlineImages - Variable in class org.apache.wiki.parser.MarkupParser

m_iterator - Variable in class org.apache.wiki.tags.IteratorTag

m_lastModified - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_level - Variable in class org.apache.wiki.parser.Heading

Denotes the level of the heading.

m_linkMutators - Variable in class org.apache.wiki.parser.MarkupParser

m_linkParsingOperations - Variable in class org.apache.wiki.parser.MarkupParser

m_localLinkMutatorChain - Variable in class org.apache.wiki.parser.MarkupParser

Optionally stores internal wikilinks

m_loginModuleClass - Variable in class org.apache.wiki.auth.DefaultAuthenticationManager

Class (of type LoginModule) to use for custom authentication.

m_loginModuleOptions - Variable in class org.apache.wiki.auth.DefaultAuthenticationManager

Options passed to LoginModule.initialize(Subject, CallbackHandler, Map, Map); initialized by DefaultAuthenticationManager.initialize(Engine, Properties).

m_maxVersion - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_maxwidth - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_minVersion - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_mode - Variable in class org.apache.wiki.rss.Feed

m_moduleUrl - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_moduleVersion - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_name - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_options - Variable in class org.apache.wiki.auth.login.AbstractLoginModule

m_page - Variable in exception org.apache.wiki.providers.RepositoryModifiedException

m_page - Variable in class org.apache.wiki.tags.IncludeTag

m_pageLocks - Variable in class org.apache.wiki.pages.DefaultPageManager

m_pageName - Variable in class org.apache.wiki.tags.InsertDiffTag

m_pageName - Variable in class org.apache.wiki.tags.InsertPageTag

m_pageName - Variable in class org.apache.wiki.tags.IteratorTag

m_pageName - Variable in class org.apache.wiki.tags.WikiLinkTag

m_parseAccessRules - Variable in class org.apache.wiki.parser.MarkupParser

m_pathPrefix - Variable in class org.apache.wiki.url.DefaultURLConstructor

Contains the absolute path of the JSPWiki Web application without the actual servlet (which is the m_urlPrefix).

m_permissions - Variable in class org.apache.wiki.auth.permissions.AllPermissionCollection

m_principals - Variable in class org.apache.wiki.auth.login.AbstractLoginModule

Implementing classes should add Principals to this collection; these will be added to the principal set when the overall login succeeds.

m_request - Variable in class org.apache.wiki.WikiContext

Stores the HttpServletRequest.

m_resource - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_scriptLocation - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_scriptText - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_separator - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_show - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_sorter - Variable in class org.apache.wiki.plugin.AbstractReferralPlugin

m_state - Variable in class org.apache.wiki.auth.login.AbstractLoginModule

m_state - Variable in class org.apache.wiki.ui.progress.ProgressItem

m_stylesheetLocation - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_stylesheetText - Variable in class org.apache.wiki.modules.WikiModuleInfo

m_subject - Variable in class org.apache.wiki.auth.login.AbstractLoginModule

m_template - Variable in class org.apache.wiki.tags.WikiLinkTag

m_title - Variable in class org.apache.wiki.tags.EditLinkTag

m_title - Variable in class org.apache.wiki.tags.LinkToTag

m_title - Variable in class org.apache.wiki.tags.PageInfoLinkTag

m_title - Variable in class org.apache.wiki.tags.RSSImageLinkTag

m_titleAnchor - Variable in class org.apache.wiki.parser.Heading

Contains the anchor to the heading

m_titleSection - Variable in class org.apache.wiki.parser.Heading

Contains a section link.

m_titleText - Variable in class org.apache.wiki.parser.Heading

Contains the text of the heading.

m_updates - Variable in class org.apache.wiki.search.LuceneSearchProvider

m_urlPrefix - Variable in class org.apache.wiki.url.ShortURLConstructor

Contains the path part after the JSPWiki base URL

m_version - Variable in class org.apache.wiki.tags.EditLinkTag

m_wikiContext - Variable in class org.apache.wiki.rss.Feed

m_wikiContext - Variable in class org.apache.wiki.tags.IteratorTag

m_wikiContext - Variable in class org.apache.wiki.tags.WikiBodyTag

m_wikiContext - Variable in class org.apache.wiki.tags.WikiTagBase

main(String[]) - Static method in class org.apache.wiki.TranslationsCheck

makeDiff(Context, String, String) - Method in class org.apache.wiki.diff.DefaultDifferenceManager

Returns valid XHTML string to be used in any way you please.

makeDiff(Context, String, String) - Method in interface org.apache.wiki.diff.DifferenceManager

Returns valid XHTML string to be used in any way you please.

makeDiffHtml(Context, String, String) - Method in class org.apache.wiki.diff.ContextualDiffProvider

Do a colored diff of the two regions.

makeDiffHtml(Context, String, String) - Method in interface org.apache.wiki.diff.DiffProvider

The return string is to be XHTML compliant ready to display html.

makeDiffHtml(Context, String, String) - Method in class org.apache.wiki.diff.DiffProvider.NullDiffProvider

The return string is to be XHTML compliant ready to display html.

makeDiffHtml(Context, String, String) - Method in class org.apache.wiki.diff.ExternalDiffProvider

Makes the diff by calling "diff" program.

makeDiffHtml(Context, String, String) - Method in class org.apache.wiki.diff.TraditionalDiffProvider

Makes a diff using the BMSI utility package.

makeEntryPage(String) - Static method in class org.apache.wiki.plugin.WeblogPlugin

Return just the basename for entires without date and entry numebr.

makeEntryPage(String, String) - Static method in class org.apache.wiki.plugin.WeblogPlugin

Returns the entry page without the entry number.

makeEntryPage(String, String, String) - Static method in class org.apache.wiki.plugin.WeblogPlugin

Create an entry name based on the blogname, a date, and an entry number.

makeError(String) - Static method in class org.apache.wiki.parser.MarkupParser

Writes HTML for error message.

makeHeading(int, String, Heading) - Method in class org.apache.wiki.parser.JSPWikiMarkupParser

Returns XHTML for the heading.

makeHeadingAnchor(String, String, Heading) - Method in class org.apache.wiki.parser.JSPWikiMarkupParser

Modifies the "hd" parameter to contain proper values.

makeHTML(Context, String) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

Makes HTML with common parameters.

makeURL(String, String, String) - Method in class org.apache.wiki.url.DefaultURLConstructor

Constructs the URL with a bunch of parameters.

makeURL(String, String, String) - Method in class org.apache.wiki.url.ShortURLConstructor

Constructs the URL with a bunch of parameters.

makeURL(String, String, String) - Method in class org.apache.wiki.url.ShortViewURLConstructor

Constructs the URL with a bunch of parameters.

makeURL(String, String, String) - Method in interface org.apache.wiki.url.URLConstructor

Constructs the URL with a bunch of parameters.

managers - Variable in class org.apache.wiki.WikiEngine

Stores WikiEngine's associated managers.

mangleName(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

This makes sure that the queried page name is still readable by the file system.

MarkupParser - Class in org.apache.wiki.parser

Provides an abstract class for the parser instances.

MarkupParser(Context, Reader) - Constructor for class org.apache.wiki.parser.MarkupParser

Constructs a MarkupParser.

matchPageContent(String, String) - Method in class org.apache.wiki.search.SearchMatcher

Compares the page content, available through the given stream, to the query items of this matcher.

MAX_DEPTH - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The maximum depth.

MAX_PROPKEYLENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

This number limits the length of a custom page property key length.

MAX_PROPLIMIT - Static variable in class org.apache.wiki.providers.AbstractFileProvider

This parameter limits the number of custom page properties allowed on a page

MAX_PROPVALUELENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

This number limits the length of a custom page property value length.

MAX_SEARCH_HITS - Static variable in class org.apache.wiki.search.LuceneSearchProvider

The maximum number of hits to return from searches.

maxResults - Variable in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

MEMBER_TOKEN - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Special target token that denotes all groups that a Subject's Principals are members of.

members() - Method in class org.apache.wiki.auth.authorize.Group

Returns the members of the group as an array of Principal objects.

MESSAGE - Static variable in class org.apache.wiki.ui.WikiCommand

MESSAGE - Static variable in class org.apache.wiki.WikiContext

JSPWiki wants to display a message.

MESSAGES_KEY - Static variable in interface org.apache.wiki.auth.authorize.GroupManager

Key used for adding UI messages to a user's Session.

MessagesTag - Class in org.apache.wiki.tags

Returns or clears the current messages associated with the user's wiki session.

MessagesTag() - Constructor for class org.apache.wiki.tags.MessagesTag

MetaWeblogHandler - Class in org.apache.wiki.xmlrpc

Provides handlers for all RPC routines of the MetaWeblog API.

MetaWeblogHandler() - Constructor for class org.apache.wiki.xmlrpc.MetaWeblogHandler

MIN_DEPTH - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The minimum depth.

MODE_BLOG - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent a 'blog' style feed.

MODE_FULL - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent a 'full' style feed.

MODE_WIKI - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent a 'wiki' style feed.

MODIFY - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the modify permission.

MODIFY_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the modify permission.

ModuleBean - Class in org.apache.wiki.ui.admin.beans

ModuleBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.ModuleBean

ModuleManager - Interface in org.apache.wiki.modules

modules() - Method in class org.apache.wiki.filters.DefaultFilterManager

Returns a collection of modules currently managed by this ModuleManager.

modules() - Method in interface org.apache.wiki.modules.ModuleManager

Returns a collection of modules currently managed by this ModuleManager.

modules() - Method in class org.apache.wiki.plugin.DefaultPluginManager

Returns a collection of modules currently managed by this ModuleManager.

modules() - Method in class org.apache.wiki.ui.admin.beans.FilterBean

Obtains the collection of modules which is going to be inspected at ModuleBean.doGet(Context).

modules() - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

Obtains the collection of modules which is going to be inspected at ModuleBean.doGet(Context).

modules() - Method in class org.apache.wiki.ui.admin.beans.PluginBean

Obtains the collection of modules which is going to be inspected at ModuleBean.doGet(Context).

modules() - Method in class org.apache.wiki.ui.DefaultEditorManager

Returns a collection of modules currently managed by this ModuleManager.

modules() - Method in class org.apache.wiki.ui.DefaultTemplateManager

Returns a collection of modules currently managed by this ModuleManager.

modules(Iterator<T>) - Method in class org.apache.wiki.modules.BaseModuleManager

moveAttachmentsForPage(String, String) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

moveAttachmentsForPage(String, String) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

movePage(String, String) - Method in class org.apache.wiki.providers.CachingProvider

movePage(String, String) - Method in class org.apache.wiki.providers.FileSystemProvider

movePage(String, String) - Method in class org.apache.wiki.providers.VersioningFileProvider

mutate(Context, String) - Method in class org.apache.wiki.LinkCollector

Returns a changed String, suitable for Wiki context.

mutate(Context, String) - Method in interface org.apache.wiki.StringTransmutator

Returns a changed String, suitable for Wiki context.

N

newMediaObject(String, String, String, Hashtable<String, Object>) - Method in class org.apache.wiki.xmlrpc.MetaWeblogHandler

Creates an attachment and adds it to the blog.

newPermissionCollection() - Method in class org.apache.wiki.auth.permissions.AllPermission

Returns a new AllPermissionCollection.

newPermissionCollection() - Method in class org.apache.wiki.auth.permissions.PagePermission

Returns a new AllPermissionCollection.

newPermissionCollection() - Method in class org.apache.wiki.auth.permissions.WikiPermission

Returns a new AllPermissionCollection.

newPluginInstance(List<String>, List<String>) - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Creates a new plugin instance.

newPost(String, String, String, Hashtable<String, Object>, boolean) - Method in class org.apache.wiki.xmlrpc.MetaWeblogHandler

Adds a new post to the blog.

newProfile() - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Factory method that instantiates a new DefaultUserProfile with a new, distinct unique identifier.

newProfile() - Method in interface org.apache.wiki.auth.user.UserDatabase

Factory method that instantiates a new user profile.

newWikiPlugin(String, ResourceBundle) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Creates a Plugin.

newWikiPlugin(String, ResourceBundle) - Method in interface org.apache.wiki.plugin.PluginManager

Creates a Plugin.

nextToken() - Method in class org.apache.wiki.parser.MarkupParser

Returns the next token in the stream.

NextVersionTag - Class in org.apache.wiki.tags

Writes the version number of the next version of the page.

NextVersionTag() - Constructor for class org.apache.wiki.tags.NextVersionTag

NONE - Static variable in class org.apache.wiki.ui.PageCommand

NONE - Static variable in class org.apache.wiki.WikiContext

This is not a JSPWiki context, use it to access static files.

NoSuchOutcomeException - Exception in org.apache.wiki.workflow

Exception thrown when an attempt is made to find an Outcome that does not exist.

NoSuchOutcomeException(String) - Constructor for exception org.apache.wiki.workflow.NoSuchOutcomeException

Constructs a new exception.

NoSuchPageTag - Class in org.apache.wiki.tags

Includes the body in case there is no such page available.

NoSuchPageTag() - Constructor for class org.apache.wiki.tags.NoSuchPageTag

NoSuchPrincipalException - Exception in org.apache.wiki.auth

Thrown in some error situations where a WikiPrincipal object does not exist.

NoSuchPrincipalException(String) - Constructor for exception org.apache.wiki.auth.NoSuchPrincipalException

Constructs a new exception object with a supplied message.

NoSuchVersionException - Exception in org.apache.wiki.providers

Indicates that an non-existing version was specified.

NoSuchVersionException(String) - Constructor for exception org.apache.wiki.providers.NoSuchVersionException

Creates a ProviderException.

Note - Class in org.apache.wiki.plugin

Outputs an image with the supplied text as the title which is shown as a tooltip by most browsers.

Note() - Constructor for class org.apache.wiki.plugin.Note

NULL - Static variable in class org.apache.wiki.auth.login.AbstractLoginModule

NullDiffProvider() - Constructor for class org.apache.wiki.diff.DiffProvider.NullDiffProvider

O

OK - Static variable in class org.apache.wiki.forms.FormInfo

State: Form is OK.

org.apache.wiki - package org.apache.wiki

The chief package of JSPWiki.

org.apache.wiki.ajax - package org.apache.wiki.ajax

AJAX support classes.

org.apache.wiki.attachment - package org.apache.wiki.attachment

Attachment management, uploading and downloading.

org.apache.wiki.auth - package org.apache.wiki.auth

Authentication, Authorization and the third A thing.

org.apache.wiki.auth.acl - package org.apache.wiki.auth.acl

Access Control List implementation.

org.apache.wiki.auth.authorize - package org.apache.wiki.auth.authorize

Authorizer implementation.

org.apache.wiki.auth.login - package org.apache.wiki.auth.login

Provides the different login modules that JSPWiki uses.

org.apache.wiki.auth.permissions - package org.apache.wiki.auth.permissions

org.apache.wiki.auth.user - package org.apache.wiki.auth.user

org.apache.wiki.content - package org.apache.wiki.content

Provides content management functionality for JSPWiki.

org.apache.wiki.diff - package org.apache.wiki.diff

org.apache.wiki.filters - package org.apache.wiki.filters

Provides page and content filtering functionality for JSPWiki.

org.apache.wiki.forms - package org.apache.wiki.forms

Contains classes for doing form handling within JSPWiki.

org.apache.wiki.i18n - package org.apache.wiki.i18n

I18n related classes.

org.apache.wiki.management - package org.apache.wiki.management

org.apache.wiki.modules - package org.apache.wiki.modules

org.apache.wiki.pages - package org.apache.wiki.pages

Provides the JSPWiki wiki page related functionality.

org.apache.wiki.parser - package org.apache.wiki.parser

org.apache.wiki.plugin - package org.apache.wiki.plugin

Provides plugins to the JSPWiki.

org.apache.wiki.preferences - package org.apache.wiki.preferences

Preferences storage.

org.apache.wiki.providers - package org.apache.wiki.providers

Provides storage for JSPWiki.

org.apache.wiki.references - package org.apache.wiki.references

Provides the JSPWiki track of pages' references.

org.apache.wiki.render - package org.apache.wiki.render

Provides the JSPWiki rendering functionality.

org.apache.wiki.rpc.atom - package org.apache.wiki.rpc.atom

Provides the JSPWiki ATOM API functionality.

org.apache.wiki.rss - package org.apache.wiki.rss

Provides the JSPWiki RSS feeds functionality.

org.apache.wiki.search - package org.apache.wiki.search

Provides the JSPWiki search functionality.

org.apache.wiki.spi - package org.apache.wiki.spi

org.apache.wiki.tags - package org.apache.wiki.tags

Provides standard JSP tags for JSPWiki.

org.apache.wiki.tasks - package org.apache.wiki.tasks

Provides specific tasks for JSPWiki, meant to be executed by the workflow framework.

org.apache.wiki.tasks.auth - package org.apache.wiki.tasks.auth

Provides auth-related Tasks, meant to be executed by the workflow framework.

org.apache.wiki.tasks.pages - package org.apache.wiki.tasks.pages

Provides WikiPages' saving related Tasks, meant to be executed by the workflow framework.

org.apache.wiki.ui - package org.apache.wiki.ui

Java classes for management of the JSP user interface.

org.apache.wiki.ui.admin - package org.apache.wiki.ui.admin

Contains classes for the JSPWiki administrative interface.

org.apache.wiki.ui.admin.beans - package org.apache.wiki.ui.admin.beans

org.apache.wiki.ui.progress - package org.apache.wiki.ui.progress

Provides progress management routines.

org.apache.wiki.url - package org.apache.wiki.url

Provides the URL generation routines.

org.apache.wiki.variables - package org.apache.wiki.variables

org.apache.wiki.workflow - package org.apache.wiki.workflow

org.apache.wiki.xmlrpc - package org.apache.wiki.xmlrpc

OTHER - Static variable in class org.apache.wiki.ui.PageCommand

OTHER - Static variable in class org.apache.wiki.WikiContext

Same as NONE; this is just a clarification.

Outcome - Class in org.apache.wiki.workflow

Resolution of a workflow Step, such as "approve," "deny," "hold," "task error," or other potential resolutions.

OUTLINK - Static variable in class org.apache.wiki.parser.MarkupParser

Outlink css class.

OUTLINK_IMAGE - Static variable in class org.apache.wiki.parser.MarkupParser

Name of the outlink image; relative path to the JSPWiki directory.

P

page(Engine, String) - Method in class org.apache.wiki.spi.ContentsSPIDefaultImpl

PAGE_DIR - Static variable in class org.apache.wiki.ui.Installer

PageCommand - Class in org.apache.wiki.ui

Defines Commands for editing, renaming, and viewing wiki pages.

PageDateTag - Class in org.apache.wiki.tags

Writes the modification date of the page, formatted as specified in the attribute "format".

PageDateTag() - Constructor for class org.apache.wiki.tags.PageDateTag

PAGEDIR - Static variable in class org.apache.wiki.providers.VersioningFileProvider

Name of the directory where the old versions are stored.

PageEventFilter - Class in org.apache.wiki.filters

Fires WikiPageEvents for page events.

PageEventFilter() - Constructor for class org.apache.wiki.filters.PageEventFilter

pageExists(String) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns true, if the page exists (any version) on the underlying WikiPageProvider.

pageExists(String) - Method in interface org.apache.wiki.pages.PageManager

Returns true, if the page exists (any version) on the underlying WikiPageProvider.

pageExists(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

pageExists(String) - Method in class org.apache.wiki.providers.CachingProvider

pageExists(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Checks for existence of a specific page and version on the underlying WikiPageProvider.

pageExists(String, int) - Method in interface org.apache.wiki.pages.PageManager

Checks for existence of a specific page and version on the underlying WikiPageProvider.

pageExists(String, int) - Method in class org.apache.wiki.providers.AbstractFileProvider

pageExists(String, int) - Method in class org.apache.wiki.providers.CachingProvider

pageExists(String, int) - Method in class org.apache.wiki.providers.VersioningFileProvider

pageExists(String, int) - Method in interface org.apache.wiki.providers.VersioningProvider

Return true, if page with a particular version exists.

pageExists(Page) - Method in interface org.apache.wiki.pages.PageManager

Checks for existence of a specific page and version denoted by a WikiPage on the underlying WikiPageProvider.

PageExistsTag - Class in org.apache.wiki.tags

Includes the body in case the set page does exist.

PageExistsTag() - Constructor for class org.apache.wiki.tags.PageExistsTag

PageInfoLinkTag - Class in org.apache.wiki.tags

Writes a link to the Wiki PageInfo.

PageInfoLinkTag() - Constructor for class org.apache.wiki.tags.PageInfoLinkTag

PageLock - Class in org.apache.wiki.pages

Describes a lock acquired by an user on a page.

PageLock(Page, String, Date, Date) - Constructor for class org.apache.wiki.pages.PageLock

Creates a new PageLock.

PageManager - Interface in org.apache.wiki.pages

PageNameTag - Class in org.apache.wiki.tags

Returns the currently requested page name.

PageNameTag() - Constructor for class org.apache.wiki.tags.PageNameTag

PagePermission - Class in org.apache.wiki.auth.permissions

Permission to perform an operation on a single page or collection of pages in a given wiki.

PagePermission(String, String) - Constructor for class org.apache.wiki.auth.permissions.PagePermission

Creates a new PagePermission for a specified page name and set of actions.

PagePermission(Page, String) - Constructor for class org.apache.wiki.auth.permissions.PagePermission

Creates a new PagePermission for a specified page and set of actions.

pageRemoved(Page) - Method in class org.apache.wiki.references.DefaultReferenceManager

Updates the m_referedTo and m_referredBy hashmaps when a page has been deleted.

pageRemoved(Page) - Method in interface org.apache.wiki.references.ReferenceManager

Updates the m_referedTo and m_referredBy hashmaps when a page has been deleted.

pageRemoved(Page) - Method in class org.apache.wiki.search.BasicSearchProvider

Delete a page from the search index.

pageRemoved(Page) - Method in class org.apache.wiki.search.LuceneSearchProvider

Delete a page from the search index.

pageRemoved(Page) - Method in interface org.apache.wiki.search.SearchManager

Removes the page from the search cache (if any).

pageRemoved(Page) - Method in interface org.apache.wiki.search.SearchProvider

Delete a page from the search index.

PageRenamer - Interface in org.apache.wiki.content

Provides page renaming functionality.

PageSizeTag - Class in org.apache.wiki.tags

Returns the currently requested page or attachment size.

PageSizeTag() - Constructor for class org.apache.wiki.tags.PageSizeTag

PageSorter - Class in org.apache.wiki.pages

Wrapper class for managing and using the PageNameComparator.

PageSorter() - Constructor for class org.apache.wiki.pages.PageSorter

Default constructor uses Java "natural" ordering.

PageSorter(Comparator<String>) - Constructor for class org.apache.wiki.pages.PageSorter

Construct with a particular comparator.

PageTimeComparator - Class in org.apache.wiki.pages

Compares the lastModified date of its arguments.

PageTimeComparator() - Constructor for class org.apache.wiki.pages.PageTimeComparator

PageTypeTag - Class in org.apache.wiki.tags

Includes the body, if the current page is of proper type.

PageTypeTag() - Constructor for class org.apache.wiki.tags.PageTypeTag

PageVersionTag - Class in org.apache.wiki.tags

Writes the version of the current page.

PageVersionTag() - Constructor for class org.apache.wiki.tags.PageVersionTag

PageViewManager() - Constructor for class org.apache.wiki.plugin.PageViewPlugin.PageViewManager

PageViewPlugin - Class in org.apache.wiki.plugin

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:
show=none sort=name

PageViewPlugin() - Constructor for class org.apache.wiki.plugin.PageViewPlugin

PageViewPlugin.PageViewManager - Class in org.apache.wiki.plugin

Page view manager, handling all storage.

PARA_EDITOR - Static variable in interface org.apache.wiki.ui.EditorManager

Parameter for changing editors at run-time

PARAM_AFTER - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for the output after the link.

PARAM_ALIGN - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the align.

PARAM_ALLOWCOMMENTS - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the allowComments.

PARAM_ALT - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the alt.

PARAM_BEFORE - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for the output before the link.

PARAM_BLOGNAME - Static variable in class org.apache.wiki.plugin.WeblogEntryPlugin

Parameter name for setting the page Value is "page".

PARAM_BODY - Static variable in interface org.apache.wiki.plugin.PluginManager

The name of the body content.

PARAM_BORDER - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the border.

PARAM_BOUNDS - Static variable in interface org.apache.wiki.plugin.PluginManager

The name of the parameter containing the start and end positions in the read stream of the plugin text (stored as a two-element int[], start and end resp.).

PARAM_CAPTION - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the caption.

PARAM_CHECKED - Static variable in class org.apache.wiki.forms.FormInput

PARAM_CLASS - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the class.

PARAM_CLASS - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the class.

PARAM_CMDLINE - Static variable in interface org.apache.wiki.plugin.PluginManager

The name of the command line content parameter.

PARAM_COLS - Static variable in class org.apache.wiki.forms.FormTextarea

Parameter name for setting the columns value.

PARAM_COLUMNS - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting the number of columns that will be displayed by the plugin.

PARAM_COLUMNS - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

Parameter name for setting the number of columns that will be displayed by the plugin.

PARAM_CONTAINS - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the contents of the page to check.

PARAM_DATE_FORMAT - Static variable in class org.apache.wiki.plugin.RecentChangesPlugin

Parameter name for the separator dateFormat.

PARAM_DAYS - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the days.

PARAM_DEBUG - Static variable in interface org.apache.wiki.plugin.PluginManager

A special name to be used in case you want to see debug output

PARAM_DEFAULT - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the default.

PARAM_DEPTH - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the depth.

PARAM_DESCRIPTION - Static variable in class org.apache.wiki.plugin.BugReportHandler

Parameter name for setting the description.

PARAM_ELEMENT - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, mandatory, indicates what form element to insert.

PARAM_ENTRYFORMAT - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the entryFormat.

PARAM_ENTRYTEXT - Static variable in class org.apache.wiki.plugin.WeblogEntryPlugin

Parameter name for setting the entrytext Value is "entrytext".

PARAM_EXCLUDE - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting the list of excluded patterns.

PARAM_EXCLUDE - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the excluded pages.

PARAM_EXCLUDEATTS - Static variable in class org.apache.wiki.plugin.UnusedPagesPlugin

If set to "true", attachments are excluded from display.

PARAM_EXISTS - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for checking whether a page/var exists.

PARAM_EXTRAS - Static variable in class org.apache.wiki.plugin.ReferringPagesPlugin

Parameter name for setting the text to show when the maximum items is overruled.

PARAM_EXTRAS - Static variable in class org.apache.wiki.plugin.ReferringUndefinedPagesPlugin

Parameter name for setting the text to show when the maximum items is overruled.

PARAM_FORM - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, mandatory in open/output: name of the form.

PARAM_FORMAT - Static variable in class org.apache.wiki.plugin.RecentChangesPlugin

Parameter name for the separator format.

PARAM_FORMAT - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the format.

PARAM_FORMNAMEHIDDEN - Static variable in class org.apache.wiki.forms.FormElement

HTTP parameter, inserted as hidden variable into the generated form.

PARAM_GROUP - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the group to check.

PARAM_HANDLER - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, mandatory in output element, indicates Plugin to use to handle form submitted data.

PARAM_HEIGHT - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the height.

PARAM_HIDEFORM - Static variable in class org.apache.wiki.forms.FormElement

Experimental: hide the form if it was submitted successfully.

PARAM_INCLUDE - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting the list of included patterns.

PARAM_INCLUDE - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the included pages.

PARAM_INCREMENT - Static variable in class org.apache.wiki.plugin.Counter

Parameter name for setting the increment.

PARAM_INPUTNAME - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, mandatory in input elements: name of an element.

PARAM_IP - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the ip address to check.

PARAM_IS - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the exact content to check.

PARAM_LASTMODIFIED - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for showing the last modification count.

PARAM_LINK - Static variable in class org.apache.wiki.plugin.Denounce

Parameter name for setting the link.

PARAM_LINK - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the link.

PARAM_MAPPINGS - Static variable in class org.apache.wiki.plugin.BugReportHandler

Parameter name for setting the map.

PARAM_MAX - Static variable in class org.apache.wiki.plugin.ReferringPagesPlugin

Parameter name for setting the maximum items to show.

PARAM_MAX - Static variable in class org.apache.wiki.plugin.ReferringUndefinedPagesPlugin

Parameter name for setting the maximum items to show.

PARAM_MAX - Static variable in class org.apache.wiki.plugin.Search

The parameter name for setting the how many results will be fetched.

PARAM_MAXENTRIES - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the maxEntries.

PARAM_MAXLENGTH - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the maxlength.

PARAM_MAXWIDTH - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting the maximum width.

PARAM_METHOD - Static variable in class org.apache.wiki.forms.FormOpen

Parameter name for setting the method (GET or POST).

PARAM_NAME - Static variable in class org.apache.wiki.plugin.Counter

Parameter name for setting the name.

PARAM_NUMBERED - Static variable in class org.apache.wiki.plugin.TableOfContents

Parameter name for setting whether the headings should be numbered.

PARAM_PAGE - Static variable in class org.apache.wiki.plugin.BugReportHandler

Parameter name for setting the page.

PARAM_PAGE - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the page name to check.

PARAM_PAGE - Static variable in class org.apache.wiki.plugin.ReferringPagesPlugin

Parameter name for choosing the page.

PARAM_PAGE - Static variable in class org.apache.wiki.plugin.WeblogArchivePlugin

Parameter name for setting the page.

PARAM_PAGE - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the page.

PARAM_PAGENAME - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the page.

PARAM_POPULATE - Static variable in class org.apache.wiki.forms.FormElement

If set to 'handler' in output element, the handler plugin is called even on first invocation (no submit).

PARAM_PREFIX - Static variable in class org.apache.wiki.plugin.TableOfContents

Parameter name for setting what the prefix for the heading is.

PARAM_PREVIEW - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the preview.

PARAM_PROP - Static variable in class org.apache.wiki.plugin.SessionsPlugin

The parameter name for setting the property value.

PARAM_QUERY - Static variable in class org.apache.wiki.plugin.Search

Parameter name for setting the query string.

PARAM_ROOT - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the root page to start from.

PARAM_ROWS - Static variable in class org.apache.wiki.forms.FormTextarea

Parameter name for setting the rows value.

PARAM_SECTION - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the section.

PARAM_SEPARATOR - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for the separator string.

PARAM_SET - Static variable in class org.apache.wiki.plugin.Search

Parameter name for setting the name of the set where the results are stored.

PARAM_SHOW - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for the show parameter.

PARAM_SHOW - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the show option.

PARAM_SHOW_RESULT - Static variable in class org.apache.wiki.plugin.Counter

Parameter name for setting the showResult.

PARAM_SHOW_VALUE_COUNT - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting show to "count".

PARAM_SHOW_VALUE_PAGES - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for setting show to "pages".

PARAM_SIZE - Static variable in class org.apache.wiki.forms.FormInput

Parameter name for setting the size of the input field.

PARAM_SORTORDER - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

Parameter name for specifying the sort order.

PARAM_SORTORDER_HUMAN - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

PARAM_SORTORDER_JAVA - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

PARAM_SORTORDER_LOCALE - Static variable in class org.apache.wiki.plugin.AbstractReferralPlugin

PARAM_SRC - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the src.

PARAM_START - Static variable in class org.apache.wiki.plugin.Counter

Parameter name for setting the start.

PARAM_START - Static variable in class org.apache.wiki.plugin.TableOfContents

Parameter name for setting where the numbering should start.

PARAM_STARTDATE - Static variable in class org.apache.wiki.plugin.WeblogPlugin

Parameter name for the startDate.

PARAM_STYLE - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the style.

PARAM_STYLE - Static variable in class org.apache.wiki.plugin.InsertPage

Parameter name for setting the style.

PARAM_SUBMITHANDLER - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, optional, indicates servlet to post to.

PARAM_TARGET - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the target.

PARAM_TEXT - Static variable in class org.apache.wiki.plugin.Denounce

Parameter name for setting the text.

PARAM_TIME_FORMAT - Static variable in class org.apache.wiki.plugin.RecentChangesPlugin

Parameter name for the separator timeFormat.

PARAM_TITLE - Static variable in class org.apache.wiki.plugin.BugReportHandler

Parameter name for setting the title.

PARAM_TITLE - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the title.

PARAM_TITLE - Static variable in class org.apache.wiki.plugin.TableOfContents

Parameter name for setting the title.

PARAM_TYPE - Static variable in class org.apache.wiki.forms.FormInput

Parameter name for setting the type.

PARAM_TYPE - Static variable in class org.apache.wiki.plugin.ReferredPagesPlugin

The parameter name for the type of the references.

PARAM_USER - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the user id to check.

PARAM_VALUE - Static variable in class org.apache.wiki.forms.FormElement

Plugin parameter, optional: default value for an input.

PARAM_VAR - Static variable in class org.apache.wiki.plugin.IfPlugin

The parameter name for setting the variable name to check.

PARAM_VERSION - Static variable in class org.apache.wiki.plugin.BugReportHandler

Parameter name for setting the version.

PARAM_WIDTH - Static variable in class org.apache.wiki.plugin.Image

The parameter name for setting the width.

ParamHandler - Interface in org.apache.wiki.tags

Interface to be implemented by any tag that wishes to contain a wiki:param tag for passing dynamic name-value pairs.

ParamTag - Class in org.apache.wiki.tags

ParamTag submits name-value pairs to the first enclosing ParamHandler instance.

ParamTag() - Constructor for class org.apache.wiki.tags.ParamTag

ParentPageNameTag - Class in org.apache.wiki.tags

Returns the parent of the currently requested page.

ParentPageNameTag() - Constructor for class org.apache.wiki.tags.ParentPageNameTag

parse() - Method in class org.apache.wiki.parser.JSPWikiMarkupParser

Parses the entire document from the Reader given in the constructor or set by MarkupParser.setInputReader(Reader).

parse() - Method in class org.apache.wiki.parser.MarkupParser

Parses the document.

parse(String) - Method in class org.apache.wiki.parser.LinkParser

Processes incoming link text, separating out the link text, the link URI, and then any specified attributes.

parseAcl(Page, String) - Method in interface org.apache.wiki.auth.acl.AclManager

A helper method for parsing textual AccessControlLists.

parseAcl(Page, String) - Method in class org.apache.wiki.auth.acl.DefaultAclManager

A helper method for parsing textual AccessControlLists.

parseAndGetValue(Context, String) - Method in class org.apache.wiki.variables.DefaultVariableManager

Parses the link and finds a value.

parseAndGetValue(Context, String) - Method in interface org.apache.wiki.variables.VariableManager

Parses the link and finds a value.

parseArgs(String) - Method in class org.apache.wiki.plugin.DefaultPluginManager

Parses plugin arguments.

parseArgs(String) - Method in interface org.apache.wiki.plugin.PluginManager

Parses plugin arguments.

ParseException - Exception in org.apache.wiki.parser

This is an exception which gets thrown whenever the parser cannot parse the parsing things.

ParseException(String) - Constructor for exception org.apache.wiki.parser.ParseException

Constructs a new ParseException.

parseGroup(String, String, boolean) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Extracts group name and members from passed parameters and populates an existing Group with them.

parseGroup(String, String, boolean) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Extracts group name and members from passed parameters and populates an existing Group with them.

parseGroup(Context, boolean) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Extracts group name and members from the HTTP request and populates an existing Group with them.

parseLong(String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Parses a long integer from a supplied string, or returns 0 if not parsable.

parsePage(String, HttpServletRequest, Charset) - Method in class org.apache.wiki.url.DefaultURLConstructor

Should parse the "page" parameter from the actual request.

parsePage(String, HttpServletRequest, Charset) - Method in class org.apache.wiki.url.ShortURLConstructor

Should parse the "page" parameter from the actual request.

parsePage(String, HttpServletRequest, Charset) - Method in interface org.apache.wiki.url.URLConstructor

Should parse the "page" parameter from the actual request.

parsePageFromURL(HttpServletRequest, Charset) - Static method in interface org.apache.wiki.url.URLConstructor

Takes the name of the page from the request URI.

parsePluginLine(Context, String, int) - Static method in class org.apache.wiki.parser.PluginContent

Parses a plugin invocation and returns a DOM element.

parseProfile(Context) - Method in class org.apache.wiki.auth.DefaultUserManager

Extracts user profile parameters from the HTTP request and populates a UserProfile with them.

parseProfile(Context) - Method in interface org.apache.wiki.auth.UserManager

Extracts user profile parameters from the HTTP request and populates a UserProfile with them.

parseProperties() - Method in class org.apache.wiki.ui.Installer

parseQuery(String) - Method in class org.apache.wiki.search.BasicSearchProvider

Parses a query into something that we can use.

parseToken(int) - Method in class org.apache.wiki.parser.JSPWikiMarkupParser

Return CHARACTER, if you think this was a plain character; ELEMENT, if you think this was a wiki markup element, and IGNORE, if you think we should ignore this altogether.

PermissionFactory - Class in org.apache.wiki.auth.permissions

Provides a factory for Permission objects.

permissions() - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Returns an enumeration of the permissions in this ACL entry.

PermissionTag - Class in org.apache.wiki.tags

Tells whether the user in the current wiki context possesses a particular permission.

PermissionTag() - Constructor for class org.apache.wiki.tags.PermissionTag

PingWeblogsComFilter - Class in org.apache.wiki.filters

A very dumb class that pings weblogs.com on each save.

PingWeblogsComFilter() - Constructor for class org.apache.wiki.filters.PingWeblogsComFilter

PLAIN - Static variable in class org.apache.wiki.tags.InsertPageTag

PlainEditorAdminBean - Class in org.apache.wiki.ui.admin.beans

This class is still experimental.

PlainEditorAdminBean() - Constructor for class org.apache.wiki.ui.admin.beans.PlainEditorAdminBean

PLUGIN_RESOURCE_LOCATION - Static variable in interface org.apache.wiki.modules.ModuleManager

Location of the property-files of plugins.

PluginBean - Class in org.apache.wiki.ui.admin.beans

PluginBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.PluginBean

PluginContent - Class in org.apache.wiki.parser

Stores the contents of a plugin in a WikiDocument DOM tree.

PluginContent(String, Map<String, String>) - Constructor for class org.apache.wiki.parser.PluginContent

Creates a new DOM element with the given plugin name and a map of parameters.

PluginManager - Interface in org.apache.wiki.plugin

pluginsEnabled() - Method in class org.apache.wiki.plugin.DefaultPluginManager

Returns plugin execution status.

pluginsEnabled() - Method in interface org.apache.wiki.plugin.PluginManager

Returns plugin execution status.

PluginTag - Class in org.apache.wiki.tags

Inserts any Wiki plugin.

PluginTag() - Constructor for class org.apache.wiki.tags.PluginTag

POLICY - Static variable in interface org.apache.wiki.auth.AuthorizationManager

Property that supplies the security policy file name, in WEB-INF.

policyPrincipals() - Method in class org.apache.wiki.auth.SecurityVerifier

Returns an array of unique Principals from the JSPWIki security policy file.

policyRoleTable() - Method in class org.apache.wiki.auth.SecurityVerifier

Formats and returns an HTML table containing sample permissions and what roles are allowed to have them.

postSave(Context, String) - Method in class org.apache.wiki.filters.PageEventFilter

This method is called after the page has been successfully saved.

postSave(Context, String) - Method in class org.apache.wiki.filters.PingWeblogsComFilter

postSave(Context, String) - Method in class org.apache.wiki.references.DefaultReferenceManager

After the page has been saved, updates the reference lists.

postTranslate(Context, String) - Method in class org.apache.wiki.filters.PageEventFilter

This method is called after a page has been fed through the TranslatorReader, so anything you are seeing here is translated content.

Preferences - Class in org.apache.wiki.preferences

Represents an object which is used to store user preferences.

Preferences() - Constructor for class org.apache.wiki.preferences.Preferences

Preferences.TimeFormat - Enum in org.apache.wiki.preferences

Is used to choose between the different date formats that JSPWiki supports.

PREFIX_LOGIN_MODULE_OPTIONS - Static variable in interface org.apache.wiki.auth.AuthenticationManager

Prefix for LoginModule options key/value pairs.

PREFS - Static variable in class org.apache.wiki.ui.WikiCommand

PREFS - Static variable in class org.apache.wiki.WikiContext

User is editing preferences

PREFS_COOKIE_NAME - Static variable in class org.apache.wiki.auth.login.CookieAssertionLoginModule

The name of the cookie that gets stored to the user browser.

preSave(Context, String) - Method in class org.apache.wiki.filters.CreoleFilter

preSave(Context, String) - Method in class org.apache.wiki.filters.PageEventFilter

This method is called before the page has been saved to the PageProvider.

preSave(Context, String) - Method in class org.apache.wiki.filters.SpamFilter

PreSaveWikiPageTask - Class in org.apache.wiki.tasks.pages

Handles the page pre-save actions.

PreSaveWikiPageTask(String) - Constructor for class org.apache.wiki.tasks.pages.PreSaveWikiPageTask

Creates the task.

preTranslate(Context, String) - Method in class org.apache.wiki.filters.CreoleFilter

preTranslate(Context, String) - Method in class org.apache.wiki.filters.PageEventFilter

This method is called whenever a page has been loaded from the provider, but not yet been sent through the TranslatorReader.

preTranslate(Context, String) - Method in class org.apache.wiki.filters.ProfanityFilter

PREVIEW - Static variable in class org.apache.wiki.ui.PageCommand

PREVIEW - Static variable in class org.apache.wiki.WikiContext

User is previewing the changes he just made.

previousStep(Step) - Method in class org.apache.wiki.workflow.Workflow

Protected method that returns the predecessor for a supplied Step.

PreviousVersionTag - Class in org.apache.wiki.tags

Outputs the version number of the previous version of this page.

PreviousVersionTag() - Constructor for class org.apache.wiki.tags.PreviousVersionTag

PrincipalWrapper - Class in org.apache.wiki.auth.login

Wrapper class for container-managed or externally-provided principals.

PrincipalWrapper(Principal) - Constructor for class org.apache.wiki.auth.login.PrincipalWrapper

Constructs a new instance of this class by wrapping (decorating) the supplied principal.

printAcl(Acl) - Static method in class org.apache.wiki.auth.acl.DefaultAclManager

Generates an ACL string for inclusion in a wiki page, based on a supplied Acl object.

printGroups(Context) - Static method in class org.apache.wiki.tags.UserProfileTag

Returns a sorted list of the Group objects a user possesses in his or her Session.

printRoles(Context) - Static method in class org.apache.wiki.tags.UserProfileTag

Returns a sorted list of the Role objects a user possesses in his or her Session.

processCurrentStep(Context) - Method in class org.apache.wiki.workflow.Workflow

Protected method that processes the current Step by calling Step.execute(Context).

ProfanityFilter - Class in org.apache.wiki.filters

This class is an example of how to have a simple filter.

ProfanityFilter() - Constructor for class org.apache.wiki.filters.ProfanityFilter

ProgressItem - Class in org.apache.wiki.ui.progress

Provides access to an progress item.

ProgressItem() - Constructor for class org.apache.wiki.ui.progress.ProgressItem

ProgressManager - Interface in org.apache.wiki.ui.progress

Manages progressing items.

PROMPT - Static variable in class org.apache.wiki.auth.login.AnonymousLoginModule

Bogus prompt sent to the callback handler.

PROP_AKISMET_API_KEY - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying the Akismet API-key.

PROP_ALLOW_COOKIE_ASSERTIONS - Static variable in interface org.apache.wiki.auth.AuthenticationManager

If this jspwiki.properties property is true, allow cookies to be used to assert identities.

PROP_ALLOW_COOKIE_AUTH - Static variable in interface org.apache.wiki.auth.AuthenticationManager

If this jspwiki.properties property is true, allow cookies to be used for authentication.

PROP_ALLOWED_GROUPS - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying groups allowed to bypass the spam filter.

PROP_ALLOWEDEXTENSIONS - Static variable in interface org.apache.wiki.attachment.AttachmentManager

A space-separated list of attachment types which can be uploaded

PROP_ALLOWHTML - Static variable in class org.apache.wiki.parser.MarkupParser

If set to "true", allows using raw HTML within Wiki text.

PROP_AUTHORIZER - Static variable in interface org.apache.wiki.auth.AuthorizationManager

The property name in jspwiki.properties for specifying the external Authorizer.

PROP_BANTIME - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying how long a host is banned.

PROP_BEAUTIFYTITLE - Static variable in interface org.apache.wiki.render.RenderingManager

PROP_BLACKLIST - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for the attachment containing the blacklist.

PROP_CAMELCASELINKS - Static variable in class org.apache.wiki.parser.MarkupParser

If true, consider CamelCase hyperlinks as well.

PROP_CAPTCHA - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying which captcha technology should be used.

PROP_CHANNEL_DESCRIPTION - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS channel description.

PROP_CHANNEL_LANGUAGE - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS channel language.

PROP_CHANNEL_TITLE - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS channel title.

PROP_CUSTOMPROP_MAXKEYLENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

PROP_CUSTOMPROP_MAXLIMIT - Static variable in class org.apache.wiki.providers.AbstractFileProvider

PROP_CUSTOMPROP_MAXVALUELENGTH - Static variable in class org.apache.wiki.providers.AbstractFileProvider

PROP_DATABASE - Static variable in class org.apache.wiki.auth.authorize.XMLGroupDatabase

The jspwiki.properties property specifying the file system location of the group database.

PROP_DATABASE - Static variable in interface org.apache.wiki.auth.UserManager

Message key for the "save profile" message.

PROP_DB_ATTRIBUTES - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_CREATED - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_DATASOURCE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_EMAIL - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_FULL_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_LOCK_EXPIRY - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_LOGIN_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_MODIFIED - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_PASSWORD - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_ROLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_ROLE_TABLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_TABLE - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_UID - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DB_WIKI_NAME - Static variable in class org.apache.wiki.auth.user.JDBCUserDatabase

PROP_DIFF_PROVIDER - Static variable in interface org.apache.wiki.diff.DifferenceManager

Property value for storing a diff provider.

PROP_DIFFCOMMAND - Static variable in class org.apache.wiki.diff.ExternalDiffProvider

Determines the command to be used for 'diff'.

PROP_DISABLECACHE - Static variable in class org.apache.wiki.providers.BasicAttachmentProvider

The property name for specifying which attachments are not cached.

PROP_EDITORTYPE - Static variable in interface org.apache.wiki.ui.EditorManager

The property name for setting the editor.

PROP_ERRORPAGE - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for the page to which you are directed if Herb rejects your edit.

PROP_EXT - Static variable in class org.apache.wiki.providers.FileSystemProvider

All metadata is stored in a file with this extension.

PROP_EXTERNALJARS - Static variable in interface org.apache.wiki.plugin.PluginManager

The property name defining which external jars will be added to the classpath when searching for plugin classes.

PROP_FILTERSTRATEGY - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying which filter strategy should be used.

PROP_FILTERXML - Static variable in interface org.apache.wiki.filters.FilterManager

Property name for setting the filter XML property file.

PROP_FORBIDDENEXTENSIONS - Static variable in interface org.apache.wiki.attachment.AttachmentManager

A space-separated list of attachment types which cannot be uploaded

PROP_FORCEDOWNLOAD - Static variable in interface org.apache.wiki.attachment.AttachmentManager

A space-separated list of attachment types which will never open in the browser.

PROP_GENERATE_RSS - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS generator main switch.

PROP_GROUPDATABASE - Static variable in interface org.apache.wiki.auth.authorize.GroupManager

PROP_GROUPDB_CREATED - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the group's creation timestamp.

PROP_GROUPDB_CREATOR - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the group creator's name.

PROP_GROUPDB_DATASOURCE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The JNDI name of the DataSource.

PROP_GROUPDB_MEMBER - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the group member's name.

PROP_GROUPDB_MEMBER_TABLE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The table that stores the names of group members.

PROP_GROUPDB_MODIFIED - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the group's last-modified timestamp.

PROP_GROUPDB_MODIFIER - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the name of the user who last modified the group.

PROP_GROUPDB_NAME - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The column containing the group's name.

PROP_GROUPDB_TABLE - Static variable in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

The table that stores the groups.

PROP_IGNORE_AUTHENTICATED - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying whether authenticated users should be ignored.

PROP_INTERVAL - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS generation interval in seconds.

PROP_IPLIST - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying the page which contains the list of IPs to ban.

PROP_LOCKEXPIRY - Static variable in interface org.apache.wiki.pages.PageManager

The property value for setting the amount of time before the page locks expire.

PROP_LOGIN_EXPIRY_DAYS - Static variable in class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

User property for setting how long the cookie is stored on the user's computer.

PROP_LOGIN_MODULE - Static variable in interface org.apache.wiki.auth.AuthenticationManager

The LoginModule to use for custom authentication.

PROP_LOGIN_THROTTLING - Static variable in interface org.apache.wiki.auth.AuthenticationManager

Whether logins should be throttled to limit brute-forcing attempts.

PROP_LUCENE_ANALYZER - Static variable in class org.apache.wiki.search.LuceneSearchProvider

Which analyzer to use.

PROP_MAX_PAGENAME_LENGTH - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying the maximum page name length.

PROP_MAXSIZE - Static variable in interface org.apache.wiki.attachment.AttachmentManager

The maximum size of attachments that can be uploaded.

PROP_MAXURLS - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying how many URLs can any given edit contain.

PROP_NOTE_IMAGE - Static variable in class org.apache.wiki.plugin.Note

Property name for setting the image for the note.

PROP_PAGE_NAME_COMPARATOR - Static variable in class org.apache.wiki.pages.PageSorter

PROP_PAGECHANGES - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying how many changes is any given IP address allowed to do per minute.

PROP_PAGEDIR - Static variable in class org.apache.wiki.providers.AbstractFileProvider

Name of the property that defines where page directories are.

PROP_PAGEPROVIDER - Static variable in interface org.apache.wiki.pages.PageManager

The property value for setting the current page provider.

PROP_PARSER - Static variable in interface org.apache.wiki.render.RenderingManager

markup parser property.

PROP_PINGURL - Static variable in class org.apache.wiki.filters.PingWeblogsComFilter

The property name for the URL to ping.

PROP_PLAINURIS - Static variable in class org.apache.wiki.parser.MarkupParser

If true, all hyperlinks are translated as well, regardless whether they are surrounded by brackets.

PROP_PREFIX - Static variable in class org.apache.wiki.url.ShortURLConstructor

This corresponds to your WikiServlet path.

PROP_PROVIDER - Static variable in interface org.apache.wiki.attachment.AttachmentManager

The property name for defining the attachment provider class name.

PROP_PROVIDER_DEPRECATED - Static variable in interface org.apache.wiki.attachment.AttachmentManager

Deprecated.

PROP_RENDERER - Static variable in interface org.apache.wiki.render.RenderingManager

default renderer property.

PROP_RSS_AUTHOR - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS author.

PROP_RSS_AUTHOREMAIL - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS author email.

PROP_RSSFILE - Static variable in interface org.apache.wiki.rss.RSSGenerator

Defines the property name for the RSS file that the wiki should generate.

PROP_RUNPLUGINS - Static variable in class org.apache.wiki.parser.MarkupParser

If set to "true", enables plugins during parsing

PROP_SEARCHPROVIDER - Static variable in interface org.apache.wiki.search.SearchManager

Property name for setting the search provider.

PROP_SIMILARCHANGES - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying how many similar changes are allowed before a host is banned.

PROP_SPECIALPAGE - Static variable in interface org.apache.wiki.ui.CommandResolver

Prefix in jspwiki.properties signifying special page keys.

PROP_STOREIPADDRESS - Static variable in interface org.apache.wiki.auth.AuthenticationManager

If this jspwiki.properties property is true, logs the IP address of the editor on saving.

PROP_UNCHANGED_CONTEXT_LIMIT - Static variable in class org.apache.wiki.diff.ContextualDiffProvider

A jspwiki.properties value to define how many characters are shown around the change context.

PROP_USEATTACHMENTIMAGE - Static variable in class org.apache.wiki.parser.MarkupParser

If true, all outward attachment info links have a small link image appended.

PROP_USEOUTLINKIMAGE - Static variable in class org.apache.wiki.parser.MarkupParser

If true, all outward links (external links) have a small link image appended.

PROP_USERDATABASE - Static variable in class org.apache.wiki.auth.user.XMLUserDatabase

The jspwiki.properties property specifying the file system location of the user database.

PROP_USERELNOFOLLOW - Static variable in class org.apache.wiki.parser.MarkupParser

If set to "true", all external links are tagged with 'rel="nofollow"'

PROP_WORDLIST - Static variable in class org.apache.wiki.filters.SpamFilter

The filter property name for specifying the page which contains the list of spamwords.

PROP_WYSIWYG_RENDERER - Static variable in interface org.apache.wiki.render.RenderingManager

default wysiwyg renderer property.

PROPERTY_APPROVER_PREFIX - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The prefix to use for looking up jspwiki.properties approval roles.

PROPERTY_FILE - Static variable in class org.apache.wiki.providers.BasicAttachmentProvider

The name of the property file.

PROPERTYFILE - Static variable in class org.apache.wiki.providers.VersioningFileProvider

Name of the property file which stores the metadata.

PROPERTYFILE - Static variable in interface org.apache.wiki.ui.TemplateManager

Name of the file that contains the properties.

PROPFILENAME - Static variable in class org.apache.wiki.ui.Installer

pushBack(int) - Method in class org.apache.wiki.parser.MarkupParser

Push back any character to the current input.

PUSHBACK_BUFFER_SIZE - Static variable in class org.apache.wiki.parser.MarkupParser

Allow this many characters to be pushed back in the stream.

putAttachmentData(Attachment, InputStream) - Method in class org.apache.wiki.providers.BasicAttachmentProvider

putAttachmentData(Attachment, InputStream) - Method in class org.apache.wiki.providers.CachingAttachmentProvider

putPageText(Page, String) - Method in class org.apache.wiki.pages.DefaultPageManager

Puts the page text into the repository.

putPageText(Page, String) - Method in interface org.apache.wiki.pages.PageManager

Puts the page text into the repository.

putPageText(Page, String) - Method in class org.apache.wiki.providers.AbstractFileProvider

putPageText(Page, String) - Method in class org.apache.wiki.providers.CachingProvider

putPageText(Page, String) - Method in class org.apache.wiki.providers.FileSystemProvider

putPageText(Page, String) - Method in class org.apache.wiki.providers.VersioningFileProvider

Q

QueryItem - Class in org.apache.wiki.search

Deprecated.

- use QueryItem instead

QueryItem() - Constructor for class org.apache.wiki.search.QueryItem

Deprecated.

R

READ - Static variable in class org.apache.wiki.parser.JSPWikiMarkupParser

reassign(Principal) - Method in class org.apache.wiki.workflow.Decision

Reassigns the Decision to a new actor (that is, provide an outcome).

reassign(Decision, Principal) - Method in class org.apache.wiki.workflow.DecisionQueue

Reassigns the owner of the Decision to a new owner.

RecentChangesPlugin - Class in org.apache.wiki.plugin

Returns the Recent Changes in the wiki being a date-sorted list of page names.

RecentChangesPlugin() - Constructor for class org.apache.wiki.plugin.RecentChangesPlugin

REDIRECT - Static variable in class org.apache.wiki.ui.RedirectCommand

RedirectCommand - Class in org.apache.wiki.ui

Defines Commands for redirections to off-site special pages.

ReferenceManager - Interface in org.apache.wiki.references

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.

ReferredPagesPlugin - Class in org.apache.wiki.plugin

Displays the pages referring to the current page.

ReferredPagesPlugin() - Constructor for class org.apache.wiki.plugin.ReferredPagesPlugin

ReferringPagesPlugin - Class in org.apache.wiki.plugin

Displays the pages referring to the current page.

ReferringPagesPlugin() - Constructor for class org.apache.wiki.plugin.ReferringPagesPlugin

ReferringUndefinedPagesPlugin - Class in org.apache.wiki.plugin

Lists all pages containing links to Undefined Pages (pages containing dead links).

ReferringUndefinedPagesPlugin() - Constructor for class org.apache.wiki.plugin.ReferringUndefinedPagesPlugin

registerServlet(String, WikiAjaxServlet) - Static method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Register a WikiAjaxServlet with a specific alias, and default permission PagePermission.VIEW.

registerServlet(String, WikiAjaxServlet, Permission) - Static method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Regster a WikiAjaxServlet given an alias, the servlet, and the permission.

registerServlet(WikiAjaxServlet) - Static method in class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

Register a WikiAjaxServlet using the servlet mapping as the alias

reindexPage(Page) - Method in class org.apache.wiki.search.BasicSearchProvider

Adds a WikiPage for indexing queue.

reindexPage(Page) - Method in class org.apache.wiki.search.LuceneSearchProvider

Adds a page-text pair to the lucene update queue.

reindexPage(Page) - Method in interface org.apache.wiki.search.SearchManager

Forces the reindex of the given page.

reindexPage(Page) - Method in interface org.apache.wiki.search.SearchProvider

Adds a WikiPage for indexing queue.

release() - Method in class org.apache.wiki.tags.CookieTag

release() - Method in class org.apache.wiki.tags.ParamTag

release() - Method in class org.apache.wiki.tags.PluginTag

release() - Method in class org.apache.wiki.tags.SearchResultIteratorTag

release() - Method in class org.apache.wiki.tags.TabbedSectionTag

reload() - Method in class org.apache.wiki.ui.admin.beans.SearchManagerBean

Starts a background thread which goes through all the pages and adds them to the reindex queue.

reloadPreferences(PageContext) - Static method in class org.apache.wiki.preferences.Preferences

Reloads the preferences from the PageContext into the WikiContext.

remove(Principal) - Method in class org.apache.wiki.auth.authorize.Group

Removes a Principal from the group.

remove(HttpServletRequest) - Method in class org.apache.wiki.auth.SessionMonitor

Removes the wiki session associated with the user's HttpRequest from the session cache.

remove(HttpSession) - Method in class org.apache.wiki.auth.SessionMonitor

Removes the wiki session associated with the user's HttpSession from the session cache.

remove(Engine, HttpServletRequest) - Method in class org.apache.wiki.spi.SessionSPIDefaultImpl

remove(Decision) - Method in class org.apache.wiki.workflow.DecisionQueue

Protected method that removes a Decision from the queue.

remove(Workflow) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Protected helper method that removes a specified Workflow from the cache, and moves it to the workflow history list.

removeAttribute(String) - Method in class org.apache.wiki.WikiEngine

removeAttribute(String) - Method in class org.apache.wiki.WikiPage

Removes an attribute from the page, if it exists.

removeEntry(AclEntry) - Method in class org.apache.wiki.auth.acl.AclImpl

removeEntry(AclEntry) - Method in interface org.apache.wiki.auth.acl.Acl

Deprecated.

use Acl.removeEntry(org.apache.wiki.api.core.AclEntry) instead.

removeFromDecisionQueue(Decision, Context) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

removeGroup(String) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Removes a named Group from the group database.

removeGroup(String) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Removes a named Group from the group database.

removeItem(String) - Method in class org.apache.wiki.tags.BreadcrumbsTag.FixedQueue

removePermission(Permission) - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Removes the specified permission from this ACL entry.

removeWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.AuthenticationManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.AuthorizationManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultAuthenticationManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.DefaultUserManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.auth.SessionMonitor

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in interface org.apache.wiki.auth.UserManager

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.filters.PageEventFilter

Un-registers a WikiEventListener with this instance.

removeWikiEventListener(WikiEventListener) - Method in class org.apache.wiki.WikiEngine

removeWikiSession(Engine, HttpServletRequest) - Static method in class org.apache.wiki.WikiSession

Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.

rename(String, String) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op; always throws NoSuchPrincipalException.

rename(String, String) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

rename(String, String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Renames a UserProfile in the user database by changing the profile's login name.

rename(String, String) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Renames a UserProfile in the user database by changing the profile's login name.

RENAME - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the rename permission.

RENAME - Static variable in class org.apache.wiki.ui.PageCommand

RENAME - Static variable in class org.apache.wiki.WikiContext

User is renaming a page.

RENAME_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the rename permission.

renamePage(Context, String, String, boolean) - Method in class org.apache.wiki.content.DefaultPageRenamer

Renames a page.

renamePage(Context, String, String, boolean) - Method in interface org.apache.wiki.content.PageRenamer

Renames a page.

renderDate(Context, Date, Preferences.TimeFormat) - Static method in class org.apache.wiki.preferences.Preferences

A simple helper function to render a date based on the user preferences.

RenderingManager - Interface in org.apache.wiki.render

This class provides a facade towards the differing rendering routines.

RepositoryModifiedException - Exception in org.apache.wiki.providers

If the provider detects that someone has modified the repository externally, it should throw this exception.

RepositoryModifiedException(String, String) - Constructor for exception org.apache.wiki.providers.RepositoryModifiedException

Constructs the exception.

REQ_EDITEDTEXT - Static variable in interface org.apache.wiki.ui.EditorManager

Known attribute name for storing the user edited text inside a HTTP parameter.

RequestResourceTag - Class in org.apache.wiki.tags

Provides easy access to TemplateManager.addResourceRequest().

RequestResourceTag() - Constructor for class org.apache.wiki.tags.RequestResourceTag

requiredPermission() - Method in class org.apache.wiki.ui.GroupCommand

Returns the permission required to execute this GroupCommand.

requiredPermission() - Method in class org.apache.wiki.ui.PageCommand

requiredPermission() - Method in class org.apache.wiki.ui.RedirectCommand

No-op; always returns null.

requiredPermission() - Method in class org.apache.wiki.ui.WikiCommand

requiredPermission() - Method in class org.apache.wiki.WikiContext

Returns the permission required to successfully execute this context.

requiresApproval(String) - Method in class org.apache.wiki.workflow.DefaultWorkflowManager

Returns true if a workflow matching a particular key contains an approval step.

requiresApproval(String) - Method in interface org.apache.wiki.workflow.WorkflowManager

Returns true if a workflow matching a particular key contains an approval step.

resetIterator() - Method in class org.apache.wiki.tags.AdminBeanIteratorTag

Override this method to reset your own iterator.

resetIterator() - Method in class org.apache.wiki.tags.IteratorTag

Override this method to reset your own iterator.

resolveEntity(String, String) - Method in class org.apache.wiki.auth.authorize.WebContainerAuthorizer.LocalEntityResolver

Returns an XML input source for a requested external resource by reading the resource instead from local storage.

resolvePage(HttpServletRequest, String) - Method in interface org.apache.wiki.ui.CommandResolver

Looks up and returns the correct, versioned WikiPage based on a supplied page name and optional version parameter passed in an HTTP request.

resolvePage(HttpServletRequest, String) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Looks up and returns the correct, versioned WikiPage based on a supplied page name and optional version parameter passed in an HTTP request.

resolvePrincipal(String) - Method in interface org.apache.wiki.auth.AuthorizationManager

Given a supplied string representing a Principal's name from an Acl, this method resolves the correct type of Principal (role, group, or user).

resolvePrincipal(String) - Method in class org.apache.wiki.auth.DefaultAuthorizationManager

Given a supplied string representing a Principal's name from an Acl, this method resolves the correct type of Principal (role, group, or user).

RESOURCE_HTTPHEADER - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests a HTTP header.

RESOURCE_INCLUDES - Static variable in interface org.apache.wiki.ui.TemplateManager

The name under which the resource includes map is stored in the WikiContext.

RESOURCE_INLINECSS - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests inlined CSS.

RESOURCE_JSFUNCTION - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests a JavaScript function to be called during window.onload.

RESOURCE_JSLOCALIZEDSTRINGS - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests a JavaScript associative array with all localized strings.

RESOURCE_SCRIPT - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests a script to be loaded.

RESOURCE_STYLESHEET - Static variable in interface org.apache.wiki.ui.TemplateManager

Requests a stylesheet to be inserted.

restart(Context) - Method in class org.apache.wiki.workflow.Workflow

Restarts the Workflow from the Workflow.WAITING state and puts it into the Workflow.RUNNING state again.

restoreUserValues() - Method in class org.apache.wiki.ui.Installer

RFC3339FORMAT - Static variable in class org.apache.wiki.rss.AtomFeed

Defines a SimpleDateFormat string for RFC3339-formatted dates.

Role - Class in org.apache.wiki.auth.authorize

A lightweight, immutable Principal that represents a built-in wiki role such as Anonymous, Asserted and Authenticated.

Role(String) - Constructor for class org.apache.wiki.auth.authorize.Role

Constructs a new Role with a given name.

rowBody(WikiModuleInfo) - Method in class org.apache.wiki.ui.admin.beans.FilterBean

html blob describingElement describing attributes

rowBody(WikiModuleInfo) - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

html blob describingElement describing attributes

rowBody(WikiModuleInfo) - Method in class org.apache.wiki.ui.admin.beans.PluginBean

html blob describingElement describing attributes

RPC_VERSION - Static variable in class org.apache.wiki.xmlrpc.AbstractRPCHandler

This is the currently implemented JSPWiki XML-RPC code revision.

RPCHandler - Class in org.apache.wiki.xmlrpc

Provides handlers for all RPC routines.

RPCHandler() - Constructor for class org.apache.wiki.xmlrpc.RPCHandler

RPCHandlerUTF8 - Class in org.apache.wiki.xmlrpc

Provides handlers for all RPC routines.

RPCHandlerUTF8() - Constructor for class org.apache.wiki.xmlrpc.RPCHandlerUTF8

RPCServlet - Class in org.apache.wiki.xmlrpc

Handles all incoming servlet requests for XML-RPC calls.

RPCServlet() - Constructor for class org.apache.wiki.xmlrpc.RPCServlet

RSS - Static variable in class org.apache.wiki.ui.PageCommand

RSS - Static variable in class org.apache.wiki.WikiContext

RSS feed is being generated.

RSS10 - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent RSS 1.0 feeds.

RSS10Feed - Class in org.apache.wiki.rss

Provides an implementation of an RSS 1.0 feed.

RSS10Feed(Context) - Constructor for class org.apache.wiki.rss.RSS10Feed

Create an RSS 1.0 feed for a given context.

RSS20 - Static variable in interface org.apache.wiki.rss.RSSGenerator

Parameter value to represent RSS 2.0 feeds.

RSS20Feed - Class in org.apache.wiki.rss

Represents an RSS 2.0 feed (with enclosures).

RSS20Feed(Context) - Constructor for class org.apache.wiki.rss.RSS20Feed

Creates an RSS 2.0 feed for the specified Context.

RSSGenerator - Interface in org.apache.wiki.rss

The master class for generating different kinds of Feeds (including RSS1.0, 2.0 and Atom).

RSSImageLinkTag - Class in org.apache.wiki.tags

Writes an image link to a JSPWiki RSS file.

RSSImageLinkTag() - Constructor for class org.apache.wiki.tags.RSSImageLinkTag

RSSThread - Class in org.apache.wiki.rss

Runs the RSS generation thread.

RSSThread(Engine, File, int) - Constructor for class org.apache.wiki.rss.RSSThread

Create a new RSS thread.

run() - Method in class org.apache.wiki.WikiBackgroundThread

Runs the background thread's WikiBackgroundThread.backgroundTask() method at the interval specified at construction.

RUNNING - Static variable in class org.apache.wiki.workflow.Workflow

State value: Workflow started, and is running.

S

SampleAjaxPlugin - Class in org.apache.wiki.plugin

SampleAjaxPlugin() - Constructor for class org.apache.wiki.plugin.SampleAjaxPlugin

save(Group, Principal) - Method in interface org.apache.wiki.auth.authorize.GroupDatabase

Saves a Group to the group database.

save(Group, Principal) - Method in class org.apache.wiki.auth.authorize.JDBCGroupDatabase

Saves a Group to the group database.

save(Group, Principal) - Method in class org.apache.wiki.auth.authorize.XMLGroupDatabase

Saves a Group to the group database.

save(UserProfile) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Saves a UserProfileto the user database, overwriting the existing profile if it exists.

save(UserProfile) - Method in class org.apache.wiki.auth.user.DummyUserDatabase

No-op.

save(UserProfile) - Method in class org.apache.wiki.auth.user.JDBCUserDatabase

save(UserProfile) - Method in interface org.apache.wiki.auth.user.UserDatabase

Saves a UserProfileto the user database, overwriting the existing profile if it exists.

save(UserProfile) - Method in class org.apache.wiki.auth.user.XMLUserDatabase

Saves a UserProfileto the user database, overwriting the existing profile if it exists.

saveProperties() - Method in class org.apache.wiki.ui.Installer

saveText(Context, String) - Method in class org.apache.wiki.pages.DefaultPageManager

saveText(Context, String) - Method in interface org.apache.wiki.pages.PageManager

Writes the WikiText of a page into the page repository.

SaveUserProfileTask - Class in org.apache.wiki.tasks.auth

Handles the actual profile save action.

SaveUserProfileTask(Locale) - Constructor for class org.apache.wiki.tasks.auth.SaveUserProfileTask

Constructs a new Task for saving a user profile.

SaveWikiPageTask - Class in org.apache.wiki.tasks.pages

Handles the actual page save and post-save actions.

SaveWikiPageTask() - Constructor for class org.apache.wiki.tasks.pages.SaveWikiPageTask

Creates the Task.

scanWikiLinks(Page, String) - Method in class org.apache.wiki.references.DefaultReferenceManager

Reads a WikiPageful of data from a String and returns all links internal to this Wiki in a Collection.

scanWikiLinks(Page, String) - Method in interface org.apache.wiki.references.ReferenceManager

Reads a WikiPageful of data from a String and returns all links internal to this Wiki in a Collection.

Search - Class in org.apache.wiki.plugin

The "Search" plugin allows you to access the JSPWiki search routines and show the displays in an array on your page.

Search() - Constructor for class org.apache.wiki.plugin.Search

SEARCHABLE_FILE_SUFFIXES - Static variable in class org.apache.wiki.search.LuceneSearchProvider

These attachment file suffixes will be indexed.

SearchManager - Interface in org.apache.wiki.search

Manages searching the Wiki.

SearchManagerBean - Class in org.apache.wiki.ui.admin.beans

The SearchManagerBean is a simple AdminBean interface to the SearchManager.

SearchManagerBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.SearchManagerBean

SearchMatcher - Class in org.apache.wiki.search

SearchMatcher performs the task of matching a search query to a page's contents.

SearchMatcher(Engine, QueryItem[]) - Constructor for class org.apache.wiki.search.SearchMatcher

Creates a new SearchMatcher.

SearchMatcher(WikiEngine, QueryItem[]) - Constructor for class org.apache.wiki.search.SearchMatcher

Deprecated.

kept for compatibility with page/attachment providers not using public API. Use SearchMatcher(Engine, QueryItem) instead.

SearchMatcher.SearchResultImpl - Class in org.apache.wiki.search

A local search result.

SearchProvider - Interface in org.apache.wiki.search

Interface for the search providers that handle searching the Wiki

SearchResult - Interface in org.apache.wiki.search

Deprecated.

- use SearchResult instead

SearchResultComparator - Class in org.apache.wiki.search

Simple class that decides which search results are more important than others.

SearchResultComparator() - Constructor for class org.apache.wiki.search.SearchResultComparator

SearchResultImpl(String, int) - Constructor for class org.apache.wiki.search.SearchMatcher.SearchResultImpl

Create a new SearchResult with a given name and a score.

SearchResultIteratorInfo - Class in org.apache.wiki.tags

Just provides the TEI data for IteratorTag.

SearchResultIteratorInfo() - Constructor for class org.apache.wiki.tags.SearchResultIteratorInfo

SearchResultIteratorTag - Class in org.apache.wiki.tags

Iterates through Search result results.

SearchResultIteratorTag() - Constructor for class org.apache.wiki.tags.SearchResultIteratorTag

SearchResultsSizeTag - Class in org.apache.wiki.tags

Outputs the size of the search results list, if it contains any items.

SearchResultsSizeTag() - Constructor for class org.apache.wiki.tags.SearchResultsSizeTag

SearchResultsTag - Class in org.apache.wiki.tags

Includes the body content, if there are any search results.

SearchResultsTag() - Constructor for class org.apache.wiki.tags.SearchResultsTag

SecurityVerifier - Class in org.apache.wiki.auth

Helper class for verifying JSPWiki's security configuration.

SecurityVerifier(Engine, Session) - Constructor for class org.apache.wiki.auth.SecurityVerifier

Constructs a new SecurityVerifier for a supplied Engine and WikiSession.

service(HttpServletRequest, HttpServletResponse, String, List<String>) - Method in interface org.apache.wiki.ajax.WikiAjaxServlet

service(HttpServletRequest, HttpServletResponse, String, List<String>) - Method in class org.apache.wiki.auth.DefaultUserManager.JSONUserModule

service(HttpServletRequest, HttpServletResponse, String, List<String>) - Method in class org.apache.wiki.plugin.SampleAjaxPlugin

service(HttpServletRequest, HttpServletResponse, String, List<String>) - Method in class org.apache.wiki.search.DefaultSearchManager.JSONSearch

service(HttpServletRequest, HttpServletResponse, String, List<String>) - Method in class org.apache.wiki.ui.progress.DefaultProgressManager.JSONTracker

sessionCreated(HttpSessionEvent) - Method in class org.apache.wiki.auth.SessionMonitor

Fires when the web container creates a new HTTP session.

sessionDestroyed(HttpSessionEvent) - Method in class org.apache.wiki.auth.SessionMonitor

Removes the user's WikiSession from the internal session cache when the web container destroys an HTTP session.

SessionMonitor - Class in org.apache.wiki.auth

Manages Sessions for different Engines.

SessionMonitor() - Constructor for class org.apache.wiki.auth.SessionMonitor

Construct the SessionListener

SESSIONPREFS - Static variable in class org.apache.wiki.preferences.Preferences

The name under which a Preferences object is stored in the HttpSession.

sessions() - Method in class org.apache.wiki.auth.SessionMonitor

Returns the current number of active wiki sessions.

sessions(Engine) - Static method in class org.apache.wiki.WikiSession

Deprecated.

use SessionMonitor.sessions() instead

SessionSPIDefaultImpl - Class in org.apache.wiki.spi

Default implementation for SessionSPI

SessionSPIDefaultImpl() - Constructor for class org.apache.wiki.spi.SessionSPIDefaultImpl

SessionsPlugin - Class in org.apache.wiki.plugin

Displays information about active wiki sessions.

SessionsPlugin() - Constructor for class org.apache.wiki.plugin.SessionsPlugin

setAccesskey(String) - Method in class org.apache.wiki.tags.EditLinkTag

setAccesskey(String) - Method in class org.apache.wiki.tags.LinkToTag

setAccesskey(String) - Method in class org.apache.wiki.tags.PageInfoLinkTag

setAccesskey(String) - Method in class org.apache.wiki.tags.TabTag

Sets the tab access key.

setAccessKey(String) - Method in class org.apache.wiki.tags.LinkTag

setAcl(Acl) - Method in class org.apache.wiki.WikiPage

Sets the Acl for this page.

setAcl(Acl) - Method in class org.apache.wiki.WikiPage

Deprecated.

use WikiPage.setAcl(org.apache.wiki.api.core.Acl)

setAction(String) - Method in class org.apache.wiki.forms.FormInfo

Set the value of the action parameter.

setAction(String) - Method in class org.apache.wiki.tags.MessagesTag

setArgs(String) - Method in class org.apache.wiki.tags.PluginTag

Set the argument string to the plugin.

setAttribute(String, Serializable) - Method in class org.apache.wiki.workflow.Workflow

Temporarily associates an object with this Workflow, as a named attribute, for the duration of workflow execution.

setAttribute(String, Object) - Method in class org.apache.wiki.WikiEngine

setAttribute(String, Object) - Method in class org.apache.wiki.WikiPage

Sets an metadata attribute.

setAttribute(Attribute) - Method in class org.apache.wiki.management.SimpleMBean

setAttributes(AttributeList) - Method in class org.apache.wiki.management.SimpleMBean

setAuthor(String) - Method in class org.apache.wiki.rss.Entry

Set the author of this entry.

setAuthor(String) - Method in class org.apache.wiki.WikiPage

Sets the author of the page.

setAuthorizer(Authorizer) - Method in class org.apache.wiki.auth.login.AuthorizerCallback

Sets the authorizer object.

setBodyContent(BodyContent) - Method in class org.apache.wiki.tags.LinkTag

setCacheable(boolean) - Method in class org.apache.wiki.attachment.Attachment

Sets this attachment to be cacheable or not.

setChannelDescription(String) - Method in class org.apache.wiki.rss.Feed

setChannelLanguage(String) - Method in class org.apache.wiki.rss.Feed

setChannelTitle(String) - Method in class org.apache.wiki.rss.Feed

setClear(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "clear" parameter.

setComment(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the COMMENT context.

setCompareToVersion(String) - Method in class org.apache.wiki.tags.LinkTag

setConflict(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the CONFLICT context.

setContainedParameter(String, String) - Method in class org.apache.wiki.tags.LinkTag

Support for ParamTag supplied parameters in body.

setContainedParameter(String, String) - Method in interface org.apache.wiki.tags.ParamHandler

setContent(String) - Method in class org.apache.wiki.rss.Entry

Set the content of this entry.

setContext(String) - Method in class org.apache.wiki.tags.CheckRequestContextTag

Set the context to check for.

setContext(String) - Method in class org.apache.wiki.tags.LinkTag

setContext(Context) - Method in class org.apache.wiki.parser.WikiDocument

Set the WikiContext in which the WikiDocument is rendered.

setCreated(Date) - Method in class org.apache.wiki.auth.authorize.Group

Sets the created date.

setCreated(Date) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

setCreated(Date) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the created date.

setCreator(String) - Method in class org.apache.wiki.auth.authorize.Group

Sets the creator of this Group.

setCssClass(String) - Method in class org.apache.wiki.tags.LinkTag

setCustomProperties(Page, Properties) - Method in class org.apache.wiki.providers.AbstractFileProvider

Set the custom properties provided into the given page.

setDefault(String) - Method in class org.apache.wiki.tags.VariableTag

setDefaultTab(String) - Method in class org.apache.wiki.tags.TabbedSectionTag

Set the id of the default tab (the tab which should be shown when the page is first loaded).

setDefaultTemplate(HttpServletRequest) - Method in class org.apache.wiki.WikiContext

Figures out which template a new WikiContext should be using.

setDiff(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the DIFF context.

setDiv(String) - Method in class org.apache.wiki.tags.MessagesTag

setEdit(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the EDIT context.

setEmail(String) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the user's e-mail address.

setEmail(String) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the user's e-mail address.

setEnabled(boolean) - Method in class org.apache.wiki.rss.DefaultRSSGenerator

Turns RSS generation on or off.

setEnabled(boolean) - Method in interface org.apache.wiki.rss.RSSGenerator

Turns RSS generation on or off.

setEngine(Engine) - Method in class org.apache.wiki.auth.login.WikiEngineCallback

Sets the engine object.

setError(String) - Method in class org.apache.wiki.forms.FormInfo

Set an error string.

setError(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the ERROR context.

setFeedURL(String) - Method in class org.apache.wiki.rss.Feed

setFileName(String) - Method in class org.apache.wiki.attachment.Attachment

Sets the file name of this attachment.

setFind(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the FIND context.

setFirstStep(Step) - Method in class org.apache.wiki.workflow.Workflow

Sets the first Step for this Workflow, which will be executed immediately after the Workflow.start(Context) method executes.

setFmtkey(String) - Method in class org.apache.wiki.tags.SetPaginationTag

setFormat(String) - Method in class org.apache.wiki.tags.AuthorTag

setFormat(String) - Method in class org.apache.wiki.tags.CsrfProtectionTag

setFormat(String) - Method in class org.apache.wiki.tags.PageDateTag

setFormat(String) - Method in class org.apache.wiki.tags.WikiLinkTag

setFullname(String) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the user's full name.

setFullname(String) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the user's full name.

setGroup(Session, Group) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Saves the Group created by a user in a wiki session.

setGroup(Session, Group) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Saves the Group created by a user in a wiki session.

setHandler(String) - Method in class org.apache.wiki.forms.FormInfo

Set the name of the handler class.

setHasMetadata() - Method in class org.apache.wiki.WikiPage

Sets the metadata flag to true.

setHide(boolean) - Method in class org.apache.wiki.forms.FormInfo

Set the hide parameter.

setHref(String) - Method in class org.apache.wiki.tags.SetPaginationTag

setId(int) - Method in class org.apache.wiki.workflow.Decision

Sets the unique identfier for this Decision.

setId(int) - Method in class org.apache.wiki.workflow.Workflow

Sets the unique identifier for this Workflow.

setId(String) - Method in class org.apache.wiki.tags.WikiTagBase

setInfo(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the INFO context.

setInputReader(Reader) - Method in class org.apache.wiki.parser.MarkupParser

Replaces the current input character stream with a new one.

setItem(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "item" parameter.

setJsp(String) - Method in class org.apache.wiki.tags.LinkTag

setLastModified(Date) - Method in class org.apache.wiki.auth.authorize.Group

Sets the last-modified date

setLastModified(Date) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the last-modified date.

setLastModified(Date) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the last-modified date

setLastModified(Date) - Method in class org.apache.wiki.WikiPage

Sets the last modification date.

setList(Object[]) - Method in class org.apache.wiki.tags.IteratorTag

Sets the collection list, but using an array.

setList(Collection<?>) - Method in class org.apache.wiki.tags.IteratorTag

Sets the collection that is used to form the iteration.

setLockExpiry(Date) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Locks the profile until a specified lock expiration date.

setLockExpiry(Date) - Method in interface org.apache.wiki.auth.user.UserProfile

Locks the profile until a specified lock expiration date.

setLoginCookie(Engine, HttpServletResponse, String) - Static method in class org.apache.wiki.auth.login.CookieAuthenticationLoginModule

Sets a login cookie based on properties set by the user.

setLoginName(String) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the name by which the user logs in.

setLoginName(String) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the name by which the user logs in.

setMaxItems(int) - Method in class org.apache.wiki.tags.SearchResultIteratorTag

setMaxlinks(int) - Method in class org.apache.wiki.tags.SetPaginationTag

setMaxpages(int) - Method in class org.apache.wiki.tags.BreadcrumbsTag

Sets how many pages to show.

setMode(String) - Method in class org.apache.wiki.rss.Feed

Set the mode of the Feed.

setMode(String) - Method in class org.apache.wiki.tags.CheckLockTag

Sets the mode to check for.

setMode(String) - Method in class org.apache.wiki.tags.CheckVersionTag

Sets the mode.

setMode(String) - Method in class org.apache.wiki.tags.InsertPageTag

setMode(String) - Method in class org.apache.wiki.tags.RSSImageLinkTag

setModifier(String) - Method in class org.apache.wiki.auth.authorize.Group

Sets the name of the user who last modified this group.

setMonthurlformat(String) - Method in class org.apache.wiki.tags.CalendarTag

Set the format to be used for links for the months.

setName(String) - Method in class org.apache.wiki.forms.FormInfo

Sets the name of the form.

setName(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "name" parameter.

setName(String) - Method in class org.apache.wiki.tags.ParamTag

Set the name of the parameter to transfer.

setNewVersion(String) - Method in class org.apache.wiki.tags.DiffLinkTag

setOnclick(String) - Method in class org.apache.wiki.tags.SetPaginationTag

setOutcome(Outcome) - Method in class org.apache.wiki.workflow.AbstractStep

Sets the current Outcome for the step.

setOutcome(Outcome) - Method in interface org.apache.wiki.workflow.Step

Sets the current Outcome for the step.

setPage(String) - Method in class org.apache.wiki.tags.IncludeTag

setPage(String) - Method in class org.apache.wiki.tags.InsertDiffTag

Sets the page name.

setPage(String) - Method in class org.apache.wiki.tags.InsertPageTag

setPage(String) - Method in class org.apache.wiki.tags.NoSuchPageTag

setPage(String) - Method in class org.apache.wiki.tags.WikiLinkTag

setPage(Page) - Method in class org.apache.wiki.rss.Entry

Sets the WikiPage to which this Entry refers to.

setPage(Page) - Method in class org.apache.wiki.WikiContext

Sets the page that is being handled.

setPageContext(PageContext) - Method in class org.apache.wiki.tags.WikiTagBase

This method calls the parent setPageContext() but it also provides a way for a tag to initialize itself before any of the setXXX() methods are called.

setPageData(String) - Method in class org.apache.wiki.parser.WikiDocument

Set the WikiMarkup for this document.

setPageformat(String) - Method in class org.apache.wiki.tags.CalendarTag

Sets the page format.

setPagesize(int) - Method in class org.apache.wiki.tags.SetPaginationTag

SetPaginationTag - Class in org.apache.wiki.tags

Calculate pagination string.

SetPaginationTag() - Constructor for class org.apache.wiki.tags.SetPaginationTag

setPassword(String) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the user's password for use with custom authentication.

setPassword(String) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the user's password for use with custom authentication.

setPermission(String) - Method in class org.apache.wiki.tags.PermissionTag

Sets the permissions to look for (case sensitive).

setPermissions(Page, Acl) - Method in interface org.apache.wiki.auth.acl.AclManager

Sets the access control list for the page and persists it.

setPermissions(Page, Acl) - Method in class org.apache.wiki.auth.acl.DefaultAclManager

Sets the access control list for the page and persists it.

setPlugin(String) - Method in class org.apache.wiki.tags.PluginTag

Set the name of the plugin to execute.

setPrefix(String) - Method in class org.apache.wiki.tags.MessagesTag

setPrefs(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the PREFS context.

setPreview(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the PREVIEW context.

setPrincipal(Principal) - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Specifies the principal for which permissions are granted or denied by this ACL entry.

setProperty(String) - Method in class org.apache.wiki.tags.UserProfileTag

setReadOnly() - Method in class org.apache.wiki.auth.permissions.AllPermissionCollection

setRealPage(Page) - Method in class org.apache.wiki.WikiContext

Sets a reference to the real page whose content is currently being rendered.

setRef(String) - Method in class org.apache.wiki.tags.LinkTag

setReference(String) - Method in class org.apache.wiki.parser.LinkParser.Link

Sets the hypertext reference.

setRel(String) - Method in class org.apache.wiki.tags.LinkTag

setRequest(HttpServletRequest) - Method in class org.apache.wiki.auth.login.HttpRequestCallback

Sets the request object.

setRequestContext(String) - Method in class org.apache.wiki.WikiContext

Sets the request context.

setResource(String) - Method in class org.apache.wiki.tags.RequestResourceTag

Sets the resource name to be added.

setResult(String) - Method in class org.apache.wiki.forms.FormInfo

Set the result.

setScope(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "scope" parameter.

setSeparator(String) - Method in class org.apache.wiki.tags.BreadcrumbsTag

Set the separator string.

setSize(long) - Method in class org.apache.wiki.WikiPage

Sets the size.

setStart(int) - Method in class org.apache.wiki.tags.SearchResultIteratorTag

setStart(int) - Method in class org.apache.wiki.tags.SetPaginationTag

setState(int) - Method in class org.apache.wiki.ui.progress.ProgressItem

Sets the state of the ProgressItem.

setStatus(int) - Method in class org.apache.wiki.forms.FormInfo

Set the status of the Form processing.

setStatus(String) - Method in class org.apache.wiki.tags.UserCheckTag

Sets the status as defined above.

setStyle(String) - Method in class org.apache.wiki.tags.LinkTag

setSubmission(Map<String, String>) - Method in class org.apache.wiki.forms.FormInfo

Copies the given values into the handler parameter map using Map.putAll().

setSuccessor(Step) - Method in class org.apache.wiki.workflow.Task

Sets the successor Step to this one, which will be triggered if the Task completes successfully (that is, Step.getOutcome() returns Outcome.STEP_COMPLETE.

setTabindex(String) - Method in class org.apache.wiki.tags.LinkTag

setTarget(String) - Method in class org.apache.wiki.tags.LinkTag

setTemplate(String) - Method in class org.apache.wiki.tags.WikiLinkTag

setTemplate(String) - Method in class org.apache.wiki.WikiContext

Sets the template to be used for this request.

setTemplatefile(String) - Method in class org.apache.wiki.tags.LinkTag

setText(String) - Method in class org.apache.wiki.parser.LinkParser.Link

Sets the link text.

setTitle(String) - Method in class org.apache.wiki.rss.Entry

Sets a title for the change.

setTitle(String) - Method in class org.apache.wiki.tags.EditLinkTag

setTitle(String) - Method in class org.apache.wiki.tags.LinkTag

setTitle(String) - Method in class org.apache.wiki.tags.LinkToTag

setTitle(String) - Method in class org.apache.wiki.tags.PageInfoLinkTag

setTitle(String) - Method in class org.apache.wiki.tags.RSSImageLinkTag

Sets the title for the link.

setTitle(String) - Method in class org.apache.wiki.tags.TabTag

Sets the tab title.

setTopic(String) - Method in class org.apache.wiki.tags.MessagesTag

setTotal(int) - Method in class org.apache.wiki.tags.SetPaginationTag

setType(String) - Method in class org.apache.wiki.tags.AdminBeanIteratorTag

Set the type of the bean.

setType(String) - Method in class org.apache.wiki.tags.IncludeResourcesTag

setType(String) - Method in class org.apache.wiki.tags.PageTypeTag

setType(String) - Method in class org.apache.wiki.tags.RequestResourceTag

Set the type of the resource to be included.

setUid(String) - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Sets the unique identifier for the user profile.

setUid(String) - Method in interface org.apache.wiki.auth.user.UserProfile

Sets the unique identifier for the user profile.

setupPreferences(PageContext) - Static method in class org.apache.wiki.preferences.Preferences

This is an utility method which is called to make sure that the JSP pages do have proper access to any user preferences.

setUrl(String) - Method in class org.apache.wiki.tags.TabTag

Sets the tab URL.

setURL(String) - Method in class org.apache.wiki.rss.Entry

Set the URL - the permalink - of the Entry.

setUrlformat(String) - Method in class org.apache.wiki.tags.CalendarTag

Set the URL format.

setUserCookie(HttpServletResponse, String) - Static method in class org.apache.wiki.auth.login.CookieAssertionLoginModule

Sets the username cookie.

setUserDatabase(UserDatabase) - Method in class org.apache.wiki.auth.login.UserDatabaseCallback

Sets the user database.

setUserProfile(Context, UserProfile) - Method in class org.apache.wiki.auth.DefaultUserManager

Saves the UserProfile for the user in a wiki session.

setUserProfile(Context, UserProfile) - Method in interface org.apache.wiki.auth.UserManager

Saves the UserProfile for the user in a wiki session.

setValue(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "value" parameter.

setValue(String) - Method in class org.apache.wiki.tags.ParamTag

Set the value of the parameter to transfer.

setVar(String) - Method in class org.apache.wiki.tags.CookieTag

Set the "var" parameter.

setVar(String) - Method in class org.apache.wiki.tags.VariableTag

setVariable(String, Object) - Method in class org.apache.wiki.WikiContext

Sets a variable.

setVersion(int) - Method in class org.apache.wiki.WikiPage

Sets the page version.

setVersion(String) - Method in class org.apache.wiki.tags.DiffLinkTag

setVersion(String) - Method in class org.apache.wiki.tags.EditLinkTag

setVersion(String) - Method in class org.apache.wiki.tags.LinkTag

setVersion(String) - Method in class org.apache.wiki.tags.LinkToTag

setView(String) - Method in class org.apache.wiki.tags.ContentTag

Set the template for the VIEW context.

setWorkflow(int, Map<String, Serializable>) - Method in class org.apache.wiki.workflow.AbstractStep

method that sets the parent Workflow id and context post-construction.

setWorkflow(int, Map<String, Serializable>) - Method in interface org.apache.wiki.workflow.Step

Sets the parent Workflow post-construction.

SHA_PREFIX - Static variable in class org.apache.wiki.auth.user.AbstractUserDatabase

SHA256_PREFIX - Static variable in class org.apache.wiki.auth.user.AbstractUserDatabase

ShortURLConstructor - Class in org.apache.wiki.url

Provides a way to do short URLs of the form /wiki/PageName.

ShortURLConstructor() - Constructor for class org.apache.wiki.url.ShortURLConstructor

ShortViewURLConstructor - Class in org.apache.wiki.url

A specific URL constructor that returns easy-to-grok URLs for VIEW and ATTACH contexts, but goes through JSP pages otherwise.

ShortViewURLConstructor() - Constructor for class org.apache.wiki.url.ShortViewURLConstructor

shutdown() - Method in class org.apache.wiki.WikiBackgroundThread

Requests the shutdown of this background thread.

shutdown() - Method in class org.apache.wiki.WikiEngine

shutdownTask() - Method in class org.apache.wiki.WikiBackgroundThread

Executes a task after shutdown signal was detected.

SimpleAdminBean - Class in org.apache.wiki.ui.admin

Provides an easy-to-use interface for JSPWiki AdminBeans, which also are JMX MBeans.

SimpleAdminBean() - Constructor for class org.apache.wiki.ui.admin.SimpleAdminBean

Constructor reserved for subclasses only.

SimpleDecision - Class in org.apache.wiki.workflow

Decision subclass that includes two available Outcomes: Outcome.DECISION_APPROVE or Outcome.DECISION_DENY.

SimpleDecision(int, Map<String, Serializable>, String, Principal) - Constructor for class org.apache.wiki.workflow.SimpleDecision

Constructs a new SimpleDecision assigned to a specified actor.

SimpleMBean - Class in org.apache.wiki.management

A simple MBean which does not require an interface class unlike the StandardMBean class.

SimpleMBean() - Constructor for class org.apache.wiki.management.SimpleMBean

Create a new SimpleMBean

SimpleNotification - Class in org.apache.wiki.workflow

Decision subclass used for notifications that includes only one available Outcome: Outcome.DECISION_ACKNOWLEDGE.

SimpleNotification(int, Map<String, Serializable>, String, Principal) - Constructor for class org.apache.wiki.workflow.SimpleNotification

Constructs a new SimpleNotification object with a supplied message key, associated Workflow, and named actor who must acknowledge the message.

simplePageExists(String) - Method in class org.apache.wiki.ui.DefaultCommandResolver

Determines whether a "page" exists by examining the list of special pages and querying the page manager.

SKIN_DIRECTORY - Static variable in interface org.apache.wiki.ui.TemplateManager

sort(String[]) - Method in class org.apache.wiki.pages.PageSorter

Sorts the specified array into ascending order based on the PageNameComparator.

sort(List<String>) - Method in class org.apache.wiki.pages.PageSorter

Sorts the specified list into ascending order based on the PageNameComparator.

SpamFilter - Class in org.apache.wiki.filters

This is Herb, the JSPWiki spamfilter that can also do choke modifications.

SpamFilter() - Constructor for class org.apache.wiki.filters.SpamFilter

SpamFilterInputsTag - Class in org.apache.wiki.tags

Provides hidden input fields which are checked by the SpamFilter.

SpamFilterInputsTag() - Constructor for class org.apache.wiki.tags.SpamFilterInputsTag

SSHA_PREFIX - Static variable in class org.apache.wiki.auth.user.AbstractUserDatabase

STANDARD - Static variable in class org.apache.wiki.ui.InputValidator

Standard input validator.

start() - Method in class org.apache.wiki.workflow.AbstractStep

Starts the Step, and sets the start time to the moment when this method is first invoked.

start() - Method in interface org.apache.wiki.workflow.Step

Starts the Step, and sets the start time to the moment when this method is first invoked.

start(Context) - Method in class org.apache.wiki.workflow.Workflow

Starts the Workflow and sets the state to Workflow.RUNNING.

STARTED - Static variable in class org.apache.wiki.ui.progress.ProgressItem

Status: The PI is started.

startProgress(ProgressItem, String) - Method in class org.apache.wiki.ui.progress.DefaultProgressManager

Call this method to get your ProgressItem into the ProgressManager queue.

startProgress(ProgressItem, String) - Method in interface org.apache.wiki.ui.progress.ProgressManager

Call this method to get your ProgressItem into the ProgressManager queue.

startupTask() - Method in class org.apache.wiki.rss.RSSThread

Executes a task just after the thread's Thread.run() method starts, but before the WikiBackgroundThread.backgroundTask() task executes.

startupTask() - Method in class org.apache.wiki.WikiBackgroundThread

Executes a task just after the thread's Thread.run() method starts, but before the WikiBackgroundThread.backgroundTask() task executes.

startUserProfileCreationWorkflow(Context, UserProfile) - Method in class org.apache.wiki.auth.DefaultUserManager

startUserProfileCreationWorkflow(Context, UserProfile) - Method in interface org.apache.wiki.auth.UserManager

Step - Interface in org.apache.wiki.workflow

Discrete unit of work in a Workflow, such as a Decision or a Task.

STEP_ABORT - Static variable in class org.apache.wiki.workflow.Outcome

Terminate workflow step (without errors)

STEP_COMPLETE - Static variable in class org.apache.wiki.workflow.Outcome

Complete workflow step (without errors)

STEP_CONTINUE - Static variable in class org.apache.wiki.workflow.Outcome

Continue workflow step (without errors)

STOPPED - Static variable in class org.apache.wiki.ui.progress.ProgressItem

Status: The PI is stopped.

stopProgress(String) - Method in class org.apache.wiki.ui.progress.DefaultProgressManager

Call this method to remove your ProgressItem from the queue (after which getProgress() will no longer find it.

stopProgress(String) - Method in interface org.apache.wiki.ui.progress.ProgressManager

Call this method to remove your ProgressItem from the queue (after which getProgress() will no longer find it.

STORAGE_DIR - Static variable in class org.apache.wiki.ui.Installer

storeAttachment(Attachment, File) - Method in interface org.apache.wiki.attachment.AttachmentManager

Stores an attachment that lives in the given file.

storeAttachment(Attachment, InputStream) - Method in interface org.apache.wiki.attachment.AttachmentManager

Stores an attachment directly from a stream.

storeAttachment(Attachment, InputStream) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Stores an attachment directly from a stream.

storeDynamicAttachment(Context, DynamicAttachment) - Method in interface org.apache.wiki.attachment.AttachmentManager

Stores a dynamic attachment.

storeDynamicAttachment(Context, DynamicAttachment) - Method in class org.apache.wiki.attachment.DefaultAttachmentManager

Stores a dynamic attachment.

storeFormInfo(Context, FormInfo) - Method in class org.apache.wiki.forms.FormElement

Utility method stores a FormInfo object into the Context.

STRATEGY_EAGER - Static variable in class org.apache.wiki.filters.SpamFilter

The string specifying the "eager" strategy.

STRATEGY_SCORE - Static variable in class org.apache.wiki.filters.SpamFilter

The string specifying the "score" strategy.

StringTransmutator - Interface in org.apache.wiki

Defines an interface for transforming strings within a Wiki context.

SYSTEM_FILTER_PRIORITY - Static variable in interface org.apache.wiki.filters.FilterManager

JSPWiki system filters are all below this value.

SYSTEM_USER - Static variable in class org.apache.wiki.workflow.SystemPrincipal

The JSPWiki system user

SystemPrincipal - Class in org.apache.wiki.workflow

System users associated with workflow Task steps.

T

TabbedSectionTag - Class in org.apache.wiki.tags

Generates tabbed page section: container for the Tab tag.

TabbedSectionTag() - Constructor for class org.apache.wiki.tags.TabbedSectionTag

TableOfContents - Class in org.apache.wiki.plugin

Provides a table of contents.

TableOfContents() - Constructor for class org.apache.wiki.plugin.TableOfContents

TabTag - Class in org.apache.wiki.tags

Generates single tabbed page layout.

TabTag() - Constructor for class org.apache.wiki.tags.TabTag

targetedCommand(Object) - Method in class org.apache.wiki.ui.AbstractCommand

targetedCommand(Object) - Method in class org.apache.wiki.ui.GroupCommand

Creates and returns a targeted Command by combining a GroupPrincipal with this Command.

targetedCommand(Object) - Method in class org.apache.wiki.ui.PageCommand

Creates and returns a targeted Command by combining a WikiPage with this Command.

targetedCommand(Object) - Method in class org.apache.wiki.ui.RedirectCommand

Creates and returns a targeted Command by combining a URL (as String) with this Command.

targetedCommand(Object) - Method in class org.apache.wiki.ui.WikiCommand

Creates and returns a targeted Command by combining a wiki (a String) with this Command.

targetedCommand(Object) - Method in class org.apache.wiki.WikiContext

Associates a target with the current Command and returns the new targeted Command.

Task - Class in org.apache.wiki.workflow

AbstractStep subclass that executes instructions, uninterrupted, and results in an Outcome.

Task(int, Map<String, Serializable>, String) - Constructor for class org.apache.wiki.workflow.Task

Constructs a new instance of a Task, with an associated Workflow and message key.

Task(String) - Constructor for class org.apache.wiki.workflow.Task

Public constructor that creates a new Task with a specified message key.

TasksManager - Interface in org.apache.wiki.tasks

Manager responsible of creation of the different JSPWiki Steps.

TemplateDirTag - Class in org.apache.wiki.tags

Returns the currently used template.

TemplateDirTag() - Constructor for class org.apache.wiki.tags.TemplateDirTag

templateExists(String) - Method in class org.apache.wiki.ui.DefaultTemplateManager

Check the existence of a template.

templateExists(String) - Method in interface org.apache.wiki.ui.TemplateManager

Check the existence of a template.

TemplateManager - Interface in org.apache.wiki.ui

This class takes care of managing JSPWiki templates.

textToHTML(Context, String) - Method in class org.apache.wiki.render.DefaultRenderingManager

textToHTML(Context, String, StringTransmutator, StringTransmutator) - Method in interface org.apache.wiki.render.RenderingManager

Just convert WikiText to HTML.

textToHTML(Context, String, StringTransmutator, StringTransmutator, StringTransmutator) - Method in interface org.apache.wiki.render.RenderingManager

Just convert WikiText to HTML.

textToHTML(Context, String, StringTransmutator, StringTransmutator, StringTransmutator, boolean, boolean) - Method in class org.apache.wiki.render.DefaultRenderingManager

Helper method for doing the HTML translation.

textToHTML(Context, String, StringTransmutator, StringTransmutator, StringTransmutator, boolean, boolean) - Method in interface org.apache.wiki.render.RenderingManager

Helper method for doing the HTML translation.

TIME - Enum constant in enum org.apache.wiki.preferences.Preferences.TimeFormat

A time format, no date.

TIME_NOT_SET - Static variable in interface org.apache.wiki.workflow.Step

Time value: the start or end time has not been set.

TIMEFORMATPROPERTIES - Static variable in interface org.apache.wiki.ui.TemplateManager

Prefix of the default timeformat properties.

timeoutExceeded(String) - Method in interface org.apache.wiki.Watchable

This is a callback which is called whenever your expected completion time is exceeded.

title() - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

TMP_DIR - Static variable in class org.apache.wiki.ui.Installer

toJson(Object) - Static method in class org.apache.wiki.ajax.AjaxUtil

Uses Google Gson (https://code.google.com/p/google-gson/) to convert to JSON

toString() - Method in class org.apache.wiki.attachment.Attachment

Returns a human-readable, only-debugging-suitable description.

toString() - Method in class org.apache.wiki.auth.acl.AclEntryImpl

Returns a string representation of the contents of this ACL entry.

toString() - Method in class org.apache.wiki.auth.acl.AclImpl

toString() - Method in class org.apache.wiki.auth.acl.UnresolvedPrincipal

Returns a String representation of the UnresolvedPrincipal.

toString() - Method in class org.apache.wiki.auth.authorize.Group

Returns a string representation of the Group.

toString() - Method in class org.apache.wiki.auth.authorize.Role

Returns a String representation of the role

toString() - Method in class org.apache.wiki.auth.GroupPrincipal

Returns a string representation of this object.

toString() - Method in class org.apache.wiki.auth.permissions.AllPermission

Prints a human-readable representation of this permission.

toString() - Method in class org.apache.wiki.auth.permissions.GroupPermission

Prints a human-readable representation of this permission.

toString() - Method in class org.apache.wiki.auth.permissions.PagePermission

Prints a human-readable representation of this permission.

toString() - Method in class org.apache.wiki.auth.permissions.WikiPermission

Prints a human-readable representation of this permission.

toString() - Method in class org.apache.wiki.auth.user.DefaultUserProfile

Returns a string representation of this user profile.

toString() - Method in interface org.apache.wiki.auth.user.UserProfile

Returns a string representation of this user profile.

toString() - Method in class org.apache.wiki.auth.WikiPrincipal

Returns a human-readable representation of the object.

toString() - Method in class org.apache.wiki.parser.LinkParser.Link

Returns a wikitext string representation of this Link.

toString() - Method in class org.apache.wiki.parser.VariableContent

Returns a debug-suitable string.

toString() - Method in class org.apache.wiki.plugin.DefaultPluginManager.WikiPluginInfo

Returns a string suitable for debugging.

toString() - Method in class org.apache.wiki.ui.AbstractCommand

Returns a String representation of the Command.

toString() - Method in class org.apache.wiki.ui.Editor

toString() - Method in class org.apache.wiki.WatchDog

Strictly for debugging/informative purposes.

toString() - Method in class org.apache.wiki.WikiPage

Returns a debug-suitable version of the page.

toString() - Method in class org.apache.wiki.workflow.Fact

Returns a String representation of this Fact.

toString() - Method in class org.apache.wiki.workflow.Outcome

TraditionalDiffProvider - Class in org.apache.wiki.diff

This is the JSPWiki 'traditional' diff.

TraditionalDiffProvider() - Constructor for class org.apache.wiki.diff.TraditionalDiffProvider

Constructs the provider.

translate(Properties, String) - Method in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

Translates Creole markup to JSPWiki markup

translateSignature(Properties, String, String) - Method in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

I have no idea what this method does.

TranslateTag - Class in org.apache.wiki.tags

Converts the body text into HTML content.

TranslateTag() - Constructor for class org.apache.wiki.tags.TranslateTag

TranslationsCheck - Class in org.apache.wiki

Simple utility that shows you a sorted list of property differences between the 'default en' and a given i18n file.

TranslationsCheck() - Constructor for class org.apache.wiki.TranslationsCheck

U

UndefinedPagesPlugin - Class in org.apache.wiki.plugin

Plugin that enumerates the pages in the wiki that have not yet been defined.

UndefinedPagesPlugin() - Constructor for class org.apache.wiki.plugin.UndefinedPagesPlugin

UNKNOWN - Static variable in interface org.apache.wiki.ui.admin.AdminBean

unlockPage(PageLock) - Method in class org.apache.wiki.pages.DefaultPageManager

Marks a page free to be written again.

unlockPage(PageLock) - Method in interface org.apache.wiki.pages.PageManager

Marks a page free to be written again.

unmangleName(String) - Method in class org.apache.wiki.providers.AbstractFileProvider

This makes the reverse of mangleName.

UnresolvedPrincipal - Class in org.apache.wiki.auth.acl

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.

UnresolvedPrincipal(String) - Constructor for class org.apache.wiki.auth.acl.UnresolvedPrincipal

Constructs a new UnresolvedPrincipal instance.

UNSPECIFIED - Static variable in class org.apache.wiki.auth.WikiPrincipal

Generic WikiPrincipal of unspecified type.

UnusedPagesPlugin - Class in org.apache.wiki.plugin

Plugin for displaying pages that are not linked to in other pages.

UnusedPagesPlugin() - Constructor for class org.apache.wiki.plugin.UnusedPagesPlugin

updateCommand(String) - Method in class org.apache.wiki.WikiContext

Protected method that updates the internally cached Command.

updateLuceneIndex(Page, String) - Method in class org.apache.wiki.search.LuceneSearchProvider

Updates the lucene index for a single page.

updateReferences(String, Collection<String>) - Method in class org.apache.wiki.references.DefaultReferenceManager

Updates the referred pages of a new or edited WikiPage.

updateReferences(String, Collection<String>) - Method in interface org.apache.wiki.references.ReferenceManager

Updates the referred pages of a new or edited WikiPage.

updateReferences(Page) - Method in class org.apache.wiki.references.DefaultReferenceManager

Updates all references for the given page.

updateReferences(Page) - Method in interface org.apache.wiki.references.ReferenceManager

Updates all references for the given page.

upload(HttpServletRequest) - Method in class org.apache.wiki.attachment.AttachmentServlet

Uploads a specific mime multipart input set, intercepts exceptions.

UPLOAD - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the upload permission.

UPLOAD - Static variable in class org.apache.wiki.ui.PageCommand

UPLOAD - Static variable in class org.apache.wiki.WikiContext

User is uploading something.

UPLOAD_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the upload permission.

UploadLinkTag - Class in org.apache.wiki.tags

Writes a link to the upload page.

UploadLinkTag() - Constructor for class org.apache.wiki.tags.UploadLinkTag

URL - Static variable in class org.apache.wiki.tags.WikiLinkTag

URLConstructor - Interface in org.apache.wiki.url

Provides an interface through which JSPWiki constructs URLs.

USER_FILTER_PRIORITY - Static variable in interface org.apache.wiki.filters.FilterManager

The standard user level filtering.

USER_PROFILE_SAVE_TASK_MESSAGE_KEY - Static variable in interface org.apache.wiki.tasks.TasksManager

The message key of the text to finally approve a user profile save.

UserBean - Class in org.apache.wiki.ui.admin.beans

UserBean(Engine) - Constructor for class org.apache.wiki.ui.admin.beans.UserBean

UserCheckTag - Class in org.apache.wiki.tags

Includes the content if an user check validates.

UserCheckTag() - Constructor for class org.apache.wiki.tags.UserCheckTag

UserDatabase - Interface in org.apache.wiki.auth.user

Defines an interface for loading, persisting and storing users.

UserDatabaseCallback - Class in org.apache.wiki.auth.login

Callback for requesting and supplying a wiki UserDatabase.

UserDatabaseCallback() - Constructor for class org.apache.wiki.auth.login.UserDatabaseCallback

UserDatabaseLoginModule - Class in org.apache.wiki.auth.login

Logs in a user based on a username, password, and static password file location.

UserDatabaseLoginModule() - Constructor for class org.apache.wiki.auth.login.UserDatabaseLoginModule

UserManager - Interface in org.apache.wiki.auth

Provides a facade for obtaining user information.

UserNameTag - Class in org.apache.wiki.tags

Returns the current user name, or empty, if the user has not been validated.

UserNameTag() - Constructor for class org.apache.wiki.tags.UserNameTag

userPrincipals() - Method in class org.apache.wiki.auth.SessionMonitor

Returns the current wiki users as a sorted array of Principal objects.

userPrincipals(Engine) - Static method in class org.apache.wiki.WikiSession

Deprecated.

use SessionMonitor.userPrincipals() instead

UserProfile - Interface in org.apache.wiki.auth.user

Class for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.

UserProfileTag - Class in org.apache.wiki.tags

Returns user profile attributes, or empty strings if the user has not been validated.

UserProfileTag() - Constructor for class org.apache.wiki.tags.UserProfileTag

V

validate(String, String, int) - Method in class org.apache.wiki.ui.InputValidator

Validates a string against a particular pattern type: e-mail address, standard HTML input, etc.

validateCustomPageProperties(Properties) - Method in class org.apache.wiki.providers.AbstractFileProvider

Default validation, validates that key and value is ASCII StringUtils.isAsciiPrintable() and within lengths set up in jspwiki-custom.properties.

validateDefaultTab(String) - Method in class org.apache.wiki.tags.TabbedSectionTag

validateFileName(String) - Static method in interface org.apache.wiki.attachment.AttachmentManager

Validates the filename and makes sure it is legal.

validateGroup(Context, Group) - Method in class org.apache.wiki.auth.authorize.DefaultGroupManager

Validates a Group, and appends any errors to the session errors list.

validateGroup(Context, Group) - Method in interface org.apache.wiki.auth.authorize.GroupManager

Validates a Group, and appends any errors to the session errors list.

validateNotNull(String, String) - Method in class org.apache.wiki.ui.InputValidator

Validates a string against the InputValidator.STANDARD validator and additionally checks that the value is not null or blank.

validateNotNull(String, String, int) - Method in class org.apache.wiki.ui.InputValidator

Validates a string against a particular pattern type and additionally checks that the value is not null or blank.

validatePassword(String, String) - Method in class org.apache.wiki.auth.user.AbstractUserDatabase

Validates the password for a given user.

validatePassword(String, String) - Method in interface org.apache.wiki.auth.user.UserDatabase

Determines whether a supplied user password is valid, given a login name and password.

validateProfile(Context, UserProfile) - Method in class org.apache.wiki.auth.DefaultUserManager

Validates a user profile, and appends any errors to the session errors list.

validateProfile(Context, UserProfile) - Method in interface org.apache.wiki.auth.UserManager

Validates a user profile, and appends any errors to the session errors list.

validateProperties() - Method in class org.apache.wiki.ui.Installer

validModuleVersion(WikiModuleInfo) - Method in class org.apache.wiki.ui.admin.beans.ModuleBean

valueOf(String) - Static method in enum org.apache.wiki.preferences.Preferences.TimeFormat

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.wiki.preferences.Preferences.TimeFormat

Returns an array containing the constants of this enum type, in the order they are declared.

VAR_BLOGNAME - Static variable in class org.apache.wiki.rss.Feed

Wiki variable storing the blog's name.

VAR_CREOLE_VERSION - Static variable in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

The version of Creole that this filter supports.

VAR_ERROR - Static variable in interface org.apache.wiki.variables.VariableManager

VAR_LINEBREAK_BLOGLIKE - Static variable in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

The linebreak style "bloglike".

VAR_LINEBREAK_C2LIKE - Static variable in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

The linebreak style "c2like".

VAR_MSG - Static variable in interface org.apache.wiki.variables.VariableManager

VAR_RUNFILTERS - Static variable in interface org.apache.wiki.variables.VariableManager

If this variable is set to false, all filters are disabled when translating.

VAR_VERSION - Static variable in class org.apache.wiki.parser.CreoleToJSPWikiTranslator

The version of the filter.

VariableContent - Class in org.apache.wiki.parser

Stores the contents of a WikiVariable in a WikiDocument DOM tree.

VariableContent(String) - Constructor for class org.apache.wiki.parser.VariableContent

Create a VariableContent for the given variable.

VariableManager - Interface in org.apache.wiki.variables

Manages variables.

VariableTag - Class in org.apache.wiki.tags

Returns the value of an Wiki variable.

VariableTag() - Constructor for class org.apache.wiki.tags.VariableTag

VER_CURRENT - Static variable in class org.apache.wiki.tags.DiffLinkTag

VER_LATEST - Static variable in class org.apache.wiki.tags.DiffLinkTag

VER_PREVIOUS - Static variable in class org.apache.wiki.tags.DiffLinkTag

VersioningFileProvider - Class in org.apache.wiki.providers

Provides a simple directory based repository for Wiki pages.

VersioningFileProvider() - Constructor for class org.apache.wiki.providers.VersioningFileProvider

VersioningProvider - Interface in org.apache.wiki.providers

This is a provider interface which providers can implement, if they support fast checks of versions.

VIEW - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Convenience constant that denotes GroupPermission( "*:*, "view" ).

VIEW - Static variable in class org.apache.wiki.auth.permissions.PagePermission

A static instance of the view permission.

VIEW - Static variable in class org.apache.wiki.ui.PageCommand

VIEW - Static variable in class org.apache.wiki.WikiContext

The VIEW context - the user just wants to view the page contents.

VIEW_ACTION - Static variable in class org.apache.wiki.auth.permissions.GroupPermission

Action for viewing a group or collection of groups.

VIEW_ACTION - Static variable in class org.apache.wiki.auth.permissions.PagePermission

Action name for the view permission.

VIEW_GROUP - Static variable in class org.apache.wiki.ui.GroupCommand

GroupCommand for viewing a group.

VIEW_GROUP - Static variable in class org.apache.wiki.WikiContext

User is viewing an existing group

W

WAITING - Static variable in class org.apache.wiki.workflow.Workflow

State value: Workflow paused, typically because a Step returned an Outcome that doesn't signify "completion."

waitstate() - Method in class org.apache.wiki.workflow.Workflow

Sets the Workflow in the Workflow.WAITING state.

WARNING - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message prefix for warnings.

WARNING_DB - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for user database warnings.

WARNING_GROUPS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for group database warnings.

WARNING_JAAS - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for JAAS warnings.

WARNING_POLICY - Static variable in class org.apache.wiki.auth.SecurityVerifier

Message topic for policy warnings.

Watchable - Interface in org.apache.wiki

A watchdog needs something to watch.

WatchDog - Class in org.apache.wiki

WatchDog is a general system watchdog.

WatchDog(Engine, Thread) - Constructor for class org.apache.wiki.WatchDog

Creates a new WatchDog for a Thread.

WatchDog(Engine, Watchable) - Constructor for class org.apache.wiki.WatchDog

Creates a new WatchDog for a Watchable.

WebAuthorizer - Interface in org.apache.wiki.auth.authorize

Extends the Authorizer interface by including a delegate method for HttpServletRequest.isUserInRole(String).

WebContainerAuthorizer - Class in org.apache.wiki.auth.authorize

Authorizes users by delegating role membership checks to the servlet container.

WebContainerAuthorizer() - Constructor for class org.apache.wiki.auth.authorize.WebContainerAuthorizer

Constructs a new instance of the WebContainerAuthorizer class.

WebContainerAuthorizer.LocalEntityResolver - Class in org.apache.wiki.auth.authorize

XML entity resolver that redirects resolution requests by JDOM, JAXP and other XML parsers to locally-cached copies of the resources.

WebContainerCallbackHandler - Class in org.apache.wiki.auth.login

Handles logins made from within JSPWiki.

WebContainerCallbackHandler(Engine, HttpServletRequest) - Constructor for class org.apache.wiki.auth.login.WebContainerCallbackHandler

Create a new handler.

WebContainerLoginModule - Class in org.apache.wiki.auth.login

Logs in a user by extracting authentication data from an Http servlet session.

WebContainerLoginModule() - Constructor for class org.apache.wiki.auth.login.WebContainerLoginModule

webContainerRoles() - Method in class org.apache.wiki.auth.SecurityVerifier

If the active Authorizer is the WebContainerAuthorizer, returns the roles it knows about; otherwise, a zero-length array.

WeblogArchivePlugin - Class in org.apache.wiki.plugin

Creates a list of all weblog entries on a monthly basis.

WeblogArchivePlugin() - Constructor for class org.apache.wiki.plugin.WeblogArchivePlugin

WeblogEntryPlugin - Class in org.apache.wiki.plugin

Builds a simple weblog.

WeblogEntryPlugin() - Constructor for class org.apache.wiki.plugin.WeblogEntryPlugin

WeblogPlugin - Class in org.apache.wiki.plugin

Builds a simple weblog.

WeblogPlugin() - Constructor for class org.apache.wiki.plugin.WeblogPlugin

WF_UP_CREATE_SAVE_APPROVER - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The name of the key from jspwiki.properties which defines who shall approve the workflow of creating a user profile.

WF_UP_CREATE_SAVE_ATTR_SAVED_PROFILE - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The workflow attribute which stores the user profile.

WF_UP_CREATE_SAVE_DECISION_MESSAGE_KEY - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The message key for storing the Decision text for saving a user profile.

WF_UP_CREATE_SAVE_FACT_PREFS_EMAIL - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the preferences' email.

WF_UP_CREATE_SAVE_FACT_PREFS_FULL_NAME - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the preferences' full name.

WF_UP_CREATE_SAVE_FACT_PREFS_LOGIN_NAME - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the preferences' login name.

WF_UP_CREATE_SAVE_FACT_SUBMITTER - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing a the submitter name.

WF_WP_SAVE_APPROVER - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The name of the key from jspwiki.properties which defines who shall approve the workflow of storing a wikipage.

WF_WP_SAVE_DECISION_MESSAGE_KEY - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The message key for storing the Decision text for saving a page.

WF_WP_SAVE_FACT_CURRENT_TEXT - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the current text.

WF_WP_SAVE_FACT_DIFF_TEXT - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing a diff text.

WF_WP_SAVE_FACT_IS_AUTHENTICATED - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing whether the user is authenticated or not.

WF_WP_SAVE_FACT_PAGE_NAME - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the page name.

WF_WP_SAVE_FACT_PROPOSED_TEXT - Static variable in interface org.apache.wiki.workflow.WorkflowManager

Fact name for storing the proposed (edited) text.

WF_WP_SAVE_REJECT_MESSAGE_KEY - Static variable in interface org.apache.wiki.workflow.WorkflowManager

The message key for rejecting the decision to save the page.

WIKI_NAME - Static variable in class org.apache.wiki.auth.WikiPrincipal

WikiPrincipal type denoting a user's wiki name.

WikiAjaxDispatcherServlet - Class in org.apache.wiki.ajax

This provides a simple ajax servlet for handling /ajax/ requests.

WikiAjaxDispatcherServlet() - Constructor for class org.apache.wiki.ajax.WikiAjaxDispatcherServlet

WikiAjaxServlet - Interface in org.apache.wiki.ajax

An interface for a servlet that wants to use Ajax functionality.

WikiBackgroundThread - Class in org.apache.wiki

Abstract Thread subclass that operates in the background; when it detects the WikiEngineEvent.SHUTDOWN event, it terminates itself.

WikiBackgroundThread(Engine, int) - Constructor for class org.apache.wiki.WikiBackgroundThread

Constructs a new instance of this background thread with a specified sleep interval, and adds the new instance to the wiki engine's event listeners.

WikiBodyTag - Class in org.apache.wiki.tags

This is a class that provides the same services as the WikiTagBase, but this time it works for the BodyTagSupport base class.

WikiBodyTag() - Constructor for class org.apache.wiki.tags.WikiBodyTag

WikiCallbackHandler - Class in org.apache.wiki.auth.login

Handles logins made from inside the wiki application, rather than via the web container.

WikiCallbackHandler(Engine, HttpServletRequest, String, String) - Constructor for class org.apache.wiki.auth.login.WikiCallbackHandler

Create a new callback handler.

WikiCommand - Class in org.apache.wiki.ui

Defines Commands for wiki-wide operations such as creating groups, editing preferences and profiles, and logging in/out.

WikiContext - Class in org.apache.wiki

Provides state information throughout the processing of a page.

WikiContext(Engine, HttpServletRequest, String) - Constructor for class org.apache.wiki.WikiContext

Creates a new WikiContext from a supplied HTTP request, using a default wiki context.

WikiContext(Engine, HttpServletRequest, Command) - Constructor for class org.apache.wiki.WikiContext

Creates a new WikiContext for the given Engine, Command and HttpServletRequest.

WikiContext(Engine, HttpServletRequest, Page) - Constructor for class org.apache.wiki.WikiContext

Creates a new WikiContext for the given Engine, WikiPage and HttpServletRequest.

WikiContext(Engine, Page) - Constructor for class org.apache.wiki.WikiContext

Create a new WikiContext for the given WikiPage.

WikiDocument - Class in org.apache.wiki.parser

Stores the DOM tree of a rendered WikiPage.

WikiDocument(Page) - Constructor for class org.apache.wiki.parser.WikiDocument

Creates a new WikiDocument for a specific page.

WikiEngine - Class in org.apache.wiki

Main implementation for Engine.

WikiEngine(Properties) - Constructor for class org.apache.wiki.WikiEngine

Instantiate the WikiEngine using a given set of properties.

WikiEngine(ServletContext, String) - Constructor for class org.apache.wiki.WikiEngine

Instantiate using this method when you're running as a servlet and WikiEngine will figure out where to look for the property file.

WikiEngineCallback - Class in org.apache.wiki.auth.login

Callback for requesting and supplying the WikiEngine object required by a LoginModule.

WikiEngineCallback() - Constructor for class org.apache.wiki.auth.login.WikiEngineCallback

WikiFileFilter() - Constructor for class org.apache.wiki.providers.AbstractFileProvider.WikiFileFilter

WikiFormAdminBean - Class in org.apache.wiki.ui.admin

This class is still experimental.

WikiFormAdminBean() - Constructor for class org.apache.wiki.ui.admin.WikiFormAdminBean

wikifyLink(String) - Static method in class org.apache.wiki.parser.MarkupParser

Cleans away extra legacy characters.

WikiJSPFilter - Class in org.apache.wiki.ui

This filter goes through the generated page response prior and places requested resources at the appropriate inclusion markers.

WikiJSPFilter() - Constructor for class org.apache.wiki.ui.WikiJSPFilter

WikiLinkTag - Class in org.apache.wiki.tags

Root class for different internal wiki links.

WikiLinkTag() - Constructor for class org.apache.wiki.tags.WikiLinkTag

WikiModuleInfo - Class in org.apache.wiki.modules

A WikiModule describes whatever JSPWiki plugin there is: it can be a plugin, an editor, a filter, etc.

WikiModuleInfo(String) - Constructor for class org.apache.wiki.modules.WikiModuleInfo

Create a new info container.

WikiPage - Class in org.apache.wiki

Simple wrapper class for the Wiki page attributes.

WikiPage(Engine, String) - Constructor for class org.apache.wiki.WikiPage

Create a new WikiPage using a given engine and name.

WikiPage(WikiEngine, String) - Constructor for class org.apache.wiki.WikiPage

Deprecated.

kept for compatibility with page/attachment providers not using public API. Use WikiPage(Engine, String) instead.

WIKIPAGE_PRESAVE_TASK_MESSAGE_KEY - Static variable in interface org.apache.wiki.tasks.TasksManager

The message key for storing the text for the presave task.

WIKIPAGE_SAVE_TASK_MESSAGE_KEY - Static variable in interface org.apache.wiki.tasks.TasksManager

The message key of the text to finally approve a page save.

wikiPageExists(String) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns true, if the requested page (or an alias) exists.

wikiPageExists(String) - Method in interface org.apache.wiki.pages.PageManager

Returns true, if the requested page (or an alias) exists.

wikiPageExists(String, int) - Method in class org.apache.wiki.pages.DefaultPageManager

Returns true, if the requested page (or an alias) exists with the requested version.

wikiPageExists(String, int) - Method in interface org.apache.wiki.pages.PageManager

Returns true, if the requested page (or an alias) exists with the requested version.

wikiPageExists(Page) - Method in interface org.apache.wiki.pages.PageManager

Returns true, if the requested page (or an alias) exists, with the specified version in the WikiPage.

WikiPermission - Class in org.apache.wiki.auth.permissions

Permission to perform an global wiki operation, such as self-registering or creating new pages.

WikiPermission(String, String) - Constructor for class org.apache.wiki.auth.permissions.WikiPermission

Creates a new WikiPermission for a specified set of actions.

WikiPrincipal - Class in org.apache.wiki.auth

A lightweight, immutable Principal class.

WikiPrincipal(String) - Constructor for class org.apache.wiki.auth.WikiPrincipal

Constructs a new WikiPrincipal with a given name and a type of WikiPrincipal.UNSPECIFIED.

WikiPrincipal(String, String) - Constructor for class org.apache.wiki.auth.WikiPrincipal

Constructs a new WikiPrincipal with a given name and optional type designator.

WikiRenderer - Class in org.apache.wiki.render

Provides an interface to the basic rendering engine.

WikiRenderer(Context, WikiDocument) - Constructor for class org.apache.wiki.render.WikiRenderer

Create a WikiRenderer.

WikiRequestWrapper - Class in org.apache.wiki.ui

Servlet request wrapper that encapsulates an incoming HTTP request and overrides its security methods so that the request returns JSPWiki-specific values.

WikiRequestWrapper(Engine, HttpServletRequest) - Constructor for class org.apache.wiki.ui.WikiRequestWrapper

Constructs a new wrapped request.

WikiRPCHandler - Interface in org.apache.wiki.xmlrpc

Any wiki RPC handler should implement this so that they can be properly initialized and recognized by JSPWiki.

WikiSecurityException - Exception in org.apache.wiki.auth

Indicates an authentication or authorization error or exception.

WikiSecurityException(String) - Constructor for exception org.apache.wiki.auth.WikiSecurityException

Constructs an exception.

WikiSecurityException(String, Throwable) - Constructor for exception org.apache.wiki.auth.WikiSecurityException

Constructs an exception with a supplied cause.

WikiServlet - Class in org.apache.wiki

This provides a master servlet for dealing with short urls.

WikiServlet() - Constructor for class org.apache.wiki.WikiServlet

WikiServletFilter - Class in org.apache.wiki.ui

Filter that verifies that the Engine is running, and sets the authentication status for the user's Session.

WikiServletFilter() - Constructor for class org.apache.wiki.ui.WikiServletFilter

Creates a Wiki Servlet Filter.

WikiSession - Class in org.apache.wiki

Default implementation for Session.

WikiTagBase - Class in org.apache.wiki.tags

Base class for JSPWiki tags.

WikiTagBase() - Constructor for class org.apache.wiki.tags.WikiTagBase

wikitizeCollection(Collection<String>, String, int) - Method in class org.apache.wiki.plugin.AbstractReferralPlugin

Makes WikiText from a Collection.

WILDCARD - Static variable in class org.apache.wiki.auth.permissions.WikiPermission

Value for a generic wildcard.

WORK_DIR - Static variable in class org.apache.wiki.ui.Installer

Workflow - Class in org.apache.wiki.workflow

Sequence of Step objects linked together.

Workflow(String, Principal) - Constructor for class org.apache.wiki.workflow.Workflow

Constructs a new Workflow object with a supplied message key, owner Principal, and undefined unique identifier Workflow.ID_NOT_SET.

WORKFLOW - Static variable in class org.apache.wiki.ui.WikiCommand

WORKFLOW - Static variable in class org.apache.wiki.WikiContext

User wants to view or administer workflows.

WorkflowBuilder - Class in org.apache.wiki.workflow

Factory class that creates common Workflow instances such as a standard approval workflow.

WorkflowManager - Interface in org.apache.wiki.workflow

Monitor class that tracks running Workflows.

WysiwygEditingRenderer - Class in org.apache.wiki.render

Implements a WikiRenderer that outputs XHTML in a format that is suitable for use by a WYSIWYG XHTML editor.

WysiwygEditingRenderer(Context, WikiDocument) - Constructor for class org.apache.wiki.render.WysiwygEditingRenderer

Creates a WYSIWYG editing renderer.

X

XHTMLRenderer - Class in org.apache.wiki.render

Implements a WikiRenderer that outputs XHTML.

XHTMLRenderer(Context, WikiDocument) - Constructor for class org.apache.wiki.render.XHTMLRenderer

Creates an XHTML 1.0 renderer.

XMLGroupDatabase - Class in org.apache.wiki.auth.authorize

GroupDatabase implementation for loading, persisting and storing wiki groups, using an XML file for persistence.

XMLGroupDatabase() - Constructor for class org.apache.wiki.auth.authorize.XMLGroupDatabase

XMLRPC_PREFIX - Static variable in class org.apache.wiki.xmlrpc.RPCServlet

This is what is appended to each command, if the handler has not been specified.

XMLUserDatabase - Class in org.apache.wiki.auth.user

Manages DefaultUserProfile objects using XML files for persistence.

XMLUserDatabase() - Constructor for class org.apache.wiki.auth.user.XMLUserDatabase

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