Uses of Interface
org.apache.wiki.api.core.Page

Packages that use Page

Package	Description
org.apache.wiki	The chief package of JSPWiki.
org.apache.wiki.api.core	JSPWiki's central API.
org.apache.wiki.api.providers	Page Providers' API package of JSPWiki.
org.apache.wiki.api.search	Search's API package of JSPWiki.
org.apache.wiki.api.spi	JSPWiki's SPI package.
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.references	Provides the JSPWiki track of pages' references.
org.apache.wiki.render	Provides the JSPWiki rendering functionality.
org.apache.wiki.rss	Provides the JSPWiki RSS feeds functionality.
org.apache.wiki.search	Provides the JSPWiki search functionality.
org.apache.wiki.search.kendra
org.apache.wiki.spi
org.apache.wiki.ui	Java classes for management of the JSP user interface.
org.apache.wiki.xmlrpc

Uses of Page in org.apache.wiki

Classes in org.apache.wiki that implement Page

Modifier and Type	Class	Description
class	WikiPage	Simple wrapper class for the Wiki page attributes.

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

Modifier and Type	Method	Description
int	WikiPage.compareTo(Page page)	Compares a page with another by name using the defined PageNameComparator.
protected static Command	WikiContext.findCommand(Engine engine, javax.servlet.http.HttpServletRequest request, Page page)	Looks up and returns a PageCommand based on a supplied WikiPage and HTTP request.
void	WikiContext.setPage(Page page)	Sets the page that is being handled.
WikiPage	WikiContext.setRealPage(Page page)	Sets a reference to the real page whose content is currently being rendered.

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

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

Uses of Page in org.apache.wiki.api.core

Subinterfaces of Page in org.apache.wiki.api.core

Modifier and Type	Interface	Description
interface	Attachment	Describes an attachment.

Methods in org.apache.wiki.api.core that return Page

Modifier and Type	Method	Description
Page	Page.clone()
Page	Context.getPage()	Returns the WikiPage that is being handled.
Page	Context.getRealPage()	Gets a reference to the real WikiPage whose content is currently being rendered.
Page	Context.setRealPage(Page wikiPage)	Sets a reference to the real WikiPage whose content is currently being rendered.

Methods in org.apache.wiki.api.core with parameters of type Page

Modifier and Type	Method	Description
void	Context.setPage(Page wikiPage)	Sets the WikiPage that is being handled.
Page	Context.setRealPage(Page wikiPage)	Sets a reference to the real WikiPage whose content is currently being rendered.

Uses of Page in org.apache.wiki.api.providers

Methods in org.apache.wiki.api.providers that return Page

Modifier and Type	Method	Description
Page	PageProvider.getPageInfo(java.lang.String page, int version)	Returns info about the page.

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

Modifier and Type	Method	Description
java.util.Collection<Page>	PageProvider.getAllChangedSince(java.util.Date date)	Gets a list of recent changes.
java.util.Collection<Page>	PageProvider.getAllPages()	Returns all pages.
java.util.List<Page>	PageProvider.getVersionHistory(java.lang.String page)	Returns version history.

Methods in org.apache.wiki.api.providers with parameters of type Page

Modifier and Type	Method	Description
Attachment	AttachmentProvider.getAttachmentInfo(Page page, java.lang.String name, int version)	Returns info about an attachment.
java.util.List<Attachment>	AttachmentProvider.listAttachments(Page page)	Lists all attachments attached to a page.
void	PageProvider.putPageText(Page page, java.lang.String text)	Attempts to save the page text for page "page".

Uses of Page in org.apache.wiki.api.search

Methods in org.apache.wiki.api.search that return Page

Modifier and Type	Method	Description
Page	SearchResult.getPage()	Return the page.

Uses of Page in org.apache.wiki.api.spi

Methods in org.apache.wiki.api.spi that return Page

Modifier and Type	Method	Description
Page	ContentsDSL.page(Engine engine, java.lang.String name)	Creates a Page instance.
Page	ContentsSPI.page(Engine engine, java.lang.String name)	Creates a Page instance.

Methods in org.apache.wiki.api.spi with parameters of type Page

Modifier and Type	Method	Description
Context	ContextDSL.create(Engine engine, javax.servlet.http.HttpServletRequest request, Page page)	Creates a new Context for the given Engine, Page and HttpServletRequest.
Context	ContextDSL.create(Engine engine, Page page)	Create a new Context for the given Page.
Context	ContextSPI.create(Engine engine, javax.servlet.http.HttpServletRequest request, Page page)	Creates a new Context for the given Engine, Page and HttpServletRequest.
Context	ContextSPI.create(Engine engine, Page page)	Create a new Context for the given Page.

