com.aspc.wiki

Class WikiEngine

java.lang.Object

com.ecyrd.jspwiki.WikiEngine

com.aspc.wiki.WikiEngine

public class WikiEngine
extends WikiEngine

WIKI engine
THREAD MODE: SINGLE-THREADED

Since:

3 Oct 2010

Author:

Lahav

Field Summary

Fields inherited from class com.ecyrd.jspwiki.WikiEngine

PREFS_COOKIE_NAME, PROP_ACL_MANAGER_IMPL, PROP_ALLOW_CREATION_OF_EMPTY_PAGES, PROP_APPNAME, PROP_BASEURL, PROP_BEAUTIFYTITLE, PROP_ENCODING, PROP_FRONTPAGE, PROP_INTERWIKIREF, PROP_MATCHPLURALS, PROP_REFSTYLE, PROP_RUNFILTERS, PROP_STOREUSERNAME, PROP_TEMPLATEDIR, PROP_URLCONSTRUCTOR, PROP_WORKDIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WikiEngine(ServletContext context, java.lang.String appid, java.util.Properties props) Instantiate using this method when you're running as a servlet and WikiEngine will figure out where to look for the property file.

Method Summary

Modifier and Type	Method and Description
WikiContext	createContext(HttpServletRequest request, java.lang.String requestContext) Shortcut to create a WikiContext from a supplied HTTP request, using a default wiki context.
java.lang.String	getHTML(java.lang.String pagename, int version) Returns the converted HTML of the page's specific version.

Methods inherited from class com.ecyrd.jspwiki.WikiEngine

addWikiEventListener, beautifyTitle, beautifyTitleNoBreak, decodeName, deletePage, deleteVersion, encodeName, findPages, fireEvent, getAclManager, getAdminBeanManager, getAllInlinedImagePatterns, getAllInterWikiLinks, getApplicationName, getAttachmentManager, getAttachmentURL, getAttribute, getAuthenticationManager, getAuthorizationManager, getBaseURL, getCommandResolver, getContentEncoding, getCurrentProvider, getCurrentProviderInfo, getCurrentWatchDog, getDiff, getDifferenceManager, getEditorManager, getEditURL, getFilterManager, getFinalPageName, getFrontPage, getGlobalRSSURL, getGroupManager, getHTML, getHTML, getInstance, getInstance, getInstance, getInternationalizationManager, getInterWikiURL, getPage, getPage, getPageCount, getPageManager, getPageRenamer, getPageSorter, getPluginManager, getPluginSearchPath, getProgressManager, getPureText, getPureText, getRecentChanges, getRedirectURL, getReferenceManager, getRenderingManager, getRequiredProperty, getRootPath, getRSSGenerator, getSearchManager, getServletContext, getSpecialPageReference, getStartTime, getTemplateDir, getTemplateManager, getText, getText, getText, getURL, getURLConstructor, getUserManager, getVariable, getVariableManager, getVersionHistory, getViewURL, getWikiProperties, getWorkDir, getWorkflowManager, initReferenceManager, pageExists, pageExists, pageExists, removeAttribute, removeWikiEventListener, renamePage, safeGetParameter, safeGetQueryString, saveText, scanWikiLinks, setAttribute, shutdown, textToHTML, textToHTML, textToHTML, updateReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WikiEngine

protected WikiEngine(ServletContext context,
                     java.lang.String appid,
                     java.util.Properties props)
              throws WikiException

Instantiate using this method when you're running as a servlet and WikiEngine will figure out where to look for the property file. Do not use this method - use WikiEngine.getInstance() instead.

Parameters:

context - A ServletContext.

appid - An Application ID. This application is an unique random string which is used to recognize this WikiEngine.

props - The WikiEngine configuration.

Throws:

WikiException - If the WikiEngine construction fails.

Method Detail

getHTML

public java.lang.String getHTML(java.lang.String pagename,
                                int version)

Returns the converted HTML of the page's specific version. The version must be a positive integer, otherwise the current version is returned.

Overrides:

getHTML in class WikiEngine

Parameters:

pagename - WikiName of the page to convert.

version - Version number to fetch

Returns:

HTML-rendered page text.

createContext

public WikiContext createContext(HttpServletRequest request,
                                 java.lang.String requestContext)

Shortcut to create a WikiContext from a supplied HTTP request, using a default wiki context.

Overrides:

createContext in class WikiEngine

Parameters:

request - the HTTP request

requestContext - the default context to use

Returns:

a new WikiContext object.

Since:

2.1.15.

See Also:

CommandResolver, Command