Uses of Class
org.apache.wiki.WikiEngine

Packages that use WikiEngine

Package	Description
org.apache.wiki	The chief package of JSPWiki.
org.apache.wiki.api.filters	Filter's API package of JSPWiki.
org.apache.wiki.api.plugin	Plugin's API package of JSPWiki.
org.apache.wiki.attachment	Attachment management, uploading and downloading.
org.apache.wiki.auth	Authentication, Authorization and the third A thing.
org.apache.wiki.auth.acl	Access Control List implementation.
org.apache.wiki.auth.authorize	Authorizer implementation.
org.apache.wiki.auth.login	Provides the different login modules that JSPWiki uses.
org.apache.wiki.auth.user
org.apache.wiki.diff
org.apache.wiki.event
org.apache.wiki.filters	Provides page and content filtering functionality for JSPWiki.
org.apache.wiki.i18n
org.apache.wiki.modules
org.apache.wiki.pages	Entry point for JSPWiki's Page Objects.
org.apache.wiki.parser
org.apache.wiki.plugin	Provides plugins to the JSPWiki.
org.apache.wiki.providers	Provides storage for JSPWiki.
org.apache.wiki.render
org.apache.wiki.rss
org.apache.wiki.search	Provides the JSPWiki search functionality.
org.apache.wiki.tasks	Provides specific tasks for JSPWiki, meant to be executed by the workflow framework.
org.apache.wiki.tasks.auth	Provides auth-related Tasks, meant to be executed by the workflow framework.
org.apache.wiki.ui	Java classes for management of the JSP user interface.
org.apache.wiki.ui.admin	Contains classes for the JSPWiki administrative interface.
org.apache.wiki.ui.admin.beans
org.apache.wiki.url	Provides the URL generation routines.
org.apache.wiki.workflow
org.apache.wiki.xmlrpc

Uses of WikiEngine in org.apache.wiki

Methods in org.apache.wiki that return WikiEngine

Modifier and Type	Method and Description
WikiEngine	WikiBackgroundThread.getEngine() Returns the WikiEngine that created this background thread.
WikiEngine	WikiContext.getEngine() Returns the handling engine.
static WikiEngine	WikiEngine.getInstance(javax.servlet.ServletConfig config) Gets a WikiEngine related to this servlet.
static WikiEngine	WikiEngine.getInstance(javax.servlet.ServletConfig config, Properties props) Gets a WikiEngine related to the servlet.
static WikiEngine	WikiEngine.getInstance(javax.servlet.ServletContext context, Properties props) Gets a WikiEngine related to the servlet.

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

Modifier and Type	Method and Description
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.
static WatchDog	WatchDog.getCurrentWatchDog(WikiEngine engine) Returns the current watchdog for the current thread.
static WikiSession	WikiSession.getWikiSession(WikiEngine engine, javax.servlet.http.HttpServletRequest request) Static factory method that returns the WikiSession object associated with the current HTTP request.
static WikiSession	WikiSession.guestSession(WikiEngine engine) 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.
void	WikiProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
static void	WikiSession.removeWikiSession(WikiEngine engine, javax.servlet.http.HttpServletRequest request) Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
static int	WikiSession.sessions(WikiEngine engine) Returns the total number of active wiki sessions for a particular wiki.
static Principal[]	WikiSession.userPrincipals(WikiEngine engine) Returns Principals representing the current users known to a particular wiki.

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

Constructor and Description
ReferenceManager(WikiEngine engine) Builds a new ReferenceManager.
WatchDog(WikiEngine engine, Thread thread) Creates a new WatchDog for a Thread.
WatchDog(WikiEngine engine, Watchable watch) Creates a new WatchDog for a Watchable.
WikiBackgroundThread(WikiEngine engine, int sleepInterval) 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.
WikiContext(WikiEngine engine, javax.servlet.http.HttpServletRequest request, Command command) Creates a new WikiContext for the given WikiEngine, Command and HttpServletRequest.
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.
WikiPage(WikiEngine engine, String name) Create a new WikiPage using a given engine and name.

Uses of WikiEngine in org.apache.wiki.api.filters

Fields in org.apache.wiki.api.filters declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	BasicPageFilter.m_engine

Methods in org.apache.wiki.api.filters with parameters of type WikiEngine

Modifier and Type	Method and Description
void	BasicPageFilter.destroy(WikiEngine engine) Called for every filter, e.g. on wiki engine shutdown.
void	PageFilter.destroy(WikiEngine engine) Called for every filter, e.g. on wiki engine shutdown.
void	BasicPageFilter.initialize(WikiEngine engine, Properties properties) If you override this, you should call super.initialize() first.
void	PageFilter.initialize(WikiEngine engine, Properties properties) Is called whenever the a new PageFilter is instantiated and reset.