Uses of Page in org.apache.wiki.attachment

Classes in org.apache.wiki.attachment that implement Page

Modifier and Type	Class	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 Page

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

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

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

Modifier and Type	Method	Description
Acl	AclManager.getPermissions(Page page)	Returns the access control list for the page.
Acl	DefaultAclManager.getPermissions(Page page)	Returns the access control list for the page.
Acl	AclManager.parseAcl(Page page, java.lang.String ruleLine)	A helper method for parsing textual AccessControlLists.
Acl	DefaultAclManager.parseAcl(Page page, java.lang.String ruleLine)	A helper method for parsing textual AccessControlLists.
void	AclManager.setPermissions(Page page, Acl acl)	Sets the access control list for the page and persists it.
void	DefaultAclManager.setPermissions(Page page, Acl acl)	Sets the access control list for the page and persists it.

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

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

Modifier and Type	Method	Description
static PagePermission	PermissionFactory.getPagePermission(Page page, java.lang.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 Page

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

Uses of Page in org.apache.wiki.filters

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

Modifier and Type	Method	Description
static java.lang.String	SpamFilter.getSpamHash(Page 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 Page in org.apache.wiki.pages

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

Modifier and Type	Method	Description
<T extends Page> java.util.List<T>	DefaultPageManager.getVersionHistory(java.lang.String pageName)	Gets a version history of page.
<T extends Page> java.util.List<T>	PageManager.getVersionHistory(java.lang.String pageName)	Gets a version history of page.

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

Modifier and Type	Method	Description
Page	DefaultPageManager.getPage(java.lang.String pagereq)	Finds the corresponding WikiPage object based on the page name.
Page	DefaultPageManager.getPage(java.lang.String pagereq, int version)	Finds the corresponding WikiPage object base on the page name and version.
Page	PageManager.getPage(java.lang.String pagereq)	Finds the corresponding WikiPage object based on the page name.
Page	PageManager.getPage(java.lang.String pagereq, int version)	Finds the corresponding WikiPage object base on the page name and version.
Page	DefaultPageManager.getPageInfo(java.lang.String pageName, int version)	Finds a WikiPage object describing a particular page and version.
Page	PageManager.getPageInfo(java.lang.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 Page

Modifier and Type	Method	Description
java.util.Collection<Page>	DefaultPageManager.getAllPages()	Returns all pages in some random order.
java.util.Collection<Page>	PageManager.getAllPages()	Returns all pages in some random order.
java.util.Set<Page>	DefaultPageManager.getRecentChanges()	Returns a Collection of WikiPages, sorted in time order of last change (i.e. first object is the most recently changed).
java.util.Set<Page>	PageManager.getRecentChanges()	Returns a Collection of WikiPages, sorted in time order of last change (i.e. first object is the most recently changed).

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

Modifier and Type	Method	Description
protected boolean	DefaultPageManager.changeAcl(Page page, java.security.Principal[] oldPrincipals, java.security.Principal newPrincipal)	For a single wiki page, replaces all Acl entries matching a supplied array of Principals with a new Principal.
int	PageTimeComparator.compare(Page p1, Page p2)
void	DefaultPageManager.deletePage(Page page)	Deletes an entire page, all versions, all traces.
void	PageManager.deletePage(Page page)	Deletes an entire page, all versions, all traces.
void	DefaultPageManager.deleteVersion(Page page)	Deletes only a specific version of a WikiPage.
void	PageManager.deleteVersion(Page page)	Deletes only a specific version of a WikiPage.
PageLock	DefaultPageManager.getCurrentLock(Page page)	Returns the current lock owner of a page.
PageLock	PageManager.getCurrentLock(Page page)	Returns the current lock owner of a page.
default java.lang.String	PageManager.getPureText(Page page)	Returns the pure text of a page, no conversions.
default java.lang.String	PageManager.getText(Page page)	Returns the un-HTMLized text of the given version of a page in the given context.
PageLock	DefaultPageManager.lockPage(Page page, java.lang.String user)	Locks page for editing.
PageLock	PageManager.lockPage(Page page, java.lang.String user)	Locks page for editing.
default boolean	PageManager.pageExists(Page page)	Checks for existence of a specific page and version denoted by a WikiPage on the underlying WikiPageProvider.
void	DefaultPageManager.putPageText(Page page, java.lang.String content)	Puts the page text into the repository.
void	PageManager.putPageText(Page page, java.lang.String content)	Puts the page text into the repository.
default boolean	PageManager.wikiPageExists(Page page)	Returns true, if the requested page (or an alias) exists, with the specified version in the WikiPage.

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

Constructor	Description
PageLock(Page page, java.lang.String locker, java.util.Date acquired, java.util.Date expiry)	Creates a new PageLock.

Uses of Page in org.apache.wiki.parser

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

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

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

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

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

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

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

Uses of Page in org.apache.wiki.plugin

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

Modifier and Type	Method	Description
protected java.util.List<Page>	AbstractReferralPlugin.filterWikiPageCollection(java.util.Collection<Page> pages)
java.util.List<Page>	WeblogPlugin.findBlogEntries(Engine engine, java.lang.String baseName, java.util.Date start, java.util.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 Page

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

Uses of Page in org.apache.wiki.providers

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

Modifier and Type	Method	Description
Page	AbstractFileProvider.getPageInfo(java.lang.String page, int version)	Always returns the latest version, since FileSystemProvider does not support versioning.
Page	CachingProvider.getPageInfo(java.lang.String pageName, int version)	Returns info about the page.
Page	FileSystemProvider.getPageInfo(java.lang.String page, int version)	Always returns the latest version, since FileSystemProvider does not support versioning.
Page	VersioningFileProvider.getPageInfo(java.lang.String page, int version)	Always returns the latest version, since FileSystemProvider does not support versioning.
Page	WikiPageAdapterProvider.getPageInfo(java.lang.String page, int version)	Deprecated. Returns info about the page.

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

Modifier and Type	Method	Description
java.util.Collection<Page>	AbstractFileProvider.getAllChangedSince(java.util.Date date)	Does not work.
java.util.Collection<Page>	CachingProvider.getAllChangedSince(java.util.Date date)	Gets a list of recent changes.
java.util.Collection<Page>	WikiPageAdapterProvider.getAllChangedSince(java.util.Date date)	Deprecated. Gets a list of recent changes.
java.util.Collection<Page>	AbstractFileProvider.getAllPages()	Returns all pages.
java.util.Collection<Page>	CachingProvider.getAllPages()	Returns all pages.
java.util.Collection<Page>	VersioningFileProvider.getAllPages()	Returns all pages.
java.util.Collection<Page>	WikiPageAdapterProvider.getAllPages()	Deprecated. Returns all pages.
java.util.List<Page>	AbstractFileProvider.getVersionHistory(java.lang.String page)	The FileSystemProvider provides only one version.
java.util.List<Page>	CachingProvider.getVersionHistory(java.lang.String pageName)	Returns version history.
java.util.List<Page>	VersioningFileProvider.getVersionHistory(java.lang.String page)	The FileSystemProvider provides only one version.
java.util.List<Page>	WikiPageAdapterProvider.getVersionHistory(java.lang.String page)	Deprecated. Returns version history.

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

Modifier and Type	Method	Description
protected java.util.Properties	AbstractFileProvider.addCustomProperties(Page page, java.util.Properties props)	By default all page attributes that start with "@" are returned as custom properties.
Attachment	BasicAttachmentProvider.getAttachmentInfo(Page page, java.lang.String name, int version)	Returns info about an attachment.
Attachment	CachingAttachmentProvider.getAttachmentInfo(Page page, java.lang.String name, int version)	Returns info about an attachment.
Attachment	WikiAttachmentAdapterProvider.getAttachmentInfo(Page page, java.lang.String name, int version)	Deprecated. Returns info about an attachment.
protected void	AbstractFileProvider.getCustomProperties(Page page, java.util.Properties defaultProperties)	Get custom properties using AbstractFileProvider.addCustomProperties(Page, Properties), validate them using AbstractFileProvider.validateCustomPageProperties(Properties) and add them to default properties provided
java.util.List<Attachment>	BasicAttachmentProvider.listAttachments(Page page)	Lists all attachments attached to a page.
java.util.List<Attachment>	CachingAttachmentProvider.listAttachments(Page page)	Lists all attachments attached to a page.
java.util.List<Attachment>	WikiAttachmentAdapterProvider.listAttachments(Page page)	Deprecated. Lists all attachments attached to a page.
void	AbstractFileProvider.putPageText(Page page, java.lang.String text)	Attempts to save the page text for page "page".
void	CachingProvider.putPageText(Page page, java.lang.String text)	Attempts to save the page text for page "page".
void	FileSystemProvider.putPageText(Page page, java.lang.String text)	Attempts to save the page text for page "page".
void	VersioningFileProvider.putPageText(Page page, java.lang.String text)	Attempts to save the page text for page "page".
void	WikiPageAdapterProvider.putPageText(Page page, java.lang.String text)	Deprecated. Attempts to save the page text for page "page".
protected void	AbstractFileProvider.setCustomProperties(Page page, java.util.Properties properties)	Set the custom properties provided into the given page.

Uses of Page in org.apache.wiki.references

Methods in org.apache.wiki.references with parameters of type Page

Modifier and Type	Method	Description
void	DefaultReferenceManager.pageRemoved(Page page)	Updates the m_referedTo and m_referredBy hashmaps when a page has been deleted.
void	ReferenceManager.pageRemoved(Page page)	Updates the m_referedTo and m_referredBy hashmaps when a page has been deleted.
java.util.Collection<java.lang.String>	DefaultReferenceManager.scanWikiLinks(Page page, java.lang.String pagedata)	Reads a WikiPageful of data from a String and returns all links internal to this Wiki in a Collection.
java.util.Collection<java.lang.String>	ReferenceManager.scanWikiLinks(Page page, java.lang.String pagedata)	Reads a WikiPageful of data from a String and returns all links internal to this Wiki in a Collection.
void	DefaultReferenceManager.updateReferences(Page page)	Updates all references for the given page.
void	ReferenceManager.updateReferences(Page page)	Updates all references for the given page.

Method parameters in org.apache.wiki.references with type arguments of type Page

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

Uses of Page in org.apache.wiki.render

Methods in org.apache.wiki.render with parameters of type Page

Modifier and Type	Method	Description
java.lang.String	DefaultRenderingManager.getHTML(Context context, Page page)	Returns the converted HTML of the page using a different context than the default context.
java.lang.String	RenderingManager.getHTML(Context context, Page page)	Returns the converted HTML of the page using a different context than the default context.

Uses of Page in org.apache.wiki.rss

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

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

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

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

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

Modifier and Type	Method	Description
java.lang.String	DefaultRSSGenerator.generateBlogRSS(Context wikiContext, java.util.List<Page> changed, Feed feed)	Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).
java.lang.String	RSSGenerator.generateBlogRSS(Context wikiContext, java.util.List<Page> changed, Feed feed)	Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).
java.lang.String	DefaultRSSGenerator.generateFeed(Context wikiContext, java.util.List<Page> changed, java.lang.String mode, java.lang.String type)	Generates a feed based on a context and list of changes.
java.lang.String	RSSGenerator.generateFeed(Context wikiContext, java.util.List<Page> changed, java.lang.String mode, java.lang.String type)	Generates a feed based on a context and list of changes.
java.lang.String	DefaultRSSGenerator.generateWikiPageRSS(Context wikiContext, java.util.List<Page> changed, Feed feed)	Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).
java.lang.String	RSSGenerator.generateWikiPageRSS(Context wikiContext, java.util.List<Page> changed, Feed feed)	Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).

