Uses of Class
org.apache.wiki.WikiPage

Packages that use WikiPage

Package	Description
org.apache.wiki	The chief package of JSPWiki.
org.apache.wiki.attachment	Attachment management, uploading and downloading.
org.apache.wiki.auth.acl	Access Control List implementation.
org.apache.wiki.auth.permissions
org.apache.wiki.filters	Provides page and content filtering functionality for JSPWiki.
org.apache.wiki.pages	Entry point for JSPWiki's Page Objects.
org.apache.wiki.parser
org.apache.wiki.parser.markdown	Markdown parsing.
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.ui	Java classes for management of the JSP user interface.
org.apache.wiki.xmlrpc

Uses of WikiPage in org.apache.wiki

Methods in org.apache.wiki that return WikiPage

Modifier and Type	Method and Description
WikiPage	WikiContext.getPage() Returns the page that is being handled.
WikiPage	WikiEngine.getPage(String pagereq) Finds the corresponding WikiPage object based on the page name.
WikiPage	WikiEngine.getPage(String pagereq, int version) Finds the corresponding WikiPage object base on the page name and version.
WikiPage	WikiContext.getRealPage() Gets a reference to the real page whose content is currently being rendered.
WikiPage	WikiContext.setRealPage(WikiPage page) Sets a reference to the real page whose content is currently being rendered.

Methods in org.apache.wiki that return types with arguments of type WikiPage

Modifier and Type	Method and Description
Set<WikiPage>	WikiEngine.getRecentChanges() Returns a Collection of WikiPages, sorted in time order of last change (i.e. first object is the most recently changed).
List<? extends WikiPage>	WikiEngine.getVersionHistory(String page) Returns a Collection of WikiPages containing the version history of a page.

Methods in org.apache.wiki with parameters of type WikiPage

Modifier and Type	Method and Description
int	WikiPage.compareTo(WikiPage page) Compares a page with another by name using the defined PageNameComparator.
void	WikiEngine.deleteVersion(WikiPage page) Deletes a specific version of a page or an attachment.
protected static Command	WikiContext.findCommand(WikiEngine engine, javax.servlet.http.HttpServletRequest request, WikiPage page) Looks up and returns a PageCommand based on a supplied WikiPage and HTTP request.
String	WikiEngine.getHTML(WikiContext context, WikiPage page) Returns the converted HTML of the page using a different context than the default context.
String	WikiEngine.getPureText(WikiPage page) Returns the pure text of a page, no conversions.
String	WikiEngine.getText(WikiContext context, WikiPage page) Returns the un-HTMLized text of the given version of a page in the given context.
boolean	WikiEngine.pageExists(WikiPage page) Returns true, if the requested page (or an alias) exists, with the specified version in the WikiPage.
void	ReferenceManager.pageRemoved(WikiPage page) Updates the m_referedTo and m_referredBy hashmaps when a page has been deleted.
Collection<String>	WikiEngine.scanWikiLinks(WikiPage page, String pagedata) Reads a WikiPageful of data from a String and returns all links internal to this Wiki in a Collection.
void	WikiContext.setPage(WikiPage page) Sets the page that is being handled.
WikiPage	WikiContext.setRealPage(WikiPage page) Sets a reference to the real page whose content is currently being rendered.
void	WikiEngine.updateReferences(WikiPage page) Updates all references for the given page.

Method parameters in org.apache.wiki with type arguments of type WikiPage

Modifier and Type	Method and Description
void	ReferenceManager.initialize(Collection<WikiPage> pages) Initializes the entire reference manager with the initial set of pages from the collection.

Constructors in org.apache.wiki with parameters of type WikiPage

Constructor and Description
WikiContext(WikiEngine engine, javax.servlet.http.HttpServletRequest request, WikiPage page) Creates a new WikiContext for the given WikiEngine, WikiPage and HttpServletRequest.
WikiContext(WikiEngine engine, WikiPage page) Create a new WikiContext for the given WikiPage.

Uses of WikiPage in org.apache.wiki.attachment

Subclasses of WikiPage in org.apache.wiki.attachment

Modifier and Type	Class and Description
class	Attachment Describes an attachment.
class	DynamicAttachment A DynamicAttachment is an attachment which does not really exist, but is created dynamically by a JSPWiki component.

Methods in org.apache.wiki.attachment with parameters of type WikiPage

Modifier and Type	Method and Description
boolean	AttachmentManager.hasAttachments(WikiPage wikipage) Returns true, if the page has any attachments at all.
List<Attachment>	AttachmentManager.listAttachments(WikiPage wikipage) Returns the list of attachments associated with a given wiki page.

Uses of WikiPage in org.apache.wiki.auth.acl

