| Package | Description | 
|---|---|
| org.apache.wiki | The chief package of JSPWiki. | 
| org.apache.wiki.attachment | Attachment management, uploading and downloading. | 
| org.apache.wiki.pages | Entry point for JSPWiki's Page Objects. | 
| org.apache.wiki.plugin | Provides plugins to the JSPWiki. | 
| org.apache.wiki.providers | Provides storage for JSPWiki. | 
| org.apache.wiki.rss | |
| org.apache.wiki.search | Provides the JSPWiki search functionality. | 
| org.apache.wiki.tags | Provides standard JSP tags for JSPWiki. | 
| org.apache.wiki.ui | Java classes for management of the JSP user interface. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | WikiEngine. deletePage(String pageName)Deletes a page or an attachment completely, including all versions. | 
| void | WikiEngine. deleteVersion(WikiPage page)Deletes a specific version of a page or an attachment. | 
| String | WikiEngine. getFinalPageName(String page)Returns the correct page name, or null, if no such
  page can be found. | 
| void | ReferenceManager. initialize(Collection<WikiPage> pages)Initializes the entire reference manager with the initial set of pages
  from the collection. | 
| boolean | WikiEngine. pageExists(String page,
          int version)Returns true, if the requested page (or an alias) exists with the
  requested version. | 
| boolean | WikiEngine. pageExists(WikiPage page)Returns true, if the requested page (or an alias) exists, with the
  specified version in the WikiPage. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | AttachmentManager. deleteAttachment(Attachment att)Deletes all versions of the given attachment. | 
| void | AttachmentManager. deleteVersion(Attachment att)Deletes the given attachment version. | 
| protected boolean | AttachmentServlet. executeUpload(WikiContext context,
             InputStream data,
             String filename,
             String errorPage,
             String parentPage,
             String changenote,
             long contentLength) | 
| Collection<Attachment> | AttachmentManager. getAllAttachments()Returns a collection of Attachments, containing each and every attachment
  that is in this Wiki. | 
| InputStream | DynamicAttachmentProvider. getAttachmentData(WikiContext context,
                 Attachment att)Returns a stream of data for this attachment. | 
| Attachment | AttachmentManager. getAttachmentInfo(String name)Gets info on a particular attachment, latest version. | 
| Attachment | AttachmentManager. getAttachmentInfo(String name,
                 int version)Gets info on a particular attachment with the given version. | 
| Attachment | AttachmentManager. getAttachmentInfo(WikiContext context,
                 String attachmentname)Figures out the full attachment name from the context and
  attachment name. | 
| Attachment | AttachmentManager. getAttachmentInfo(WikiContext context,
                 String attachmentname,
                 int version)Figures out the full attachment name from the context and
  attachment name. | 
| InputStream | AttachmentManager. getAttachmentStream(Attachment att)Finds a (real) attachment from the repository as a stream. | 
| InputStream | AttachmentManager. getAttachmentStream(WikiContext ctx,
                   Attachment att)Returns an attachment stream using the particular WikiContext. | 
| List<Attachment> | AttachmentManager. getVersionHistory(String attachmentName)Returns a list of versions of the attachment. | 
| List<Attachment> | AttachmentManager. listAttachments(WikiPage wikipage)Returns the list of attachments associated with a given wiki page. | 
| void | AttachmentManager. storeAttachment(Attachment att,
               File source)Stores an attachment that lives in the given file. | 
| void | AttachmentManager. storeAttachment(Attachment att,
               InputStream in)Stores an attachment directly from a stream. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | DefaultPageManager. deletePage(WikiPage page) | 
| void | PageManager. deletePage(WikiPage page)Deletes an entire page, all versions, all traces. | 
| void | DefaultPageManager. deleteVersion(WikiPage page) | 
| void | PageManager. deleteVersion(WikiPage page)Deletes only a specific version of a WikiPage. | 
| Collection<WikiPage> | DefaultPageManager. getAllPages() | 
| Collection<WikiPage> | PageManager. getAllPages()Returns all pages in some random order. | 
| WikiPage | DefaultPageManager. getPageInfo(String pageName,
           int version) | 
| WikiPage | PageManager. getPageInfo(String pageName,
           int version)Finds a WikiPage object describing a particular page and version. | 
| String | DefaultPageManager. getPageText(String pageName,
           int version) | 
| String | PageManager. getPageText(String pageName,
           int version)Fetches the page text from the repository. | 
| List<WikiPage> | DefaultPageManager. getVersionHistory(String pageName) | 
| List<WikiPage> | PageManager. getVersionHistory(String pageName)Gets a version history of page. | 
| boolean | DefaultPageManager. pageExists(String pageName) | 
| boolean | PageManager. pageExists(String pageName)Returns true, if the page exists (any version). | 
| boolean | DefaultPageManager. pageExists(String pageName,
          int version) | 
| boolean | PageManager. pageExists(String pageName,
          int version)Checks for existence of a specific page and version. | 