Uses of WikiEngine in org.apache.wiki.api.plugin

Methods in org.apache.wiki.api.plugin with parameters of type WikiEngine

Modifier and Type	Method and Description
void	InitializablePlugin.initialize(WikiEngine engine) Called whenever the plugin is being instantiated for the first time.

Uses of WikiEngine in org.apache.wiki.attachment

Constructors in org.apache.wiki.attachment with parameters of type WikiEngine

Constructor and Description
Attachment(WikiEngine engine, String parentPage, String fileName) Creates a new attachment.
AttachmentManager(WikiEngine engine, Properties props) Creates a new AttachmentManager.
DynamicAttachment(WikiEngine engine, String parentPage, String fileName, DynamicAttachmentProvider provider) Creates a DynamicAttachment.

Uses of WikiEngine in org.apache.wiki.auth

Methods in org.apache.wiki.auth with parameters of type WikiEngine

Modifier and Type	Method and Description
protected static URL	AuthenticationManager.findConfigFile(WikiEngine engine, String name) Looks up and obtains a configuration file inside the WEB-INF folder of a wiki webapp.
static SessionMonitor	SessionMonitor.getInstance(WikiEngine engine) Returns the instance of the SessionMonitor for this wiki.
void	AuthenticationManager.initialize(WikiEngine engine, Properties props) Creates an AuthenticationManager instance for the given WikiEngine and the specified set of properties.
void	AuthorizationManager.initialize(WikiEngine engine, Properties properties) Initializes AuthorizationManager with an engine and set of properties.
void	Authorizer.initialize(WikiEngine engine, Properties props) Initializes the authorizer.
void	UserManager.initialize(WikiEngine engine, Properties props) Initializes the engine for its nefarious purposes.
void	UserManager.DummyUserDatabase.initialize(WikiEngine engine, Properties props) No-op.

Constructors in org.apache.wiki.auth with parameters of type WikiEngine

Constructor and Description
SecurityVerifier(WikiEngine engine, WikiSession session) Constructs a new SecurityVerifier for a supplied WikiEngine and WikiSession.

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

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

Modifier and Type	Method and Description
void	AclManager.initialize(WikiEngine engine, Properties props) Initializes the AclManager with a supplied wiki engine and properties.
void	DefaultAclManager.initialize(WikiEngine engine, Properties props) Initializes the AclManager with a supplied wiki engine and properties.

Uses of WikiEngine in org.apache.wiki.auth.authorize

Fields in org.apache.wiki.auth.authorize declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	GroupManager.m_engine
protected WikiEngine	WebContainerAuthorizer.m_engine

Methods in org.apache.wiki.auth.authorize with parameters of type WikiEngine

Modifier and Type	Method and Description
void	GroupDatabase.initialize(WikiEngine engine, Properties props) Initializes the group database based on values from a Properties object.
void	GroupManager.initialize(WikiEngine engine, Properties props) Initializes the group cache by initializing the group database and obtaining a list of all of the groups it stores.
void	JDBCGroupDatabase.initialize(WikiEngine engine, Properties props) Initializes the group database based on values from a Properties object.
void	WebContainerAuthorizer.initialize(WikiEngine engine, Properties props) Initializes the authorizer for.
void	XMLGroupDatabase.initialize(WikiEngine engine, Properties props) Initializes the group database based on values from a Properties object.

Uses of WikiEngine in org.apache.wiki.auth.login

Methods in org.apache.wiki.auth.login that return WikiEngine

Modifier and Type	Method and Description
WikiEngine	WikiEngineCallback.getEngine() Returns the engine.

Methods in org.apache.wiki.auth.login with parameters of type WikiEngine