Methods in org.apache.wiki.auth.acl with parameters of type WikiPage

Modifier and Type	Method and Description
Acl	AclManager.getPermissions(WikiPage page) Returns the access control list for the page.
Acl	DefaultAclManager.getPermissions(WikiPage page) Returns the access control list for the page.
Acl	AclManager.parseAcl(WikiPage page, String ruleLine) A helper method for parsing textual AccessControlLists.
Acl	DefaultAclManager.parseAcl(WikiPage page, String ruleLine) A helper method for parsing textual AccessControlLists.
void	AclManager.setPermissions(WikiPage page, Acl acl) Sets the access control list for the page and persists it.
void	DefaultAclManager.setPermissions(WikiPage page, Acl acl) Sets the access control list for the page and persists it by prepending it to the wiki page markup and saving the page.

Uses of WikiPage in org.apache.wiki.auth.permissions

Methods in org.apache.wiki.auth.permissions with parameters of type WikiPage

Modifier and Type	Method and Description
static PagePermission	PermissionFactory.getPagePermission(WikiPage page, String actions) Get a permission object for a WikiPage and a set of actions.

Constructors in org.apache.wiki.auth.permissions with parameters of type WikiPage

Constructor and Description
PagePermission(WikiPage page, String actions) Creates a new PagePermission for a specified page and set of actions.

Uses of WikiPage in org.apache.wiki.filters

Methods in org.apache.wiki.filters with parameters of type WikiPage

Modifier and Type	Method and Description
static String	SpamFilter.getSpamHash(WikiPage page, javax.servlet.http.HttpServletRequest request) This method is used to calculate an unique code when submitting the page to detect edit conflicts.

Uses of WikiPage in org.apache.wiki.pages

Methods in org.apache.wiki.pages that return WikiPage

Modifier and Type	Method and Description
WikiPage	DefaultPageManager.getPageInfo(String pageName, int version)
WikiPage	PageManager.getPageInfo(String pageName, int version) Finds a WikiPage object describing a particular page and version.

Methods in org.apache.wiki.pages that return types with arguments of type WikiPage

Modifier and Type	Method and Description
Collection<WikiPage>	DefaultPageManager.getAllPages()
Collection<WikiPage>	PageManager.getAllPages() Returns all pages in some random order.
List<WikiPage>	DefaultPageManager.getVersionHistory(String pageName)
List<WikiPage>	PageManager.getVersionHistory(String pageName) Gets a version history of page.

Methods in org.apache.wiki.pages with parameters of type WikiPage

Modifier and Type	Method and Description
protected boolean	DefaultPageManager.changeAcl(WikiPage page, Principal[] oldPrincipals, Principal newPrincipal) For a single wiki page, replaces all Acl entries matching a supplied array of Principals with a new Principal.
int	PageTimeComparator.compare(WikiPage w1, WikiPage w2)
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.
PageLock	DefaultPageManager.getCurrentLock(WikiPage page)
PageLock	PageManager.getCurrentLock(WikiPage page) Returns the current lock owner of a page.
PageLock	DefaultPageManager.lockPage(WikiPage page, String user)
PageLock	PageManager.lockPage(WikiPage page, String user) Locks page for editing.
void	DefaultPageManager.putPageText(WikiPage page, String content)
void	PageManager.putPageText(WikiPage page, String content) Puts the page text into the repository.

Constructors in org.apache.wiki.pages with parameters of type WikiPage

Constructor and Description
PageLock(WikiPage page, String locker, Date acquired, Date expiry) Creates a new PageLock.

Uses of WikiPage in org.apache.wiki.parser

Methods in org.apache.wiki.parser that return WikiPage

Modifier and Type	Method and Description
WikiPage	WikiDocument.getPage() Return the WikiPage for whom this WikiDocument exists.

Constructors in org.apache.wiki.parser with parameters of type WikiPage

Constructor and Description
WikiDocument(WikiPage page) Creates a new WikiDocument for a specific page.

Uses of WikiPage in org.apache.wiki.parser.markdown

Constructors in org.apache.wiki.parser.markdown with parameters of type WikiPage

Constructor and Description
MarkdownDocument(WikiPage page, com.vladsch.flexmark.util.ast.Node md)

Uses of WikiPage in org.apache.wiki.plugin

Methods in org.apache.wiki.plugin that return types with arguments of type WikiPage

Modifier and Type	Method and Description
protected List<WikiPage>	AbstractReferralPlugin.filterWikiPageCollection(Collection<WikiPage> pages)
List<WikiPage>	WeblogPlugin.findBlogEntries(WikiEngine engine, String baseName, Date start, Date end) Attempts to locate all pages that correspond to the blog entry pattern.