| void | DefaultPageManager. putPageText(WikiPage page,
           String content) | 
| void | PageManager. putPageText(WikiPage page,
           String content)Puts the page text into the repository. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<WikiPage> | WeblogPlugin. findBlogEntries(WikiEngine engine,
               String baseName,
               Date start,
               Date end)Attempts to locate all pages that correspond to the
  blog entry pattern. | 
| String | WeblogEntryPlugin. getNewEntryPage(WikiEngine engine,
               String blogName)Returns a new page name for entries. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | NoSuchVersionExceptionIndicates that an non-existing version was specified. | 
| class  | RepositoryModifiedExceptionIf the provider detects that someone has modified the repository
  externally, it should throw this exception. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | BasicAttachmentProvider. deleteAttachment(Attachment att)Removes an entire page from the repository. | 
| void | CachingAttachmentProvider. deleteAttachment(Attachment att)Removes an entire page from the repository. | 
| void | WikiAttachmentProvider. deleteAttachment(Attachment att)Removes an entire page from the repository. | 
| void | AbstractFileProvider. deletePage(String pageName)Removes an entire page from the repository. | 
| void | CachingProvider. deletePage(String pageName)Removes an entire page from the repository. | 
| void | FileSystemProvider. deletePage(String pageName)Removes an entire page from the repository. | 
| void | VersioningFileProvider. deletePage(String page)Removes the relevant page directory under "OLD" -directory as well,
  but does not remove any extra subdirectories from it. | 
| void | WikiPageProvider. deletePage(String pageName)Removes an entire page from the repository. | 
| void | BasicAttachmentProvider. deleteVersion(Attachment att)Removes a specific version from the repository. | 
| void | CachingAttachmentProvider. deleteVersion(Attachment att)Removes a specific version from the repository. | 
| void | WikiAttachmentProvider. deleteVersion(Attachment att)Removes a specific version from the repository. | 
| void | AbstractFileProvider. deleteVersion(String pageName,
             int version)Removes a specific version from the repository. | 
| void | CachingProvider. deleteVersion(String pageName,
             int version)Removes a specific version from the repository. | 
| void | VersioningFileProvider. deleteVersion(String page,
             int version)Removes a specific version from the repository. | 
| void | WikiPageProvider. deleteVersion(String pageName,
             int version)Removes a specific version from the repository. | 
| Collection<WikiPage> | AbstractFileProvider. getAllPages()Returns all pages. | 
| Collection<WikiPage> | CachingProvider. getAllPages()Returns all pages. | 
| Collection<WikiPage> | VersioningFileProvider. getAllPages()Returns all pages. | 
| Collection<WikiPage> | WikiPageProvider. getAllPages()Returns all pages. | 
| InputStream | BasicAttachmentProvider. getAttachmentData(Attachment att)Get attachment data. | 
| InputStream | CachingAttachmentProvider. getAttachmentData(Attachment att)Get attachment data. | 
| InputStream | WikiAttachmentProvider. getAttachmentData(Attachment att)Get attachment data. | 
| Attachment | BasicAttachmentProvider. getAttachmentInfo(WikiPage page,
                 String name,
                 int version)Returns info about an attachment. | 
| Attachment | CachingAttachmentProvider. getAttachmentInfo(WikiPage page,
                 String name,
                 int version)Returns info about an attachment. | 
| Attachment | WikiAttachmentProvider. getAttachmentInfo(WikiPage page,
                 String name,
                 int version)Returns info about an attachment. | 
| int | CachingProvider. getPageCount()Gets the number of pages. | 
| int | WikiPageProvider. getPageCount()Gets the number of pages. | 
| WikiPage | AbstractFileProvider. getPageInfo(String page,
           int version)Always returns the latest version, since FileSystemProvider
  does not support versioning. | 
| WikiPage | CachingProvider. getPageInfo(String pageName,
           int version)Returns info about the page. | 
| WikiPage | FileSystemProvider. getPageInfo(String page,
           int version)Always returns the latest version, since FileSystemProvider
  does not support versioning. | 
| WikiPage | VersioningFileProvider. getPageInfo(String page,
           int version)Always returns the latest version, since FileSystemProvider
  does not support versioning. | 
| WikiPage | WikiPageProvider. getPageInfo(String page,
           int version)Returns info about the page. | 
| String | AbstractFileProvider. getPageText(String page,
           int version)This implementation just returns the current version, as filesystem
  does not provide versioning information for now. | 
| String | CachingProvider. getPageText(String pageName,
           int version)Gets a specific version out of the repository. | 
| String | VersioningFileProvider. getPageText(String page,
           int version)This implementation just returns the current version, as filesystem
  does not provide versioning information for now. | 
| String | WikiPageProvider. getPageText(String page,
           int version)Gets a specific version out of the repository. | 