Uses of Page in org.apache.wiki.search

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

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

Uses of Page in org.apache.wiki.search.kendra

Methods in org.apache.wiki.search.kendra with parameters of type Page

Modifier and Type	Method	Description
void	KendraSearchProvider.pageRemoved(Page page)	Delete a page from the search index.
void	KendraSearchProvider.reindexPage(Page page)	Adds a WikiPage for indexing queue.

Uses of Page in org.apache.wiki.spi

Methods in org.apache.wiki.spi that return Page

Modifier and Type	Method	Description
Page	ContentsSPIDefaultImpl.page(Engine engine, java.lang.String name)	Creates a Page instance.

Methods in org.apache.wiki.spi with parameters of type Page

Modifier and Type	Method	Description
Context	ContextSPIDefaultImpl.create(Engine engine, javax.servlet.http.HttpServletRequest request, Page page)	Creates a new Context for the given Engine, Page and HttpServletRequest.
Context	ContextSPIDefaultImpl.create(Engine engine, Page page)	Create a new Context for the given Page.

Uses of Page in org.apache.wiki.ui

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

Modifier and Type	Method	Description
Page	CommandResolver.resolvePage(javax.servlet.http.HttpServletRequest request, java.lang.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.
Page	DefaultCommandResolver.resolvePage(javax.servlet.http.HttpServletRequest request, java.lang.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 Page in org.apache.wiki.xmlrpc

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

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