Method parameters in org.apache.wiki.plugin with type arguments of type WikiPage

Modifier and Type	Method and Description
protected List<WikiPage>	AbstractReferralPlugin.filterWikiPageCollection(Collection<WikiPage> pages)

Uses of WikiPage in org.apache.wiki.providers

Methods in org.apache.wiki.providers that return WikiPage

Modifier and Type	Method and Description
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.

Methods in org.apache.wiki.providers that return types with arguments of type WikiPage

Modifier and Type	Method and Description
Collection<WikiPage>	AbstractFileProvider.getAllChangedSince(Date date) Does not work.
Collection<WikiPage>	CachingProvider.getAllChangedSince(Date date) Gets a list of recent changes.
Collection<WikiPage>	WikiPageProvider.getAllChangedSince(Date date) Gets a list of recent changes.
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.
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.

Methods in org.apache.wiki.providers with parameters of type WikiPage

Modifier and Type	Method and Description
protected Properties	AbstractFileProvider.addCustomProperties(WikiPage page, Properties props) By default all page attributes that start with "@" are returned as custom properties.
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.
protected void	AbstractFileProvider.getCustomProperties(WikiPage page, Properties defaultProperties) Get custom properties using AbstractFileProvider.addCustomProperties(WikiPage, Properties), validate them using AbstractFileProvider.validateCustomPageProperties(Properties) and add them to default properties provided
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	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".
protected void	AbstractFileProvider.setCustomProperties(WikiPage page, Properties properties) Set the custom properties provided into the given page.

Uses of WikiPage in org.apache.wiki.rss

Methods in org.apache.wiki.rss that return WikiPage

Modifier and Type	Method and Description
WikiPage	Entry.getPage() Returns the page set by Entry.setPage(WikiPage).

Methods in org.apache.wiki.rss with parameters of type WikiPage

Modifier and Type	Method and Description
void	Entry.setPage(WikiPage p) Sets the WikiPage to which this Entry refers to.

Method parameters in org.apache.wiki.rss with type arguments of type WikiPage

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.
protected String	RSSGenerator.generateWikiPageRSS(WikiContext wikiContext, List<WikiPage> changed, Feed feed) Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).

Uses of WikiPage in org.apache.wiki.search

Methods in org.apache.wiki.search that return WikiPage

Modifier and Type	Method and Description
WikiPage	SearchMatcher.SearchResultImpl.getPage() Returns Wikipage for this result.
WikiPage	SearchResult.getPage() Return the page.

Methods in org.apache.wiki.search with parameters of type WikiPage

Modifier and Type	Method and Description
protected org.apache.lucene.document.Document	LuceneSearchProvider.luceneIndexPage(WikiPage page, String text, org.apache.lucene.index.IndexWriter writer) Indexes page using the given IndexWriter.
void	BasicSearchProvider.pageRemoved(WikiPage page) Delete a page from the search index
void	LuceneSearchProvider.pageRemoved(WikiPage page) Delete a page from the search index
void	SearchManager.pageRemoved(WikiPage page) Removes the page from the search cache (if any).
void	SearchProvider.pageRemoved(WikiPage page) Delete a page from the search index
void	BasicSearchProvider.reindexPage(WikiPage page) Adds a WikiPage for indexing queue.
void	LuceneSearchProvider.reindexPage(WikiPage page) Adds a page-text pair to the lucene update queue.
void	SearchManager.reindexPage(WikiPage page) Forces the reindex of the given page.
void	SearchProvider.reindexPage(WikiPage page) Adds a WikiPage for indexing queue.
protected void	LuceneSearchProvider.updateLuceneIndex(WikiPage page, String text) Updates the lucene index for a single page.

Uses of WikiPage in org.apache.wiki.ui

Methods in org.apache.wiki.ui that return WikiPage

Modifier and Type	Method and Description
protected WikiPage	CommandResolver.resolvePage(javax.servlet.http.HttpServletRequest request, String page) Looks up and returns the correct, versioned WikiPage based on a supplied page name and optional version parameter passed in an HTTP request.

Uses of WikiPage in org.apache.wiki.xmlrpc

Methods in org.apache.wiki.xmlrpc with parameters of type WikiPage

Modifier and Type	Method and Description
protected abstract Hashtable	AbstractRPCHandler.encodeWikiPage(WikiPage p)
protected Hashtable<String,Object>	RPCHandler.encodeWikiPage(WikiPage page) Encodes a single wiki page info into a Hashtable.
protected Hashtable<String,Object>	RPCHandlerUTF8.encodeWikiPage(WikiPage page) Encodes a single wiki page info into a Hashtable.