| List<WikiPage> | AbstractFileProvider. getVersionHistory(String page)The FileSystemProvider provides only one version. | 
| List<WikiPage> | CachingProvider. getVersionHistory(String pageName)Returns version history. | 
| List<WikiPage> | VersioningFileProvider. getVersionHistory(String page)The FileSystemProvider provides only one version. | 
| List<WikiPage> | WikiPageProvider. getVersionHistory(String page)Returns version history. | 
| List<Attachment> | BasicAttachmentProvider. listAllChanged(Date timestamp)Lists changed attachments since given date. | 
| List<Attachment> | CachingAttachmentProvider. listAllChanged(Date timestamp)Lists changed attachments since given date. | 
| List<Attachment> | WikiAttachmentProvider. listAllChanged(Date timestamp)Lists changed attachments since given date. | 
| List<Attachment> | BasicAttachmentProvider. listAttachments(WikiPage page)Lists all attachments attached to a page. | 
| List<Attachment> | CachingAttachmentProvider. listAttachments(WikiPage page)Lists all attachments attached to a page. | 
| List<Attachment> | WikiAttachmentProvider. listAttachments(WikiPage page)Lists all attachments attached to a page. | 
| void | BasicAttachmentProvider. moveAttachmentsForPage(String oldParent,
                      String newParent)Move all the attachments for a given page so that they are attached to a
 new page. | 
| void | CachingAttachmentProvider. moveAttachmentsForPage(String oldParent,
                      String newParent)Move all the attachments for a given page so that they are attached to a
 new page. | 
| void | WikiAttachmentProvider. moveAttachmentsForPage(String oldParent,
                      String newParent)Move all the attachments for a given page so that they are attached to a
 new page. | 
| void | CachingProvider. movePage(String from,
        String to)Move a page | 
| void | FileSystemProvider. movePage(String from,
        String to)Move a page | 
| void | WikiPageProvider. movePage(String from,
        String to)Move a page | 
| void | BasicAttachmentProvider. putAttachmentData(Attachment att,
                 InputStream data)Put new attachment data. | 
| void | CachingAttachmentProvider. putAttachmentData(Attachment att,
                 InputStream data)Put new attachment data. | 
| void | WikiAttachmentProvider. putAttachmentData(Attachment att,
                 InputStream data)Put new attachment data. | 
| void | AbstractFileProvider. putPageText(WikiPage page,
           String text)Attempts to save the page text for page "page". | 
| void | CachingProvider. putPageText(WikiPage page,
           String text)Attempts to save the page text for page "page". | 
| void | FileSystemProvider. putPageText(WikiPage page,
           String text)Attempts to save the page text for page "page". | 
| void | VersioningFileProvider. putPageText(WikiPage page,
           String text)Attempts to save the page text for page "page". | 
| void | WikiPageProvider. putPageText(WikiPage page,
           String text)Attempts to save the page text for page "page". | 
| Modifier and Type | Method and Description | 
|---|---|
| protected String | RSSGenerator. generateBlogRSS(WikiContext wikiContext,
               List<WikiPage> changed,
               Feed feed)Creates RSS from modifications as if this page was a blog (using the WeblogPlugin). | 
| String | RSSGenerator. generateFeed(WikiContext wikiContext,
            List<WikiPage> changed,
            String mode,
            String type)Generates a feed based on a context and list of changes. | 
| Modifier and Type | Method and Description | 
|---|---|
| Collection<SearchResult> | LuceneSearchProvider. findPages(String query,
         int flags,
         WikiContext wikiContext)Searches pages using a particular combination of flags. | 
| Collection<SearchResult> | LuceneSearchProvider. findPages(String query,
         WikiContext wikiContext)Search for pages matching a search query | 
| Collection<SearchResult> | SearchManager. findPages(String query,
         WikiContext wikiContext)Sends a search to the current search provider. | 
| Collection<SearchResult> | SearchProvider. findPages(String query,
         WikiContext wikiContext)Search for pages matching a search query | 
| Modifier and Type | Method and Description | 
|---|---|
| int | CheckLockTag. doWikiStartTag()This method is allowed to do pretty much whatever he wants. | 
| int | CheckRequestContextTag. doWikiStartTag()This method is allowed to do pretty much whatever he wants. | 
| int | CheckVersionTag. doWikiStartTag()This method is allowed to do pretty much whatever he wants. | 
| int | ContentTag. doWikiStartTag()This method is allowed to do pretty much whatever he wants. | 
| int | IncludeTag. doWikiStartTag() | 
| int | InsertPageTag. doWikiStartTag() | 
| int | NoSuchPageTag. doWikiStartTag() | 
| int | PageExistsTag. doWikiStartTag() | 
| Modifier and Type | Method and Description | 
|---|---|
| String | CommandResolver. getFinalPageName(String page)
 Returns the correct page name, or  null, if no such page can be found. | 
| protected boolean | CommandResolver. simplePageExists(String page)Determines whether a "page" exists by examining the list of special pages
 and querying the page manager. | 
Copyright © 2001-2019 The Apache Software Foundation. All rights reserved.