Modifier and Type	Method and Description
static void	CookieAuthenticationLoginModule.clearLoginCookie(WikiEngine engine, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears away the login cookie, and removes the uid-username mapping file as well.
void	WikiEngineCallback.setEngine(WikiEngine engine) Sets the engine object.
static void	CookieAuthenticationLoginModule.setLoginCookie(WikiEngine engine, javax.servlet.http.HttpServletResponse response, String username) Sets a login cookie based on properties set by the user.

Constructors in org.apache.wiki.auth.login with parameters of type WikiEngine

Constructor and Description
WebContainerCallbackHandler(WikiEngine engine, javax.servlet.http.HttpServletRequest request) Create a new handler.
WikiCallbackHandler(WikiEngine engine, javax.servlet.http.HttpServletRequest request, String username, String password) Create a new callback handler.

Uses of WikiEngine in org.apache.wiki.auth.user

Methods in org.apache.wiki.auth.user with parameters of type WikiEngine

Modifier and Type	Method and Description
abstract void	AbstractUserDatabase.initialize(WikiEngine engine, Properties props) Initializes the user database based on values from a Properties object.
void	JDBCUserDatabase.initialize(WikiEngine engine, Properties props)
void	UserDatabase.initialize(WikiEngine engine, Properties props) Initializes the user database based on values from a Properties object.
void	XMLUserDatabase.initialize(WikiEngine engine, Properties props) Initializes the user database based on values from a Properties object.

Uses of WikiEngine in org.apache.wiki.diff

Methods in org.apache.wiki.diff with parameters of type WikiEngine

Modifier and Type	Method and Description
void	ContextualDiffProvider.initialize(WikiEngine engine, Properties properties)
void	DiffProvider.NullDiffProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	ExternalDiffProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	TraditionalDiffProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.

Constructors in org.apache.wiki.diff with parameters of type WikiEngine

Constructor and Description
DifferenceManager(WikiEngine engine, Properties props) Creates a new DifferenceManager for the given engine.

Uses of WikiEngine in org.apache.wiki.event

Methods in org.apache.wiki.event that return WikiEngine

Modifier and Type	Method and Description
WikiEngine	WikiEngineEvent.getEngine() Returns the WikiEngine that spawned this event.

Uses of WikiEngine in org.apache.wiki.filters

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

Modifier and Type	Method and Description
void	CreoleFilter.initialize(WikiEngine engine, Properties props) If you override this, you should call super.initialize() first.
void	PingWeblogsComFilter.initialize(WikiEngine engine, Properties props) If you override this, you should call super.initialize() first.
void	SpamFilter.initialize(WikiEngine engine, Properties properties) If you override this, you should call super.initialize() first.

Constructors in org.apache.wiki.filters with parameters of type WikiEngine

Constructor and Description
DefaultFilterManager(WikiEngine engine, Properties props) Constructs a new FilterManager object.

Uses of WikiEngine in org.apache.wiki.i18n

Constructors in org.apache.wiki.i18n with parameters of type WikiEngine

Constructor and Description
InternationalizationManager(WikiEngine engine) Constructs a new InternationalizationManager.

Uses of WikiEngine in org.apache.wiki.modules

Fields in org.apache.wiki.modules declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	ModuleManager.m_engine

Constructors in org.apache.wiki.modules with parameters of type WikiEngine

Constructor and Description
ModuleManager(WikiEngine engine) Constructs the ModuleManager.

Uses of WikiEngine in org.apache.wiki.pages

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

Modifier and Type	Method and Description
WikiEngine	DefaultPageManager.getEngine()
WikiEngine	PageManager.getEngine() Returns the WikiEngine to which this PageManager belongs to.

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

Constructor and Description
DefaultPageManager(WikiEngine engine, Properties props) Creates a new PageManager.

Uses of WikiEngine in org.apache.wiki.parser

Fields in org.apache.wiki.parser declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	MarkupParser.m_engine

Uses of WikiEngine in org.apache.wiki.plugin

Fields in org.apache.wiki.plugin declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	AbstractReferralPlugin.m_engine

Methods in org.apache.wiki.plugin with parameters of type WikiEngine

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.
void	PageViewPlugin.initialize(WikiEngine engine) Initialize the PageViewPlugin and its singleton.
void	PageViewPlugin.PageViewManager.initialize(WikiEngine engine) Initialize the page view manager.
protected void	DefaultPluginManager.WikiPluginInfo.initializePlugin(DefaultPluginManager.WikiPluginInfo info, WikiEngine engine, List<String> searchPath, List<String> externalJars) Initializes a plugin, if it has not yet been initialized.

Constructors in org.apache.wiki.plugin with parameters of type WikiEngine

Constructor and Description
DefaultPluginManager(WikiEngine engine, Properties props) Create a new PluginManager.

Uses of WikiEngine in org.apache.wiki.providers

Fields in org.apache.wiki.providers declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	AbstractFileProvider.m_engine

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

Modifier and Type	Method and Description
void	AbstractFileProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	BasicAttachmentProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	CachingAttachmentProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	CachingProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.
void	VersioningFileProvider.initialize(WikiEngine engine, Properties properties) Initializes the page provider.

Uses of WikiEngine in org.apache.wiki.render

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

Modifier and Type	Method and Description
void	RenderingManager.initialize(WikiEngine engine, Properties properties) Initializes the RenderingManager.

Uses of WikiEngine in org.apache.wiki.rss

Constructors in org.apache.wiki.rss with parameters of type WikiEngine

Constructor and Description
RSSGenerator(WikiEngine engine, Properties properties) Initialize the RSS generator for a given WikiEngine.
RSSThread(WikiEngine engine, File rssFile, int rssInterval) Create a new RSS thread.

Uses of WikiEngine in org.apache.wiki.search

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

Modifier and Type	Method and Description
protected WikiEngine	LuceneSearchProvider.getEngine() Returns the handling engine.

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

Modifier and Type	Method and Description
void	BasicSearchProvider.initialize(WikiEngine engine, Properties props) Initializes the page provider.
void	LuceneSearchProvider.initialize(WikiEngine engine, Properties props) Initializes the page provider.
void	SearchManager.initialize(WikiEngine engine, Properties properties) This particular method starts off indexing and all sorts of various activities, so you need to run this last, after things are done.

Constructors in org.apache.wiki.search with parameters of type WikiEngine

Constructor and Description
SearchManager(WikiEngine engine, Properties properties) Creates a new SearchManager.
SearchMatcher(WikiEngine engine, QueryItem[] queries) Creates a new SearchMatcher.

Uses of WikiEngine in org.apache.wiki.tasks

Methods in org.apache.wiki.tasks with parameters of type WikiEngine

Modifier and Type	Method and Description
Step	DefaultTasksManager.buildSaveUserProfileTask(WikiEngine engine, Locale loc) Builds a save user profile task.
Step	TasksManager.buildSaveUserProfileTask(WikiEngine engine, Locale loc) Builds a save user profile task.

Uses of WikiEngine in org.apache.wiki.tasks.auth

Constructors in org.apache.wiki.tasks.auth with parameters of type WikiEngine

Constructor and Description
SaveUserProfileTask(WikiEngine engine, Locale loc) Constructs a new Task for saving a user profile.

Uses of WikiEngine in org.apache.wiki.ui

Fields in org.apache.wiki.ui declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	WikiServletFilter.m_engine

Constructors in org.apache.wiki.ui with parameters of type WikiEngine

Constructor and Description
CommandResolver(WikiEngine engine, Properties properties) Constructs a CommandResolver for a given WikiEngine.
EditorManager(WikiEngine engine)
TemplateManager(WikiEngine engine, Properties properties) Creates a new TemplateManager.
WikiRequestWrapper(WikiEngine engine, javax.servlet.http.HttpServletRequest request) Constructs a new wrapped request.

Uses of WikiEngine in org.apache.wiki.ui.admin

Fields in org.apache.wiki.ui.admin declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	SimpleAdminBean.m_engine Provides access to a WikiEngine instance to which this AdminBean belongs to.

Methods in org.apache.wiki.ui.admin with parameters of type WikiEngine

Modifier and Type	Method and Description
void	AdminBean.initialize(WikiEngine engine)
void	SimpleAdminBean.initialize(WikiEngine engine) Initialize the AdminBean by setting up a WikiEngine instance internally.

Constructors in org.apache.wiki.ui.admin with parameters of type WikiEngine

Constructor and Description
DefaultAdminBeanManager(WikiEngine engine)

Uses of WikiEngine in org.apache.wiki.ui.admin.beans

Methods in org.apache.wiki.ui.admin.beans with parameters of type WikiEngine

Modifier and Type	Method and Description
void	PlainEditorAdminBean.initialize(WikiEngine engine)

Constructors in org.apache.wiki.ui.admin.beans with parameters of type WikiEngine

Constructor and Description
CoreBean(WikiEngine engine)
FilterBean(WikiEngine engine)
ModuleBean(WikiEngine engine)
PluginBean(WikiEngine engine)
SearchManagerBean(WikiEngine engine)
UserBean(WikiEngine engine)

Uses of WikiEngine in org.apache.wiki.url

Fields in org.apache.wiki.url declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	DefaultURLConstructor.m_engine

Methods in org.apache.wiki.url with parameters of type WikiEngine

Modifier and Type	Method and Description
void	DefaultURLConstructor.initialize(WikiEngine engine, Properties properties) Initializes.
void	ShortURLConstructor.initialize(WikiEngine engine, Properties properties) Initializes.
void	ShortViewURLConstructor.initialize(WikiEngine engine, Properties properties) Initializes.
void	URLConstructor.initialize(WikiEngine engine, Properties properties) Initializes.

Uses of WikiEngine in org.apache.wiki.workflow

Methods in org.apache.wiki.workflow that return WikiEngine

Modifier and Type	Method and Description
protected WikiEngine	WorkflowManager.getEngine() Protected helper method that returns the associated WikiEngine

Methods in org.apache.wiki.workflow with parameters of type WikiEngine

Modifier and Type	Method and Description
static WorkflowBuilder	WorkflowBuilder.getBuilder(WikiEngine engine) Returns the WorkflowBuilder instance for a WikiEngine.
void	WorkflowManager.initialize(WikiEngine engine, Properties props) Initializes the WorkflowManager using a specfied WikiEngine and properties.

Uses of WikiEngine in org.apache.wiki.xmlrpc

Fields in org.apache.wiki.xmlrpc declared as WikiEngine

Modifier and Type	Field and Description
protected WikiEngine	AbstractRPCHandler.m_engine